DocDB / Client / create_db_cluster

create_db_cluster

DocDB.Client.create_db_cluster(**kwargs)

Creates a new Amazon DocumentDB cluster.

See also: AWS API Documentation

Request Syntax

response = client.create_db_cluster(
    AvailabilityZones=[
        'string',
    ],
    BackupRetentionPeriod=123,
    DBClusterIdentifier='string',
    DBClusterParameterGroupName='string',
    VpcSecurityGroupIds=[
        'string',
    ],
    DBSubnetGroupName='string',
    Engine='string',
    EngineVersion='string',
    Port=123,
    MasterUsername='string',
    MasterUserPassword='string',
    PreferredBackupWindow='string',
    PreferredMaintenanceWindow='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    StorageEncrypted=True|False,
    KmsKeyId='string',
    EnableCloudwatchLogsExports=[
        'string',
    ],
    DeletionProtection=True|False,
    GlobalClusterIdentifier='string',
    StorageType='string',
    ManageMasterUserPassword=True|False,
    MasterUserSecretKmsKeyId='string',
    SourceRegion='string'
)

Parameters:

• AvailabilityZones (list) –

  A list of Amazon EC2 Availability Zones that instances in the cluster can be created in.

  • (string) –

• BackupRetentionPeriod (integer) –

  The number of days for which automated backups are retained. You must specify a minimum value of 1.

  Default: 1

  Constraints:

  • Must be a value from 1 to 35.

• DBClusterIdentifier (string) –

  [REQUIRED]

  The cluster identifier. 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

• DBClusterParameterGroupName (string) – The name of the cluster parameter group to associate with this cluster.

• VpcSecurityGroupIds (list) –

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

  • (string) –

• DBSubnetGroupName (string) –

  A subnet group to associate with this cluster.

  Constraints: Must match the name of an existing DBSubnetGroup. Must not be default.

  Example: mySubnetgroup

• Engine (string) –

  [REQUIRED]

  The name of the database engine to be used for this cluster.

  Valid values: docdb

• EngineVersion (string) – The version number of the database engine to use. The --engine-version will default to the latest major engine version. For production workloads, we recommend explicitly declaring this parameter with the intended major engine version.

• Port (integer) – The port number on which the instances in the cluster accept connections.

• MasterUsername (string) –

  The name of the master user for the cluster.

  Constraints:

  • Must be from 1 to 63 letters or numbers.

  • The first character must be a letter.

  • Cannot be a reserved word for the chosen database engine.

• MasterUserPassword (string) –

  The password for the master database user. 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.

• PreferredBackupWindow (string) –

  The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.

  The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region.

  Constraints:

  • Must be in the format hh24:mi-hh24:mi.

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

• PreferredMaintenanceWindow (string) –

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

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

  The default is 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.

• Tags (list) –

  The tags to be assigned to the cluster.

  • (dict) –

    Metadata assigned to an Amazon DocumentDB resource consisting of a key-value pair.

    • Key (string) –

      The required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can’t be prefixed with “ aws:” or “ rds:”. The string can contain only the set of Unicode letters, digits, white space, ‘_’, ‘.’, ‘/’, ‘=’, ‘+’, ‘-’ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$”).

    • Value (string) –

      The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can’t be prefixed with “ aws:” or “ rds:”. The string can contain only the set of Unicode letters, digits, white space, ‘_’, ‘.’, ‘/’, ‘=’, ‘+’, ‘-’ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$”).

• StorageEncrypted (boolean) – Specifies whether the cluster is encrypted.

• KmsKeyId (string) –

  The KMS key identifier for an encrypted 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 Web Services account that owns the KMS encryption key that is used to encrypt the new cluster, you can use the KMS key alias instead of the ARN for the KMS encryption key.

  If an encryption key is not specified in KmsKeyId:

  • If the StorageEncrypted parameter is true, Amazon DocumentDB uses your default encryption key.

  KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Regions.

• PreSignedUrl (string) –

  Not currently supported.

  Please note that this parameter is automatically populated if it is not provided. Including this parameter is not required

• EnableCloudwatchLogsExports (list) –

  A list of log types that need to be enabled for exporting to Amazon CloudWatch Logs. You can enable audit logs or profiler logs. For more information, see Auditing Amazon DocumentDB Events and Profiling Amazon DocumentDB Operations.

  • (string) –

• DeletionProtection (boolean) – Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

• GlobalClusterIdentifier (string) – The cluster identifier of the new global cluster.

• StorageType (string) –

  The storage type to associate with the DB cluster.

  For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.

  Valid values for storage type - standard | iopt1

  Default value is standard

  Note

  When you create a DocumentDB DB cluster with the storage type set to iopt1, the storage type is returned in the response. The storage type isn’t returned when you set it to standard.

• ManageMasterUserPassword (boolean) –

  Specifies whether to manage the master user password with Amazon Web Services Secrets Manager.

  Constraint: You can’t manage the master user password with Amazon Web Services Secrets Manager if MasterUserPassword is specified.

