update_cluster

update_cluster(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.update_cluster(
    adminUserPassword='string',
    authType='PLAIN_TEXT'|'SECRET_ARN',
    clientToken='string',
    clusterArn='string',
    preferredMaintenanceWindow='string',
    shardCapacity=123,
    shardCount=123,
    subnetIds=[
        'string',
    ],
    vpcSecurityGroupIds=[
        'string',
    ]
)
Parameters
  • adminUserPassword (string) --

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

    Constraints : Must contain from 8 to 100 characters.
  • authType (string) -- The authentication type for the Elastic DocumentDB cluster.
  • clientToken (string) --

    The client token for the Elastic DocumentDB cluster.

    This field is autopopulated if not provided.

  • clusterArn (string) --

    [REQUIRED]

    The arn of the Elastic DocumentDB cluster.

  • preferredMaintenanceWindow (string) --

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

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

    Default : a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.

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

    Constraints : Minimum 30-minute window.

  • shardCapacity (integer) -- The capacity of each shard in the Elastic DocumentDB cluster.
  • shardCount (integer) -- The number of shards to create in the Elastic DocumentDB cluster.
  • subnetIds (list) --

    The number of shards to create in the Elastic DocumentDB cluster.

    • (string) --
  • vpcSecurityGroupIds (list) --

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

    • (string) --
Return type

dict

Returns

Response Syntax

{
    'cluster': {
        'adminUserName': 'string',
        'authType': 'PLAIN_TEXT'|'SECRET_ARN',
        'clusterArn': 'string',
        'clusterEndpoint': 'string',
        'clusterName': 'string',
        'createTime': 'string',
        'kmsKeyId': 'string',
        'preferredMaintenanceWindow': 'string',
        'shardCapacity': 123,
        'shardCount': 123,
        'status': 'CREATING'|'ACTIVE'|'DELETING'|'UPDATING'|'VPC_ENDPOINT_LIMIT_EXCEEDED'|'IP_ADDRESS_LIMIT_EXCEEDED'|'INVALID_SECURITY_GROUP_ID'|'INVALID_SUBNET_ID'|'INACCESSIBLE_ENCRYPTION_CREDS',
        'subnetIds': [
            'string',
        ],
        'vpcSecurityGroupIds': [
            'string',
        ]
    }
}

Response Structure

  • (dict) --

    • cluster (dict) --

      Returns information about the updated Elastic DocumentDB cluster.

      • adminUserName (string) --

        The name of the Elastic DocumentDB cluster administrator.

      • authType (string) --

        The authentication type for the Elastic DocumentDB cluster.

      • clusterArn (string) --

        The arn of the Elastic DocumentDB cluster.

      • clusterEndpoint (string) --

        The URL used to connect to the Elastic DocumentDB cluster.

      • clusterName (string) --

        The name of the Elastic DocumentDB cluster.

      • createTime (string) --

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

      • kmsKeyId (string) --

        The KMS key identifier to use to encrypt the Elastic DocumentDB cluster.

      • 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 capacity of each shard in the Elastic DocumentDB cluster.

      • shardCount (integer) --

        The number of shards in the Elastic DocumentDB cluster.

      • status (string) --

        The status of the Elastic DocumentDB cluster.

      • subnetIds (list) --

        The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.

        • (string) --
      • vpcSecurityGroupIds (list) --

        A list of EC2 VPC security groups associated with this cluster.

        • (string) --

Exceptions

  • DocDBElastic.Client.exceptions.ThrottlingException
  • DocDBElastic.Client.exceptions.ValidationException
  • DocDBElastic.Client.exceptions.ConflictException
  • DocDBElastic.Client.exceptions.InternalServerException
  • DocDBElastic.Client.exceptions.ResourceNotFoundException
  • DocDBElastic.Client.exceptions.AccessDeniedException