Amazon DocumentDB Elastic Clusters

2024/11/01 - Amazon DocumentDB Elastic Clusters - 3 new13 updated api methods

Changes  Amazon DocumentDB Elastic Clusters adds support for pending maintenance actions feature with APIs GetPendingMaintenanceAction, ListPendingMaintenanceActions and ApplyPendingMaintenanceAction

GetPendingMaintenanceAction (new) Link ¶

Retrieves all maintenance actions that are pending.

See also: AWS API Documentation

Request Syntax

client.get_pending_maintenance_action(
    resourceArn='string'
)
type resourceArn:

string

param resourceArn:

[REQUIRED]

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

rtype:

dict

returns:

Response Syntax

{
    'resourcePendingMaintenanceAction': {
        'pendingMaintenanceActionDetails': [
            {
                'action': 'string',
                'autoAppliedAfterDate': 'string',
                'currentApplyDate': 'string',
                'description': 'string',
                'forcedApplyDate': 'string',
                'optInStatus': 'string'
            },
        ],
        'resourceArn': 'string'
    }
}

Response Structure

  • (dict) --

    • resourcePendingMaintenanceAction (dict) --

      Provides information about a pending maintenance action for a resource.

      • pendingMaintenanceActionDetails (list) --

        Provides information about a pending maintenance action for a resource.

        • (dict) --

          Retrieves the details of maintenance actions that are pending.

          • action (string) --

            Displays the specific action of a pending maintenance action.

          • autoAppliedAfterDate (string) --

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

          • currentApplyDate (string) --

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

          • description (string) --

            Displays a description providing more detail about the maintenance action.

          • forcedApplyDate (string) --

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

          • optInStatus (string) --

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

      • resourceArn (string) --

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

ApplyPendingMaintenanceAction (new) Link ¶

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

See also: AWS API Documentation

Request Syntax

client.apply_pending_maintenance_action(
    applyAction='string',
    applyOn='string',
    optInType='IMMEDIATE'|'NEXT_MAINTENANCE'|'APPLY_ON'|'UNDO_OPT_IN',
    resourceArn='string'
)
type applyAction:

string

param applyAction:

[REQUIRED]

The pending maintenance action to apply to the resource.

Valid actions are:

  • ENGINE_UPDATE

  • ENGINE_UPGRADE

  • SECURITY_UPDATE

  • OS_UPDATE

  • MASTER_USER_PASSWORD_UPDATE

type applyOn:

string

param applyOn:

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

type optInType:

string

param optInType:

[REQUIRED]

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.

type resourceArn:

string

param resourceArn:

[REQUIRED]

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

rtype:

dict

returns:

Response Syntax

{
    'resourcePendingMaintenanceAction': {
        'pendingMaintenanceActionDetails': [
            {
                'action': 'string',
                'autoAppliedAfterDate': 'string',
                'currentApplyDate': 'string',
                'description': 'string',
                'forcedApplyDate': 'string',
                'optInStatus': 'string'
            },
        ],
        'resourceArn': 'string'
    }
}

Response Structure

  • (dict) --

    • resourcePendingMaintenanceAction (dict) --

      The output of the pending maintenance action being applied.

      • pendingMaintenanceActionDetails (list) --

        Provides information about a pending maintenance action for a resource.

        • (dict) --

          Retrieves the details of maintenance actions that are pending.

          • action (string) --

            Displays the specific action of a pending maintenance action.

          • autoAppliedAfterDate (string) --

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

          • currentApplyDate (string) --

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

          • description (string) --

            Displays a description providing more detail about the maintenance action.

          • forcedApplyDate (string) --

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

          • optInStatus (string) --

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

      • resourceArn (string) --

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

ListPendingMaintenanceActions (new) Link ¶

Retrieves a list of all maintenance actions that are pending.

See also: AWS API Documentation

Request Syntax

client.list_pending_maintenance_actions(
    maxResults=123,
    nextToken='string'
)
type maxResults:

integer

param maxResults:

The maximum number of results to include in the response. 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.

type nextToken:

string

param nextToken:

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.

rtype:

dict

returns:

Response Syntax

