ClusterInstanceState class
Input properties used for looking up and filtering ClusterInstance resources.
Constructors
-
ClusterInstanceState({Input<
bool?> ? applyImmediately, Input<String?> ? arn, Input<bool?> ? autoMinorVersionUpgrade, Input<String?> ? availabilityZone, Input<String?> ? caCertIdentifier, Input<String?> ? clusterIdentifier, Input<bool?> ? copyTagsToSnapshot, Input<String?> ? customIamInstanceProfile, Input<String?> ? dbParameterGroupName, Input<String?> ? dbSubnetGroupName, Input<String?> ? dbiResourceId, Input<String?> ? endpoint, Input<EngineType?> ? engine, Input<String?> ? engineVersion, Input<String?> ? engineVersionActual, Input<bool?> ? forceDestroy, Input<String?> ? identifier, Input<String?> ? identifierPrefix, Input? instanceClass, Input<String?> ? kmsKeyId, Input<int?> ? monitoringInterval, Input<String?> ? monitoringRoleArn, Input<String?> ? networkType, Input<bool?> ? performanceInsightsEnabled, Input<String?> ? performanceInsightsKmsKeyId, Input<int?> ? performanceInsightsRetentionPeriod, Input<int?> ? port, Input<String?> ? preferredBackupWindow, Input<String?> ? preferredMaintenanceWindow, Input<int?> ? promotionTier, Input<bool?> ? publiclyAccessible, Input<String?> ? region, Input<bool?> ? storageEncrypted, Input<Map< ? tags, Input<String, String> ?>Map< ? tagsAll, Input<String, String> ?>bool?> ? writer}) -
Creates a new ClusterInstanceState.
applyImmediatelySpecifies whether any database modifications are applied immediately, or during the next maintenance window. Default isfalse.arnARN of cluster instanceautoMinorVersionUpgradeIndicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Defaulttrue.availabilityZoneEC2 Availability Zone that the DB instance is created in. See docs about the details.caCertIdentifierIdentifier of the CA certificate for the DB instance.clusterIdentifierIdentifier of theaws.rds.Clusterin which to launch this instance.copyTagsToSnapshotIndicates whether to copy all of the user-defined tags from the DB instance to snapshots of the DB instance. Defaultfalse.customIamInstanceProfileInstance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.dbParameterGroupNameName of the DB parameter group to associate with this instance.dbSubnetGroupNameSpecifies the DB subnet group to associate with this DB instance. The default behavior varies depending on whetherdbSubnetGroupNameis specified. Please refer to official AWS documentation to understand howdbSubnetGroupNameandpubliclyAccessibleparameters affect DB instance behaviour. NOTE: This must match thedbSubnetGroupNameof the attachedaws.rds.Cluster.dbiResourceIdRegion-unique, immutable identifier for the DB instance.endpointDNS address for this instance. May not be writableengineName of the database engine to be used for the RDS cluster instance.engineVersionDatabase engine version. Please note that to upgrade theengineVersionof the instance, it must be done on theaws.rds.ClusterengineVersion. Trying to upgrade inaws.rds.ClusterInstancewill not update theengineVersion.engineVersionActualDatabase engine versionforceDestroyForces an instance to be destroyed when a part of a read replica cluster. Note: will promote the read replica to a standalone cluster before instance deletion.identifierIdentifier for the RDS instance, if omitted, Pulumi will assign a random, unique identifier.identifierPrefixCreates a unique identifier beginning with the specified prefix. Conflicts withidentifier.instanceClassInstance class to use. For details on CPU and memory, see Scaling Aurora DB Instances. Aurora usesdb.*instance classes/types. Please see AWS Documentation for currently available instance classes and complete details. For Aurora Serverless v2 usedb.serverless.kmsKeyIdARN for the KMS encryption key if one is set to the cluster.monitoringIntervalInterval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60.monitoringRoleArnARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. You can find more information on the AWS Documentation what IAM permissions are needed to allow Enhanced Monitoring for RDS Instances.networkTypeNetwork type of the DB instance.performanceInsightsEnabledSpecifies whether Performance Insights is enabled or not. NOTE: When Performance Insights is configured at the cluster level throughaws.rds.Cluster, this argument cannot be set to a value that conflicts with the cluster's configuration.performanceInsightsKmsKeyIdARN for the KMS key to encrypt Performance Insights data. When specifyingperformanceInsightsKmsKeyId,performanceInsightsEnabledneeds to be set to true.performanceInsightsRetentionPeriodAmount of time in days to retain Performance Insights data. Valid values are7,731(2 years) or a multiple of31. When specifyingperformanceInsightsRetentionPeriod,performanceInsightsEnabledneeds to be set to true. Defaults to '7'.portDatabase portpreferredBackupWindowDaily time range during which automated backups are created if automated backups are enabled. Eg: "04:00-09:00". NOTE: IfpreferredBackupWindowis set at the cluster level, this argument must be omitted.preferredMaintenanceWindowWindow to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00".promotionTierDefault 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoted to writer.publiclyAccessibleBool to control if instance is publicly accessible. Defaultfalse. See the documentation on Creating DB Instances for more details on controlling this property.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.storageEncryptedSpecifies whether the DB cluster is encrypted.tagsMap of tags to assign to the instance. If configured with a providerdefaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.tagsAllMap of tags assigned to the resource, including those inherited from the providerdefaultTagsconfiguration block.writerBoolean indicating if this instance is writable.Falseindicates this instance is a read replica.const -
ClusterInstanceState.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
applyImmediately
→ Input<
bool?> ? -
Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default is
false.final -
arn
→ Input<
String?> ? -
ARN of cluster instance
final
-
autoMinorVersionUpgrade
→ Input<
bool?> ? -
Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Default
true.final -
availabilityZone
→ Input<
String?> ? -
EC2 Availability Zone that the DB instance is created in. See docs about the details.
final
-
caCertIdentifier
→ Input<
String?> ? -
Identifier of the CA certificate for the DB instance.
final
-
clusterIdentifier
→ Input<
String?> ? -
Identifier of the
aws.rds.Clusterin which to launch this instance.final -
copyTagsToSnapshot
→ Input<
bool?> ? -
Indicates whether to copy all of the user-defined tags from the DB instance to snapshots of the DB instance. Default
false.final -
customIamInstanceProfile
→ Input<
String?> ? -
Instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance.
final
-
dbiResourceId
→ Input<
String?> ? -
Region-unique, immutable identifier for the DB instance.
final
-
dbParameterGroupName
→ Input<
String?> ? -
Name of the DB parameter group to associate with this instance.
final
-
dbSubnetGroupName
→ Input<
String?> ? -
Specifies the DB subnet group to associate with this DB instance. The default behavior varies depending on whether
dbSubnetGroupNameis specified. Please refer to official AWS documentation to understand howdbSubnetGroupNameandpubliclyAccessibleparameters affect DB instance behaviour. NOTE: This must match thedbSubnetGroupNameof the attachedaws.rds.Cluster.final -
endpoint
→ Input<
String?> ? -
DNS address for this instance. May not be writable
final
-
engine
→ Input<
EngineType?> ? -
Name of the database engine to be used for the RDS cluster instance.
Valid Values:
aurora-mysql,aurora-postgresql,mysql,postgres.(Note thatmysqlandpostgresare Multi-AZ RDS clusters).final -
engineVersion
→ Input<
String?> ? -
Database engine version. Please note that to upgrade the
engineVersionof the instance, it must be done on theaws.rds.ClusterengineVersion. Trying to upgrade inaws.rds.ClusterInstancewill not update theengineVersion.final -
engineVersionActual
→ Input<
String?> ? -
Database engine version
final
-
forceDestroy
→ Input<
bool?> ? -
Forces an instance to be destroyed when a part of a read replica cluster. Note: will promote the read replica to a standalone cluster before instance deletion.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
-
identifier
→ Input<
String?> ? -
Identifier for the RDS instance, if omitted, Pulumi will assign a random, unique identifier.
final
-
identifierPrefix
→ Input<
String?> ? -
Creates a unique identifier beginning with the specified prefix. Conflicts with
identifier.final - instanceClass → Input?
-
Instance class to use. For details on CPU and memory, see Scaling Aurora DB Instances. Aurora uses
db.*instance classes/types. Please see AWS Documentation for currently available instance classes and complete details. For Aurora Serverless v2 usedb.serverless.final -
kmsKeyId
→ Input<
String?> ? -
ARN for the KMS encryption key if one is set to the cluster.
final
-
monitoringInterval
→ Input<
int?> ? -
Interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60.
final
-
monitoringRoleArn
→ Input<
String?> ? -
ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. You can find more information on the AWS Documentation what IAM permissions are needed to allow Enhanced Monitoring for RDS Instances.
final
-
networkType
→ Input<
String?> ? -
Network type of the DB instance.
final
-
performanceInsightsEnabled
→ Input<
bool?> ? -
Specifies whether Performance Insights is enabled or not. NOTE: When Performance Insights is configured at the cluster level through
aws.rds.Cluster, this argument cannot be set to a value that conflicts with the cluster's configuration.final -
performanceInsightsKmsKeyId
→ Input<
String?> ? -
ARN for the KMS key to encrypt Performance Insights data. When specifying
performanceInsightsKmsKeyId,performanceInsightsEnabledneeds to be set to true.final -
performanceInsightsRetentionPeriod
→ Input<
int?> ? -
Amount of time in days to retain Performance Insights data. Valid values are
7,731(2 years) or a multiple of31. When specifyingperformanceInsightsRetentionPeriod,performanceInsightsEnabledneeds to be set to true. Defaults to '7'.final -
port
→ Input<
int?> ? -
Database port
final
-
preferredBackupWindow
→ Input<
String?> ? -
Daily time range during which automated backups are created if automated backups are enabled. Eg: "04:00-09:00". NOTE: If
preferredBackupWindowis set at the cluster level, this argument must be omitted.final -
preferredMaintenanceWindow
→ Input<
String?> ? -
Window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00".
final
-
promotionTier
→ Input<
int?> ? -
Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoted to writer.
final
-
publiclyAccessible
→ Input<
bool?> ? -
Bool to control if instance is publicly accessible. Default
false. See the documentation on Creating DB Instances for more details on controlling this property.final -
region
→ Input<
String?> ? -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
storageEncrypted
→ Input<
bool?> ? -
Specifies whether the DB cluster is encrypted.
final
-
Map of tags to assign to the instance. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.final -
Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.final -
writer
→ Input<
bool?> ? -
Boolean indicating if this instance is writable.
Falseindicates this instance is a read replica.final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited