Serialized Form (AWS Java SDK for Amazon DocumentDB Elastic Clusters 1.12.426 API)

Package com.amazonaws.services.docdbelastic.model
- Class com.amazonaws.services.docdbelastic.model.AccessDeniedException extends AmazonDocDBElasticException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.docdbelastic.model.AmazonDocDBElasticException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.docdbelastic.model.Cluster extends Object implements Serializable
  - Serialized Fields
    - adminUserName
```
String adminUserName
```
      The name of the Elastic DocumentDB cluster administrator.
    - authType
```
String authType
```
      The authentication type for the Elastic DocumentDB cluster.
    - clusterArn
```
String clusterArn
```
      The arn of the Elastic DocumentDB cluster.
    - clusterEndpoint
```
String clusterEndpoint
```
      The URL used to connect to the Elastic DocumentDB cluster.
    - clusterName
```
String clusterName
```
      The name of the Elastic DocumentDB cluster.
    - createTime
```
String createTime
```
      The time when the Elastic DocumentDB cluster was created in Universal Coordinated Time (UTC).
    - kmsKeyId
```
String kmsKeyId
```
      The KMS key identifier to use to encrypt the Elastic DocumentDB cluster.
    - preferredMaintenanceWindow
```
String preferredMaintenanceWindow
```
      The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
      
      Format: ddd:hh24:mi-ddd:hh24:mi
    - shardCapacity
```
Integer shardCapacity
```
      The capacity of each shard in the Elastic DocumentDB cluster.
    - shardCount
```
Integer shardCount
```
      The number of shards in the Elastic DocumentDB cluster.
    - status
```
String status
```
      The status of the Elastic DocumentDB cluster.
    - subnetIds
```
List<E> subnetIds
```
      The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.
    - vpcSecurityGroupIds
```
List<E> vpcSecurityGroupIds
```
      A list of EC2 VPC security groups associated with this cluster.
- Class com.amazonaws.services.docdbelastic.model.ClusterInList extends Object implements Serializable
  - Serialized Fields
    - clusterArn
```
String clusterArn
```
      The arn of the Elastic DocumentDB cluster.
    - clusterName
```
String clusterName
```
      The name of the Elastic DocumentDB cluster.
    - status
```
String status
```
      The status of the Elastic DocumentDB cluster.
- Class com.amazonaws.services.docdbelastic.model.ClusterSnapshot extends Object implements Serializable
  - Serialized Fields
    - adminUserName
```
String adminUserName
```
      The name of the Elastic DocumentDB cluster administrator.
    - clusterArn
```
String clusterArn
```
      The arn of the Elastic DocumentDB cluster.
    - clusterCreationTime
```
String clusterCreationTime
```
      The time when the Elastic DocumentDB cluster was created in Universal Coordinated Time (UTC).
    - kmsKeyId
```
String kmsKeyId
```
      The KMS key identifier to use to encrypt the Elastic DocumentDB cluster.
    - snapshotArn
```
String snapshotArn
```
      The arn of the Elastic DocumentDB snapshot
    - snapshotCreationTime
```
String snapshotCreationTime
```
      The time when the Elastic DocumentDB snapshot was created in Universal Coordinated Time (UTC).
    - snapshotName
```
String snapshotName
```
      The name of the Elastic DocumentDB snapshot.
    - status
```
String status
```
      The status of the Elastic DocumentDB snapshot.
    - subnetIds
```
List<E> subnetIds
```
      A list of the IDs of subnets associated with the DB cluster snapshot.
    - vpcSecurityGroupIds
```
List<E> vpcSecurityGroupIds
```
      A list of the IDs of the VPC security groups associated with the cluster snapshot.
- Class com.amazonaws.services.docdbelastic.model.ClusterSnapshotInList extends Object implements Serializable
  - Serialized Fields
    - clusterArn
```
String clusterArn
```
      The arn of the Elastic DocumentDB cluster.
    - snapshotArn
```
String snapshotArn
```
      The arn of the Elastic DocumentDB snapshot
    - snapshotCreationTime
```
String snapshotCreationTime
```
      The time when the Elastic DocumentDB snapshot was created in Universal Coordinated Time (UTC).
    - snapshotName
