ClusterInstanceArgs class
The set of arguments for ClusterInstance. The set of arguments for ClusterInstance.
Constructors
-
ClusterInstanceArgs({Input<
bool> ? applyImmediately, Input<bool> ? autoMinorVersionUpgrade, Input<String> ? availabilityZone, Input<String> ? caCertIdentifier, Input<String> ? certificateRotationRestart, required Input<String> clusterIdentifier, Input<bool> ? copyTagsToSnapshot, Input<bool> ? enablePerformanceInsights, Input<String> ? engine, Input<String> ? identifier, Input<String> ? identifierPrefix, required Input<String> instanceClass, Input<String> ? performanceInsightsKmsKeyId, Input<String> ? preferredMaintenanceWindow, Input<int> ? promotionTier, Input<String> ? region, Input<Map< ? tags})String, String> > -
Creates a new ClusterInstanceArgs.
applyImmediatelyWhether any database modifications are applied immediately, or during the next maintenance window. Default isfalse.autoMinorVersionUpgradeParameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set (see docs). Defaulttrue.availabilityZoneEC2 Availability Zone that the DB instance is created in. See docs about the details.caCertIdentifierIdentifier of the certificate authority (CA) certificate for the DB instance.certificateRotationRestartWhether 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 tofalseonly if you are not using SSL/TLS to connect to the DB instance.clusterIdentifierIdentifier of theaws.docdb.Clusterin which to launch this instance.copyTagsToSnapshotCopy all DB instancetagsto snapshots. Default isfalse.enablePerformanceInsightsValue that indicates whether to enable Performance Insights for the DB Instance. Defaultfalse. Seedocs(https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html) about the details.engineName of the database engine to be used for the DocumentDB instance. Defaults todocdb. Valid Values:docdb.identifierThe identifier for the DocumentDB instance, if omitted, the provider 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 for DocumentDB Instances. See theaws.docdb.getOrderableDbInstancedata source. See AWS Documentation for complete details.performanceInsightsKmsKeyIdKMS 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.preferredMaintenanceWindowWindow to perform maintenance in. Syntax: "ddd:hh24:mi-ddd:hh24:mi". Eg: "Mon:00:00-Mon:03:00".promotionTierFailover Priority setting on instance level. Default0. The reader who has lower tier has higher priority to get promoter to writer.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.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.const -
ClusterInstanceArgs.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
applyImmediately
→ Input<
bool> ? -
Whether any database modifications are applied immediately, or during the next maintenance window. Default is
false.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
falseonly if you are not using SSL/TLS to connect to the DB instance.final -
clusterIdentifier
→ Input<
String> -
Identifier of the
aws.docdb.Clusterin which to launch this instance.final -
copyTagsToSnapshot
→ Input<
bool> ? -
Copy all DB instance
tagsto snapshots. Default isfalse.final -
enablePerformanceInsights
→ Input<
bool> ? -
Value that indicates whether to enable Performance Insights for the DB Instance. Default
false. Seedocs(https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html) about the details.final -
engine
→ Input<
String> ? -
Name of the database engine to be used for the DocumentDB instance. Defaults to
docdb. Valid Values:docdb.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.getOrderableDbInstancedata source. See AWS Documentation for complete details.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
-
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 -
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
-
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
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