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< ? subnetIds, Input<String> >Map< ? tags, Input<String, String> >Map< ? tagsAll, Input<String, String> >ElasticClusterTimeouts> ? timeouts, Input<List< ? vpcSecurityGroupIds})String> > -
Creates a new ElasticClusterState.
adminUserNameName of the Elastic DocumentDB cluster administratoradminUserPasswordPassword for the Elastic DocumentDB cluster administrator. Can contain any printable ASCII characters. Must be at least 8 charactersarnARN of the DocumentDB Elastic ClusterauthTypeAuthentication type for the Elastic DocumentDB cluster. Valid values arePLAIN_TEXTandSECRET_ARNbackupRetentionPeriodThe 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.endpointThe DNS address of the DocDB instancekmsKeyIdARN 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.nameName of the Elastic DocumentDB clusterpreferredBackupWindowThe daily time range during which automated backups are created if automated backups are enabled, as determined by thebackupRetentionPeriod.preferredMaintenanceWindowWeekly 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.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.shardCapacityNumber of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64shardCountNumber of shards assigned to the elastic cluster. Maximum is 32shardInstanceCountNumber of replica instances applying to all shards in the elastic cluster. If not specified, the default value of 2 is set.subnetIdsIDs of subnets in which the Elastic DocumentDB Cluster operates.tagsA map of tags to assign to the collection. If configured with a providerdefaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.tagsAllOptional.timeoutsOptional.vpcSecurityGroupIdsList of VPC security groups to associate with the Elastic DocumentDB Clusterconst -
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_TEXTandSECRET_ARNfinal -
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
-
Number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64
final
-
Number of shards assigned to the elastic cluster. Maximum is 32
final
-
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
-
A map of tags to assign to the collection. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.final -
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