• MasterUserSecretKmsKeyId (string) –

  The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager. This setting is valid only if the master user password is managed by Amazon DocumentDB in Amazon Web Services Secrets Manager for the DB cluster.

  The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.

  If you don’t specify MasterUserSecretKmsKeyId, then the aws/secretsmanager KMS key is used to encrypt the secret. If the secret is in a different Amazon Web Services account, then you can’t use the aws/secretsmanager KMS key to encrypt the secret, and you must use a customer managed KMS key.

  There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.

• SourceRegion (string) – The ID of the region that contains the source for the db cluster.

Return type:

dict

Returns:

Response Syntax

{
    'DBCluster': {
        'AvailabilityZones': [
            'string',
        ],
        'BackupRetentionPeriod': 123,
        'DBClusterIdentifier': 'string',
        'DBClusterParameterGroup': 'string',
        'DBSubnetGroup': 'string',
        'Status': 'string',
        'PercentProgress': 'string',
        'EarliestRestorableTime': datetime(2015, 1, 1),
        'Endpoint': 'string',
        'ReaderEndpoint': 'string',
        'MultiAZ': True|False,
        'Engine': 'string',
        'EngineVersion': 'string',
        'LatestRestorableTime': datetime(2015, 1, 1),
        'Port': 123,
        'MasterUsername': 'string',
        'PreferredBackupWindow': 'string',
        'PreferredMaintenanceWindow': 'string',
        'ReplicationSourceIdentifier': 'string',
        'ReadReplicaIdentifiers': [
            'string',
        ],
        'DBClusterMembers': [
            {
                'DBInstanceIdentifier': 'string',
                'IsClusterWriter': True|False,
                'DBClusterParameterGroupStatus': 'string',
                'PromotionTier': 123
            },
        ],
        'VpcSecurityGroups': [
            {
                'VpcSecurityGroupId': 'string',
                'Status': 'string'
            },
        ],
        'HostedZoneId': 'string',
        'StorageEncrypted': True|False,
        'KmsKeyId': 'string',
        'DbClusterResourceId': 'string',
        'DBClusterArn': 'string',
        'AssociatedRoles': [
            {
                'RoleArn': 'string',
                'Status': 'string'
            },
        ],
        'CloneGroupId': 'string',
        'ClusterCreateTime': datetime(2015, 1, 1),
        'EnabledCloudwatchLogsExports': [
            'string',
        ],
        'DeletionProtection': True|False,
        'StorageType': 'string',
        'MasterUserSecret': {
            'SecretArn': 'string',
            'SecretStatus': 'string',
            'KmsKeyId': 'string'
        }
    }
}

Response Structure

