ElasticClusterState class

Input properties used for looking up and filtering ElasticCluster resources.

Constructors

ElasticClusterState({Input<String?>? adminUserName, Input<String?>? adminUserPassword, Input<String?>? arn, Input<String?>? authType, Input<int?>? backupRetentionPeriod, Input<String?>? endpoint, Input<String?>? kmsKeyId, Input<String?>? name, Input<String?>? preferredBackupWindow, Input<String?>? preferredMaintenanceWindow, Input<String?>? region, Input<int?>? shardCapacity, Input<int?>? shardCount, Input<int?>? shardInstanceCount, Input<List<String>?>? subnetIds, Input<Map<String, String>?>? tags, Input<Map<String, String>?>? tagsAll, Input<ElasticClusterTimeouts?>? timeouts, Input<List<String>?>? vpcSecurityGroupIds})
Creates a new ElasticClusterState. adminUserName Name of the Elastic DocumentDB cluster administrator adminUserPassword Password for the Elastic DocumentDB cluster administrator. Can contain any printable ASCII characters. Must be at least 8 characters arn ARN of the DocumentDB Elastic Cluster authType Authentication type for the Elastic DocumentDB cluster. Valid values are PLAIN_TEXT and SECRET_ARN backupRetentionPeriod The number of days for which automatic snapshots are retained. It should be in between 1 and 35. If not specified, the default value of 1 is set. endpoint The DNS address of the DocDB instance kmsKeyId ARN of a KMS key that is used to encrypt the Elastic DocumentDB cluster. If not specified, the default encryption key that KMS creates for your account is used. name Name of the Elastic DocumentDB cluster preferredBackupWindow The daily time range during which automated backups are created if automated backups are enabled, as determined by the backupRetentionPeriod. preferredMaintenanceWindow Weekly time range during which system maintenance can occur in UTC. Format: ddd:hh24:mi-ddd:hh24:mi. If not specified, AWS will choose a random 30-minute window on a random day of the week. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. shardCapacity Number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64 shardCount Number of shards assigned to the elastic cluster. Maximum is 32 shardInstanceCount Number of replica instances applying to all shards in the elastic cluster. If not specified, the default value of 2 is set. subnetIds IDs of subnets in which the Elastic DocumentDB Cluster operates. tags A map of tags to assign to the collection. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level. tagsAll Optional. timeouts Optional. vpcSecurityGroupIds List of VPC security groups to associate with the Elastic DocumentDB Cluster
const
ElasticClusterState.fromMap(Map<String, dynamic> map)
factory

Properties

adminUserName → Input<String?>?
Name of the Elastic DocumentDB cluster administrator
final
adminUserPassword → Input<String?>?
Password for the Elastic DocumentDB cluster administrator. Can contain any printable ASCII characters. Must be at least 8 characters
final
arn → Input<String?>?
ARN of the DocumentDB Elastic Cluster
final
authType → Input<String?>?
Authentication type for the Elastic DocumentDB cluster. Valid values are PLAIN_TEXT and SECRET_ARN
final
backupRetentionPeriod → Input<int?>?
The number of days for which automatic snapshots are retained. It should be in between 1 and 35. If not specified, the default value of 1 is set.
final
endpoint → Input<String?>?
The DNS address of the DocDB instance
final
hashCode → int
The hash code for this object.
no setterinherited
kmsKeyId → Input<String?>?
ARN of a KMS key that is used to encrypt the Elastic DocumentDB cluster. If not specified, the default encryption key that KMS creates for your account is used.
final
name → Input<String?>?
Name of the Elastic DocumentDB cluster
final
preferredBackupWindow → Input<String?>?
The daily time range during which automated backups are created if automated backups are enabled, as determined by the backupRetentionPeriod.
final
preferredMaintenanceWindow → Input<String?>?
Weekly time range during which system maintenance can occur in UTC. Format: ddd:hh24:mi-ddd:hh24:mi. If not specified, AWS will choose a random 30-minute window on a random day of the week.
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
shardCapacity → Input<int?>?
Number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64
final
shardCount → Input<int?>?
Number of shards assigned to the elastic cluster. Maximum is 32
final
shardInstanceCount → Input<int?>?
Number of replica instances applying to all shards in the elastic cluster. If not specified, the default value of 2 is set.
final
subnetIds → Input<List<String>?>?
IDs of subnets in which the Elastic DocumentDB Cluster operates.
final
tags → Input<Map<String, String>?>?
A map of tags to assign to the collection. 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>?>?
final
timeouts → Input<ElasticClusterTimeouts?>?
final
vpcSecurityGroupIds → Input<List<String>?>?
List of VPC security groups to associate with the Elastic DocumentDB Cluster
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