{
    'nextToken': 'string',
    'resourcePendingMaintenanceActions': [
        {
            'pendingMaintenanceActionDetails': [
                {
                    'action': 'string',
                    'autoAppliedAfterDate': 'string',
                    'currentApplyDate': 'string',
                    'description': 'string',
                    'forcedApplyDate': 'string',
                    'optInStatus': 'string'
                },
            ],
            'resourceArn': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • nextToken (string) --

      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.

    • resourcePendingMaintenanceActions (list) --

      Provides information about a pending maintenance action for a resource.

      • (dict) --

        Provides information about a pending maintenance action for a resource.

        • pendingMaintenanceActionDetails (list) --

          Provides information about a pending maintenance action for a resource.

          • (dict) --

            Retrieves the details of maintenance actions that are pending.

            • action (string) --

              Displays the specific action of a pending maintenance action.

            • autoAppliedAfterDate (string) --

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

            • currentApplyDate (string) --

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

            • description (string) --

              Displays a description providing more detail about the maintenance action.

            • forcedApplyDate (string) --

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

            • optInStatus (string) --

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

        • resourceArn (string) --

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

CopyClusterSnapshot (updated) Link ¶
Changes (response) 
{'snapshot': {'status': {'INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE',
                         'MAINTENANCE'}}}

Copies a snapshot of an elastic cluster.

See also: AWS API Documentation

Request Syntax

client.copy_cluster_snapshot(
    copyTags=True|False,
    kmsKeyId='string',
    snapshotArn='string',
    tags={
        'string': 'string'
    },
    targetSnapshotName='string'
)
type copyTags:

boolean

param copyTags:

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

type kmsKeyId:

string

param kmsKeyId:

The Amazon Web Services KMS key ID for an encrypted elastic cluster snapshot. The Amazon Web Services KMS key ID is the Amazon Resource Name (ARN), Amazon Web Services KMS key identifier, or the Amazon Web Services KMS key alias for the Amazon Web Services KMS encryption key.

If you copy an encrypted elastic cluster snapshot from your Amazon Web Services account, you can specify a value for KmsKeyId to encrypt the copy with a new Amazon Web ServicesS KMS encryption key. If you don't specify a value for KmsKeyId, then the copy of the elastic cluster snapshot is encrypted with the same AWS KMS key as the source elastic cluster snapshot.

To copy an encrypted elastic cluster snapshot to another Amazon Web Services region, set KmsKeyId to the Amazon Web Services KMS key ID that you want to use to encrypt the copy of the elastic cluster snapshot in the destination region. Amazon Web Services KMS encryption keys are specific to the Amazon Web Services region that they are created in, and you can't use encryption keys from one Amazon Web Services region in another Amazon Web Services region.

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

type snapshotArn:

string

param snapshotArn:

[REQUIRED]

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

type tags:

dict

param tags:

The tags to be assigned to the elastic cluster snapshot.

  • (string) --

    • (string) --

type targetSnapshotName:

string

param targetSnapshotName:

[REQUIRED]

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

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: elastic-cluster-snapshot-5

rtype:

dict

returns:

Response Syntax

{
    'snapshot': {
        'adminUserName': 'string',
        'clusterArn': 'string',
        'clusterCreationTime': 'string',
        'kmsKeyId': 'string',
        'snapshotArn': 'string',
        'snapshotCreationTime': 'string',
        'snapshotName': 'string',
        'snapshotType': 'MANUAL'|'AUTOMATED',
        'status': 'CREATING'|'ACTIVE'|'DELETING'|'UPDATING'|'VPC_ENDPOINT_LIMIT_EXCEEDED'|'IP_ADDRESS_LIMIT_EXCEEDED'|'INVALID_SECURITY_GROUP_ID'|'INVALID_SUBNET_ID'|'INACCESSIBLE_ENCRYPTION_CREDS'|'INACCESSIBLE_SECRET_ARN'|'INACCESSIBLE_VPC_ENDPOINT'|'INCOMPATIBLE_NETWORK'|'MERGING'|'MODIFYING'|'SPLITTING'|'COPYING'|'STARTING'|'STOPPING'|'STOPPED'|'MAINTENANCE'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE',
        'subnetIds': [
            'string',
        ],
        'vpcSecurityGroupIds': [
            'string',
        ]
    }
}

Response Structure

  • (dict) --

    • snapshot (dict) --

      Returns information about a specific elastic cluster snapshot.

      • adminUserName (string) --

        The name of the elastic cluster administrator.

      • clusterArn (string) --

        The ARN identifier of the elastic cluster.

      • clusterCreationTime (string) --

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

      • kmsKeyId (string) --

        The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key. If an encryption key is not specified here, Amazon DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.

      • snapshotArn (string) --

        The ARN identifier of the elastic cluster snapshot.

      • snapshotCreationTime (string) --

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

      • snapshotName (string) --

        The name of the elastic cluster snapshot.

      • snapshotType (string) --

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

        • automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account.

        • manual - Return all cluster snapshots that you have manually created for your Amazon Web Services account.

      • status (string) --

        The status of the elastic cluster snapshot.

      • subnetIds (list) --

        The Amazon EC2 subnet IDs for the elastic cluster.

        • (string) --

      • vpcSecurityGroupIds (list) --

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

        • (string) --

CreateCluster (updated) Link ¶
Changes (response) 
{'cluster': {'shards': {'status': {'INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE',
                                   'MAINTENANCE'}},
             'status': {'INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE',
                        'MAINTENANCE'}}}

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

See also: AWS API Documentation

Request Syntax

client.create_cluster(
    adminUserName='string',
    adminUserPassword='string',
    authType='PLAIN_TEXT'|'SECRET_ARN',
    backupRetentionPeriod=123,
    clientToken='string',
    clusterName='string',
    kmsKeyId='string',
    preferredBackupWindow='string',
    preferredMaintenanceWindow='string',
    shardCapacity=123,
    shardCount=123,
    shardInstanceCount=123,
    subnetIds=[
        'string',
    ],
    tags={
        'string': 'string'
    },
    vpcSecurityGroupIds=[
        'string',
    ]
)
type adminUserName:

string

param adminUserName:

[REQUIRED]

The name of the Amazon DocumentDB elastic clusters administrator.

Constraints:

  • Must be from 1 to 63 letters or numbers.

  • The first character must be a letter.

  • Cannot be a reserved word.

type adminUserPassword:

string

param adminUserPassword:

[REQUIRED]

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

Constraints:

  • Must contain from 8 to 100 characters.

  • Cannot contain a forward slash (/), double quote ("), or the "at" symbol (@).

type authType:

string

param authType:

[REQUIRED]

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

type backupRetentionPeriod:

integer

param backupRetentionPeriod:

The number of days for which automatic snapshots are retained.

type clientToken:

string

param clientToken:

The client token for the elastic cluster.

This field is autopopulated if not provided.

type clusterName:

string

param clusterName:

[REQUIRED]

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

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster

type kmsKeyId:

string

param kmsKeyId:

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

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

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

type preferredBackupWindow:

string

param preferredBackupWindow:

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

type preferredMaintenanceWindow:

string

param 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.

type shardCapacity:

integer

param shardCapacity:

[REQUIRED]

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

type shardCount:

integer

param shardCount:

[REQUIRED]

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

type shardInstanceCount:

integer

param shardInstanceCount:

The number of replica instances applying to all shards in the elastic cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.

type subnetIds:

list

param subnetIds:

The Amazon EC2 subnet IDs for the new elastic cluster.

  • (string) --

type tags:

dict

param tags:

The tags to be assigned to the new elastic cluster.

  • (string) --

    • (string) --

type vpcSecurityGroupIds:

list

param vpcSecurityGroupIds:

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

  • (string) --

rtype:

dict

returns:

Response Syntax

{
    'cluster': {
        'adminUserName': 'string',
        'authType': 'PLAIN_TEXT'|'SECRET_ARN',
        'backupRetentionPeriod': 123,
        'clusterArn': 'string',
        'clusterEndpoint': 'string',
        'clusterName': 'string',
        'createTime': 'string',
        'kmsKeyId': 'string',
        'preferredBackupWindow': 'string',
        'preferredMaintenanceWindow': 'string',
        'shardCapacity': 123,
        'shardCount': 123,
        'shardInstanceCount': 123,
        'shards': [
            {
                'createTime': 'string',
                'shardId': 'string',
                'status': 'CREATING'|'ACTIVE'|'DELETING'|'UPDATING'|'VPC_ENDPOINT_LIMIT_EXCEEDED'|'IP_ADDRESS_LIMIT_EXCEEDED'|'INVALID_SECURITY_GROUP_ID'|'INVALID_SUBNET_ID'|'INACCESSIBLE_ENCRYPTION_CREDS'|'INACCESSIBLE_SECRET_ARN'|'INACCESSIBLE_VPC_ENDPOINT'|'INCOMPATIBLE_NETWORK'|'MERGING'|'MODIFYING'|'SPLITTING'|'COPYING'|'STARTING'|'STOPPING'|'STOPPED'|'MAINTENANCE'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE'
            },
        ],
        'status': 'CREATING'|'ACTIVE'|'DELETING'|'UPDATING'|'VPC_ENDPOINT_LIMIT_EXCEEDED'|'IP_ADDRESS_LIMIT_EXCEEDED'|'INVALID_SECURITY_GROUP_ID'|'INVALID_SUBNET_ID'|'INACCESSIBLE_ENCRYPTION_CREDS'|'INACCESSIBLE_SECRET_ARN'|'INACCESSIBLE_VPC_ENDPOINT'|'INCOMPATIBLE_NETWORK'|'MERGING'|'MODIFYING'|'SPLITTING'|'COPYING'|'STARTING'|'STOPPING'|'STOPPED'|'MAINTENANCE'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE',
        'subnetIds': [
            'string',
        ],
        'vpcSecurityGroupIds': [
            'string',
        ]
    }
}

Response Structure

  • (dict) --

    • cluster (dict) --

      The new elastic cluster that has been created.

      • adminUserName (string) --

        The name of the elastic cluster administrator.

      • authType (string) --

        The authentication type for the elastic cluster.

      • backupRetentionPeriod (integer) --

        The number of days for which automatic snapshots are retained.

      • clusterArn (string) --

        The ARN identifier of the elastic cluster.

      • clusterEndpoint (string) --

        The URL used to connect to the elastic cluster.

      • clusterName (string) --

        The name of the elastic cluster.

      • createTime (string) --

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

      • kmsKeyId (string) --

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

      • preferredBackupWindow (string) --

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

      • preferredMaintenanceWindow (string) --

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

        Format: ddd:hh24:mi-ddd:hh24:mi

      • shardCapacity (integer) --

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

      • shardCount (integer) --

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

      • shardInstanceCount (integer) --

        The number of replica instances applying to all shards in the cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.

      • shards (list) --

        The total number of shards in the cluster.

        • (dict) --

          The name of the shard.

          • createTime (string) --

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

          • shardId (string) --

            The ID of the shard.

          • status (string) --

            The current status of the shard.

      • status (string) --

        The status of the elastic cluster.

      • subnetIds (list) --

        The Amazon EC2 subnet IDs for the elastic cluster.

        • (string) --

      • vpcSecurityGroupIds (list) --

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

        • (string) --

CreateClusterSnapshot (updated) Link ¶
Changes (response) 
{'snapshot': {'status': {'INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE',
                         'MAINTENANCE'}}}

Creates a snapshot of an elastic cluster.

See also: AWS API Documentation

Request Syntax

client.create_cluster_snapshot(
    clusterArn='string',
    snapshotName='string',
    tags={
        'string': 'string'
    }
)
type clusterArn:

string

param clusterArn:

[REQUIRED]

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

type snapshotName:

string

param snapshotName:

[REQUIRED]

The name of the new elastic cluster snapshot.

type tags:

dict

param tags:

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

  • (string) --

    • (string) --

rtype:

dict

returns:

Response Syntax

{
    'snapshot': {
        'adminUserName': 'string',
        'clusterArn': 'string',
        'clusterCreationTime': 'string',
        'kmsKeyId': 'string',
        'snapshotArn': 'string',
        'snapshotCreationTime': 'string',
        'snapshotName': 'string',
        'snapshotType': 'MANUAL'|'AUTOMATED',
        'status': 'CREATING'|'ACTIVE'|'DELETING'|'UPDATING'|'VPC_ENDPOINT_LIMIT_EXCEEDED'|'IP_ADDRESS_LIMIT_EXCEEDED'|'INVALID_SECURITY_GROUP_ID'|'INVALID_SUBNET_ID'|'INACCESSIBLE_ENCRYPTION_CREDS'|'INACCESSIBLE_SECRET_ARN'|'INACCESSIBLE_VPC_ENDPOINT'|'INCOMPATIBLE_NETWORK'|'MERGING'|'MODIFYING'|'SPLITTING'|'COPYING'|'STARTING'|'STOPPING'|'STOPPED'|'MAINTENANCE'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE',
        'subnetIds': [
            'string',
        ],
        'vpcSecurityGroupIds': [
            'string',
        ]
    }
}

Response Structure

  • (dict) --

    • snapshot (dict) --

      Returns information about the new elastic cluster snapshot.

      • adminUserName (string) --

        The name of the elastic cluster administrator.

      • clusterArn (string) --

        The ARN identifier of the elastic cluster.

      • clusterCreationTime (string) --

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

      • kmsKeyId (string) --

        The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key. If an encryption key is not specified here, Amazon DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.

      • snapshotArn (string) --

        The ARN identifier of the elastic cluster snapshot.

      • snapshotCreationTime (string) --

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

      • snapshotName (string) --

        The name of the elastic cluster snapshot.

      • snapshotType (string) --

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

        • automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account.

        • manual - Return all cluster snapshots that you have manually created for your Amazon Web Services account.

      • status (string) --

        The status of the elastic cluster snapshot.

      • subnetIds (list) --

        The Amazon EC2 subnet IDs for the elastic cluster.

        • (string) --

      • vpcSecurityGroupIds (list) --

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

        • (string) --

DeleteCluster (updated) Link ¶
Changes (response) 
{'cluster': {'shards': {'status': {'INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE',
                                   'MAINTENANCE'}},
             'status': {'INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE',
                        'MAINTENANCE'}}}

Delete an elastic cluster.

See also: AWS API Documentation

Request Syntax

client.delete_cluster(
    clusterArn='string'
)
type clusterArn:

string

param clusterArn:

[REQUIRED]

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

rtype:

dict

returns:

Response Syntax

{
    'cluster': {
        'adminUserName': 'string',
        'authType': 'PLAIN_TEXT'|'SECRET_ARN',
        'backupRetentionPeriod': 123,
        'clusterArn': 'string',
        'clusterEndpoint': 'string',
        'clusterName': 'string',
        'createTime': 'string',
        'kmsKeyId': 'string',
        'preferredBackupWindow': 'string',
        'preferredMaintenanceWindow': 'string',
        'shardCapacity': 123,
        'shardCount': 123,
        'shardInstanceCount': 123,
        'shards': [
            {
                'createTime': 'string',
                'shardId': 'string',
                'status': 'CREATING'|'ACTIVE'|'DELETING'|'UPDATING'|'VPC_ENDPOINT_LIMIT_EXCEEDED'|'IP_ADDRESS_LIMIT_EXCEEDED'|'INVALID_SECURITY_GROUP_ID'|'INVALID_SUBNET_ID'|'INACCESSIBLE_ENCRYPTION_CREDS'|'INACCESSIBLE_SECRET_ARN'|'INACCESSIBLE_VPC_ENDPOINT'|'INCOMPATIBLE_NETWORK'|'MERGING'|'MODIFYING'|'SPLITTING'|'COPYING'|'STARTING'|'STOPPING'|'STOPPED'|'MAINTENANCE'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE'
            },
        ],
        'status': 'CREATING'|'ACTIVE'|'DELETING'|'UPDATING'|'VPC_ENDPOINT_LIMIT_EXCEEDED'|'IP_ADDRESS_LIMIT_EXCEEDED'|'INVALID_SECURITY_GROUP_ID'|'INVALID_SUBNET_ID'|'INACCESSIBLE_ENCRYPTION_CREDS'|'INACCESSIBLE_SECRET_ARN'|'INACCESSIBLE_VPC_ENDPOINT'|'INCOMPATIBLE_NETWORK'|'MERGING'|'MODIFYING'|'SPLITTING'|'COPYING'|'STARTING'|'STOPPING'|'STOPPED'|'MAINTENANCE'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE',
        'subnetIds': [
            'string',
        ],
        'vpcSecurityGroupIds': [
            'string',
        ]
    }
}

Response Structure

  • (dict) --

    • cluster (dict) --

      Returns information about the newly deleted elastic cluster.

      • adminUserName (string) --

        The name of the elastic cluster administrator.

      • authType (string) --

        The authentication type for the elastic cluster.

      • backupRetentionPeriod (integer) --

        The number of days for which automatic snapshots are retained.

      • clusterArn (string) --

        The ARN identifier of the elastic cluster.

      • clusterEndpoint (string) --

        The URL used to connect to the elastic cluster.

      • clusterName (string) --

        The name of the elastic cluster.

      • createTime (string) --

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

      • kmsKeyId (string) --

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

      • preferredBackupWindow (string) --

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

      • preferredMaintenanceWindow (string) --

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

        Format: ddd:hh24:mi-ddd:hh24:mi

      • shardCapacity (integer) --

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

      • shardCount (integer) --

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

      • shardInstanceCount (integer) --

        The number of replica instances applying to all shards in the cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.

      • shards (list) --

        The total number of shards in the cluster.

        • (dict) --

          The name of the shard.

          • createTime (string) --

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

          • shardId (string) --

            The ID of the shard.

          • status (string) --

            The current status of the shard.

      • status (string) --

        The status of the elastic cluster.

      • subnetIds (list) --

        The Amazon EC2 subnet IDs for the elastic cluster.

        • (string) --

      • vpcSecurityGroupIds (list) --

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

        • (string) --

DeleteClusterSnapshot (updated) Link ¶
Changes (response) 
{'snapshot': {'status': {'INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE',
                         'MAINTENANCE'}}}

Delete an elastic cluster snapshot.

See also: AWS API Documentation

Request Syntax

client.delete_cluster_snapshot(
    snapshotArn='string'
)
type snapshotArn:

string

param snapshotArn:

[REQUIRED]

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

rtype:

dict

returns:

Response Syntax

{
    'snapshot': {
        'adminUserName': 'string',
        'clusterArn': 'string',
        'clusterCreationTime': 'string',
        'kmsKeyId': 'string',
        'snapshotArn': 'string',
        'snapshotCreationTime': 'string',
        'snapshotName': 'string',
        'snapshotType': 'MANUAL'|'AUTOMATED',
        'status': 'CREATING'|'ACTIVE'|'DELETING'|'UPDATING'|'VPC_ENDPOINT_LIMIT_EXCEEDED'|'IP_ADDRESS_LIMIT_EXCEEDED'|'INVALID_SECURITY_GROUP_ID'|'INVALID_SUBNET_ID'|'INACCESSIBLE_ENCRYPTION_CREDS'|'INACCESSIBLE_SECRET_ARN'|'INACCESSIBLE_VPC_ENDPOINT'|'INCOMPATIBLE_NETWORK'|'MERGING'|'MODIFYING'|'SPLITTING'|'COPYING'|'STARTING'|'STOPPING'|'STOPPED'|'MAINTENANCE'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE',
        'subnetIds': [
            'string',
        ],
        'vpcSecurityGroupIds': [
            'string',
        ]
    }
}

Response Structure

  • (dict) --

    • snapshot (dict) --

      Returns information about the newly deleted elastic cluster snapshot.

      • adminUserName (string) --

        The name of the elastic cluster administrator.

      • clusterArn (string) --

        The ARN identifier of the elastic cluster.

      • clusterCreationTime (string) --

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

      • kmsKeyId (string) --

        The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key. If an encryption key is not specified here, Amazon DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.

      • snapshotArn (string) --

        The ARN identifier of the elastic cluster snapshot.

      • snapshotCreationTime (string) --

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

      • snapshotName (string) --

        The name of the elastic cluster snapshot.

      • snapshotType (string) --

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

        • automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account.

        • manual - Return all cluster snapshots that you have manually created for your Amazon Web Services account.

      • status (string) --

        The status of the elastic cluster snapshot.

      • subnetIds (list) --

        The Amazon EC2 subnet IDs for the elastic cluster.

        • (string) --

      • vpcSecurityGroupIds (list) --

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

        • (string) --

GetCluster (updated) Link ¶
Changes (response) 
{'cluster': {'shards': {'status': {'INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE',
                                   'MAINTENANCE'}},
             'status': {'INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE',
                        'MAINTENANCE'}}}

Returns information about a specific elastic cluster.

See also: AWS API Documentation

Request Syntax

client.get_cluster(
    clusterArn='string'
)
type clusterArn:

string

param clusterArn:

[REQUIRED]

The ARN identifier of the elastic cluster.

rtype:

dict

returns:

Response Syntax

{
    'cluster': {
        'adminUserName': 'string',
        'authType': 'PLAIN_TEXT'|'SECRET_ARN',
        'backupRetentionPeriod': 123,
        'clusterArn': 'string',
        'clusterEndpoint': 'string',
        'clusterName': 'string',
        'createTime': 'string',
        'kmsKeyId': 'string',
        'preferredBackupWindow': 'string',
        'preferredMaintenanceWindow': 'string',
        'shardCapacity': 123,
        'shardCount': 123,
        'shardInstanceCount': 123,
        'shards': [
            {
                'createTime': 'string',
                'shardId': 'string',
                'status': 'CREATING'|'ACTIVE'|'DELETING'|'UPDATING'|'VPC_ENDPOINT_LIMIT_EXCEEDED'|'IP_ADDRESS_LIMIT_EXCEEDED'|'INVALID_SECURITY_GROUP_ID'|'INVALID_SUBNET_ID'|'INACCESSIBLE_ENCRYPTION_CREDS'|'INACCESSIBLE_SECRET_ARN'|'INACCESSIBLE_VPC_ENDPOINT'|'INCOMPATIBLE_NETWORK'|'MERGING'|'MODIFYING'|'SPLITTING'|'COPYING'|'STARTING'|'STOPPING'|'STOPPED'|'MAINTENANCE'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE'
            },
        ],
        'status': 'CREATING'|'ACTIVE'|'DELETING'|'UPDATING'|'VPC_ENDPOINT_LIMIT_EXCEEDED'|'IP_ADDRESS_LIMIT_EXCEEDED'|'INVALID_SECURITY_GROUP_ID'|'INVALID_SUBNET_ID'|'INACCESSIBLE_ENCRYPTION_CREDS'|'INACCESSIBLE_SECRET_ARN'|'INACCESSIBLE_VPC_ENDPOINT'|'INCOMPATIBLE_NETWORK'|'MERGING'|'MODIFYING'|'SPLITTING'|'COPYING'|'STARTING'|'STOPPING'|'STOPPED'|'MAINTENANCE'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE',
        'subnetIds': [
            'string',
        ],
        'vpcSecurityGroupIds': [
            'string',
        ]
    }
}

Response Structure

  • (dict) --

    • cluster (dict) --

      Returns information about a specific elastic cluster.

      • adminUserName (string) --

        The name of the elastic cluster administrator.

      • authType (string) --

        The authentication type for the elastic cluster.

      • backupRetentionPeriod (integer) --

        The number of days for which automatic snapshots are retained.

      • clusterArn (string) --

        The ARN identifier of the elastic cluster.

      • clusterEndpoint (string) --

        The URL used to connect to the elastic cluster.

      • clusterName (string) --

        The name of the elastic cluster.

      • createTime (string) --

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

      • kmsKeyId (string) --

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

      • preferredBackupWindow (string) --

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

      • preferredMaintenanceWindow (string) --

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

        Format: ddd:hh24:mi-ddd:hh24:mi

      • shardCapacity (integer) --

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

      • shardCount (integer) --

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

      • shardInstanceCount (integer) --

        The number of replica instances applying to all shards in the cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.

      • shards (list) --

        The total number of shards in the cluster.

        • (dict) --

          The name of the shard.

          • createTime (string) --

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

          • shardId (string) --

            The ID of the shard.

          • status (string) --

            The current status of the shard.

      • status (string) --

        The status of the elastic cluster.

      • subnetIds (list) --

        The Amazon EC2 subnet IDs for the elastic cluster.

        • (string) --

      • vpcSecurityGroupIds (list) --

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

        • (string) --

GetClusterSnapshot (updated) Link ¶
Changes (response) 
{'snapshot': {'status': {'INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE',
                         'MAINTENANCE'}}}

Returns information about a specific elastic cluster snapshot

See also: AWS API Documentation

Request Syntax

client.get_cluster_snapshot(
    snapshotArn='string'
)
type snapshotArn:

string

param snapshotArn:

[REQUIRED]

The ARN identifier of the elastic cluster snapshot.

rtype:

dict

returns:

Response Syntax

{
    'snapshot': {
        'adminUserName': 'string',
        'clusterArn': 'string',
        'clusterCreationTime': 'string',
        'kmsKeyId': 'string',
        'snapshotArn': 'string',
        'snapshotCreationTime': 'string',
        'snapshotName': 'string',
        'snapshotType': 'MANUAL'|'AUTOMATED',
        'status': 'CREATING'|'ACTIVE'|'DELETING'|'UPDATING'|'VPC_ENDPOINT_LIMIT_EXCEEDED'|'IP_ADDRESS_LIMIT_EXCEEDED'|'INVALID_SECURITY_GROUP_ID'|'INVALID_SUBNET_ID'|'INACCESSIBLE_ENCRYPTION_CREDS'|'INACCESSIBLE_SECRET_ARN'|'INACCESSIBLE_VPC_ENDPOINT'|'INCOMPATIBLE_NETWORK'|'MERGING'|'MODIFYING'|'SPLITTING'|'COPYING'|'STARTING'|'STOPPING'|'STOPPED'|'MAINTENANCE'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE',
        'subnetIds': [
            'string',
        ],
        'vpcSecurityGroupIds': [
            'string',
        ]
    }
}

Response Structure

  • (dict) --

    • snapshot (dict) --

      Returns information about a specific elastic cluster snapshot.

      • adminUserName (string) --

        The name of the elastic cluster administrator.

      • clusterArn (string) --

        The ARN identifier of the elastic cluster.

      • clusterCreationTime (string) --

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

      • kmsKeyId (string) --

        The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key. If an encryption key is not specified here, Amazon DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.

      • snapshotArn (string) --

        The ARN identifier of the elastic cluster snapshot.

      • snapshotCreationTime (string) --

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

      • snapshotName (string) --

        The name of the elastic cluster snapshot.

      • snapshotType (string) --

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

        • automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account.

        • manual - Return all cluster snapshots that you have manually created for your Amazon Web Services account.

      • status (string) --

        The status of the elastic cluster snapshot.

      • subnetIds (list) --

        The Amazon EC2 subnet IDs for the elastic cluster.

        • (string) --

      • vpcSecurityGroupIds (list) --

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

        • (string) --

ListClusterSnapshots (updated) Link ¶
Changes (response) 
{'snapshots': {'status': {'INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE',
                          'MAINTENANCE'}}}

Returns information about snapshots for a specified elastic cluster.

See also: AWS API Documentation

Request Syntax

client.list_cluster_snapshots(
    clusterArn='string',
    maxResults=123,
    nextToken='string',
    snapshotType='string'
)
type clusterArn:

string

param clusterArn:

The ARN identifier of the elastic cluster.

type maxResults:

integer

param maxResults:

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

type nextToken:

string

param nextToken:

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

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

type snapshotType:

string

param snapshotType:

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

  • automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account.

  • manual - Return all cluster snapshots that you have manually created for your Amazon Web Services account.

rtype:

dict

returns:

Response Syntax

{
    'nextToken': 'string',
    'snapshots': [
        {
            'clusterArn': 'string',
            'snapshotArn': 'string',
            'snapshotCreationTime': 'string',
            'snapshotName': 'string',
            'status': 'CREATING'|'ACTIVE'|'DELETING'|'UPDATING'|'VPC_ENDPOINT_LIMIT_EXCEEDED'|'IP_ADDRESS_LIMIT_EXCEEDED'|'INVALID_SECURITY_GROUP_ID'|'INVALID_SUBNET_ID'|'INACCESSIBLE_ENCRYPTION_CREDS'|'INACCESSIBLE_SECRET_ARN'|'INACCESSIBLE_VPC_ENDPOINT'|'INCOMPATIBLE_NETWORK'|'MERGING'|'MODIFYING'|'SPLITTING'|'COPYING'|'STARTING'|'STOPPING'|'STOPPED'|'MAINTENANCE'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE'
        },
    ]
}

Response Structure

  • (dict) --

    • nextToken (string) --

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

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

    • snapshots (list) --

      A list of snapshots for a specified elastic cluster.

      • (dict) --

        A list of elastic cluster snapshots.

        • clusterArn (string) --

          The ARN identifier of the elastic cluster.

        • snapshotArn (string) --

          The ARN identifier of the elastic cluster snapshot.

        • snapshotCreationTime (string) --

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

        • snapshotName (string) --

          The name of the elastic cluster snapshot.

        • status (string) --

          The status of the elastic cluster snapshot.

ListClusters (updated) Link ¶
Changes (response) 
{'clusters': {'status': {'INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE',
                         'MAINTENANCE'}}}

Returns information about provisioned Amazon DocumentDB elastic clusters.

See also: AWS API Documentation

Request Syntax

client.list_clusters(
    maxResults=123,
    nextToken='string'
)
type maxResults:

integer

param maxResults:

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

type nextToken:

string

param nextToken:

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

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

rtype:

dict

returns:

Response Syntax

{
    'clusters': [
        {
            'clusterArn': 'string',
            'clusterName': 'string',
            'status': 'CREATING'|'ACTIVE'|'DELETING'|'UPDATING'|'VPC_ENDPOINT_LIMIT_EXCEEDED'|'IP_ADDRESS_LIMIT_EXCEEDED'|'INVALID_SECURITY_GROUP_ID'|'INVALID_SUBNET_ID'|'INACCESSIBLE_ENCRYPTION_CREDS'|'INACCESSIBLE_SECRET_ARN'|'INACCESSIBLE_VPC_ENDPOINT'|'INCOMPATIBLE_NETWORK'|'MERGING'|'MODIFYING'|'SPLITTING'|'COPYING'|'STARTING'|'STOPPING'|'STOPPED'|'MAINTENANCE'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) --

    • clusters (list) --

      A list of Amazon DocumentDB elastic clusters.

      • (dict) --

        A list of Amazon DocumentDB elastic clusters.

        • clusterArn (string) --

          The ARN identifier of the elastic cluster.

        • clusterName (string) --

          The name of the elastic cluster.

        • status (string) --

          The status of the elastic cluster.

    • nextToken (string) --

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

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

RestoreClusterFromSnapshot (updated) Link ¶
Changes (response) 
{'cluster': {'shards': {'status': {'INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE',
                                   'MAINTENANCE'}},
             'status': {'INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE',
                        'MAINTENANCE'}}}

Restores an elastic cluster from a snapshot.

See also: AWS API Documentation

Request Syntax

client.restore_cluster_from_snapshot(
    clusterName='string',
    kmsKeyId='string',
    shardCapacity=123,
    shardInstanceCount=123,
    snapshotArn='string',
    subnetIds=[
        'string',
    ],
    tags={
        'string': 'string'
    },
    vpcSecurityGroupIds=[
        'string',
    ]
)
type clusterName:

string

param clusterName:

[REQUIRED]

The name of the elastic cluster.

type kmsKeyId:

string

param kmsKeyId:

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

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

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

type shardCapacity:

integer

param shardCapacity:

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

type shardInstanceCount:

integer

param shardInstanceCount:

The number of replica instances applying to all shards in the elastic cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.

type snapshotArn:

string

param snapshotArn:

[REQUIRED]

The ARN identifier of the elastic cluster snapshot.

type subnetIds:

list

param subnetIds:

The Amazon EC2 subnet IDs for the elastic cluster.

  • (string) --

type tags:

dict

param tags:

A list of the tag names to be assigned to the restored elastic cluster, in the form of an array of key-value pairs in which the key is the tag name and the value is the key value.

  • (string) --

    • (string) --

type vpcSecurityGroupIds:

list

param vpcSecurityGroupIds:

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

  • (string) --

rtype:

dict

returns:

Response Syntax

{
    'cluster': {
        'adminUserName': 'string',
        'authType': 'PLAIN_TEXT'|'SECRET_ARN',
        'backupRetentionPeriod': 123,
        'clusterArn': 'string',
        'clusterEndpoint': 'string',
        'clusterName': 'string',
        'createTime': 'string',
        'kmsKeyId': 'string',
        'preferredBackupWindow': 'string',
        'preferredMaintenanceWindow': 'string',
        'shardCapacity': 123,
        'shardCount': 123,
        'shardInstanceCount': 123,
        'shards': [
            {
                'createTime': 'string',
                'shardId': 'string',
                'status': 'CREATING'|'ACTIVE'|'DELETING'|'UPDATING'|'VPC_ENDPOINT_LIMIT_EXCEEDED'|'IP_ADDRESS_LIMIT_EXCEEDED'|'INVALID_SECURITY_GROUP_ID'|'INVALID_SUBNET_ID'|'INACCESSIBLE_ENCRYPTION_CREDS'|'INACCESSIBLE_SECRET_ARN'|'INACCESSIBLE_VPC_ENDPOINT'|'INCOMPATIBLE_NETWORK'|'MERGING'|'MODIFYING'|'SPLITTING'|'COPYING'|'STARTING'|'STOPPING'|'STOPPED'|'MAINTENANCE'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE'
            },
        ],
        'status': 'CREATING'|'ACTIVE'|'DELETING'|'UPDATING'|'VPC_ENDPOINT_LIMIT_EXCEEDED'|'IP_ADDRESS_LIMIT_EXCEEDED'|'INVALID_SECURITY_GROUP_ID'|'INVALID_SUBNET_ID'|'INACCESSIBLE_ENCRYPTION_CREDS'|'INACCESSIBLE_SECRET_ARN'|'INACCESSIBLE_VPC_ENDPOINT'|'INCOMPATIBLE_NETWORK'|'MERGING'|'MODIFYING'|'SPLITTING'|'COPYING'|'STARTING'|'STOPPING'|'STOPPED'|'MAINTENANCE'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE',
        'subnetIds': [
            'string',
        ],
        'vpcSecurityGroupIds': [
            'string',
        ]
    }
}

Response Structure

  • (dict) --

    • cluster (dict) --

      Returns information about a the restored elastic cluster.

      • adminUserName (string) --

        The name of the elastic cluster administrator.

      • authType (string) --

        The authentication type for the elastic cluster.

      • backupRetentionPeriod (integer) --

        The number of days for which automatic snapshots are retained.

      • clusterArn (string) --

        The ARN identifier of the elastic cluster.

      • clusterEndpoint (string) --

        The URL used to connect to the elastic cluster.

      • clusterName (string) --

        The name of the elastic cluster.

      • createTime (string) --

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

      • kmsKeyId (string) --

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

      • preferredBackupWindow (string) --

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

      • preferredMaintenanceWindow (string) --

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

        Format: ddd:hh24:mi-ddd:hh24:mi

      • shardCapacity (integer) --

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

      • shardCount (integer) --

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

      • shardInstanceCount (integer) --

        The number of replica instances applying to all shards in the cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.

      • shards (list) --

        The total number of shards in the cluster.

        • (dict) --

          The name of the shard.

          • createTime (string) --

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

          • shardId (string) --

            The ID of the shard.

          • status (string) --

            The current status of the shard.

      • status (string) --

        The status of the elastic cluster.

      • subnetIds (list) --

        The Amazon EC2 subnet IDs for the elastic cluster.

        • (string) --

      • vpcSecurityGroupIds (list) --

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

        • (string) --

StartCluster (updated) Link ¶
Changes (response) 
{'cluster': {'shards': {'status': {'INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE',
                                   'MAINTENANCE'}},
             'status': {'INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE',
                        'MAINTENANCE'}}}

Restarts the stopped elastic cluster that is specified by clusterARN.

See also: AWS API Documentation

Request Syntax

client.start_cluster(
    clusterArn='string'
)
type clusterArn:

string

param clusterArn:

[REQUIRED]

The ARN identifier of the elastic cluster.

rtype:

dict

returns:

Response Syntax

{
    'cluster': {
        'adminUserName': 'string',
        'authType': 'PLAIN_TEXT'|'SECRET_ARN',
        'backupRetentionPeriod': 123,
        'clusterArn': 'string',
        'clusterEndpoint': 'string',
        'clusterName': 'string',
        'createTime': 'string',
        'kmsKeyId': 'string',
        'preferredBackupWindow': 'string',
        'preferredMaintenanceWindow': 'string',
        'shardCapacity': 123,
        'shardCount': 123,
        'shardInstanceCount': 123,
        'shards': [
            {
                'createTime': 'string',
                'shardId': 'string',
                'status': 'CREATING'|'ACTIVE'|'DELETING'|'UPDATING'|'VPC_ENDPOINT_LIMIT_EXCEEDED'|'IP_ADDRESS_LIMIT_EXCEEDED'|'INVALID_SECURITY_GROUP_ID'|'INVALID_SUBNET_ID'|'INACCESSIBLE_ENCRYPTION_CREDS'|'INACCESSIBLE_SECRET_ARN'|'INACCESSIBLE_VPC_ENDPOINT'|'INCOMPATIBLE_NETWORK'|'MERGING'|'MODIFYING'|'SPLITTING'|'COPYING'|'STARTING'|'STOPPING'|'STOPPED'|'MAINTENANCE'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE'
            },
        ],
        'status': 'CREATING'|'ACTIVE'|'DELETING'|'UPDATING'|'VPC_ENDPOINT_LIMIT_EXCEEDED'|'IP_ADDRESS_LIMIT_EXCEEDED'|'INVALID_SECURITY_GROUP_ID'|'INVALID_SUBNET_ID'|'INACCESSIBLE_ENCRYPTION_CREDS'|'INACCESSIBLE_SECRET_ARN'|'INACCESSIBLE_VPC_ENDPOINT'|'INCOMPATIBLE_NETWORK'|'MERGING'|'MODIFYING'|'SPLITTING'|'COPYING'|'STARTING'|'STOPPING'|'STOPPED'|'MAINTENANCE'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE',
        'subnetIds': [
            'string',
        ],
        'vpcSecurityGroupIds': [
            'string',
        ]
    }
}

Response Structure

  • (dict) --

    • cluster (dict) --

      Returns information about a specific elastic cluster.

      • adminUserName (string) --

        The name of the elastic cluster administrator.

      • authType (string) --

        The authentication type for the elastic cluster.

      • backupRetentionPeriod (integer) --

        The number of days for which automatic snapshots are retained.

      • clusterArn (string) --

        The ARN identifier of the elastic cluster.

      • clusterEndpoint (string) --

        The URL used to connect to the elastic cluster.

      • clusterName (string) --

        The name of the elastic cluster.

      • createTime (string) --

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

      • kmsKeyId (string) --

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

      • preferredBackupWindow (string) --

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

      • preferredMaintenanceWindow (string) --

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

        Format: ddd:hh24:mi-ddd:hh24:mi

      • shardCapacity (integer) --

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

      • shardCount (integer) --

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

      • shardInstanceCount (integer) --

        The number of replica instances applying to all shards in the cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.

      • shards (list) --

        The total number of shards in the cluster.

        • (dict) --

          The name of the shard.

          • createTime (string) --

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

          • shardId (string) --

            The ID of the shard.

          • status (string) --

            The current status of the shard.

      • status (string) --

        The status of the elastic cluster.

      • subnetIds (list) --

        The Amazon EC2 subnet IDs for the elastic cluster.

        • (string) --

      • vpcSecurityGroupIds (list) --

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

        • (string) --

StopCluster (updated) Link ¶
Changes (response) 
{'cluster': {'shards': {'status': {'INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE',
                                   'MAINTENANCE'}},
             'status': {'INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE',
                        'MAINTENANCE'}}}

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

See also: AWS API Documentation

Request Syntax

client.stop_cluster(
    clusterArn='string'
)
type clusterArn:

string

param clusterArn:

[REQUIRED]

The ARN identifier of the elastic cluster.

rtype:

dict

returns:

Response Syntax

{
    'cluster': {
        'adminUserName': 'string',
        'authType': 'PLAIN_TEXT'|'SECRET_ARN',
        'backupRetentionPeriod': 123,
        'clusterArn': 'string',
        'clusterEndpoint': 'string',
        'clusterName': 'string',
        'createTime': 'string',
        'kmsKeyId': 'string',
        'preferredBackupWindow': 'string',
        'preferredMaintenanceWindow': 'string',
        'shardCapacity': 123,
        'shardCount': 123,
        'shardInstanceCount': 123,
        'shards': [
            {
                'createTime': 'string',
                'shardId': 'string',
                'status': 'CREATING'|'ACTIVE'|'DELETING'|'UPDATING'|'VPC_ENDPOINT_LIMIT_EXCEEDED'|'IP_ADDRESS_LIMIT_EXCEEDED'|'INVALID_SECURITY_GROUP_ID'|'INVALID_SUBNET_ID'|'INACCESSIBLE_ENCRYPTION_CREDS'|'INACCESSIBLE_SECRET_ARN'|'INACCESSIBLE_VPC_ENDPOINT'|'INCOMPATIBLE_NETWORK'|'MERGING'|'MODIFYING'|'SPLITTING'|'COPYING'|'STARTING'|'STOPPING'|'STOPPED'|'MAINTENANCE'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE'
            },
        ],
        'status': 'CREATING'|'ACTIVE'|'DELETING'|'UPDATING'|'VPC_ENDPOINT_LIMIT_EXCEEDED'|'IP_ADDRESS_LIMIT_EXCEEDED'|'INVALID_SECURITY_GROUP_ID'|'INVALID_SUBNET_ID'|'INACCESSIBLE_ENCRYPTION_CREDS'|'INACCESSIBLE_SECRET_ARN'|'INACCESSIBLE_VPC_ENDPOINT'|'INCOMPATIBLE_NETWORK'|'MERGING'|'MODIFYING'|'SPLITTING'|'COPYING'|'STARTING'|'STOPPING'|'STOPPED'|'MAINTENANCE'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE',
        'subnetIds': [
            'string',
        ],
        'vpcSecurityGroupIds': [
            'string',
        ]
    }
}

Response Structure

  • (dict) --

    • cluster (dict) --

      Returns information about a specific elastic cluster.

      • adminUserName (string) --

        The name of the elastic cluster administrator.

      • authType (string) --

        The authentication type for the elastic cluster.

      • backupRetentionPeriod (integer) --

        The number of days for which automatic snapshots are retained.

      • clusterArn (string) --

        The ARN identifier of the elastic cluster.

      • clusterEndpoint (string) --

        The URL used to connect to the elastic cluster.

      • clusterName (string) --

        The name of the elastic cluster.

      • createTime (string) --

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

      • kmsKeyId (string) --

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

      • preferredBackupWindow (string) --

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

      • preferredMaintenanceWindow (string) --

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

        Format: ddd:hh24:mi-ddd:hh24:mi

      • shardCapacity (integer) --

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

      • shardCount (integer) --

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

      • shardInstanceCount (integer) --

        The number of replica instances applying to all shards in the cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.

      • shards (list) --

        The total number of shards in the cluster.

        • (dict) --

          The name of the shard.

          • createTime (string) --

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

          • shardId (string) --

            The ID of the shard.

          • status (string) --

            The current status of the shard.

      • status (string) --

        The status of the elastic cluster.

      • subnetIds (list) --

        The Amazon EC2 subnet IDs for the elastic cluster.

        • (string) --

      • vpcSecurityGroupIds (list) --

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

        • (string) --

UpdateCluster (updated) Link ¶
Changes (response) 
{'cluster': {'shards': {'status': {'INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE',
                                   'MAINTENANCE'}},
             'status': {'INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE',
                        'MAINTENANCE'}}}

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

See also: AWS API Documentation

Request Syntax

client.update_cluster(
    adminUserPassword='string',
    authType='PLAIN_TEXT'|'SECRET_ARN',
    backupRetentionPeriod=123,
    clientToken='string',
    clusterArn='string',
    preferredBackupWindow='string',
    preferredMaintenanceWindow='string',
    shardCapacity=123,
    shardCount=123,
    shardInstanceCount=123,
    subnetIds=[
        'string',
    ],
    vpcSecurityGroupIds=[
        'string',
    ]
)
type adminUserPassword:

string

param adminUserPassword:

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

Constraints: Must contain from 8 to 100 characters.

type authType:

string

param authType:

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

type backupRetentionPeriod:

integer

param backupRetentionPeriod:

The number of days for which automatic snapshots are retained.

type clientToken:

string

param clientToken:

The client token for the elastic cluster.

This field is autopopulated if not provided.

type clusterArn:

string

param clusterArn:

[REQUIRED]

The ARN identifier of the elastic cluster.

type preferredBackupWindow:

string

param preferredBackupWindow:

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

type preferredMaintenanceWindow:

string

param 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.

type shardCapacity:

integer

param shardCapacity:

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

type shardCount:

integer

param shardCount:

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

type shardInstanceCount:

integer

param shardInstanceCount:

The number of replica instances applying to all shards in the elastic cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.

type subnetIds:

list

param subnetIds:

The Amazon EC2 subnet IDs for the elastic cluster.

  • (string) --

type vpcSecurityGroupIds:

list

param vpcSecurityGroupIds:

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

  • (string) --

rtype:

dict

returns:

Response Syntax

{
    'cluster': {
        'adminUserName': 'string',
        'authType': 'PLAIN_TEXT'|'SECRET_ARN',
        'backupRetentionPeriod': 123,
        'clusterArn': 'string',
        'clusterEndpoint': 'string',
        'clusterName': 'string',
        'createTime': 'string',
        'kmsKeyId': 'string',
        'preferredBackupWindow': 'string',
        'preferredMaintenanceWindow': 'string',
        'shardCapacity': 123,
        'shardCount': 123,
        'shardInstanceCount': 123,
        'shards': [
            {
                'createTime': 'string',
                'shardId': 'string',
                'status': 'CREATING'|'ACTIVE'|'DELETING'|'UPDATING'|'VPC_ENDPOINT_LIMIT_EXCEEDED'|'IP_ADDRESS_LIMIT_EXCEEDED'|'INVALID_SECURITY_GROUP_ID'|'INVALID_SUBNET_ID'|'INACCESSIBLE_ENCRYPTION_CREDS'|'INACCESSIBLE_SECRET_ARN'|'INACCESSIBLE_VPC_ENDPOINT'|'INCOMPATIBLE_NETWORK'|'MERGING'|'MODIFYING'|'SPLITTING'|'COPYING'|'STARTING'|'STOPPING'|'STOPPED'|'MAINTENANCE'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE'
            },
        ],
        'status': 'CREATING'|'ACTIVE'|'DELETING'|'UPDATING'|'VPC_ENDPOINT_LIMIT_EXCEEDED'|'IP_ADDRESS_LIMIT_EXCEEDED'|'INVALID_SECURITY_GROUP_ID'|'INVALID_SUBNET_ID'|'INACCESSIBLE_ENCRYPTION_CREDS'|'INACCESSIBLE_SECRET_ARN'|'INACCESSIBLE_VPC_ENDPOINT'|'INCOMPATIBLE_NETWORK'|'MERGING'|'MODIFYING'|'SPLITTING'|'COPYING'|'STARTING'|'STOPPING'|'STOPPED'|'MAINTENANCE'|'INACCESSIBLE_ENCRYPTION_CREDENTIALS_RECOVERABLE',
        'subnetIds': [
            'string',
        ],
        'vpcSecurityGroupIds': [
            'string',
        ]
    }
}

Response Structure

  • (dict) --

    • cluster (dict) --

      Returns information about the updated elastic cluster.

      • adminUserName (string) --

        The name of the elastic cluster administrator.

      • authType (string) --

        The authentication type for the elastic cluster.

      • backupRetentionPeriod (integer) --

        The number of days for which automatic snapshots are retained.

      • clusterArn (string) --

        The ARN identifier of the elastic cluster.

      • clusterEndpoint (string) --

        The URL used to connect to the elastic cluster.

      • clusterName (string) --

        The name of the elastic cluster.

      • createTime (string) --

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

      • kmsKeyId (string) --

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

      • preferredBackupWindow (string) --

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

      • preferredMaintenanceWindow (string) --

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

        Format: ddd:hh24:mi-ddd:hh24:mi

      • shardCapacity (integer) --

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

      • shardCount (integer) --

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

      • shardInstanceCount (integer) --

        The number of replica instances applying to all shards in the cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.

      • shards (list) --

        The total number of shards in the cluster.

        • (dict) --

          The name of the shard.

          • createTime (string) --

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

          • shardId (string) --

            The ID of the shard.

          • status (string) --

            The current status of the shard.

      • status (string) --

        The status of the elastic cluster.

      • subnetIds (list) --

        The Amazon EC2 subnet IDs for the elastic cluster.

        • (string) --

      • vpcSecurityGroupIds (list) --

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

        • (string) --