{ "smithy": "2.0", "shapes": { "com.amazonaws.docdbelastic#AccessDeniedException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

An error message explaining why access was denied.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

An exception that occurs when there are not sufficient permissions to perform an action.

", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.docdbelastic#ApplyPendingMaintenanceAction": { "type": "operation", "input": { "target": "com.amazonaws.docdbelastic#ApplyPendingMaintenanceActionInput" }, "output": { "target": "com.amazonaws.docdbelastic#ApplyPendingMaintenanceActionOutput" }, "errors": [ { "target": "com.amazonaws.docdbelastic#AccessDeniedException" }, { "target": "com.amazonaws.docdbelastic#ConflictException" }, { "target": "com.amazonaws.docdbelastic#InternalServerException" }, { "target": "com.amazonaws.docdbelastic#ResourceNotFoundException" }, { "target": "com.amazonaws.docdbelastic#ThrottlingException" }, { "target": "com.amazonaws.docdbelastic#ValidationException" } ], "traits": { "smithy.api#documentation": "

The type of pending maintenance action to be applied to the resource.

", "smithy.api#http": { "code": 200, "method": "POST", "uri": "/pending-action" }, "smithy.api#idempotent": {} } }, "com.amazonaws.docdbelastic#ApplyPendingMaintenanceActionInput": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.docdbelastic#InputString", "traits": { "smithy.api#documentation": "

The Amazon DocumentDB Amazon Resource Name (ARN) of the resource to which the pending maintenance action applies.

", "smithy.api#required": {} } }, "applyAction": { "target": "com.amazonaws.docdbelastic#InputString", "traits": { "smithy.api#documentation": "

The pending maintenance action to apply to the resource.

\n

Valid actions are:

\n ", "smithy.api#required": {} } }, "optInType": { "target": "com.amazonaws.docdbelastic#OptInType", "traits": { "smithy.api#documentation": "

A value that specifies the type of opt-in request, or undoes an opt-in request. An opt-in request of type IMMEDIATE can't be undone.

", "smithy.api#required": {} } }, "applyOn": { "target": "com.amazonaws.docdbelastic#InputString", "traits": { "smithy.api#documentation": "

A specific date to apply the pending maintenance action. Required if opt-in-type is APPLY_ON. Format: yyyy/MM/dd HH:mm-yyyy/MM/dd HH:mm\n

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.docdbelastic#ApplyPendingMaintenanceActionOutput": { "type": "structure", "members": { "resourcePendingMaintenanceAction": { "target": "com.amazonaws.docdbelastic#ResourcePendingMaintenanceAction", "traits": { "smithy.api#documentation": "

The output of the pending maintenance action being applied.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.docdbelastic#Arn": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1011 } } }, "com.amazonaws.docdbelastic#Auth": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "PLAIN_TEXT", "name": "PLAIN_TEXT" }, { "value": "SECRET_ARN", "name": "SECRET_ARN" } ] } }, "com.amazonaws.docdbelastic#ChimeraDbLionfishServiceLambda": { "type": "service", "version": "2022-11-28", "operations": [ { "target": "com.amazonaws.docdbelastic#ApplyPendingMaintenanceAction" }, { "target": "com.amazonaws.docdbelastic#CopyClusterSnapshot" }, { "target": "com.amazonaws.docdbelastic#CreateCluster" }, { "target": "com.amazonaws.docdbelastic#CreateClusterSnapshot" }, { "target": "com.amazonaws.docdbelastic#DeleteCluster" }, { "target": "com.amazonaws.docdbelastic#DeleteClusterSnapshot" }, { "target": "com.amazonaws.docdbelastic#GetCluster" }, { "target": "com.amazonaws.docdbelastic#GetClusterSnapshot" }, { "target": "com.amazonaws.docdbelastic#GetPendingMaintenanceAction" }, { "target": "com.amazonaws.docdbelastic#ListClusters" }, { "target": "com.amazonaws.docdbelastic#ListClusterSnapshots" }, { "target": "com.amazonaws.docdbelastic#ListPendingMaintenanceActions" }, { "target": "com.amazonaws.docdbelastic#ListTagsForResource" }, { "target": "com.amazonaws.docdbelastic#RestoreClusterFromSnapshot" }, { "target": "com.amazonaws.docdbelastic#StartCluster" }, { "target": "com.amazonaws.docdbelastic#StopCluster" }, { "target": "com.amazonaws.docdbelastic#TagResource" }, { "target": "com.amazonaws.docdbelastic#UntagResource" }, { "target": "com.amazonaws.docdbelastic#UpdateCluster" } ], "traits": { "aws.api#service": { "sdkId": "DocDB Elastic", "arnNamespace": "docdb-elastic", "cloudTrailEventSource": "CASCADES_EVENT_SOURCE" }, "aws.auth#sigv4": { "name": "docdb-elastic" }, "aws.protocols#restJson1": {}, "smithy.api#cors": { "additionalAllowedHeaders": [ "*", "content-type", "x-amz-content-sha256", "x-amz-user-agent", "x-amzn-platform-id", "x-amzn-trace-id" ], "additionalExposedHeaders": [ "x-amzn-errortype", "x-amzn-requestid", "x-amzn-trace-id" ], "maxAge": 86400 }, "smithy.api#documentation": "Amazon DocumentDB elastic clusters\n

Amazon DocumentDB elastic-clusters support workloads with millions of reads/writes per second and petabytes of storage capacity. \n Amazon DocumentDB elastic clusters also simplify how developers interact with Amazon DocumentDB elastic-clusters by eliminating the need to choose, manage or upgrade instances.

\n

Amazon DocumentDB elastic-clusters were created to:

\n ", "smithy.api#title": "Amazon DocumentDB Elastic Clusters", "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://docdb-elastic-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://docdb-elastic-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://docdb-elastic.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://docdb-elastic.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 13, "nodes": "/////wAAAAH/////AAAAAAAAAAwAAAADAAAAAQAAAAQF9eELAAAAAgAAAAUF9eELAAAAAwAAAAgAAAAGAAAABAAAAAcF9eEKAAAABQX14QgF9eEJAAAABAAAAAoAAAAJAAAABgX14QYF9eEHAAAABQAAAAsF9eEFAAAABgX14QQF9eEFAAAAAwX14QEAAAANAAAABAX14QIF9eED" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] } ] }, { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "rules": [ { "conditions": [], "endpoint": { "url": "https://docdb-elastic-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "rules": [ { "conditions": [], "endpoint": { "url": "https://docdb-elastic-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "rules": [ { "conditions": [], "endpoint": { "url": "https://docdb-elastic.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "rules": [ { "conditions": [], "endpoint": { "url": "https://docdb-elastic.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "type": "tree" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://docdb-elastic-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://docdb-elastic-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://docdb-elastic.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://docdb-elastic.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://docdb-elastic-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://docdb-elastic-fips.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://docdb-elastic.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://docdb-elastic.cn-north-1.amazonaws.com.cn" } }, "params": { "Region": "cn-north-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://docdb-elastic-fips.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://docdb-elastic-fips.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://docdb-elastic.us-gov-east-1.api.aws" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://docdb-elastic.us-gov-east-1.amazonaws.com" } }, "params": { "Region": "us-gov-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://docdb-elastic-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://docdb-elastic.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://docdb-elastic-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://docdb-elastic.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "UseFIPS": false, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips enabled and dualstack disabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "Endpoint": "https://example.com" } }, { "documentation": "For custom endpoint with fips disabled and dualstack enabled", "expect": { "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true, "Endpoint": "https://example.com" } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } } ], "version": "1.0" } } }, "com.amazonaws.docdbelastic#Cluster": { "type": "structure", "members": { "clusterName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The name of the elastic cluster.

", "smithy.api#required": {} } }, "clusterArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The ARN identifier of the elastic cluster.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.docdbelastic#Status", "traits": { "smithy.api#documentation": "

The status of the elastic cluster.

", "smithy.api#required": {} } }, "clusterEndpoint": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The URL used to connect to the elastic cluster.

", "smithy.api#required": {} } }, "createTime": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The time when the elastic cluster was created in Universal Coordinated Time (UTC).

", "smithy.api#required": {} } }, "adminUserName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The name of the elastic cluster administrator.

", "smithy.api#required": {} } }, "authType": { "target": "com.amazonaws.docdbelastic#Auth", "traits": { "smithy.api#documentation": "

The authentication type for the elastic cluster.

", "smithy.api#required": {} } }, "shardCapacity": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. \n Allowed values are 2, 4, 8, 16, 32, 64.

", "smithy.api#required": {} } }, "shardCount": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

The number of shards assigned to the elastic cluster. Maximum is 32.

", "smithy.api#required": {} } }, "vpcSecurityGroupIds": { "target": "com.amazonaws.docdbelastic#StringList", "traits": { "smithy.api#documentation": "

A list of EC2 VPC security groups associated with thie elastic cluster.

", "smithy.api#required": {} } }, "subnetIds": { "target": "com.amazonaws.docdbelastic#StringList", "traits": { "smithy.api#documentation": "

The Amazon EC2 subnet IDs for the elastic cluster.

", "smithy.api#required": {} } }, "preferredMaintenanceWindow": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

\n

\n Format: ddd:hh24:mi-ddd:hh24:mi\n

", "smithy.api#required": {} } }, "kmsKeyId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The KMS key identifier to use to encrypt the elastic cluster.

", "smithy.api#required": {} } }, "shards": { "target": "com.amazonaws.docdbelastic#ShardList", "traits": { "smithy.api#documentation": "

The total number of shards in the cluster.

" } }, "backupRetentionPeriod": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

The number of days for which automatic snapshots are retained.

" } }, "preferredBackupWindow": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The daily time range during which automated backups are created if automated backups are enabled, as determined by backupRetentionPeriod.

" } }, "shardInstanceCount": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

The number of replica instances applying to all shards in the cluster. \n 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.

" } } }, "traits": { "smithy.api#documentation": "

Returns information about a specific elastic cluster.

" } }, "com.amazonaws.docdbelastic#ClusterInList": { "type": "structure", "members": { "clusterName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The name of the elastic cluster.

", "smithy.api#required": {} } }, "clusterArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The ARN identifier of the elastic cluster.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.docdbelastic#Status", "traits": { "smithy.api#documentation": "

The status of the elastic cluster.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

A list of Amazon DocumentDB elastic clusters.

" } }, "com.amazonaws.docdbelastic#ClusterList": { "type": "list", "member": { "target": "com.amazonaws.docdbelastic#ClusterInList" } }, "com.amazonaws.docdbelastic#ClusterSnapshot": { "type": "structure", "members": { "subnetIds": { "target": "com.amazonaws.docdbelastic#StringList", "traits": { "smithy.api#documentation": "

The Amazon EC2 subnet IDs for the elastic cluster.

", "smithy.api#required": {} } }, "snapshotName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The name of the elastic cluster snapshot.

", "smithy.api#required": {} } }, "snapshotArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The ARN identifier of the elastic cluster snapshot.

", "smithy.api#required": {} } }, "snapshotCreationTime": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The time when the elastic cluster snapshot was created in Universal Coordinated Time (UTC).

", "smithy.api#required": {} } }, "clusterArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The ARN identifier of the elastic cluster.

", "smithy.api#required": {} } }, "clusterCreationTime": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The time when the elastic cluster was created in Universal Coordinated Time (UTC).

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.docdbelastic#Status", "traits": { "smithy.api#documentation": "

The status of the elastic cluster snapshot.

", "smithy.api#required": {} } }, "vpcSecurityGroupIds": { "target": "com.amazonaws.docdbelastic#StringList", "traits": { "smithy.api#documentation": "

A list of EC2 VPC security groups to associate with the elastic cluster.

", "smithy.api#required": {} } }, "adminUserName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The name of the elastic cluster administrator.

", "smithy.api#required": {} } }, "kmsKeyId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. \n 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.\n If an encryption key is not specified here, Amazon DocumentDB uses the default encryption key that KMS creates for your account. \n Your account has a different default encryption key for each Amazon Region.\n

", "smithy.api#required": {} } }, "snapshotType": { "target": "com.amazonaws.docdbelastic#SnapshotType", "traits": { "smithy.api#documentation": "

The type of cluster snapshots to be returned. \n You can specify one of the following values:

\n " } } }, "traits": { "smithy.api#documentation": "

Returns information about a specific elastic cluster snapshot.

" } }, "com.amazonaws.docdbelastic#ClusterSnapshotInList": { "type": "structure", "members": { "snapshotName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The name of the elastic cluster snapshot.

", "smithy.api#required": {} } }, "snapshotArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The ARN identifier of the elastic cluster snapshot.

", "smithy.api#required": {} } }, "clusterArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The ARN identifier of the elastic cluster.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.docdbelastic#Status", "traits": { "smithy.api#documentation": "

The status of the elastic cluster snapshot.

", "smithy.api#required": {} } }, "snapshotCreationTime": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The time when the elastic cluster snapshot was created in Universal Coordinated Time (UTC).

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

A list of elastic cluster snapshots.

" } }, "com.amazonaws.docdbelastic#ClusterSnapshotList": { "type": "list", "member": { "target": "com.amazonaws.docdbelastic#ClusterSnapshotInList" } }, "com.amazonaws.docdbelastic#ConflictException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } }, "resourceId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The ID of the resource where there was an access conflict.

", "smithy.api#required": {} } }, "resourceType": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The type of the resource where there was an access conflict.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

There was an access conflict.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.docdbelastic#CopyClusterSnapshot": { "type": "operation", "input": { "target": "com.amazonaws.docdbelastic#CopyClusterSnapshotInput" }, "output": { "target": "com.amazonaws.docdbelastic#CopyClusterSnapshotOutput" }, "errors": [ { "target": "com.amazonaws.docdbelastic#AccessDeniedException" }, { "target": "com.amazonaws.docdbelastic#ConflictException" }, { "target": "com.amazonaws.docdbelastic#InternalServerException" }, { "target": "com.amazonaws.docdbelastic#ResourceNotFoundException" }, { "target": "com.amazonaws.docdbelastic#ServiceQuotaExceededException" }, { "target": "com.amazonaws.docdbelastic#ThrottlingException" }, { "target": "com.amazonaws.docdbelastic#ValidationException" } ], "traits": { "smithy.api#documentation": "

Copies a snapshot of an elastic cluster.

", "smithy.api#examples": [ { "title": "Basic Copy Cluster Snapshot Example", "documentation": "update applied", "input": { "snapshotArn": "arn:aws:docdb-elastic:us-east-1:$AWS_ACCOUNT_ID:cluster-snapshot/$SOURCE_SNAPSHOT_ID", "targetSnapshotName": "sampleSnapshotName" }, "output": { "snapshot": { "subnetIds": [ "subnetId1", "subnetId2" ], "snapshotName": "sampleSnapshotName", "snapshotArn": "arn:aws:docdb-elastic:us-east-1:$AWS_ACCOUNT_ID:cluster-snapshot/$TARGET_SNAPSHOT_ID", "snapshotCreationTime": "2000-01-01T00:00:00.000Z", "clusterArn": "arn:aws:docdb-elastic:us-east-1:$AWS_ACCOUNT_ID:cluster/$CLUSTER_ID", "clusterCreationTime": "2000-01-01T00:00:00.000Z", "status": "ACTIVE", "vpcSecurityGroupIds": [ "vpcSgId1, vpcSgId2" ], "adminUserName": "sampleAdminUser", "kmsKeyId": "AWS_OWNED_KMS_KEY", "snapshotType": "MANUAL" } } } ], "smithy.api#http": { "code": 200, "method": "POST", "uri": "/cluster-snapshot/{snapshotArn}/copy" }, "smithy.api#idempotent": {} } }, "com.amazonaws.docdbelastic#CopyClusterSnapshotInput": { "type": "structure", "members": { "snapshotArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) identifier of the elastic cluster snapshot.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "snapshotArn" } }, "targetSnapshotName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The identifier of the new elastic cluster snapshot to create from the source cluster snapshot. \n This parameter is not case sensitive.

\n

Constraints:

\n \n

Example: elastic-cluster-snapshot-5\n

", "smithy.api#length": { "min": 1, "max": 63 }, "smithy.api#required": {} } }, "kmsKeyId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The Amazon Web Services KMS key ID for an encrypted elastic cluster snapshot. \n 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.

\n

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. \n 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.

\n

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. \n 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.

\n

If you copy an unencrypted elastic cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.

" } }, "copyTags": { "target": "smithy.api#Boolean", "traits": { "smithy.api#default": null, "smithy.api#documentation": "

Set to true to copy all tags from the source cluster snapshot to the target elastic cluster snapshot. \n The default is false.

" } }, "tags": { "target": "com.amazonaws.docdbelastic#TagMap", "traits": { "smithy.api#documentation": "

The tags to be assigned to the elastic cluster snapshot.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.docdbelastic#CopyClusterSnapshotOutput": { "type": "structure", "members": { "snapshot": { "target": "com.amazonaws.docdbelastic#ClusterSnapshot", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.docdbelastic#CreateCluster": { "type": "operation", "input": { "target": "com.amazonaws.docdbelastic#CreateClusterInput" }, "output": { "target": "com.amazonaws.docdbelastic#CreateClusterOutput" }, "errors": [ { "target": "com.amazonaws.docdbelastic#AccessDeniedException" }, { "target": "com.amazonaws.docdbelastic#ConflictException" }, { "target": "com.amazonaws.docdbelastic#InternalServerException" }, { "target": "com.amazonaws.docdbelastic#ServiceQuotaExceededException" }, { "target": "com.amazonaws.docdbelastic#ThrottlingException" }, { "target": "com.amazonaws.docdbelastic#ValidationException" } ], "traits": { "smithy.api#documentation": "

Creates a new Amazon DocumentDB elastic cluster and returns its cluster structure.

", "smithy.api#http": { "code": 200, "method": "POST", "uri": "/cluster" }, "smithy.api#idempotent": {} } }, "com.amazonaws.docdbelastic#CreateClusterInput": { "type": "structure", "members": { "clusterName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The name of the new elastic cluster. This parameter is stored as\n a lowercase string.

\n

\n Constraints:

\n \n

\n Example: my-cluster\n

", "smithy.api#required": {} } }, "authType": { "target": "com.amazonaws.docdbelastic#Auth", "traits": { "smithy.api#documentation": "

The authentication type used to determine where to fetch the password used for accessing the elastic cluster. \n Valid types are PLAIN_TEXT or SECRET_ARN.

", "smithy.api#required": {} } }, "adminUserName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The name of the Amazon DocumentDB elastic clusters administrator.

\n

\n Constraints:

\n ", "smithy.api#required": {} } }, "adminUserPassword": { "target": "com.amazonaws.docdbelastic#Password", "traits": { "smithy.api#documentation": "

The password for the Amazon DocumentDB elastic clusters administrator. The password can contain any printable ASCII characters.

\n

\n Constraints:

\n ", "smithy.api#required": {} } }, "shardCapacity": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.

", "smithy.api#required": {} } }, "shardCount": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

The number of shards assigned to the elastic cluster. Maximum is 32.

", "smithy.api#required": {} } }, "vpcSecurityGroupIds": { "target": "com.amazonaws.docdbelastic#StringList", "traits": { "smithy.api#documentation": "

A list of EC2 VPC security groups to associate with the new\n elastic cluster.

" } }, "subnetIds": { "target": "com.amazonaws.docdbelastic#StringList", "traits": { "smithy.api#documentation": "

The Amazon EC2 subnet IDs for the new elastic cluster.

" } }, "kmsKeyId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The KMS key identifier to use to encrypt the new elastic cluster.

\n

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS\n encryption key. If you are creating a cluster using the same Amazon account\n that owns this KMS encryption key, you can use the KMS key alias instead\n of the ARN as the KMS encryption key.

\n

If an encryption key is not specified, Amazon DocumentDB uses the\n default encryption key that KMS creates for your account. Your account\n has a different default encryption key for each Amazon Region.

" } }, "clientToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The client token for the elastic cluster.

", "smithy.api#idempotencyToken": {} } }, "preferredMaintenanceWindow": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The weekly time range during which system maintenance can occur,\n in Universal Coordinated Time (UTC).

\n

\n Format: ddd:hh24:mi-ddd:hh24:mi\n

\n

\n 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.

\n

\n Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

\n

\n Constraints: Minimum 30-minute window.

" } }, "tags": { "target": "com.amazonaws.docdbelastic#TagMap", "traits": { "smithy.api#documentation": "

The tags to be assigned to the new elastic cluster.

" } }, "backupRetentionPeriod": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

The number of days for which automatic snapshots are retained.

" } }, "preferredBackupWindow": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The daily time range during which automated backups are created if automated backups are enabled, as determined by the backupRetentionPeriod.

" } }, "shardInstanceCount": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

The number of replica instances applying to all shards in the elastic cluster. \n 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.

" } } } }, "com.amazonaws.docdbelastic#CreateClusterOutput": { "type": "structure", "members": { "cluster": { "target": "com.amazonaws.docdbelastic#Cluster", "traits": { "smithy.api#documentation": "

The new elastic cluster that has been created.

", "smithy.api#required": {} } } } }, "com.amazonaws.docdbelastic#CreateClusterSnapshot": { "type": "operation", "input": { "target": "com.amazonaws.docdbelastic#CreateClusterSnapshotInput" }, "output": { "target": "com.amazonaws.docdbelastic#CreateClusterSnapshotOutput" }, "errors": [ { "target": "com.amazonaws.docdbelastic#AccessDeniedException" }, { "target": "com.amazonaws.docdbelastic#ConflictException" }, { "target": "com.amazonaws.docdbelastic#InternalServerException" }, { "target": "com.amazonaws.docdbelastic#ResourceNotFoundException" }, { "target": "com.amazonaws.docdbelastic#ServiceQuotaExceededException" }, { "target": "com.amazonaws.docdbelastic#ThrottlingException" }, { "target": "com.amazonaws.docdbelastic#ValidationException" } ], "traits": { "smithy.api#documentation": "

Creates a snapshot of an elastic cluster.

", "smithy.api#http": { "code": 200, "method": "POST", "uri": "/cluster-snapshot" }, "smithy.api#idempotent": {} } }, "com.amazonaws.docdbelastic#CreateClusterSnapshotInput": { "type": "structure", "members": { "clusterArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The ARN identifier of the elastic cluster of which you want to create a snapshot.

", "smithy.api#required": {} } }, "snapshotName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The name of the new elastic cluster snapshot.

", "smithy.api#length": { "min": 1, "max": 63 }, "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.docdbelastic#TagMap", "traits": { "smithy.api#documentation": "

The tags to be assigned to the new elastic cluster snapshot.

" } } } }, "com.amazonaws.docdbelastic#CreateClusterSnapshotOutput": { "type": "structure", "members": { "snapshot": { "target": "com.amazonaws.docdbelastic#ClusterSnapshot", "traits": { "smithy.api#documentation": "

Returns information about the new elastic cluster snapshot.

", "smithy.api#required": {} } } } }, "com.amazonaws.docdbelastic#DeleteCluster": { "type": "operation", "input": { "target": "com.amazonaws.docdbelastic#DeleteClusterInput" }, "output": { "target": "com.amazonaws.docdbelastic#DeleteClusterOutput" }, "errors": [ { "target": "com.amazonaws.docdbelastic#AccessDeniedException" }, { "target": "com.amazonaws.docdbelastic#ConflictException" }, { "target": "com.amazonaws.docdbelastic#InternalServerException" }, { "target": "com.amazonaws.docdbelastic#ResourceNotFoundException" }, { "target": "com.amazonaws.docdbelastic#ThrottlingException" }, { "target": "com.amazonaws.docdbelastic#ValidationException" } ], "traits": { "smithy.api#documentation": "

Delete an elastic cluster.

", "smithy.api#http": { "code": 200, "method": "DELETE", "uri": "/cluster/{clusterArn}" }, "smithy.api#idempotent": {} } }, "com.amazonaws.docdbelastic#DeleteClusterInput": { "type": "structure", "members": { "clusterArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The ARN identifier of the elastic cluster that is to be deleted.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "clusterArn" } } } }, "com.amazonaws.docdbelastic#DeleteClusterOutput": { "type": "structure", "members": { "cluster": { "target": "com.amazonaws.docdbelastic#Cluster", "traits": { "smithy.api#documentation": "

Returns information about the newly deleted elastic cluster.

", "smithy.api#required": {} } } } }, "com.amazonaws.docdbelastic#DeleteClusterSnapshot": { "type": "operation", "input": { "target": "com.amazonaws.docdbelastic#DeleteClusterSnapshotInput" }, "output": { "target": "com.amazonaws.docdbelastic#DeleteClusterSnapshotOutput" }, "errors": [ { "target": "com.amazonaws.docdbelastic#AccessDeniedException" }, { "target": "com.amazonaws.docdbelastic#ConflictException" }, { "target": "com.amazonaws.docdbelastic#InternalServerException" }, { "target": "com.amazonaws.docdbelastic#ResourceNotFoundException" }, { "target": "com.amazonaws.docdbelastic#ThrottlingException" }, { "target": "com.amazonaws.docdbelastic#ValidationException" } ], "traits": { "smithy.api#documentation": "

Delete an elastic cluster snapshot.

", "smithy.api#http": { "code": 200, "method": "DELETE", "uri": "/cluster-snapshot/{snapshotArn}" }, "smithy.api#idempotent": {} } }, "com.amazonaws.docdbelastic#DeleteClusterSnapshotInput": { "type": "structure", "members": { "snapshotArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The ARN identifier of the elastic cluster snapshot that is to be deleted.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "snapshotArn" } } } }, "com.amazonaws.docdbelastic#DeleteClusterSnapshotOutput": { "type": "structure", "members": { "snapshot": { "target": "com.amazonaws.docdbelastic#ClusterSnapshot", "traits": { "smithy.api#documentation": "

Returns information about the newly deleted elastic cluster snapshot.

", "smithy.api#required": {} } } } }, "com.amazonaws.docdbelastic#GetCluster": { "type": "operation", "input": { "target": "com.amazonaws.docdbelastic#GetClusterInput" }, "output": { "target": "com.amazonaws.docdbelastic#GetClusterOutput" }, "errors": [ { "target": "com.amazonaws.docdbelastic#AccessDeniedException" }, { "target": "com.amazonaws.docdbelastic#InternalServerException" }, { "target": "com.amazonaws.docdbelastic#ResourceNotFoundException" }, { "target": "com.amazonaws.docdbelastic#ThrottlingException" }, { "target": "com.amazonaws.docdbelastic#ValidationException" } ], "traits": { "smithy.api#documentation": "

Returns information about a specific elastic cluster.

", "smithy.api#http": { "code": 200, "method": "GET", "uri": "/cluster/{clusterArn}" }, "smithy.api#readonly": {} } }, "com.amazonaws.docdbelastic#GetClusterInput": { "type": "structure", "members": { "clusterArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The ARN identifier of the elastic cluster.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "clusterArn" } } } }, "com.amazonaws.docdbelastic#GetClusterOutput": { "type": "structure", "members": { "cluster": { "target": "com.amazonaws.docdbelastic#Cluster", "traits": { "smithy.api#documentation": "

Returns information about a specific elastic cluster.

", "smithy.api#required": {} } } } }, "com.amazonaws.docdbelastic#GetClusterSnapshot": { "type": "operation", "input": { "target": "com.amazonaws.docdbelastic#GetClusterSnapshotInput" }, "output": { "target": "com.amazonaws.docdbelastic#GetClusterSnapshotOutput" }, "errors": [ { "target": "com.amazonaws.docdbelastic#AccessDeniedException" }, { "target": "com.amazonaws.docdbelastic#InternalServerException" }, { "target": "com.amazonaws.docdbelastic#ResourceNotFoundException" }, { "target": "com.amazonaws.docdbelastic#ThrottlingException" }, { "target": "com.amazonaws.docdbelastic#ValidationException" } ], "traits": { "smithy.api#documentation": "

Returns information about a specific elastic cluster snapshot

", "smithy.api#http": { "code": 200, "method": "GET", "uri": "/cluster-snapshot/{snapshotArn}" }, "smithy.api#readonly": {} } }, "com.amazonaws.docdbelastic#GetClusterSnapshotInput": { "type": "structure", "members": { "snapshotArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The ARN identifier of the elastic cluster snapshot.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "snapshotArn" } } } }, "com.amazonaws.docdbelastic#GetClusterSnapshotOutput": { "type": "structure", "members": { "snapshot": { "target": "com.amazonaws.docdbelastic#ClusterSnapshot", "traits": { "smithy.api#documentation": "

Returns information about a specific elastic cluster snapshot.

", "smithy.api#required": {} } } } }, "com.amazonaws.docdbelastic#GetPendingMaintenanceAction": { "type": "operation", "input": { "target": "com.amazonaws.docdbelastic#GetPendingMaintenanceActionInput" }, "output": { "target": "com.amazonaws.docdbelastic#GetPendingMaintenanceActionOutput" }, "errors": [ { "target": "com.amazonaws.docdbelastic#AccessDeniedException" }, { "target": "com.amazonaws.docdbelastic#ConflictException" }, { "target": "com.amazonaws.docdbelastic#InternalServerException" }, { "target": "com.amazonaws.docdbelastic#ResourceNotFoundException" }, { "target": "com.amazonaws.docdbelastic#ThrottlingException" }, { "target": "com.amazonaws.docdbelastic#ValidationException" } ], "traits": { "smithy.api#documentation": "

Retrieves all maintenance actions that are pending.

", "smithy.api#http": { "code": 200, "method": "GET", "uri": "/pending-action/{resourceArn}" }, "smithy.api#readonly": {} } }, "com.amazonaws.docdbelastic#GetPendingMaintenanceActionInput": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.docdbelastic#InputString", "traits": { "smithy.api#documentation": "

Retrieves pending maintenance actions for a specific Amazon Resource Name (ARN).

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "resourceArn" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.docdbelastic#GetPendingMaintenanceActionOutput": { "type": "structure", "members": { "resourcePendingMaintenanceAction": { "target": "com.amazonaws.docdbelastic#ResourcePendingMaintenanceAction", "traits": { "smithy.api#documentation": "

Provides information about a pending maintenance action for a resource.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.docdbelastic#InputString": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 } } }, "com.amazonaws.docdbelastic#InternalServerException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

There was an internal server error.

", "smithy.api#error": "server", "smithy.api#httpError": 500, "smithy.api#retryable": {} } }, "com.amazonaws.docdbelastic#ListClusterSnapshots": { "type": "operation", "input": { "target": "com.amazonaws.docdbelastic#ListClusterSnapshotsInput" }, "output": { "target": "com.amazonaws.docdbelastic#ListClusterSnapshotsOutput" }, "errors": [ { "target": "com.amazonaws.docdbelastic#AccessDeniedException" }, { "target": "com.amazonaws.docdbelastic#InternalServerException" }, { "target": "com.amazonaws.docdbelastic#ThrottlingException" }, { "target": "com.amazonaws.docdbelastic#ValidationException" } ], "traits": { "smithy.api#documentation": "

Returns information about snapshots for a specified elastic cluster.

", "smithy.api#http": { "code": 200, "method": "GET", "uri": "/cluster-snapshots" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "snapshots" }, "smithy.api#readonly": {} } }, "com.amazonaws.docdbelastic#ListClusterSnapshotsInput": { "type": "structure", "members": { "clusterArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The ARN identifier of the elastic cluster.

", "smithy.api#httpQuery": "clusterArn" } }, "nextToken": { "target": "com.amazonaws.docdbelastic#PaginationToken", "traits": { "smithy.api#documentation": "

A pagination token provided by a previous request. \n If this parameter is specified, the response includes only records beyond this token, up to the value specified by max-results.

\n

If there is no more data in the responce, the nextToken will not be returned.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#default": null, "smithy.api#documentation": "

The maximum number of elastic cluster snapshot results to receive in the response.

", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { "min": 20, "max": 100 } } }, "snapshotType": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The type of cluster snapshots to be returned. You can specify one of the following values:

\n ", "smithy.api#httpQuery": "snapshotType" } } } }, "com.amazonaws.docdbelastic#ListClusterSnapshotsOutput": { "type": "structure", "members": { "snapshots": { "target": "com.amazonaws.docdbelastic#ClusterSnapshotList", "traits": { "smithy.api#documentation": "

A list of snapshots for a specified elastic cluster.

" } }, "nextToken": { "target": "com.amazonaws.docdbelastic#PaginationToken", "traits": { "smithy.api#documentation": "

A pagination token provided by a previous request. \n If this parameter is specified, the response includes only records beyond this token, up to the value specified by max-results.

\n

If there is no more data in the responce, the nextToken will not be returned.

" } } } }, "com.amazonaws.docdbelastic#ListClusters": { "type": "operation", "input": { "target": "com.amazonaws.docdbelastic#ListClustersInput" }, "output": { "target": "com.amazonaws.docdbelastic#ListClustersOutput" }, "errors": [ { "target": "com.amazonaws.docdbelastic#AccessDeniedException" }, { "target": "com.amazonaws.docdbelastic#InternalServerException" }, { "target": "com.amazonaws.docdbelastic#ThrottlingException" }, { "target": "com.amazonaws.docdbelastic#ValidationException" } ], "traits": { "smithy.api#documentation": "

Returns information about provisioned Amazon DocumentDB elastic clusters.

", "smithy.api#http": { "code": 200, "method": "GET", "uri": "/clusters" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "clusters" }, "smithy.api#readonly": {} } }, "com.amazonaws.docdbelastic#ListClustersInput": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.docdbelastic#PaginationToken", "traits": { "smithy.api#documentation": "

A pagination token provided by a previous request. \n If this parameter is specified, the response includes only records beyond this token, up to the value specified by max-results.

\n

If there is no more data in the responce, the nextToken will not be returned.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#default": null, "smithy.api#documentation": "

The maximum number of elastic cluster snapshot results to receive in the response.

", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { "min": 1, "max": 100 } } } } }, "com.amazonaws.docdbelastic#ListClustersOutput": { "type": "structure", "members": { "clusters": { "target": "com.amazonaws.docdbelastic#ClusterList", "traits": { "smithy.api#documentation": "

A list of Amazon DocumentDB elastic clusters.

" } }, "nextToken": { "target": "com.amazonaws.docdbelastic#PaginationToken", "traits": { "smithy.api#documentation": "

A pagination token provided by a previous request. \n If this parameter is specified, the response includes only records beyond this token, up to the value specified by max-results.

\n

If there is no more data in the responce, the nextToken will not be returned.

" } } } }, "com.amazonaws.docdbelastic#ListPendingMaintenanceActions": { "type": "operation", "input": { "target": "com.amazonaws.docdbelastic#ListPendingMaintenanceActionsInput" }, "output": { "target": "com.amazonaws.docdbelastic#ListPendingMaintenanceActionsOutput" }, "errors": [ { "target": "com.amazonaws.docdbelastic#AccessDeniedException" }, { "target": "com.amazonaws.docdbelastic#InternalServerException" }, { "target": "com.amazonaws.docdbelastic#ThrottlingException" }, { "target": "com.amazonaws.docdbelastic#ValidationException" } ], "traits": { "smithy.api#documentation": "

Retrieves a list of all maintenance actions that are pending.

", "smithy.api#http": { "code": 200, "method": "GET", "uri": "/pending-actions" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "resourcePendingMaintenanceActions" }, "smithy.api#readonly": {} } }, "com.amazonaws.docdbelastic#ListPendingMaintenanceActionsInput": { "type": "structure", "members": { "nextToken": { "target": "com.amazonaws.docdbelastic#PaginationToken", "traits": { "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by maxResults.

", "smithy.api#httpQuery": "nextToken" } }, "maxResults": { "target": "smithy.api#Integer", "traits": { "smithy.api#default": null, "smithy.api#documentation": "

The maximum number of results to include in the response. \n If more records exist than the specified maxResults value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { "min": 1, "max": 100 } } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.docdbelastic#ListPendingMaintenanceActionsOutput": { "type": "structure", "members": { "resourcePendingMaintenanceActions": { "target": "com.amazonaws.docdbelastic#ResourcePendingMaintenanceActionList", "traits": { "smithy.api#documentation": "

Provides information about a pending maintenance action for a resource.

", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.docdbelastic#PaginationToken", "traits": { "smithy.api#documentation": "

An optional pagination token provided by a previous request. If this parameter is displayed, the responses will include only records beyond the marker, up to the value specified by maxResults.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.docdbelastic#ListTagsForResource": { "type": "operation", "input": { "target": "com.amazonaws.docdbelastic#ListTagsForResourceRequest" }, "output": { "target": "com.amazonaws.docdbelastic#ListTagsForResourceResponse" }, "errors": [ { "target": "com.amazonaws.docdbelastic#InternalServerException" }, { "target": "com.amazonaws.docdbelastic#ResourceNotFoundException" }, { "target": "com.amazonaws.docdbelastic#ThrottlingException" }, { "target": "com.amazonaws.docdbelastic#ValidationException" } ], "traits": { "smithy.api#documentation": "

Lists all tags on a elastic cluster resource

", "smithy.api#http": { "uri": "/tags/{resourceArn}", "method": "GET" }, "smithy.api#readonly": {} } }, "com.amazonaws.docdbelastic#ListTagsForResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.docdbelastic#Arn", "traits": { "smithy.api#documentation": "

The ARN identifier of the elastic cluster resource.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.docdbelastic#ListTagsForResourceResponse": { "type": "structure", "members": { "tags": { "target": "com.amazonaws.docdbelastic#TagMap", "traits": { "smithy.api#documentation": "

The list of tags for the specified elastic cluster resource.

" } } } }, "com.amazonaws.docdbelastic#OptInType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "IMMEDIATE", "name": "IMMEDIATE" }, { "value": "NEXT_MAINTENANCE", "name": "NEXT_MAINTENANCE" }, { "value": "APPLY_ON", "name": "APPLY_ON" }, { "value": "UNDO_OPT_IN", "name": "UNDO_OPT_IN" } ] } }, "com.amazonaws.docdbelastic#PaginationToken": { "type": "string", "traits": { "smithy.api#documentation": " Token or cursor used in paginated operations.\n\n When this value is provided as operation input, the service returns results from where the previous response left off.\n When this value is present in operation output, it indicates that there are more results to retrieve.\n\n This should be opaque to not expose implementation details and potentially versioned to allow evolution of pagination\n strategy.\n" } }, "com.amazonaws.docdbelastic#Password": { "type": "string", "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.docdbelastic#PendingMaintenanceActionDetails": { "type": "structure", "members": { "action": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Displays the specific action of a pending maintenance action.

", "smithy.api#required": {} } }, "autoAppliedAfterDate": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Displays the date of the maintenance window when the action is applied. \n The maintenance action is applied to the resource during its first maintenance window after this date. \n If this date is specified, any NEXT_MAINTENANCE\n optInType requests are ignored.

" } }, "forcedApplyDate": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Displays the date when the maintenance action is automatically applied. \n The maintenance action is applied to the resource on this date regardless of the maintenance window for the resource. \n If this date is specified, any IMMEDIATE\n optInType requests are ignored.

" } }, "optInStatus": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Displays the type of optInType request that has been received for the resource.

" } }, "currentApplyDate": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Displays the effective date when the pending maintenance action is applied to the resource.

" } }, "description": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Displays a description providing more detail about the maintenance action.

" } } }, "traits": { "smithy.api#documentation": "

Retrieves the details of maintenance actions that are pending.

" } }, "com.amazonaws.docdbelastic#PendingMaintenanceActionDetailsList": { "type": "list", "member": { "target": "com.amazonaws.docdbelastic#PendingMaintenanceActionDetails" } }, "com.amazonaws.docdbelastic#ResourceNotFoundException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

An error message describing the failure.

", "smithy.api#required": {} } }, "resourceId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The ID of the resource that could not be located.

", "smithy.api#required": {} } }, "resourceType": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The type of the resource that could not be found.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The specified resource could not be located.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.docdbelastic#ResourcePendingMaintenanceAction": { "type": "structure", "members": { "resourceArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The Amazon DocumentDB Amazon Resource Name (ARN) of the resource to which the pending maintenance action applies.

" } }, "pendingMaintenanceActionDetails": { "target": "com.amazonaws.docdbelastic#PendingMaintenanceActionDetailsList", "traits": { "smithy.api#documentation": "

Provides information about a pending maintenance action for a resource.

" } } }, "traits": { "smithy.api#documentation": "

Provides information about a pending maintenance action for a resource.

" } }, "com.amazonaws.docdbelastic#ResourcePendingMaintenanceActionList": { "type": "list", "member": { "target": "com.amazonaws.docdbelastic#ResourcePendingMaintenanceAction" } }, "com.amazonaws.docdbelastic#RestoreClusterFromSnapshot": { "type": "operation", "input": { "target": "com.amazonaws.docdbelastic#RestoreClusterFromSnapshotInput" }, "output": { "target": "com.amazonaws.docdbelastic#RestoreClusterFromSnapshotOutput" }, "errors": [ { "target": "com.amazonaws.docdbelastic#AccessDeniedException" }, { "target": "com.amazonaws.docdbelastic#ConflictException" }, { "target": "com.amazonaws.docdbelastic#InternalServerException" }, { "target": "com.amazonaws.docdbelastic#ResourceNotFoundException" }, { "target": "com.amazonaws.docdbelastic#ServiceQuotaExceededException" }, { "target": "com.amazonaws.docdbelastic#ThrottlingException" }, { "target": "com.amazonaws.docdbelastic#ValidationException" } ], "traits": { "smithy.api#documentation": "

Restores an elastic cluster from a snapshot.

", "smithy.api#http": { "code": 200, "method": "POST", "uri": "/cluster-snapshot/{snapshotArn}/restore" }, "smithy.api#idempotent": {} } }, "com.amazonaws.docdbelastic#RestoreClusterFromSnapshotInput": { "type": "structure", "members": { "clusterName": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The name of the elastic cluster.

", "smithy.api#required": {} } }, "snapshotArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The ARN identifier of the elastic cluster snapshot.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "snapshotArn" } }, "vpcSecurityGroupIds": { "target": "com.amazonaws.docdbelastic#StringList", "traits": { "smithy.api#documentation": "

A list of EC2 VPC security groups to associate with the elastic cluster.

" } }, "subnetIds": { "target": "com.amazonaws.docdbelastic#StringList", "traits": { "smithy.api#documentation": "

The Amazon EC2 subnet IDs for the elastic cluster.

" } }, "kmsKeyId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The KMS key identifier to use to encrypt the new Amazon DocumentDB elastic clusters cluster.

\n

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS\n encryption key. If you are creating a cluster using the same Amazon account\n that owns this KMS encryption key, you can use the KMS key alias instead\n of the ARN as the KMS encryption key.

\n

If an encryption key is not specified here, Amazon DocumentDB uses the\n default encryption key that KMS creates for your account. Your account\n has a different default encryption key for each Amazon Region.

" } }, "tags": { "target": "com.amazonaws.docdbelastic#TagMap", "traits": { "smithy.api#documentation": "

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.

" } }, "shardCapacity": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

The capacity of each shard in the new restored elastic cluster.

" } }, "shardInstanceCount": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

The number of replica instances applying to all shards in the elastic cluster. \n 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.

" } } } }, "com.amazonaws.docdbelastic#RestoreClusterFromSnapshotOutput": { "type": "structure", "members": { "cluster": { "target": "com.amazonaws.docdbelastic#Cluster", "traits": { "smithy.api#documentation": "

Returns information about a the restored elastic cluster.

", "smithy.api#required": {} } } } }, "com.amazonaws.docdbelastic#ServiceQuotaExceededException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The service quota for the action was exceeded.

", "smithy.api#error": "client", "smithy.api#httpError": 402 } }, "com.amazonaws.docdbelastic#Shard": { "type": "structure", "members": { "shardId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The ID of the shard.

", "smithy.api#required": {} } }, "createTime": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The time when the shard was created in Universal Coordinated Time (UTC).

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.docdbelastic#Status", "traits": { "smithy.api#documentation": "

The current status of the shard.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The name of the shard.

" } }, "com.amazonaws.docdbelastic#ShardList": { "type": "list", "member": { "target": "com.amazonaws.docdbelastic#Shard" } }, "com.amazonaws.docdbelastic#SnapshotType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "MANUAL", "name": "MANUAL" }, { "value": "AUTOMATED", "name": "AUTOMATED" } ] } }, "com.amazonaws.docdbelastic#StartCluster": { "type": "operation", "input": { "target": "com.amazonaws.docdbelastic#StartClusterInput" }, "output": { "target": "com.amazonaws.docdbelastic#StartClusterOutput" }, "errors": [ { "target": "com.amazonaws.docdbelastic#AccessDeniedException" }, { "target": "com.amazonaws.docdbelastic#InternalServerException" }, { "target": "com.amazonaws.docdbelastic#ResourceNotFoundException" }, { "target": "com.amazonaws.docdbelastic#ThrottlingException" }, { "target": "com.amazonaws.docdbelastic#ValidationException" } ], "traits": { "smithy.api#documentation": "

Restarts the stopped elastic cluster that is specified by clusterARN.

", "smithy.api#examples": [ { "title": "Basic Start Cluster Example", "documentation": "update applied", "input": { "clusterArn": "arn:aws:docdb-elastic:us-east-1:$AWS_ACCOUNT_ID:cluster/$CLUSTER_ID" }, "output": { "cluster": { "clusterName": "sampleClusterName", "clusterArn": "arn:aws:docdb-elastic:us-east-1:$AWS_ACCOUNT_ID:cluster/$CLUSTER_ID", "status": "STARTING", "clusterEndpoint": "sampleClusterName.us-east-1.docdb-elastic.amazonaws.com", "createTime": "2000-01-01T00:00:00.000Z", "adminUserName": "sampleAdminUser", "authType": "PLAIN_TEXT", "shardCapacity": 2, "shardCount": 2, "vpcSecurityGroupIds": [ "vpcSgId1, vpcSgId2" ], "subnetIds": [ "subnetId1", "subnetId2" ], "preferredMaintenanceWindow": "mon:00:00-mon:00:30", "kmsKeyId": "AWS_OWNED_KMS_KEY", "shards": [], "backupRetentionPeriod": 1, "preferredBackupWindow": "01:00-01:30", "shardInstanceCount": 1 } } } ], "smithy.api#http": { "code": 200, "method": "POST", "uri": "/cluster/{clusterArn}/start" }, "smithy.api#idempotent": {} } }, "com.amazonaws.docdbelastic#StartClusterInput": { "type": "structure", "members": { "clusterArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The ARN identifier of the elastic cluster.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "clusterArn" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.docdbelastic#StartClusterOutput": { "type": "structure", "members": { "cluster": { "target": "com.amazonaws.docdbelastic#Cluster", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.docdbelastic#Status": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "CREATING", "name": "CREATING" }, { "value": "ACTIVE", "name": "ACTIVE" }, { "value": "DELETING", "name": "DELETING" }, { "value": "UPDATING", "name": "UPDATING" }, { "value": "VPC_ENDPOINT_LIMIT_EXCEEDED", "name": "VPC_ENDPOINT_LIMIT_EXCEEDED" }, { "value": "IP_ADDRESS_LIMIT_EXCEEDED", "name": "IP_ADDRESS_LIMIT_EXCEEDED" }, { "value": "INVALID_SECURITY_GROUP_ID", "name": "INVALID_SECURITY_GROUP_ID" }, { "value": "INVALID_SUBNET_ID", "name": "INVALID_SUBNET_ID" }, { "value": "INACCESSIBLE_ENCRYPTION_CREDS", "name": "INACCESSIBLE_ENCRYPTION_CREDS" }, { "value": "INACCESSIBLE_SECRET_ARN", "name": "INACCESSIBLE_SECRET_ARN" }, { "value": "INACCESSIBLE_VPC_ENDPOINT", "name": "INACCESSIBLE_VPC_ENDPOINT" }, { "value": "INCOMPATIBLE_NETWORK", "name": "INCOMPATIBLE_NETWORK" }, { "value": "MERGING", "name": "MERGING" }, { "value": "MODIFYING", "name": "MODIFYING" }, { "value": "SPLITTING", "name": "SPLITTING" }, { "value": "COPYING", "name": "COPYING" }, { "value": "STARTING", "name": "STARTING" }, { "value": "STOPPING", "name": "STOPPING" }, { "value": "STOPPED", "name": "STOPPED" }, { "value": "MAINTENANCE", "name": "MAINTENANCE" }, { "value": "INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE", "name": "INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE" } ] } }, "com.amazonaws.docdbelastic#StopCluster": { "type": "operation", "input": { "target": "com.amazonaws.docdbelastic#StopClusterInput" }, "output": { "target": "com.amazonaws.docdbelastic#StopClusterOutput" }, "errors": [ { "target": "com.amazonaws.docdbelastic#AccessDeniedException" }, { "target": "com.amazonaws.docdbelastic#InternalServerException" }, { "target": "com.amazonaws.docdbelastic#ResourceNotFoundException" }, { "target": "com.amazonaws.docdbelastic#ThrottlingException" }, { "target": "com.amazonaws.docdbelastic#ValidationException" } ], "traits": { "smithy.api#documentation": "

Stops the running elastic cluster that is specified by clusterArn. \n The elastic cluster must be in the available state.

", "smithy.api#examples": [ { "title": "Basic Stop Cluster Example", "documentation": "update applied", "input": { "clusterArn": "arn:aws:docdb-elastic:us-east-1:$AWS_ACCOUNT_ID:cluster/$CLUSTER_ID" }, "output": { "cluster": { "clusterName": "sampleClusterName", "clusterArn": "arn:aws:docdb-elastic:us-east-1:$AWS_ACCOUNT_ID:cluster/$CLUSTER_ID", "status": "STOPPING", "clusterEndpoint": "sampleClusterName.us-east-1.docdb-elastic.amazonaws.com", "createTime": "2000-01-01T00:00:00.000Z", "adminUserName": "sampleAdminUser", "authType": "PLAIN_TEXT", "shardCapacity": 2, "shardCount": 2, "vpcSecurityGroupIds": [ "vpcSgId1, vpcSgId2" ], "subnetIds": [ "subnetId1", "subnetId2" ], "preferredMaintenanceWindow": "mon:00:00-mon:00:30", "kmsKeyId": "AWS_OWNED_KMS_KEY", "shards": [], "backupRetentionPeriod": 1, "preferredBackupWindow": "01:00-01:30", "shardInstanceCount": 1 } } } ], "smithy.api#http": { "code": 200, "method": "POST", "uri": "/cluster/{clusterArn}/stop" }, "smithy.api#idempotent": {} } }, "com.amazonaws.docdbelastic#StopClusterInput": { "type": "structure", "members": { "clusterArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The ARN identifier of the elastic cluster.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "clusterArn" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.docdbelastic#StopClusterOutput": { "type": "structure", "members": { "cluster": { "target": "com.amazonaws.docdbelastic#Cluster", "traits": { "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.docdbelastic#StringList": { "type": "list", "member": { "target": "smithy.api#String" } }, "com.amazonaws.docdbelastic#TagKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^(?!aws:)[a-zA-Z+-=._:/]+$" } }, "com.amazonaws.docdbelastic#TagKeyList": { "type": "list", "member": { "target": "com.amazonaws.docdbelastic#TagKey" }, "traits": { "smithy.api#length": { "min": 0, "max": 50 } } }, "com.amazonaws.docdbelastic#TagMap": { "type": "map", "key": { "target": "com.amazonaws.docdbelastic#TagKey" }, "value": { "target": "com.amazonaws.docdbelastic#TagValue" } }, "com.amazonaws.docdbelastic#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.docdbelastic#TagResourceRequest" }, "output": { "target": "com.amazonaws.docdbelastic#TagResourceResponse" }, "errors": [ { "target": "com.amazonaws.docdbelastic#InternalServerException" }, { "target": "com.amazonaws.docdbelastic#ResourceNotFoundException" }, { "target": "com.amazonaws.docdbelastic#ThrottlingException" }, { "target": "com.amazonaws.docdbelastic#ValidationException" } ], "traits": { "smithy.api#documentation": "

Adds metadata tags to an elastic cluster resource

", "smithy.api#http": { "uri": "/tags/{resourceArn}", "method": "POST" } } }, "com.amazonaws.docdbelastic#TagResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.docdbelastic#Arn", "traits": { "smithy.api#documentation": "

The ARN identifier of the elastic cluster resource.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.docdbelastic#TagMap", "traits": { "smithy.api#documentation": "

The tags that are assigned to the elastic cluster resource.

", "smithy.api#required": {} } } } }, "com.amazonaws.docdbelastic#TagResourceResponse": { "type": "structure", "members": {} }, "com.amazonaws.docdbelastic#TagValue": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 256 } } }, "com.amazonaws.docdbelastic#ThrottlingException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#required": {} } }, "retryAfterSeconds": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

The number of seconds to wait before retrying the operation.

", "smithy.api#httpHeader": "Retry-After" } } }, "traits": { "smithy.api#documentation": "

ThrottlingException will be thrown when request was denied due to request throttling.

", "smithy.api#error": "client", "smithy.api#httpError": 429, "smithy.api#retryable": {} } }, "com.amazonaws.docdbelastic#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.docdbelastic#UntagResourceRequest" }, "output": { "target": "com.amazonaws.docdbelastic#UntagResourceResponse" }, "errors": [ { "target": "com.amazonaws.docdbelastic#InternalServerException" }, { "target": "com.amazonaws.docdbelastic#ResourceNotFoundException" }, { "target": "com.amazonaws.docdbelastic#ThrottlingException" }, { "target": "com.amazonaws.docdbelastic#ValidationException" } ], "traits": { "smithy.api#documentation": "

Removes metadata tags from an elastic cluster resource

", "smithy.api#http": { "uri": "/tags/{resourceArn}", "method": "DELETE" }, "smithy.api#idempotent": {} } }, "com.amazonaws.docdbelastic#UntagResourceRequest": { "type": "structure", "members": { "resourceArn": { "target": "com.amazonaws.docdbelastic#Arn", "traits": { "smithy.api#documentation": "

The ARN identifier of the elastic cluster resource.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "tagKeys": { "target": "com.amazonaws.docdbelastic#TagKeyList", "traits": { "smithy.api#documentation": "

The tag keys to be removed from the elastic cluster resource.

", "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} } } } }, "com.amazonaws.docdbelastic#UntagResourceResponse": { "type": "structure", "members": {} }, "com.amazonaws.docdbelastic#UpdateCluster": { "type": "operation", "input": { "target": "com.amazonaws.docdbelastic#UpdateClusterInput" }, "output": { "target": "com.amazonaws.docdbelastic#UpdateClusterOutput" }, "errors": [ { "target": "com.amazonaws.docdbelastic#AccessDeniedException" }, { "target": "com.amazonaws.docdbelastic#ConflictException" }, { "target": "com.amazonaws.docdbelastic#InternalServerException" }, { "target": "com.amazonaws.docdbelastic#ResourceNotFoundException" }, { "target": "com.amazonaws.docdbelastic#ThrottlingException" }, { "target": "com.amazonaws.docdbelastic#ValidationException" } ], "traits": { "smithy.api#documentation": "

Modifies an elastic cluster. This includes updating admin-username/password, \n upgrading the API version, and setting up a backup window and maintenance window

", "smithy.api#http": { "code": 200, "method": "PUT", "uri": "/cluster/{clusterArn}" }, "smithy.api#idempotent": {} } }, "com.amazonaws.docdbelastic#UpdateClusterInput": { "type": "structure", "members": { "clusterArn": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The ARN identifier of the elastic cluster.

", "smithy.api#httpLabel": {}, "smithy.api#required": {}, "smithy.api#resourceIdentifier": "clusterArn" } }, "authType": { "target": "com.amazonaws.docdbelastic#Auth", "traits": { "smithy.api#documentation": "

The authentication type used to determine where to fetch the password used for accessing the elastic cluster. \n Valid types are PLAIN_TEXT or SECRET_ARN.

" } }, "shardCapacity": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

The number of vCPUs assigned to each elastic cluster shard. \n Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.

" } }, "shardCount": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

The number of shards assigned to the elastic cluster. Maximum is 32.

" } }, "vpcSecurityGroupIds": { "target": "com.amazonaws.docdbelastic#StringList", "traits": { "smithy.api#documentation": "

A list of EC2 VPC security groups to associate with the elastic cluster.

" } }, "subnetIds": { "target": "com.amazonaws.docdbelastic#StringList", "traits": { "smithy.api#documentation": "

The Amazon EC2 subnet IDs for the elastic cluster.

" } }, "adminUserPassword": { "target": "com.amazonaws.docdbelastic#Password", "traits": { "smithy.api#documentation": "

The password associated with the elastic cluster administrator. \n This password can contain any printable ASCII character except forward slash (/), double quote (\"), or the \"at\" symbol (@).

\n

\n Constraints: Must contain from 8 to 100 characters.

" } }, "clientToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The client token for the elastic cluster.

", "smithy.api#idempotencyToken": {} } }, "preferredMaintenanceWindow": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

\n

\n Format: ddd:hh24:mi-ddd:hh24:mi\n

\n

\n 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.

\n

\n Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

\n

\n Constraints: Minimum 30-minute window.

" } }, "backupRetentionPeriod": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

The number of days for which automatic snapshots are retained.

" } }, "preferredBackupWindow": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The daily time range during which automated backups are created if automated backups are enabled, as determined by the backupRetentionPeriod.

" } }, "shardInstanceCount": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

The number of replica instances applying to all shards in the elastic cluster. \n 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.

" } } } }, "com.amazonaws.docdbelastic#UpdateClusterOutput": { "type": "structure", "members": { "cluster": { "target": "com.amazonaws.docdbelastic#Cluster", "traits": { "smithy.api#documentation": "

Returns information about the updated elastic cluster.

", "smithy.api#required": {} } } } }, "com.amazonaws.docdbelastic#ValidationException": { "type": "structure", "members": { "message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

An error message describing the validation exception.

", "smithy.api#required": {} } }, "reason": { "target": "com.amazonaws.docdbelastic#ValidationExceptionReason", "traits": { "smithy.api#documentation": "

The reason why the validation exception occurred (one of unknownOperation,\n cannotParse, fieldValidationFailed, or other).

", "smithy.api#required": {} } }, "fieldList": { "target": "com.amazonaws.docdbelastic#ValidationExceptionFieldList", "traits": { "smithy.api#documentation": "

A list of the fields in which the validation exception occurred.

" } } }, "traits": { "smithy.api#documentation": "

A structure defining a validation exception.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.docdbelastic#ValidationExceptionField": { "type": "structure", "members": { "name": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The name of the field where the validation exception occurred.

", "smithy.api#required": {} } }, "message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

An error message describing the validation exception in this field.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

A specific field in which a given validation exception occurred.

" } }, "com.amazonaws.docdbelastic#ValidationExceptionFieldList": { "type": "list", "member": { "target": "com.amazonaws.docdbelastic#ValidationExceptionField" } }, "com.amazonaws.docdbelastic#ValidationExceptionReason": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "unknownOperation", "name": "UNKNOWN_OPERATION" }, { "value": "cannotParse", "name": "CANNOT_PARSE" }, { "value": "fieldValidationFailed", "name": "FIELD_VALIDATION_FAILED" }, { "value": "other", "name": "OTHER" } ] } } } }