```
String snapshotName
```
      The name of the Elastic DocumentDB snapshot.
    - status
```
String status
```
      The status of the Elastic DocumentDB snapshot.
- Class com.amazonaws.services.docdbelastic.model.ConflictException extends AmazonDocDBElasticException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - resourceId
```
String resourceId
```
      The ID of the resource where there was an access conflict.
    - resourceType
```
String resourceType
```
      The type of the resource where there was an access conflict.
- Class com.amazonaws.services.docdbelastic.model.CreateClusterRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - adminUserName
```
String adminUserName
```
      The name of the Elastic DocumentDB cluster administrator.
      
      Constraints:
      
      Must be from 1 to 63 letters or numbers.
      
      The first character must be a letter.
      
      Cannot be a reserved word.
    - adminUserPassword
```
String adminUserPassword
```
      The password for the Elastic DocumentDB cluster administrator and 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 (@).
    - authType
```
String authType
```
      The authentication type for the Elastic DocumentDB cluster.
    - clientToken
```
String clientToken
```
      The client token for the Elastic DocumentDB cluster.
    - clusterName
```
String clusterName
```
      The name of the new Elastic DocumentDB 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
    - kmsKeyId
```
String kmsKeyId
```
      The KMS key identifier to use to encrypt the new Elastic DocumentDB 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, Elastic DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.
    - preferredMaintenanceWindow
