String adminUserName
The name of the elastic cluster administrator.
String authType
The authentication type for the elastic cluster.
Integer backupRetentionPeriod
The number of days for which automatic snapshots are retained.
String clusterArn
The ARN identifier of the elastic cluster.
String clusterEndpoint
The URL used to connect to the elastic cluster.
String clusterName
The name of the elastic cluster.
String createTime
The time when the elastic cluster was created in Universal Coordinated Time (UTC).
String kmsKeyId
The KMS key identifier to use to encrypt the elastic cluster.
String preferredBackupWindow
The daily time range during which automated backups are created if automated backups are enabled, as determined
by backupRetentionPeriod.
String preferredMaintenanceWindow
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
Integer shardCapacity
The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.
Integer shardCount
The number of shards assigned to the elastic cluster. Maximum is 32.
Integer shardInstanceCount
The number of replica instances applying to all shards in the cluster. A shardInstanceCount value of
1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to
improve availability.
List<E> shards
The total number of shards in the cluster.
String status
The status of the elastic cluster.
List<E> subnetIds
The Amazon EC2 subnet IDs for the elastic cluster.
List<E> vpcSecurityGroupIds
A list of EC2 VPC security groups associated with thie elastic cluster.
String adminUserName
The name of the elastic cluster administrator.
String clusterArn
The ARN identifier of the elastic cluster.
String clusterCreationTime
The time when the elastic cluster was created in Universal Coordinated Time (UTC).
String kmsKeyId
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key. If an encryption key is not specified here, Amazon DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.
String snapshotArn
The ARN identifier of the elastic cluster snapshot.
String snapshotCreationTime
The time when the elastic cluster snapshot was created in Universal Coordinated Time (UTC).
String snapshotName
The name of the elastic cluster snapshot.
String snapshotType
The type of cluster snapshots to be returned. You can specify one of the following values:
automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your
Amazon Web Services account.
manual - Return all cluster snapshots that you have manually created for your Amazon Web Services
account.
String status
The status of the elastic cluster snapshot.
List<E> subnetIds
The Amazon EC2 subnet IDs for the elastic cluster.
List<E> vpcSecurityGroupIds
A list of EC2 VPC security groups to associate with the elastic cluster.
String clusterArn
The ARN identifier of the elastic cluster.
String snapshotArn
The ARN identifier of the elastic cluster snapshot.
String snapshotCreationTime
The time when the elastic cluster snapshot was created in Universal Coordinated Time (UTC).
String snapshotName
The name of the elastic cluster snapshot.
String status
The status of the elastic cluster snapshot.
Boolean copyTags
Set to true to copy all tags from the source cluster snapshot to the target elastic cluster
snapshot. The default is false.
String kmsKeyId
The Amazon Web Services KMS key ID for an encrypted elastic cluster snapshot. The Amazon Web Services KMS key ID is the Amazon Resource Name (ARN), Amazon Web Services KMS key identifier, or the Amazon Web Services KMS key alias for the Amazon Web Services KMS encryption key.
If you copy an encrypted elastic cluster snapshot from your Amazon Web Services account, you can specify a value
for KmsKeyId to encrypt the copy with a new Amazon Web ServicesS KMS encryption key. If you don't
specify a value for KmsKeyId, then the copy of the elastic cluster snapshot is encrypted with the
same AWS KMS key as the source elastic cluster snapshot.
To copy an encrypted elastic cluster snapshot to another Amazon Web Services region, set KmsKeyId to
the Amazon Web Services KMS key ID that you want to use to encrypt the copy of the elastic cluster snapshot in
the destination region. Amazon Web Services KMS encryption keys are specific to the Amazon Web Services region
that they are created in, and you can't use encryption keys from one Amazon Web Services region in another Amazon
Web Services region.
If you copy an unencrypted elastic cluster snapshot and specify a value for the KmsKeyId parameter,
an error is returned.
String snapshotArn
The Amazon Resource Name (ARN) identifier of the elastic cluster snapshot.
Map<K,V> tags
The tags to be assigned to the elastic cluster snapshot.
String targetSnapshotName
The identifier of the new elastic cluster snapshot to create from the source cluster snapshot. This parameter is not case sensitive.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Example: elastic-cluster-snapshot-5
ClusterSnapshot snapshot
String adminUserName
The name of the Amazon DocumentDB elastic clusters administrator.
Constraints:
Must be from 1 to 63 letters or numbers.
The first character must be a letter.
Cannot be a reserved word.
String adminUserPassword
The password for the Amazon DocumentDB elastic clusters administrator. The password can contain any printable ASCII characters.
Constraints:
Must contain from 8 to 100 characters.
Cannot contain a forward slash (/), double quote ("), or the "at" symbol (@).
String authType
The authentication type used to determine where to fetch the password used for accessing the elastic cluster.
Valid types are PLAIN_TEXT or SECRET_ARN.
Integer backupRetentionPeriod
The number of days for which automatic snapshots are retained.
String clientToken
The client token for the elastic cluster.
String clusterName
The name of the new elastic cluster. This parameter is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Example: my-cluster
String kmsKeyId
The KMS key identifier to use to encrypt the new elastic cluster.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key.
If an encryption key is not specified, Amazon DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.
String preferredBackupWindow
The daily time range during which automated backups are created if automated backups are enabled, as determined
by the backupRetentionPeriod.
String preferredMaintenanceWindow
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
Default: a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
Integer shardCapacity
The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.
Integer shardCount
The number of shards assigned to the elastic cluster. Maximum is 32.
Integer shardInstanceCount
The number of replica instances applying to all shards in the elastic cluster. A shardInstanceCount
value of 1 means there is one writer instance, and any additional instances are replicas that can be used for
reads and to improve availability.
List<E> subnetIds
The Amazon EC2 subnet IDs for the new elastic cluster.
Map<K,V> tags
The tags to be assigned to the new elastic cluster.
List<E> vpcSecurityGroupIds
A list of EC2 VPC security groups to associate with the new elastic cluster.
Cluster cluster
The new elastic cluster that has been created.
ClusterSnapshot snapshot
Returns information about the new elastic cluster snapshot.
String clusterArn
The ARN identifier of the elastic cluster that is to be deleted.
Cluster cluster
Returns information about the newly deleted elastic cluster.
String snapshotArn
The ARN identifier of the elastic cluster snapshot that is to be deleted.
ClusterSnapshot snapshot
Returns information about the newly deleted elastic cluster snapshot.
String clusterArn
The ARN identifier of the elastic cluster.
Cluster cluster
Returns information about a specific elastic cluster.
String snapshotArn
The ARN identifier of the elastic cluster snapshot.
ClusterSnapshot snapshot
Returns information about a specific elastic cluster snapshot.
String clusterArn
The ARN identifier of the elastic cluster.
Integer maxResults
The maximum number of elastic cluster snapshot results to receive in the response.
String nextToken
A pagination token provided by a previous request. If this parameter is specified, the response includes only
records beyond this token, up to the value specified by max-results.
If there is no more data in the responce, the nextToken will not be returned.
String snapshotType
The type of cluster snapshots to be returned. You can specify one of the following values:
automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your
Amazon Web Services account.
manual - Return all cluster snapshots that you have manually created for your Amazon Web Services
account.
String nextToken
A pagination token provided by a previous request. If this parameter is specified, the response includes only
records beyond this token, up to the value specified by max-results.
If there is no more data in the responce, the nextToken will not be returned.
List<E> snapshots
A list of snapshots for a specified elastic cluster.
Integer maxResults
The maximum number of elastic cluster snapshot results to receive in the response.
String nextToken
A pagination token provided by a previous request. If this parameter is specified, the response includes only
records beyond this token, up to the value specified by max-results.
If there is no more data in the responce, the nextToken will not be returned.
List<E> clusters
A list of Amazon DocumentDB elastic clusters.
String nextToken
A pagination token provided by a previous request. If this parameter is specified, the response includes only
records beyond this token, up to the value specified by max-results.
If there is no more data in the responce, the nextToken will not be returned.
String resourceArn
The ARN identifier of the elastic cluster resource.
String clusterName
The name of the elastic cluster.
String kmsKeyId
The KMS key identifier to use to encrypt the new Amazon DocumentDB elastic clusters cluster.
The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key.
If an encryption key is not specified here, Amazon DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.
Integer shardCapacity
The capacity of each shard in the new restored elastic cluster.
Integer shardInstanceCount
The number of replica instances applying to all shards in the elastic cluster. A shardInstanceCount
value of 1 means there is one writer instance, and any additional instances are replicas that can be used for
reads and to improve availability.
String snapshotArn
The ARN identifier of the elastic cluster snapshot.
List<E> subnetIds
The Amazon EC2 subnet IDs for the elastic cluster.
Map<K,V> tags
A list of the tag names to be assigned to the restored elastic cluster, in the form of an array of key-value pairs in which the key is the tag name and the value is the key value.
List<E> vpcSecurityGroupIds
A list of EC2 VPC security groups to associate with the elastic cluster.
Cluster cluster
Returns information about a the restored elastic cluster.
String clusterArn
The ARN identifier of the elastic cluster.
Cluster cluster
String clusterArn
The ARN identifier of the elastic cluster.
Cluster cluster
Integer retryAfterSeconds
The number of seconds to wait before retrying the operation.
String adminUserPassword
The password associated with the elastic cluster administrator. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).
Constraints: Must contain from 8 to 100 characters.
String authType
The authentication type used to determine where to fetch the password used for accessing the elastic cluster.
Valid types are PLAIN_TEXT or SECRET_ARN.
Integer backupRetentionPeriod
The number of days for which automatic snapshots are retained.
String clientToken
The client token for the elastic cluster.
String clusterArn
The ARN identifier of the elastic cluster.
String preferredBackupWindow
The daily time range during which automated backups are created if automated backups are enabled, as determined
by the backupRetentionPeriod.
String preferredMaintenanceWindow
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format: ddd:hh24:mi-ddd:hh24:mi
Default: a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.
Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
Constraints: Minimum 30-minute window.
Integer shardCapacity
The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.
Integer shardCount
The number of shards assigned to the elastic cluster. Maximum is 32.
Integer shardInstanceCount
The number of replica instances applying to all shards in the elastic cluster. A shardInstanceCount
value of 1 means there is one writer instance, and any additional instances are replicas that can be used for
reads and to improve availability.
List<E> subnetIds
The Amazon EC2 subnet IDs for the elastic cluster.
List<E> vpcSecurityGroupIds
A list of EC2 VPC security groups to associate with the elastic cluster.
Cluster cluster
Returns information about the updated elastic cluster.
Copyright © 2024. All rights reserved.