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?>? certificateRotationRestart, Input<String?>? clusterIdentifier, Input<bool?>? copyTagsToSnapshot, Input<String?>? dbSubnetGroupName, Input<String?>? dbiResourceId, Input<bool?>? enablePerformanceInsights, Input<String?>? endpoint, Input<String?>? engine, Input<String?>? engineVersion, Input<String?>? identifier, Input<String?>? identifierPrefix, Input<String?>? instanceClass, Input<String?>? kmsKeyId, Input<String?>? performanceInsightsKmsKeyId, Input<int?>? port, Input<String?>? preferredBackupWindow, Input<String?>? preferredMaintenanceWindow, Input<int?>? promotionTier, Input<bool?>? publiclyAccessible, Input<String?>? region, Input<bool?>? storageEncrypted, Input<Map<String, String>?>? tags, Input<Map<String, String>?>? tagsAll, Input<bool?>? writer})
Creates a new ClusterInstanceState. applyImmediately Whether any database modifications are applied immediately, or during the next maintenance window. Default isfalse. arn ARN of cluster instance autoMinorVersionUpgrade Parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set (see docs). Default true. availabilityZone EC2 Availability Zone that the DB instance is created in. See docs about the details. caCertIdentifier Identifier of the certificate authority (CA) certificate for the DB instance. certificateRotationRestart Whether to restart the DB instance when rotating its SSL/TLS certificate. By default, AWS restarts the DB instance when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted. Set to false only if you are not using SSL/TLS to connect to the DB instance. clusterIdentifier Identifier of the aws.docdb.Cluster in which to launch this instance. copyTagsToSnapshot Copy all DB instance tags to snapshots. Default is false. dbSubnetGroupName DB subnet group to associate with this DB instance. dbiResourceId Region-unique, immutable identifier for the DB instance. enablePerformanceInsights Value that indicates whether to enable Performance Insights for the DB Instance. Default false. See docs (https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html) about the details. endpoint DNS address for this instance. May not be writable engine Name of the database engine to be used for the DocumentDB instance. Defaults to docdb. Valid Values: docdb. engineVersion Database engine version identifier The identifier for the DocumentDB instance, if omitted, the provider will assign a random, unique identifier. identifierPrefix Creates a unique identifier beginning with the specified prefix. Conflicts with identifier. instanceClass Instance class to use. For details on CPU and memory, see Scaling for DocumentDB Instances. See the aws.docdb.getOrderableDbInstance data source. See AWS Documentation for complete details. kmsKeyId ARN for the KMS encryption key if one is set to the cluster. performanceInsightsKmsKeyId KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon DocumentDB uses your default KMS key. port Database port preferredBackupWindow Daily time range during which automated backups are created if automated backups are enabled. preferredMaintenanceWindow Window to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00". promotionTier Failover Priority setting on instance level. Default 0. The reader who has lower tier has higher priority to get promoter to writer. publiclyAccessible Optional. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. storageEncrypted Whether the DB cluster is encrypted. tags Map of tags to assign to the instance. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level. tagsAll Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block. writer Whether this instance is writable. False indicates this instance is a read replica.
const
ClusterInstanceState.fromMap(Map<String, dynamic> map)
factory

Properties

applyImmediately → Input<bool?>?
Whether any database modifications are applied immediately, or during the next maintenance window. Default isfalse.
final
arn → Input<String?>?
ARN of cluster instance
final
autoMinorVersionUpgrade → Input<bool?>?
Parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set (see docs). 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 certificate authority (CA) certificate for the DB instance.
final
certificateRotationRestart → Input<String?>?
Whether to restart the DB instance when rotating its SSL/TLS certificate. By default, AWS restarts the DB instance when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted. Set to false only if you are not using SSL/TLS to connect to the DB instance.
final
clusterIdentifier → Input<String?>?
Identifier of the aws.docdb.Cluster in which to launch this instance.
final
copyTagsToSnapshot → Input<bool?>?
Copy all DB instance tags to snapshots. Default is false.
final
dbiResourceId → Input<String?>?
Region-unique, immutable identifier for the DB instance.
final
dbSubnetGroupName → Input<String?>?
DB subnet group to associate with this DB instance.
final
enablePerformanceInsights → Input<bool?>?
Value that indicates whether to enable Performance Insights for the DB Instance. Default false. See docs (https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html) about the details.
final
endpoint → Input<String?>?
DNS address for this instance. May not be writable
final
engine → Input<String?>?
Name of the database engine to be used for the DocumentDB instance. Defaults to docdb. Valid Values: docdb.
final
engineVersion → Input<String?>?
Database engine version
final
hashCode → int
The hash code for this object.
no setterinherited
identifier → Input<String?>?
The identifier for the DocumentDB instance, if omitted, the provider 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<String?>?
Instance class to use. For details on CPU and memory, see Scaling for DocumentDB Instances. See the aws.docdb.getOrderableDbInstance data source. See AWS Documentation for complete details.
final
kmsKeyId → Input<String?>?
ARN for the KMS encryption key if one is set to the cluster.
final
performanceInsightsKmsKeyId → Input<String?>?
KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon DocumentDB uses your default KMS key.
final
port → Input<int?>?
Database port
final
preferredBackupWindow → Input<String?>?
Daily time range during which automated backups are created if automated backups are enabled.
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?>?
Failover Priority setting on instance level. Default 0. The reader who has lower tier has higher priority to get promoter to writer.
final
publiclyAccessible → Input<bool?>?
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?>?
Whether the DB cluster is encrypted.
final
tags → Input<Map<String, String>?>?
Map of tags to assign to the instance. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
final
tagsAll → Input<Map<String, String>?>?
Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
final
writer → Input<bool?>?
Whether this instance is writable. False indicates 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