```
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.
    - shardCapacity
```
Integer shardCapacity
```
      The capacity of each shard in the new Elastic DocumentDB cluster.
    - shardCount
```
Integer shardCount
```
      The number of shards to create in the new Elastic DocumentDB cluster.
    - subnetIds
```
List<E> subnetIds
```
      The Amazon EC2 subnet IDs for the new Elastic DocumentDB cluster.
    - tags
```
Map<K,V> tags
```
      The tags to be assigned to the new Elastic DocumentDB cluster.
    - vpcSecurityGroupIds
```
List<E> vpcSecurityGroupIds
```
      A list of EC2 VPC security groups to associate with the new Elastic DocumentDB cluster.
- Class com.amazonaws.services.docdbelastic.model.CreateClusterResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - cluster
```
Cluster cluster
```
      The new Elastic DocumentDB cluster that has been created.
- Class com.amazonaws.services.docdbelastic.model.CreateClusterSnapshotRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - clusterArn
```
String clusterArn
```
      The arn of the Elastic DocumentDB cluster that the snapshot will be taken from.
    - snapshotName
```
String snapshotName
```
      The name of the Elastic DocumentDB snapshot.
    - tags
```
Map<K,V> tags
```
      The tags to be assigned to the new Elastic DocumentDB snapshot.
- Class com.amazonaws.services.docdbelastic.model.CreateClusterSnapshotResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - snapshot
```
ClusterSnapshot snapshot
```
      Returns information about the new Elastic DocumentDB snapshot.
- Class com.amazonaws.services.docdbelastic.model.DeleteClusterRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - clusterArn
```
String clusterArn
```
      The arn of the Elastic DocumentDB cluster that is to be deleted.
- Class com.amazonaws.services.docdbelastic.model.DeleteClusterResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - cluster
```
Cluster cluster
```
      Returns information about the newly deleted Elastic DocumentDB cluster.
- Class com.amazonaws.services.docdbelastic.model.DeleteClusterSnapshotRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - snapshotArn
```
String snapshotArn
```
      The arn of the Elastic DocumentDB snapshot that is to be deleted.
- Class com.amazonaws.services.docdbelastic.model.DeleteClusterSnapshotResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - snapshot
```
ClusterSnapshot snapshot
```
      Returns information about the newly deleted Elastic DocumentDB snapshot.
- Class com.amazonaws.services.docdbelastic.model.GetClusterRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - clusterArn
```
String clusterArn
```
      The arn of the Elastic DocumentDB cluster.
- Class com.amazonaws.services.docdbelastic.model.GetClusterResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - cluster
```
Cluster cluster
```
      Returns information about a specific Elastic DocumentDB cluster.
- Class com.amazonaws.services.docdbelastic.model.GetClusterSnapshotRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - snapshotArn
```
String snapshotArn
```
      The arn of the Elastic DocumentDB snapshot.
- Class com.amazonaws.services.docdbelastic.model.GetClusterSnapshotResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - snapshot
```
ClusterSnapshot snapshot
```
      Returns information about a specific Elastic DocumentDB snapshot.
- Class com.amazonaws.services.docdbelastic.model.InternalServerException extends AmazonDocDBElasticException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.docdbelastic.model.ListClusterSnapshotsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - clusterArn
```
String clusterArn
```
      The arn of the Elastic DocumentDB cluster.
    - maxResults
```
Integer maxResults
```
      The maximum number of entries to recieve in the response.
    - nextToken
```
String nextToken
```
      The nextToken which is used the get the next page of data.
- Class com.amazonaws.services.docdbelastic.model.ListClusterSnapshotsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - nextToken
```
String nextToken
```
      The response will provide a nextToken if there is more data beyond the maxResults.
      
      If there is no more data in the responce, the nextToken will not be returned.
    - snapshots
```
List<E> snapshots
```
      A list of Elastic DocumentDB snapshots for a specified cluster.
- Class com.amazonaws.services.docdbelastic.model.ListClustersRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - maxResults
```
Integer maxResults
```
      The maximum number of entries to recieve in the response.
    - nextToken
```
String nextToken
```
      The nextToken which is used the get the next page of data.
- Class com.amazonaws.services.docdbelastic.model.ListClustersResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - clusters
```
List<E> clusters
```
      A list of Elastic DocumentDB cluster.
    - nextToken
```
String nextToken
```
      The response will provide a nextToken if there is more data beyond the maxResults.
      
      If there is no more data in the responce, the nextToken will not be returned.
- Class com.amazonaws.services.docdbelastic.model.ListTagsForResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      The arn of the Elastic DocumentDB resource.
- Class com.amazonaws.services.docdbelastic.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - tags
```
Map<K,V> tags
```
      The list of tags for the specified Elastic DocumentDB resource.
- Class com.amazonaws.services.docdbelastic.model.ResourceNotFoundException extends AmazonDocDBElasticException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - resourceId
```
String resourceId
```
      The ID of the resource that could not be located.
    - resourceType
```
String resourceType
```
      The type of the resource that could not be found.
- Class com.amazonaws.services.docdbelastic.model.RestoreClusterFromSnapshotRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - clusterName
```
String clusterName
```
      The name of the Elastic DocumentDB cluster.
    - kmsKeyId
```
String kmsKeyId
```
      The KMS key identifier to use to encrypt the new Elastic DocumentDB 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, Elastic DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.
    - snapshotArn
```
String snapshotArn
```
      The arn of the Elastic DocumentDB snapshot.
    - subnetIds
```
List<E> subnetIds
```
      The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.
    - tags
```
Map<K,V> tags
```
      A list of the tag names to be assigned to the restored DB 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.
    - vpcSecurityGroupIds
```
List<E> vpcSecurityGroupIds
```
      A list of EC2 VPC security groups to associate with the Elastic DocumentDB cluster.
- Class com.amazonaws.services.docdbelastic.model.RestoreClusterFromSnapshotResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - cluster
```
Cluster cluster
```
      Returns information about a the restored Elastic DocumentDB cluster.
- Class com.amazonaws.services.docdbelastic.model.ServiceQuotaExceededException extends AmazonDocDBElasticException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.docdbelastic.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      The arn of the Elastic DocumentDB resource.
    - tags
```
Map<K,V> tags
```
      The tags to be assigned to the Elastic DocumentDB resource.
- Class com.amazonaws.services.docdbelastic.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.docdbelastic.model.ThrottlingException extends AmazonDocDBElasticException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - retryAfterSeconds
```
Integer retryAfterSeconds
```
      The number of seconds to wait before retrying the operation.
- Class com.amazonaws.services.docdbelastic.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - resourceArn
```
String resourceArn
```
      The arn of the Elastic DocumentDB resource.
    - tagKeys
```
List<E> tagKeys
```
      The tag keys to be removed from the Elastic DocumentDB resource.
- Class com.amazonaws.services.docdbelastic.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.docdbelastic.model.UpdateClusterRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - adminUserPassword
```
String adminUserPassword
```
      The password for the Elastic DocumentDB 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.
    - authType
```
String authType
```
      The authentication type for the Elastic DocumentDB cluster.
    - clientToken
```
String clientToken
```
      The client token for the Elastic DocumentDB cluster.
    - clusterArn
```
String clusterArn
```
      The arn of the Elastic DocumentDB cluster.
    - preferredMaintenanceWindow
```
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.
    - shardCapacity