• (dict) –

  • DBCluster (dict) –

    Detailed information about a cluster.

    • AvailabilityZones (list) –

      Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.

      • (string) –

    • BackupRetentionPeriod (integer) –

      Specifies the number of days for which automatic snapshots are retained.

    • DBClusterIdentifier (string) –

      Contains a user-supplied cluster identifier. This identifier is the unique key that identifies a cluster.

    • DBClusterParameterGroup (string) –

      Specifies the name of the cluster parameter group for the cluster.

    • DBSubnetGroup (string) –

      Specifies information on the subnet group that is associated with the cluster, including the name, description, and subnets in the subnet group.

    • Status (string) –

      Specifies the current state of this cluster.

    • PercentProgress (string) –

      Specifies the progress of the operation as a percentage.

    • EarliestRestorableTime (datetime) –

      The earliest time to which a database can be restored with point-in-time restore.

    • Endpoint (string) –

      Specifies the connection endpoint for the primary instance of the cluster.

    • ReaderEndpoint (string) –

      The reader endpoint for the cluster. The reader endpoint for a cluster load balances connections across the Amazon DocumentDB replicas that are available in a cluster. As clients request new connections to the reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB replicas in the cluster. This functionality can help balance your read workload across multiple Amazon DocumentDB replicas in your cluster.

      If a failover occurs, and the Amazon DocumentDB replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.

    • MultiAZ (boolean) –

      Specifies whether the cluster has instances in multiple Availability Zones.

    • Engine (string) –

      Provides the name of the database engine to be used for this cluster.

    • EngineVersion (string) –

      Indicates the database engine version.

    • LatestRestorableTime (datetime) –

      Specifies the latest time to which a database can be restored with point-in-time restore.

    • Port (integer) –

      Specifies the port that the database engine is listening on.

    • MasterUsername (string) –

      Contains the master user name for the cluster.

    • PreferredBackupWindow (string) –

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

    • PreferredMaintenanceWindow (string) –

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

    • ReplicationSourceIdentifier (string) –

      Contains the identifier of the source cluster if this cluster is a secondary cluster.

    • ReadReplicaIdentifiers (list) –

      Contains one or more identifiers of the secondary clusters that are associated with this cluster.

      • (string) –

    • DBClusterMembers (list) –

      Provides the list of instances that make up the cluster.

      • (dict) –

        Contains information about an instance that is part of a cluster.

        • DBInstanceIdentifier (string) –

          Specifies the instance identifier for this member of the cluster.

        • IsClusterWriter (boolean) –

          A value that is true if the cluster member is the primary instance for the cluster and false otherwise.

        • DBClusterParameterGroupStatus (string) –

          Specifies the status of the cluster parameter group for this member of the DB cluster.

        • PromotionTier (integer) –

          A value that specifies the order in which an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

    • VpcSecurityGroups (list) –

      Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.

      • (dict) –

        Used as a response element for queries on virtual private cloud (VPC) security group membership.

        • VpcSecurityGroupId (string) –

          The name of the VPC security group.

        • Status (string) –

          The status of the VPC security group.

    • HostedZoneId (string) –

      Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

    • StorageEncrypted (boolean) –

      Specifies whether the cluster is encrypted.

    • KmsKeyId (string) –

      If StorageEncrypted is true, the KMS key identifier for the encrypted cluster.

    • DbClusterResourceId (string) –

      The Amazon Web Services Region-unique, immutable identifier for the cluster. This identifier is found in CloudTrail log entries whenever the KMS key for the cluster is accessed.

    • DBClusterArn (string) –

      The Amazon Resource Name (ARN) for the cluster.

    • AssociatedRoles (list) –

      Provides a list of the Identity and Access Management (IAM) roles that are associated with the cluster. (IAM) roles that are associated with a cluster grant permission for the cluster to access other Amazon Web Services services on your behalf.

      • (dict) –

        Describes an Identity and Access Management (IAM) role that is associated with a cluster.

        • RoleArn (string) –

          The Amazon Resource Name (ARN) of the IAMrole that is associated with the DB cluster.

        • Status (string) –

          Describes the state of association between the IAMrole and the cluster. The Status property returns one of the following values:

          • ACTIVE - The IAMrole ARN is associated with the cluster and can be used to access other Amazon Web Services services on your behalf.

          • PENDING - The IAMrole ARN is being associated with the cluster.

          • INVALID - The IAMrole ARN is associated with the cluster, but the cluster cannot assume the IAMrole to access other Amazon Web Services services on your behalf.

    • CloneGroupId (string) –

      Identifies the clone group to which the DB cluster is associated.

    • ClusterCreateTime (datetime) –

      Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).

    • EnabledCloudwatchLogsExports (list) –

      A list of log types that this cluster is configured to export to Amazon CloudWatch Logs.

      • (string) –

    • DeletionProtection (boolean) –

      Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

    • StorageType (string) –

      Storage type associated with your cluster

      Storage type associated with your cluster

      For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.

      Valid values for storage type - standard | iopt1

      Default value is standard

    • MasterUserSecret (dict) –

      The secret managed by Amazon DocumentDB in Amazon Web Services Secrets Manager for the master user password.

      • SecretArn (string) –

        The Amazon Resource Name (ARN) of the secret.

      • SecretStatus (string) –

        The status of the secret.

        The possible status values include the following:

        • creating - The secret is being created.

        • active - The secret is available for normal use and rotation.

        • rotating - The secret is being rotated.

        • impaired - The secret can be used to access database credentials, but it can’t be rotated. A secret might have this status if, for example, permissions are changed so that Amazon DocumentDB can no longer access either the secret or the KMS key for the secret. When a secret has this status, you can correct the condition that caused the status. Alternatively, modify the instance to turn off automatic management of database credentials, and then modify the instance again to turn on automatic management of database credentials.

      • KmsKeyId (string) –

        The Amazon Web Services KMS key identifier that is used to encrypt the secret.

Exceptions

• DocDB.Client.exceptions.DBClusterAlreadyExistsFault

• DocDB.Client.exceptions.InsufficientStorageClusterCapacityFault

• DocDB.Client.exceptions.DBClusterQuotaExceededFault

• DocDB.Client.exceptions.StorageQuotaExceededFault

• DocDB.Client.exceptions.DBSubnetGroupNotFoundFault

• DocDB.Client.exceptions.InvalidVPCNetworkStateFault

• DocDB.Client.exceptions.InvalidDBClusterStateFault

• DocDB.Client.exceptions.InvalidDBSubnetGroupStateFault

• DocDB.Client.exceptions.InvalidSubnet

• DocDB.Client.exceptions.InvalidDBInstanceStateFault

• DocDB.Client.exceptions.DBClusterParameterGroupNotFoundFault

• DocDB.Client.exceptions.KMSKeyNotAccessibleFault

• DocDB.Client.exceptions.DBClusterNotFoundFault

• DocDB.Client.exceptions.DBInstanceNotFoundFault

• DocDB.Client.exceptions.DBSubnetGroupDoesNotCoverEnoughAZs

• DocDB.Client.exceptions.GlobalClusterNotFoundFault

• DocDB.Client.exceptions.InvalidGlobalClusterStateFault