```
Integer shardCapacity
```
      The capacity of each shard in the Elastic DocumentDB cluster.
    - shardCount
```
Integer shardCount
```
      The number of shards to create in the Elastic DocumentDB cluster.
    - subnetIds
```
List<E> subnetIds
```
      The number of shards to create in the Elastic DocumentDB cluster.
    - vpcSecurityGroupIds
```
List<E> vpcSecurityGroupIds
```
      A list of EC2 VPC security groups to associate with the new Elastic DocumentDB cluster.
- Class com.amazonaws.services.docdbelastic.model.UpdateClusterResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - cluster
```
Cluster cluster
```
      Returns information about the updated Elastic DocumentDB cluster.
- Class com.amazonaws.services.docdbelastic.model.ValidationException extends AmazonDocDBElasticException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - fieldList
```
List<E> fieldList
```
      A list of the fields in which the validation exception occurred.
    - reason
```
String reason
```
      The reason why the validation exception occurred (one of unknownOperation, cannotParse, fieldValidationFailed, or other).
- Class com.amazonaws.services.docdbelastic.model.ValidationExceptionField extends Object implements Serializable
  - Serialized Fields
    - message
```
String message
```
      An error message describing the validation exception in this field.
    - name
```
String name
```
      The name of the field where the validation exception occurred.

Serialized Form

Package com.amazonaws.services.docdbelastic.model

Class com.amazonaws.services.docdbelastic.model.AccessDeniedException extends AmazonDocDBElasticException implements Serializable

Class com.amazonaws.services.docdbelastic.model.AmazonDocDBElasticException extends AmazonServiceException implements Serializable

Class com.amazonaws.services.docdbelastic.model.Cluster extends Object implements Serializable

Serialized Fields

adminUserName

authType

clusterArn

clusterEndpoint

clusterName

createTime

kmsKeyId

preferredMaintenanceWindow

shardCapacity

shardCount

status

subnetIds

vpcSecurityGroupIds

Class com.amazonaws.services.docdbelastic.model.ClusterInList extends Object implements Serializable

Serialized Fields

clusterArn

clusterName

status

Class com.amazonaws.services.docdbelastic.model.ClusterSnapshot extends Object implements Serializable

Serialized Fields

adminUserName

clusterArn

clusterCreationTime

kmsKeyId

snapshotArn

snapshotCreationTime

snapshotName

status

subnetIds

vpcSecurityGroupIds

Class com.amazonaws.services.docdbelastic.model.ClusterSnapshotInList extends Object implements Serializable

Serialized Fields

clusterArn

snapshotArn

snapshotCreationTime

snapshotName

status

Class com.amazonaws.services.docdbelastic.model.ConflictException extends AmazonDocDBElasticException implements Serializable

Serialized Fields

resourceId

resourceType

Class com.amazonaws.services.docdbelastic.model.CreateClusterRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

adminUserName

adminUserPassword

authType

clientToken

clusterName

kmsKeyId

preferredMaintenanceWindow

shardCapacity

shardCount

subnetIds

tags

vpcSecurityGroupIds

Class com.amazonaws.services.docdbelastic.model.CreateClusterResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

cluster

Class com.amazonaws.services.docdbelastic.model.CreateClusterSnapshotRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clusterArn

snapshotName

tags

Class com.amazonaws.services.docdbelastic.model.CreateClusterSnapshotResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

snapshot

Class com.amazonaws.services.docdbelastic.model.DeleteClusterRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clusterArn

Class com.amazonaws.services.docdbelastic.model.DeleteClusterResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

cluster

Class com.amazonaws.services.docdbelastic.model.DeleteClusterSnapshotRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields