Amazon Neptune

{'DBClusterSnapshot': {'StorageType': 'string'}}

Copies a snapshot of a DB cluster.

To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.

See also: AWS API Documentation

Request Syntax

client.copy_db_cluster_snapshot(
    SourceDBClusterSnapshotIdentifier='string',
    TargetDBClusterSnapshotIdentifier='string',
    KmsKeyId='string',
    PreSignedUrl='string',
    CopyTags=True|False,
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

type SourceDBClusterSnapshotIdentifier:

string

param SourceDBClusterSnapshotIdentifier:

[REQUIRED]

The identifier of the DB cluster snapshot to copy. This parameter is not case-sensitive.

Constraints:

• Must specify a valid system snapshot in the "available" state.

• Specify a valid DB snapshot identifier.

Example: my-cluster-snapshot1

type TargetDBClusterSnapshotIdentifier:

string

param TargetDBClusterSnapshotIdentifier:

[REQUIRED]

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

Constraints:

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

• First character must be a letter.

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

Example: my-cluster-snapshot2

type KmsKeyId:

string

param KmsKeyId:

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

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

If you copy an encrypted DB cluster snapshot that is shared from another Amazon account, then you must specify a value for KmsKeyId.

KMS encryption keys are specific to the Amazon Region that they are created in, and you can't use encryption keys from one Amazon Region in another Amazon Region.

You cannot encrypt an unencrypted DB cluster snapshot when you copy it. If you try to copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.

type PreSignedUrl:

string

param PreSignedUrl:

Not currently supported.

type CopyTags:

boolean

param CopyTags:

True to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot, and otherwise false. The default is false.

type Tags:

list

param Tags:

The tags to assign to the new DB cluster snapshot copy.

• (dict) --

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

  • Key (string) --

    A key is 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 only contain the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").

  • Value (string) --

    A value is 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 only contain the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").

rtype:

dict

returns:

Response Syntax

{
    'DBClusterSnapshot': {
        'AvailabilityZones': [
            'string',
        ],
        'DBClusterSnapshotIdentifier': 'string',
        'DBClusterIdentifier': 'string',
        'SnapshotCreateTime': datetime(2015, 1, 1),
        'Engine': 'string',
        'AllocatedStorage': 123,
        'Status': 'string',
        'Port': 123,
        'VpcId': 'string',
        'ClusterCreateTime': datetime(2015, 1, 1),
        'MasterUsername': 'string',
        'EngineVersion': 'string',
        'LicenseModel': 'string',
        'SnapshotType': 'string',
        'PercentProgress': 123,
        'StorageEncrypted': True|False,
        'KmsKeyId': 'string',
        'DBClusterSnapshotArn': 'string',
        'SourceDBClusterSnapshotArn': 'string',
        'IAMDatabaseAuthenticationEnabled': True|False,
        'StorageType': 'string'
    }
}

Response Structure

• (dict) --

  • DBClusterSnapshot (dict) --

    Contains the details for an Amazon Neptune DB cluster snapshot

    This data type is used as a response element in the DescribeDBClusterSnapshots action.

    • AvailabilityZones (list) --

      Provides the list of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.

      • (string) --

    • DBClusterSnapshotIdentifier (string) --

      Specifies the identifier for a DB cluster snapshot. Must match the identifier of an existing snapshot.

      After you restore a DB cluster using a DBClusterSnapshotIdentifier, you must specify the same DBClusterSnapshotIdentifier for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed.

      However, if you don't specify the DBClusterSnapshotIdentifier, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the snapshot specified by the DBClusterSnapshotIdentifier, and the original DB cluster is deleted.

    • DBClusterIdentifier (string) --

      Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.

    • SnapshotCreateTime (datetime) --

      Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).

    • Engine (string) --

      Specifies the name of the database engine.

    • AllocatedStorage (integer) --

      Specifies the allocated storage size in gibibytes (GiB).

    • Status (string) --

      Specifies the status of this DB cluster snapshot.

    • Port (integer) --

      Specifies the port that the DB cluster was listening on at the time of the snapshot.

    • VpcId (string) --

      Provides the VPC ID associated with the DB cluster snapshot.

    • ClusterCreateTime (datetime) --

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

    • MasterUsername (string) --

      Not supported by Neptune.

    • EngineVersion (string) --

      Provides the version of the database engine for this DB cluster snapshot.

    • LicenseModel (string) --

      Provides the license model information for this DB cluster snapshot.

    • SnapshotType (string) --

      Provides the type of the DB cluster snapshot.

    • PercentProgress (integer) --

      Specifies the percentage of the estimated data that has been transferred.

    • StorageEncrypted (boolean) --

      Specifies whether the DB cluster snapshot is encrypted.

    • KmsKeyId (string) --

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

    • DBClusterSnapshotArn (string) --

      The Amazon Resource Name (ARN) for the DB cluster snapshot.

    • SourceDBClusterSnapshotArn (string) --

      If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.

    • IAMDatabaseAuthenticationEnabled (boolean) --

      True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

    • StorageType (string) --

      The storage type associated with the DB cluster snapshot.

{'StorageType': 'string'}

{'DBCluster': {'IOOptimizedNextAllowedModificationTime': 'timestamp',
               'PendingModifiedValues': {'StorageType': 'string'},
               'StorageType': 'string'}}

Creates a new Amazon Neptune DB cluster.

You can use the ReplicationSourceIdentifier parameter to create the DB cluster as a Read Replica of another DB cluster or Amazon Neptune DB instance.

Note that when you create a new cluster using CreateDBCluster directly, deletion protection is disabled by default (when you create a new production cluster in the console, deletion protection is enabled by default). You can only delete a DB cluster if its DeletionProtection field is set to false.

See also: AWS API Documentation

Request Syntax

client.create_db_cluster(
    AvailabilityZones=[
        'string',
    ],
    BackupRetentionPeriod=123,
    CharacterSetName='string',
    CopyTagsToSnapshot=True|False,
    DatabaseName='string',
    DBClusterIdentifier='string',
    DBClusterParameterGroupName='string',
    VpcSecurityGroupIds=[
        'string',
    ],
    DBSubnetGroupName='string',
    Engine='string',
    EngineVersion='string',
    Port=123,
    MasterUsername='string',
    MasterUserPassword='string',
    OptionGroupName='string',
    PreferredBackupWindow='string',
    PreferredMaintenanceWindow='string',
    ReplicationSourceIdentifier='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    StorageEncrypted=True|False,
    KmsKeyId='string',
    PreSignedUrl='string',
    EnableIAMDatabaseAuthentication=True|False,
    EnableCloudwatchLogsExports=[
        'string',
    ],
    DeletionProtection=True|False,
    ServerlessV2ScalingConfiguration={
        'MinCapacity': 123.0,
        'MaxCapacity': 123.0
    },
    GlobalClusterIdentifier='string',
    StorageType='string'
)

type AvailabilityZones:

list

param AvailabilityZones:

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

• (string) --

type BackupRetentionPeriod:

integer

param BackupRetentionPeriod:

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

type CharacterSetName:

string

param CharacterSetName:

(Not supported by Neptune)

type CopyTagsToSnapshot:

boolean

param CopyTagsToSnapshot:

If set to true, tags are copied to any snapshot of the DB cluster that is created.

type DatabaseName:

string

param DatabaseName:

The name for your database of up to 64 alpha-numeric characters. If you do not provide a name, Amazon Neptune will not create a database in the DB cluster you are creating.

type DBClusterIdentifier:

string

param DBClusterIdentifier:

[REQUIRED]

The DB cluster identifier. This parameter is stored as a lowercase string.

Constraints:

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

• First character must be a letter.

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

Example: my-cluster1

type DBClusterParameterGroupName:

string

param DBClusterParameterGroupName:

The name of the DB cluster parameter group to associate with this DB cluster. If this argument is omitted, the default is used.

Constraints:

• If supplied, must match the name of an existing DBClusterParameterGroup.

type VpcSecurityGroupIds:

list

param VpcSecurityGroupIds:

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

• (string) --

type DBSubnetGroupName:

string

param DBSubnetGroupName:

A DB subnet group to associate with this DB cluster.

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

Example: mySubnetgroup

type Engine:

string

param Engine:

[REQUIRED]

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

Valid Values: neptune

type EngineVersion:

string

param EngineVersion:

The version number of the database engine to use for the new DB cluster.

Example: 1.0.2.1

type Port:

integer

param Port:

The port number on which the instances in the DB cluster accept connections.

Default: 8182

type MasterUsername:

string

param MasterUsername:

Not supported by Neptune.

type MasterUserPassword:

string

param MasterUserPassword:

Not supported by Neptune.

type OptionGroupName:

string

param OptionGroupName:

(Not supported by Neptune)

type PreferredBackupWindow:

string

param PreferredBackupWindow:

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 Region. To see the time blocks available, see Neptune Maintenance Window in the Amazon Neptune User Guide.

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.

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

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Region, occurring on a random day of the week. To see the time blocks available, see Neptune Maintenance Window in the Amazon Neptune User Guide.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

Constraints: Minimum 30-minute window.

type ReplicationSourceIdentifier:

string

param ReplicationSourceIdentifier:

The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica.

type Tags:

list

param Tags:

The tags to assign to the new DB cluster.

• (dict) --

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

  • Key (string) --

    A key is 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 only contain the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").

  • Value (string) --

    A value is 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 only contain the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").

type StorageEncrypted:

boolean

param StorageEncrypted:

Specifies whether the DB cluster is encrypted.

type KmsKeyId:

string

param KmsKeyId:

The Amazon KMS key identifier for an encrypted DB cluster.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB cluster with the same Amazon account that owns the KMS encryption key used to encrypt the new DB cluster, then 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 ReplicationSourceIdentifier identifies an encrypted source, then Amazon Neptune will use the encryption key used to encrypt the source. Otherwise, Amazon Neptune will use your default encryption key.

• If the StorageEncrypted parameter is true and ReplicationSourceIdentifier is not specified, then Amazon Neptune will use your default encryption key.

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

If you create a Read Replica of an encrypted DB cluster in another Amazon Region, you must set KmsKeyId to a KMS key ID that is valid in the destination Amazon Region. This key is used to encrypt the Read Replica in that Amazon Region.

type PreSignedUrl:

string

param PreSignedUrl:

This parameter is not currently supported.

type EnableIAMDatabaseAuthentication:

boolean

param EnableIAMDatabaseAuthentication:

If set to true, enables Amazon Identity and Access Management (IAM) authentication for the entire DB cluster (this cannot be set at an instance level).

Default: false.

type EnableCloudwatchLogsExports:

list

param EnableCloudwatchLogsExports:

A list of the log types that this DB cluster should export to CloudWatch Logs. Valid log types are: audit (to publish audit logs) and slowquery (to publish slow-query logs). See Publishing Neptune logs to Amazon CloudWatch logs.

• (string) --

type DeletionProtection:

boolean

param DeletionProtection:

A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is enabled.

type ServerlessV2ScalingConfiguration:

dict

param ServerlessV2ScalingConfiguration:

Contains the scaling configuration of a Neptune Serverless DB cluster.

For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.

• MinCapacity (float) --

  The minimum number of Neptune capacity units (NCUs) for a DB instance in a Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 8, 8.5, 9, and so on.

• MaxCapacity (float) --

  The maximum number of Neptune capacity units (NCUs) for a DB instance in a Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 40, 40.5, 41, and so on.

type GlobalClusterIdentifier:

string

param GlobalClusterIdentifier:

The ID of the Neptune global database to which this new DB cluster should be added.

type StorageType:

string

param StorageType:

The storage type to associate with the DB cluster.

Valid Values:

• standard | iopt1

Default:

• standard

rtype:

dict

returns:

Response Syntax

{
    'DBCluster': {
        'AllocatedStorage': 123,
        'AvailabilityZones': [
            'string',
        ],
        'BackupRetentionPeriod': 123,
        'CharacterSetName': 'string',
        'DatabaseName': 'string',
        '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',
        'DBClusterOptionGroupMemberships': [
            {
                'DBClusterOptionGroupName': 'string',
                'Status': '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',
                'FeatureName': 'string'
            },
        ],
        'IAMDatabaseAuthenticationEnabled': True|False,
        'CloneGroupId': 'string',
        'ClusterCreateTime': datetime(2015, 1, 1),
        'CopyTagsToSnapshot': True|False,
        'EnabledCloudwatchLogsExports': [
            'string',
        ],
        'PendingModifiedValues': {
            'PendingCloudwatchLogsExports': {
                'LogTypesToEnable': [
                    'string',
                ],
                'LogTypesToDisable': [
                    'string',
                ]
            },
            'DBClusterIdentifier': 'string',
            'IAMDatabaseAuthenticationEnabled': True|False,
            'EngineVersion': 'string',
            'BackupRetentionPeriod': 123,
            'StorageType': 'string',
            'AllocatedStorage': 123,
            'Iops': 123
        },
        'DeletionProtection': True|False,
        'CrossAccountClone': True|False,
        'AutomaticRestartTime': datetime(2015, 1, 1),
        'ServerlessV2ScalingConfiguration': {
            'MinCapacity': 123.0,
            'MaxCapacity': 123.0
        },
        'GlobalClusterIdentifier': 'string',
        'IOOptimizedNextAllowedModificationTime': datetime(2015, 1, 1),
        'StorageType': 'string'
    }
}

Response Structure

• (dict) --

  • DBCluster (dict) --

    Contains the details of an Amazon Neptune DB cluster.

    This data type is used as a response element in the DescribeDBClusters.

    • AllocatedStorage (integer) --

      AllocatedStorage always returns 1, because Neptune DB cluster storage size is not fixed, but instead automatically adjusts as needed.

    • AvailabilityZones (list) --

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

      • (string) --

    • BackupRetentionPeriod (integer) --

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

    • CharacterSetName (string) --

      Not supported by Neptune.

    • DatabaseName (string) --

      Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.

    • DBClusterIdentifier (string) --

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

    • DBClusterParameterGroup (string) --

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

    • DBSubnetGroup (string) --

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

    • Status (string) --

      Specifies the current state of this DB cluster.

    • PercentProgress (string) --

      Specifies the progress of the operation as a percentage.

    • EarliestRestorableTime (datetime) --

      Specifies 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 DB cluster.

    • ReaderEndpoint (string) --

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

      If a failover occurs, and the Read 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 Read Replicas in the cluster, you can then reconnect to the reader endpoint.

    • MultiAZ (boolean) --

      Specifies whether the DB cluster has instances in multiple Availability Zones.

    • Engine (string) --

      Provides the name of the database engine to be used for this DB 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) --

      Not supported by Neptune.

    • DBClusterOptionGroupMemberships (list) --

      Not supported by Neptune.

      • (dict) --

        Not supported by Neptune.

        • DBClusterOptionGroupName (string) --

          Not supported by Neptune.

        • Status (string) --

          Not supported by Neptune.

    • 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) --

      Not supported by Neptune.

    • ReadReplicaIdentifiers (list) --

      Contains one or more identifiers of the Read Replicas associated with this DB cluster.

      • (string) --

    • DBClusterMembers (list) --

      Provides the list of instances that make up the DB cluster.

      • (dict) --

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

        • DBInstanceIdentifier (string) --

          Specifies the instance identifier for this member of the DB cluster.

        • IsClusterWriter (boolean) --

          Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.

        • DBClusterParameterGroupStatus (string) --

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

        • PromotionTier (integer) --

          A value that specifies the order in which a Read Replica is promoted to the primary instance after a failure of the existing primary instance.

    • VpcSecurityGroups (list) --

      Provides a list of VPC security groups that the DB cluster belongs to.

      • (dict) --

        This data type is used as a response element for queries on 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 DB cluster is encrypted.

    • KmsKeyId (string) --

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

    • DbClusterResourceId (string) --

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

    • DBClusterArn (string) --

      The Amazon Resource Name (ARN) for the DB cluster.

    • AssociatedRoles (list) --

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

      • (dict) --

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

        • RoleArn (string) --

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

        • Status (string) --

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

          • ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to access other Amazon services on your behalf.

          • PENDING - the IAM role ARN is being associated with the DB cluster.

          • INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other Amazon services on your behalf.

        • FeatureName (string) --

          The name of the feature associated with the Amazon Identity and Access Management (IAM) role. For the list of supported feature names, see DescribeDBEngineVersions.

    • IAMDatabaseAuthenticationEnabled (boolean) --

      True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

    • CloneGroupId (string) --

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

    • ClusterCreateTime (datetime) --

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

    • CopyTagsToSnapshot (boolean) --

      If set to true, tags are copied to any snapshot of the DB cluster that is created.

    • EnabledCloudwatchLogsExports (list) --

      A list of the log types that this DB cluster is configured to export to CloudWatch Logs. Valid log types are: audit (to publish audit logs to CloudWatch) and slowquery (to publish slow-query logs to CloudWatch). See Publishing Neptune logs to Amazon CloudWatch logs.

      • (string) --

    • PendingModifiedValues (dict) --

      This data type is used as a response element in the ModifyDBCluster operation and contains changes that will be applied during the next maintenance window.

      • PendingCloudwatchLogsExports (dict) --

        This PendingCloudwatchLogsExports structure specifies pending changes to which CloudWatch logs are enabled and which are disabled.

        • LogTypesToEnable (list) --

          Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.

          • (string) --

        • LogTypesToDisable (list) --

          Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.

          • (string) --

      • DBClusterIdentifier (string) --

        The DBClusterIdentifier value for the DB cluster.

      • IAMDatabaseAuthenticationEnabled (boolean) --

        A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

      • EngineVersion (string) --

        The database engine version.

      • BackupRetentionPeriod (integer) --

        The number of days for which automatic DB snapshots are retained.

      • StorageType (string) --

        The storage type for the DB cluster.

      • AllocatedStorage (integer) --

        The allocated storage size in gibibytes (GiB) for database engines. For Neptune, AllocatedStorage always returns 1, because Neptune DB cluster storage size isn't fixed, but instead automatically adjusts as needed.

      • Iops (integer) --

        The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters.

    • DeletionProtection (boolean) --

      Indicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.

    • CrossAccountClone (boolean) --

      If set to true, the DB cluster can be cloned across accounts.

    • AutomaticRestartTime (datetime) --

      Time at which the DB cluster will be automatically restarted.

    • ServerlessV2ScalingConfiguration (dict) --

      Shows the scaling configuration for a Neptune Serverless DB cluster.

      For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.

      • MinCapacity (float) --

        The minimum number of Neptune capacity units (NCUs) for a DB instance in a Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 8, 8.5, 9, and so on.

      • MaxCapacity (float) --

        The maximum number of Neptune capacity units (NCUs) for a DB instance in a Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 40, 40.5, 41, and so on.

    • GlobalClusterIdentifier (string) --

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

    • IOOptimizedNextAllowedModificationTime (datetime) --

      The next time you can modify the DB cluster to use the iopt1 storage type.

    • StorageType (string) --

      The storage type associated with the DB cluster.

{'DBClusterSnapshot': {'StorageType': 'string'}}

Creates a snapshot of a DB cluster.

See also: AWS API Documentation

Request Syntax

client.create_db_cluster_snapshot(
    DBClusterSnapshotIdentifier='string',
    DBClusterIdentifier='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

type DBClusterSnapshotIdentifier:

string

param DBClusterSnapshotIdentifier:

[REQUIRED]

The identifier of the DB cluster snapshot. This parameter is stored as a lowercase string.

Constraints:

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

• First character must be a letter.

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

Example: my-cluster1-snapshot1

type DBClusterIdentifier:

string

param DBClusterIdentifier:

[REQUIRED]

The identifier of the DB cluster to create a snapshot for. This parameter is not case-sensitive.

Constraints:

• Must match the identifier of an existing DBCluster.

Example: my-cluster1

type Tags:

list

param Tags:

The tags to be assigned to the DB cluster snapshot.

• (dict) --

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

  • Key (string) --

    A key is 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 only contain the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").

  • Value (string) --

    A value is 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 only contain the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").

rtype:

dict

returns:

Response Syntax

{
    'DBClusterSnapshot': {
        'AvailabilityZones': [
            'string',
        ],
        'DBClusterSnapshotIdentifier': 'string',
        'DBClusterIdentifier': 'string',
        'SnapshotCreateTime': datetime(2015, 1, 1),
        'Engine': 'string',
        'AllocatedStorage': 123,
        'Status': 'string',
        'Port': 123,
        'VpcId': 'string',
        'ClusterCreateTime': datetime(2015, 1, 1),
        'MasterUsername': 'string',
        'EngineVersion': 'string',
        'LicenseModel': 'string',
        'SnapshotType': 'string',
        'PercentProgress': 123,
        'StorageEncrypted': True|False,
        'KmsKeyId': 'string',
        'DBClusterSnapshotArn': 'string',
        'SourceDBClusterSnapshotArn': 'string',
        'IAMDatabaseAuthenticationEnabled': True|False,
        'StorageType': 'string'
    }
}

Response Structure

• (dict) --

  • DBClusterSnapshot (dict) --

    Contains the details for an Amazon Neptune DB cluster snapshot

    This data type is used as a response element in the DescribeDBClusterSnapshots action.

    • AvailabilityZones (list) --

      Provides the list of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.

      • (string) --

    • DBClusterSnapshotIdentifier (string) --

      Specifies the identifier for a DB cluster snapshot. Must match the identifier of an existing snapshot.

      After you restore a DB cluster using a DBClusterSnapshotIdentifier, you must specify the same DBClusterSnapshotIdentifier for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed.

      However, if you don't specify the DBClusterSnapshotIdentifier, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the snapshot specified by the DBClusterSnapshotIdentifier, and the original DB cluster is deleted.

    • DBClusterIdentifier (string) --

      Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.

    • SnapshotCreateTime (datetime) --

      Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).

    • Engine (string) --

      Specifies the name of the database engine.

    • AllocatedStorage (integer) --

      Specifies the allocated storage size in gibibytes (GiB).

    • Status (string) --

      Specifies the status of this DB cluster snapshot.

    • Port (integer) --

      Specifies the port that the DB cluster was listening on at the time of the snapshot.

    • VpcId (string) --

      Provides the VPC ID associated with the DB cluster snapshot.

    • ClusterCreateTime (datetime) --

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

    • MasterUsername (string) --

      Not supported by Neptune.

    • EngineVersion (string) --

      Provides the version of the database engine for this DB cluster snapshot.

    • LicenseModel (string) --

      Provides the license model information for this DB cluster snapshot.

    • SnapshotType (string) --

      Provides the type of the DB cluster snapshot.

    • PercentProgress (integer) --

      Specifies the percentage of the estimated data that has been transferred.

    • StorageEncrypted (boolean) --

      Specifies whether the DB cluster snapshot is encrypted.

    • KmsKeyId (string) --

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

    • DBClusterSnapshotArn (string) --

      The Amazon Resource Name (ARN) for the DB cluster snapshot.

    • SourceDBClusterSnapshotArn (string) --

      If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.

    • IAMDatabaseAuthenticationEnabled (boolean) --

      True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

    • StorageType (string) --

      The storage type associated with the DB cluster snapshot.

{'DBCluster': {'IOOptimizedNextAllowedModificationTime': 'timestamp',
               'PendingModifiedValues': {'StorageType': 'string'},
               'StorageType': 'string'}}

The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted.

Note that the DB Cluster cannot be deleted if deletion protection is enabled. To delete it, you must first set its DeletionProtection field to False.

See also: AWS API Documentation

Request Syntax

client.delete_db_cluster(
    DBClusterIdentifier='string',
    SkipFinalSnapshot=True|False,
    FinalDBSnapshotIdentifier='string'
)

type DBClusterIdentifier:

string

param DBClusterIdentifier:

[REQUIRED]

The DB cluster identifier for the DB cluster to be deleted. This parameter isn't case-sensitive.

Constraints:

• Must match an existing DBClusterIdentifier.

type SkipFinalSnapshot:

boolean

param SkipFinalSnapshot:

Determines whether a final DB cluster snapshot is created before the DB cluster is deleted. If true is specified, no DB cluster snapshot is created. If false is specified, a DB cluster snapshot is created before the DB cluster is deleted.

Default: false

type FinalDBSnapshotIdentifier:

string

param FinalDBSnapshotIdentifier:

The DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot is set to false.

Constraints:

• Must be 1 to 255 letters, numbers, or hyphens.

• First character must be a letter

• Cannot end with a hyphen or contain two consecutive hyphens

rtype:

dict

returns:

Response Syntax

{
    'DBCluster': {
        'AllocatedStorage': 123,
        'AvailabilityZones': [
            'string',
        ],
        'BackupRetentionPeriod': 123,
        'CharacterSetName': 'string',
        'DatabaseName': 'string',
        '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',
        'DBClusterOptionGroupMemberships': [
            {
                'DBClusterOptionGroupName': 'string',
                'Status': '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',
                'FeatureName': 'string'
            },
        ],
        'IAMDatabaseAuthenticationEnabled': True|False,
        'CloneGroupId': 'string',
        'ClusterCreateTime': datetime(2015, 1, 1),
        'CopyTagsToSnapshot': True|False,
        'EnabledCloudwatchLogsExports': [
            'string',
        ],
        'PendingModifiedValues': {
            'PendingCloudwatchLogsExports': {
                'LogTypesToEnable': [
                    'string',
                ],
                'LogTypesToDisable': [
                    'string',
                ]
            },
            'DBClusterIdentifier': 'string',
            'IAMDatabaseAuthenticationEnabled': True|False,
            'EngineVersion': 'string',
            'BackupRetentionPeriod': 123,
            'StorageType': 'string',
            'AllocatedStorage': 123,
            'Iops': 123
        },
        'DeletionProtection': True|False,
        'CrossAccountClone': True|False,
        'AutomaticRestartTime': datetime(2015, 1, 1),
        'ServerlessV2ScalingConfiguration': {
            'MinCapacity': 123.0,
            'MaxCapacity': 123.0
        },
        'GlobalClusterIdentifier': 'string',
        'IOOptimizedNextAllowedModificationTime': datetime(2015, 1, 1),
        'StorageType': 'string'
    }
}

Response Structure

• (dict) --

  • DBCluster (dict) --

    Contains the details of an Amazon Neptune DB cluster.

    This data type is used as a response element in the DescribeDBClusters.

    • AllocatedStorage (integer) --

      AllocatedStorage always returns 1, because Neptune DB cluster storage size is not fixed, but instead automatically adjusts as needed.

    • AvailabilityZones (list) --

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

      • (string) --

    • BackupRetentionPeriod (integer) --

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

    • CharacterSetName (string) --

      Not supported by Neptune.

    • DatabaseName (string) --

      Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.

    • DBClusterIdentifier (string) --

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

    • DBClusterParameterGroup (string) --

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

    • DBSubnetGroup (string) --

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

    • Status (string) --

      Specifies the current state of this DB cluster.

    • PercentProgress (string) --

      Specifies the progress of the operation as a percentage.

    • EarliestRestorableTime (datetime) --

      Specifies 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 DB cluster.

    • ReaderEndpoint (string) --

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

      If a failover occurs, and the Read 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 Read Replicas in the cluster, you can then reconnect to the reader endpoint.

    • MultiAZ (boolean) --

      Specifies whether the DB cluster has instances in multiple Availability Zones.

    • Engine (string) --

      Provides the name of the database engine to be used for this DB 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) --

      Not supported by Neptune.

    • DBClusterOptionGroupMemberships (list) --

      Not supported by Neptune.

      • (dict) --

        Not supported by Neptune.

        • DBClusterOptionGroupName (string) --

          Not supported by Neptune.

        • Status (string) --

          Not supported by Neptune.

    • 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) --

      Not supported by Neptune.

    • ReadReplicaIdentifiers (list) --

      Contains one or more identifiers of the Read Replicas associated with this DB cluster.

      • (string) --

    • DBClusterMembers (list) --

      Provides the list of instances that make up the DB cluster.

      • (dict) --

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

        • DBInstanceIdentifier (string) --

          Specifies the instance identifier for this member of the DB cluster.

        • IsClusterWriter (boolean) --

          Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.

        • DBClusterParameterGroupStatus (string) --

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

        • PromotionTier (integer) --

          A value that specifies the order in which a Read Replica is promoted to the primary instance after a failure of the existing primary instance.

    • VpcSecurityGroups (list) --

      Provides a list of VPC security groups that the DB cluster belongs to.

      • (dict) --

        This data type is used as a response element for queries on 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 DB cluster is encrypted.

    • KmsKeyId (string) --

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

    • DbClusterResourceId (string) --

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

    • DBClusterArn (string) --

      The Amazon Resource Name (ARN) for the DB cluster.

    • AssociatedRoles (list) --

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

      • (dict) --

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

        • RoleArn (string) --

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

        • Status (string) --

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

          • ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to access other Amazon services on your behalf.

          • PENDING - the IAM role ARN is being associated with the DB cluster.

          • INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other Amazon services on your behalf.

        • FeatureName (string) --

          The name of the feature associated with the Amazon Identity and Access Management (IAM) role. For the list of supported feature names, see DescribeDBEngineVersions.

    • IAMDatabaseAuthenticationEnabled (boolean) --

      True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

    • CloneGroupId (string) --

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

    • ClusterCreateTime (datetime) --

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

    • CopyTagsToSnapshot (boolean) --

      If set to true, tags are copied to any snapshot of the DB cluster that is created.

    • EnabledCloudwatchLogsExports (list) --

      A list of the log types that this DB cluster is configured to export to CloudWatch Logs. Valid log types are: audit (to publish audit logs to CloudWatch) and slowquery (to publish slow-query logs to CloudWatch). See Publishing Neptune logs to Amazon CloudWatch logs.

      • (string) --

    • PendingModifiedValues (dict) --

      This data type is used as a response element in the ModifyDBCluster operation and contains changes that will be applied during the next maintenance window.

      • PendingCloudwatchLogsExports (dict) --

        This PendingCloudwatchLogsExports structure specifies pending changes to which CloudWatch logs are enabled and which are disabled.

        • LogTypesToEnable (list) --

          Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.

          • (string) --

        • LogTypesToDisable (list) --

          Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.

          • (string) --

      • DBClusterIdentifier (string) --

        The DBClusterIdentifier value for the DB cluster.

      • IAMDatabaseAuthenticationEnabled (boolean) --

        A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

      • EngineVersion (string) --

        The database engine version.

      • BackupRetentionPeriod (integer) --

        The number of days for which automatic DB snapshots are retained.

      • StorageType (string) --

        The storage type for the DB cluster.

      • AllocatedStorage (integer) --

        The allocated storage size in gibibytes (GiB) for database engines. For Neptune, AllocatedStorage always returns 1, because Neptune DB cluster storage size isn't fixed, but instead automatically adjusts as needed.

      • Iops (integer) --

        The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters.

    • DeletionProtection (boolean) --

      Indicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.

    • CrossAccountClone (boolean) --

      If set to true, the DB cluster can be cloned across accounts.

    • AutomaticRestartTime (datetime) --

      Time at which the DB cluster will be automatically restarted.

    • ServerlessV2ScalingConfiguration (dict) --

      Shows the scaling configuration for a Neptune Serverless DB cluster.

      For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.

      • MinCapacity (float) --

        The minimum number of Neptune capacity units (NCUs) for a DB instance in a Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 8, 8.5, 9, and so on.

      • MaxCapacity (float) --

        The maximum number of Neptune capacity units (NCUs) for a DB instance in a Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 40, 40.5, 41, and so on.

    • GlobalClusterIdentifier (string) --

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

    • IOOptimizedNextAllowedModificationTime (datetime) --

      The next time you can modify the DB cluster to use the iopt1 storage type.

    • StorageType (string) --

      The storage type associated with the DB cluster.

{'DBClusterSnapshot': {'StorageType': 'string'}}

Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.

See also: AWS API Documentation

Request Syntax

client.delete_db_cluster_snapshot(
    DBClusterSnapshotIdentifier='string'
)

type DBClusterSnapshotIdentifier:

string

param DBClusterSnapshotIdentifier:

[REQUIRED]

The identifier of the DB cluster snapshot to delete.

Constraints: Must be the name of an existing DB cluster snapshot in the available state.

rtype:

dict

returns:

Response Syntax

{
    'DBClusterSnapshot': {
        'AvailabilityZones': [
            'string',
        ],
        'DBClusterSnapshotIdentifier': 'string',
        'DBClusterIdentifier': 'string',
        'SnapshotCreateTime': datetime(2015, 1, 1),
        'Engine': 'string',
        'AllocatedStorage': 123,
        'Status': 'string',
        'Port': 123,
        'VpcId': 'string',
        'ClusterCreateTime': datetime(2015, 1, 1),
        'MasterUsername': 'string',
        'EngineVersion': 'string',
        'LicenseModel': 'string',
        'SnapshotType': 'string',
        'PercentProgress': 123,
        'StorageEncrypted': True|False,
        'KmsKeyId': 'string',
        'DBClusterSnapshotArn': 'string',
        'SourceDBClusterSnapshotArn': 'string',
        'IAMDatabaseAuthenticationEnabled': True|False,
        'StorageType': 'string'
    }
}

Response Structure

• (dict) --

  • DBClusterSnapshot (dict) --

    Contains the details for an Amazon Neptune DB cluster snapshot

    This data type is used as a response element in the DescribeDBClusterSnapshots action.

    • AvailabilityZones (list) --

      Provides the list of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.

      • (string) --

    • DBClusterSnapshotIdentifier (string) --

      Specifies the identifier for a DB cluster snapshot. Must match the identifier of an existing snapshot.

      After you restore a DB cluster using a DBClusterSnapshotIdentifier, you must specify the same DBClusterSnapshotIdentifier for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed.

      However, if you don't specify the DBClusterSnapshotIdentifier, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the snapshot specified by the DBClusterSnapshotIdentifier, and the original DB cluster is deleted.

    • DBClusterIdentifier (string) --

      Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.

    • SnapshotCreateTime (datetime) --

      Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).

    • Engine (string) --

      Specifies the name of the database engine.

    • AllocatedStorage (integer) --

      Specifies the allocated storage size in gibibytes (GiB).

    • Status (string) --

      Specifies the status of this DB cluster snapshot.

    • Port (integer) --

      Specifies the port that the DB cluster was listening on at the time of the snapshot.

    • VpcId (string) --

      Provides the VPC ID associated with the DB cluster snapshot.

    • ClusterCreateTime (datetime) --

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

    • MasterUsername (string) --

      Not supported by Neptune.

    • EngineVersion (string) --

      Provides the version of the database engine for this DB cluster snapshot.

    • LicenseModel (string) --

      Provides the license model information for this DB cluster snapshot.

    • SnapshotType (string) --

      Provides the type of the DB cluster snapshot.

    • PercentProgress (integer) --

      Specifies the percentage of the estimated data that has been transferred.

    • StorageEncrypted (boolean) --

      Specifies whether the DB cluster snapshot is encrypted.

    • KmsKeyId (string) --

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

    • DBClusterSnapshotArn (string) --

      The Amazon Resource Name (ARN) for the DB cluster snapshot.

    • SourceDBClusterSnapshotArn (string) --

      If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.

    • IAMDatabaseAuthenticationEnabled (boolean) --

      True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

    • StorageType (string) --

      The storage type associated with the DB cluster snapshot.

{'DBClusterSnapshots': {'StorageType': 'string'}}

Returns information about DB cluster snapshots. This API action supports pagination.

See also: AWS API Documentation

Request Syntax

client.describe_db_cluster_snapshots(
    DBClusterIdentifier='string',
    DBClusterSnapshotIdentifier='string',
    SnapshotType='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxRecords=123,
    Marker='string',
    IncludeShared=True|False,
    IncludePublic=True|False
)

type DBClusterIdentifier:

string

param DBClusterIdentifier:

The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used in conjunction with the DBClusterSnapshotIdentifier parameter. This parameter is not case-sensitive.

Constraints:

• If supplied, must match the identifier of an existing DBCluster.

type DBClusterSnapshotIdentifier:

string

param DBClusterSnapshotIdentifier:

A specific DB cluster snapshot identifier to describe. This parameter can't be used in conjunction with the DBClusterIdentifier parameter. This value is stored as a lowercase string.

Constraints:

• If supplied, must match the identifier of an existing DBClusterSnapshot.

• If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.

type SnapshotType:

string

param SnapshotType:

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

• automated - Return all DB cluster snapshots that have been automatically taken by Amazon Neptune for my Amazon account.

• manual - Return all DB cluster snapshots that have been taken by my Amazon account.

• shared - Return all manual DB cluster snapshots that have been shared to my Amazon account.

• public - Return all DB cluster snapshots that have been marked as public.

If you don't specify a SnapshotType value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by setting the IncludeShared parameter to true. You can include public DB cluster snapshots with these results by setting the IncludePublic parameter to true.

The IncludeShared and IncludePublic parameters don't apply for SnapshotType values of manual or automated. The IncludePublic parameter doesn't apply when SnapshotType is set to shared. The IncludeShared parameter doesn't apply when SnapshotType is set to public.

type Filters:

list

param Filters:

This parameter is not currently supported.

• (dict) --

  This type is not currently supported.

  • Name (string) -- [REQUIRED]

    This parameter is not currently supported.

  • Values (list) -- [REQUIRED]

    This parameter is not currently supported.

    • (string) --

type MaxRecords:

integer

param MaxRecords:

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

Default: 100

Constraints: Minimum 20, maximum 100.

type Marker:

string

param Marker:

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

type IncludeShared:

boolean

param IncludeShared:

True to include shared manual DB cluster snapshots from other Amazon accounts that this Amazon account has been given permission to copy or restore, and otherwise false. The default is false.

You can give an Amazon account permission to restore a manual DB cluster snapshot from another Amazon account by the ModifyDBClusterSnapshotAttribute API action.

type IncludePublic:

boolean

param IncludePublic:

True to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon account, and otherwise false. The default is false. The default is false.

You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.

rtype:

dict

returns:

Response Syntax

{
    'Marker': 'string',
    'DBClusterSnapshots': [
        {
            'AvailabilityZones': [
                'string',
            ],
            'DBClusterSnapshotIdentifier': 'string',
            'DBClusterIdentifier': 'string',
            'SnapshotCreateTime': datetime(2015, 1, 1),
            'Engine': 'string',
            'AllocatedStorage': 123,
            'Status': 'string',
            'Port': 123,
            'VpcId': 'string',
            'ClusterCreateTime': datetime(2015, 1, 1),
            'MasterUsername': 'string',
            'EngineVersion': 'string',
            'LicenseModel': 'string',
            'SnapshotType': 'string',
            'PercentProgress': 123,
            'StorageEncrypted': True|False,
            'KmsKeyId': 'string',
            'DBClusterSnapshotArn': 'string',
            'SourceDBClusterSnapshotArn': 'string',
            'IAMDatabaseAuthenticationEnabled': True|False,
            'StorageType': 'string'
        },
    ]
}

Response Structure

• (dict) --

  • Marker (string) --

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

  • DBClusterSnapshots (list) --

    Provides a list of DB cluster snapshots for the user.

    • (dict) --

      Contains the details for an Amazon Neptune DB cluster snapshot

      This data type is used as a response element in the DescribeDBClusterSnapshots action.

      • AvailabilityZones (list) --

        Provides the list of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.

        • (string) --

      • DBClusterSnapshotIdentifier (string) --

        Specifies the identifier for a DB cluster snapshot. Must match the identifier of an existing snapshot.

        After you restore a DB cluster using a DBClusterSnapshotIdentifier, you must specify the same DBClusterSnapshotIdentifier for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed.

        However, if you don't specify the DBClusterSnapshotIdentifier, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the snapshot specified by the DBClusterSnapshotIdentifier, and the original DB cluster is deleted.

      • DBClusterIdentifier (string) --

        Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.

      • SnapshotCreateTime (datetime) --

        Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).

      • Engine (string) --

        Specifies the name of the database engine.

      • AllocatedStorage (integer) --

        Specifies the allocated storage size in gibibytes (GiB).

      • Status (string) --

        Specifies the status of this DB cluster snapshot.

      • Port (integer) --

        Specifies the port that the DB cluster was listening on at the time of the snapshot.

      • VpcId (string) --

        Provides the VPC ID associated with the DB cluster snapshot.

      • ClusterCreateTime (datetime) --

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

      • MasterUsername (string) --

        Not supported by Neptune.

      • EngineVersion (string) --

        Provides the version of the database engine for this DB cluster snapshot.

      • LicenseModel (string) --

        Provides the license model information for this DB cluster snapshot.

      • SnapshotType (string) --

        Provides the type of the DB cluster snapshot.

      • PercentProgress (integer) --

        Specifies the percentage of the estimated data that has been transferred.

      • StorageEncrypted (boolean) --

        Specifies whether the DB cluster snapshot is encrypted.

      • KmsKeyId (string) --

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

      • DBClusterSnapshotArn (string) --

        The Amazon Resource Name (ARN) for the DB cluster snapshot.

      • SourceDBClusterSnapshotArn (string) --

        If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.

      • IAMDatabaseAuthenticationEnabled (boolean) --

        True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

      • StorageType (string) --

        The storage type associated with the DB cluster snapshot.

{'DBClusters': {'IOOptimizedNextAllowedModificationTime': 'timestamp',
                'PendingModifiedValues': {'StorageType': 'string'},
                'StorageType': 'string'}}

Returns information about provisioned DB clusters, and supports pagination.

See also: AWS API Documentation

Request Syntax

client.describe_db_clusters(
    DBClusterIdentifier='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxRecords=123,
    Marker='string'
)

type DBClusterIdentifier:

string

param DBClusterIdentifier:

The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive.

Constraints:

• If supplied, must match an existing DBClusterIdentifier.

type Filters:

list

param Filters:

A filter that specifies one or more DB clusters to describe.

Supported filters:

• db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB clusters identified by these ARNs.

• engine - Accepts an engine name (such as neptune), and restricts the results list to DB clusters created by that engine.

For example, to invoke this API from the Amazon CLI and filter so that only Neptune DB clusters are returned, you could use the following command:

• (dict) --

  This type is not currently supported.

  • Name (string) -- [REQUIRED]

    This parameter is not currently supported.

  • Values (list) -- [REQUIRED]

    This parameter is not currently supported.

    • (string) --

type MaxRecords:

integer

param MaxRecords:

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

Default: 100

Constraints: Minimum 20, maximum 100.

type Marker:

string

param Marker:

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

rtype:

dict

returns:

Response Syntax

{
    'Marker': 'string',
    'DBClusters': [
        {
            'AllocatedStorage': 123,
            'AvailabilityZones': [
                'string',
            ],
            'BackupRetentionPeriod': 123,
            'CharacterSetName': 'string',
            'DatabaseName': 'string',
            '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',
            'DBClusterOptionGroupMemberships': [
                {
                    'DBClusterOptionGroupName': 'string',
                    'Status': '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',
                    'FeatureName': 'string'
                },
            ],
            'IAMDatabaseAuthenticationEnabled': True|False,
            'CloneGroupId': 'string',
            'ClusterCreateTime': datetime(2015, 1, 1),
            'CopyTagsToSnapshot': True|False,
            'EnabledCloudwatchLogsExports': [
                'string',
            ],
            'PendingModifiedValues': {
                'PendingCloudwatchLogsExports': {
                    'LogTypesToEnable': [
                        'string',
                    ],
                    'LogTypesToDisable': [
                        'string',
                    ]
                },
                'DBClusterIdentifier': 'string',
                'IAMDatabaseAuthenticationEnabled': True|False,
                'EngineVersion': 'string',
                'BackupRetentionPeriod': 123,
                'StorageType': 'string',
                'AllocatedStorage': 123,
                'Iops': 123
            },
            'DeletionProtection': True|False,
            'CrossAccountClone': True|False,
            'AutomaticRestartTime': datetime(2015, 1, 1),
            'ServerlessV2ScalingConfiguration': {
                'MinCapacity': 123.0,
                'MaxCapacity': 123.0
            },
            'GlobalClusterIdentifier': 'string',
            'IOOptimizedNextAllowedModificationTime': datetime(2015, 1, 1),
            'StorageType': 'string'
        },
    ]
}

Response Structure

• (dict) --

  • Marker (string) --

    A pagination token that can be used in a subsequent DescribeDBClusters request.

  • DBClusters (list) --

    Contains a list of DB clusters for the user.

    • (dict) --

      Contains the details of an Amazon Neptune DB cluster.

      This data type is used as a response element in the DescribeDBClusters.

      • AllocatedStorage (integer) --

        AllocatedStorage always returns 1, because Neptune DB cluster storage size is not fixed, but instead automatically adjusts as needed.

      • AvailabilityZones (list) --

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

        • (string) --

      • BackupRetentionPeriod (integer) --

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

      • CharacterSetName (string) --

        Not supported by Neptune.

      • DatabaseName (string) --

        Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.

      • DBClusterIdentifier (string) --

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

      • DBClusterParameterGroup (string) --

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

      • DBSubnetGroup (string) --

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

      • Status (string) --

        Specifies the current state of this DB cluster.

      • PercentProgress (string) --

        Specifies the progress of the operation as a percentage.

      • EarliestRestorableTime (datetime) --

        Specifies 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 DB cluster.

      • ReaderEndpoint (string) --

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

        If a failover occurs, and the Read 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 Read Replicas in the cluster, you can then reconnect to the reader endpoint.

      • MultiAZ (boolean) --

        Specifies whether the DB cluster has instances in multiple Availability Zones.

      • Engine (string) --

        Provides the name of the database engine to be used for this DB 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) --

        Not supported by Neptune.

      • DBClusterOptionGroupMemberships (list) --

        Not supported by Neptune.

        • (dict) --

          Not supported by Neptune.

          • DBClusterOptionGroupName (string) --

            Not supported by Neptune.

          • Status (string) --

            Not supported by Neptune.

      • 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) --

        Not supported by Neptune.

      • ReadReplicaIdentifiers (list) --

        Contains one or more identifiers of the Read Replicas associated with this DB cluster.

        • (string) --

      • DBClusterMembers (list) --

        Provides the list of instances that make up the DB cluster.

        • (dict) --

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

          • DBInstanceIdentifier (string) --

            Specifies the instance identifier for this member of the DB cluster.

          • IsClusterWriter (boolean) --

            Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.

          • DBClusterParameterGroupStatus (string) --

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

          • PromotionTier (integer) --

            A value that specifies the order in which a Read Replica is promoted to the primary instance after a failure of the existing primary instance.

      • VpcSecurityGroups (list) --

        Provides a list of VPC security groups that the DB cluster belongs to.

        • (dict) --

          This data type is used as a response element for queries on 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 DB cluster is encrypted.

      • KmsKeyId (string) --

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

      • DbClusterResourceId (string) --

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

      • DBClusterArn (string) --

        The Amazon Resource Name (ARN) for the DB cluster.

      • AssociatedRoles (list) --

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

        • (dict) --

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

          • RoleArn (string) --

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

          • Status (string) --

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

            • ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to access other Amazon services on your behalf.

            • PENDING - the IAM role ARN is being associated with the DB cluster.

            • INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other Amazon services on your behalf.

          • FeatureName (string) --

            The name of the feature associated with the Amazon Identity and Access Management (IAM) role. For the list of supported feature names, see DescribeDBEngineVersions.

      • IAMDatabaseAuthenticationEnabled (boolean) --

        True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

      • CloneGroupId (string) --

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

      • ClusterCreateTime (datetime) --

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

      • CopyTagsToSnapshot (boolean) --

        If set to true, tags are copied to any snapshot of the DB cluster that is created.

      • EnabledCloudwatchLogsExports (list) --

        A list of the log types that this DB cluster is configured to export to CloudWatch Logs. Valid log types are: audit (to publish audit logs to CloudWatch) and slowquery (to publish slow-query logs to CloudWatch). See Publishing Neptune logs to Amazon CloudWatch logs.

        • (string) --

      • PendingModifiedValues (dict) --

        This data type is used as a response element in the ModifyDBCluster operation and contains changes that will be applied during the next maintenance window.

        • PendingCloudwatchLogsExports (dict) --

          This PendingCloudwatchLogsExports structure specifies pending changes to which CloudWatch logs are enabled and which are disabled.

          • LogTypesToEnable (list) --

            Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.

            • (string) --

          • LogTypesToDisable (list) --

            Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.

            • (string) --

        • DBClusterIdentifier (string) --

          The DBClusterIdentifier value for the DB cluster.

        • IAMDatabaseAuthenticationEnabled (boolean) --

          A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

        • EngineVersion (string) --

          The database engine version.

        • BackupRetentionPeriod (integer) --

          The number of days for which automatic DB snapshots are retained.

        • StorageType (string) --

          The storage type for the DB cluster.

        • AllocatedStorage (integer) --

          The allocated storage size in gibibytes (GiB) for database engines. For Neptune, AllocatedStorage always returns 1, because Neptune DB cluster storage size isn't fixed, but instead automatically adjusts as needed.

        • Iops (integer) --

          The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters.

      • DeletionProtection (boolean) --

        Indicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.

      • CrossAccountClone (boolean) --

        If set to true, the DB cluster can be cloned across accounts.

      • AutomaticRestartTime (datetime) --

        Time at which the DB cluster will be automatically restarted.

      • ServerlessV2ScalingConfiguration (dict) --

        Shows the scaling configuration for a Neptune Serverless DB cluster.

        For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.

        • MinCapacity (float) --

          The minimum number of Neptune capacity units (NCUs) for a DB instance in a Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 8, 8.5, 9, and so on.

        • MaxCapacity (float) --

          The maximum number of Neptune capacity units (NCUs) for a DB instance in a Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 40, 40.5, 41, and so on.

      • GlobalClusterIdentifier (string) --

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

      • IOOptimizedNextAllowedModificationTime (datetime) --

        The next time you can modify the DB cluster to use the iopt1 storage type.

      • StorageType (string) --

        The storage type associated with the DB cluster.

{'DBCluster': {'IOOptimizedNextAllowedModificationTime': 'timestamp',
               'PendingModifiedValues': {'StorageType': 'string'},
               'StorageType': 'string'}}

Forces a failover for a DB cluster.

A failover for a DB cluster promotes one of the Read Replicas (read-only instances) in the DB cluster to be the primary instance (the cluster writer).

Amazon Neptune will automatically fail over to a Read Replica, if one exists, when the primary instance fails. You can force a failover when you want to simulate a failure of a primary instance for testing. Because each instance in a DB cluster has its own endpoint address, you will need to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete.

See also: AWS API Documentation

Request Syntax

client.failover_db_cluster(
    DBClusterIdentifier='string',
    TargetDBInstanceIdentifier='string'
)

type DBClusterIdentifier:

string

param DBClusterIdentifier:

A DB cluster identifier to force a failover for. This parameter is not case-sensitive.

Constraints:

• Must match the identifier of an existing DBCluster.

type TargetDBInstanceIdentifier:

string

param TargetDBInstanceIdentifier:

The name of the instance to promote to the primary instance.

You must specify the instance identifier for an Read Replica in the DB cluster. For example, mydbcluster-replica1.

rtype:

dict

returns:

Response Syntax

{
    'DBCluster': {
        'AllocatedStorage': 123,
        'AvailabilityZones': [
            'string',
        ],
        'BackupRetentionPeriod': 123,
        'CharacterSetName': 'string',
        'DatabaseName': 'string',
        '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',
        'DBClusterOptionGroupMemberships': [
            {
                'DBClusterOptionGroupName': 'string',
                'Status': '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',
                'FeatureName': 'string'
            },
        ],
        'IAMDatabaseAuthenticationEnabled': True|False,
        'CloneGroupId': 'string',
        'ClusterCreateTime': datetime(2015, 1, 1),
        'CopyTagsToSnapshot': True|False,
        'EnabledCloudwatchLogsExports': [
            'string',
        ],
        'PendingModifiedValues': {
            'PendingCloudwatchLogsExports': {
                'LogTypesToEnable': [
                    'string',
                ],
                'LogTypesToDisable': [
                    'string',
                ]
            },
            'DBClusterIdentifier': 'string',
            'IAMDatabaseAuthenticationEnabled': True|False,
            'EngineVersion': 'string',
            'BackupRetentionPeriod': 123,
            'StorageType': 'string',
            'AllocatedStorage': 123,
            'Iops': 123
        },
        'DeletionProtection': True|False,
        'CrossAccountClone': True|False,
        'AutomaticRestartTime': datetime(2015, 1, 1),
        'ServerlessV2ScalingConfiguration': {
            'MinCapacity': 123.0,
            'MaxCapacity': 123.0
        },
        'GlobalClusterIdentifier': 'string',
        'IOOptimizedNextAllowedModificationTime': datetime(2015, 1, 1),
        'StorageType': 'string'
    }
}

Response Structure

• (dict) --

  • DBCluster (dict) --

    Contains the details of an Amazon Neptune DB cluster.

    This data type is used as a response element in the DescribeDBClusters.

    • AllocatedStorage (integer) --

      AllocatedStorage always returns 1, because Neptune DB cluster storage size is not fixed, but instead automatically adjusts as needed.

    • AvailabilityZones (list) --

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

      • (string) --

    • BackupRetentionPeriod (integer) --

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

    • CharacterSetName (string) --

      Not supported by Neptune.

    • DatabaseName (string) --

      Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.

    • DBClusterIdentifier (string) --

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

    • DBClusterParameterGroup (string) --

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

    • DBSubnetGroup (string) --

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

    • Status (string) --

      Specifies the current state of this DB cluster.

    • PercentProgress (string) --

      Specifies the progress of the operation as a percentage.

    • EarliestRestorableTime (datetime) --

      Specifies 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 DB cluster.

    • ReaderEndpoint (string) --

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

      If a failover occurs, and the Read 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 Read Replicas in the cluster, you can then reconnect to the reader endpoint.

    • MultiAZ (boolean) --

      Specifies whether the DB cluster has instances in multiple Availability Zones.

    • Engine (string) --

      Provides the name of the database engine to be used for this DB 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) --

      Not supported by Neptune.

    • DBClusterOptionGroupMemberships (list) --

      Not supported by Neptune.

      • (dict) --

        Not supported by Neptune.

        • DBClusterOptionGroupName (string) --

          Not supported by Neptune.

        • Status (string) --

          Not supported by Neptune.

    • 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) --

      Not supported by Neptune.

    • ReadReplicaIdentifiers (list) --

      Contains one or more identifiers of the Read Replicas associated with this DB cluster.

      • (string) --

    • DBClusterMembers (list) --

      Provides the list of instances that make up the DB cluster.

      • (dict) --

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

        • DBInstanceIdentifier (string) --

          Specifies the instance identifier for this member of the DB cluster.

        • IsClusterWriter (boolean) --

          Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.

        • DBClusterParameterGroupStatus (string) --

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

        • PromotionTier (integer) --

          A value that specifies the order in which a Read Replica is promoted to the primary instance after a failure of the existing primary instance.

    • VpcSecurityGroups (list) --

      Provides a list of VPC security groups that the DB cluster belongs to.

      • (dict) --

        This data type is used as a response element for queries on 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 DB cluster is encrypted.

    • KmsKeyId (string) --

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

    • DbClusterResourceId (string) --

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

    • DBClusterArn (string) --

      The Amazon Resource Name (ARN) for the DB cluster.

    • AssociatedRoles (list) --

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

      • (dict) --

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

        • RoleArn (string) --

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

        • Status (string) --

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

          • ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to access other Amazon services on your behalf.

          • PENDING - the IAM role ARN is being associated with the DB cluster.

          • INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other Amazon services on your behalf.

        • FeatureName (string) --

          The name of the feature associated with the Amazon Identity and Access Management (IAM) role. For the list of supported feature names, see DescribeDBEngineVersions.

    • IAMDatabaseAuthenticationEnabled (boolean) --

      True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

    • CloneGroupId (string) --

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

    • ClusterCreateTime (datetime) --

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

    • CopyTagsToSnapshot (boolean) --

      If set to true, tags are copied to any snapshot of the DB cluster that is created.

    • EnabledCloudwatchLogsExports (list) --

      A list of the log types that this DB cluster is configured to export to CloudWatch Logs. Valid log types are: audit (to publish audit logs to CloudWatch) and slowquery (to publish slow-query logs to CloudWatch). See Publishing Neptune logs to Amazon CloudWatch logs.

      • (string) --

    • PendingModifiedValues (dict) --

      This data type is used as a response element in the ModifyDBCluster operation and contains changes that will be applied during the next maintenance window.

      • PendingCloudwatchLogsExports (dict) --

        This PendingCloudwatchLogsExports structure specifies pending changes to which CloudWatch logs are enabled and which are disabled.

        • LogTypesToEnable (list) --

          Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.

          • (string) --

        • LogTypesToDisable (list) --

          Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.

          • (string) --

      • DBClusterIdentifier (string) --

        The DBClusterIdentifier value for the DB cluster.

      • IAMDatabaseAuthenticationEnabled (boolean) --

        A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

      • EngineVersion (string) --

        The database engine version.

      • BackupRetentionPeriod (integer) --

        The number of days for which automatic DB snapshots are retained.

      • StorageType (string) --

        The storage type for the DB cluster.

      • AllocatedStorage (integer) --

        The allocated storage size in gibibytes (GiB) for database engines. For Neptune, AllocatedStorage always returns 1, because Neptune DB cluster storage size isn't fixed, but instead automatically adjusts as needed.

      • Iops (integer) --

        The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters.

    • DeletionProtection (boolean) --

      Indicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.

    • CrossAccountClone (boolean) --

      If set to true, the DB cluster can be cloned across accounts.

    • AutomaticRestartTime (datetime) --

      Time at which the DB cluster will be automatically restarted.

    • ServerlessV2ScalingConfiguration (dict) --

      Shows the scaling configuration for a Neptune Serverless DB cluster.

      For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.

      • MinCapacity (float) --

        The minimum number of Neptune capacity units (NCUs) for a DB instance in a Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 8, 8.5, 9, and so on.

      • MaxCapacity (float) --

        The maximum number of Neptune capacity units (NCUs) for a DB instance in a Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 40, 40.5, 41, and so on.

    • GlobalClusterIdentifier (string) --

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

    • IOOptimizedNextAllowedModificationTime (datetime) --

      The next time you can modify the DB cluster to use the iopt1 storage type.

    • StorageType (string) --

      The storage type associated with the DB cluster.

{'StorageType': 'string'}

{'DBCluster': {'IOOptimizedNextAllowedModificationTime': 'timestamp',
               'PendingModifiedValues': {'StorageType': 'string'},
               'StorageType': 'string'}}

Modify a setting for a DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.

See also: AWS API Documentation

Request Syntax

client.modify_db_cluster(
    DBClusterIdentifier='string',
    NewDBClusterIdentifier='string',
    ApplyImmediately=True|False,
    BackupRetentionPeriod=123,
    DBClusterParameterGroupName='string',
    VpcSecurityGroupIds=[
        'string',
    ],
    Port=123,
    MasterUserPassword='string',
    OptionGroupName='string',
    PreferredBackupWindow='string',
    PreferredMaintenanceWindow='string',
    EnableIAMDatabaseAuthentication=True|False,
    CloudwatchLogsExportConfiguration={
        'EnableLogTypes': [
            'string',
        ],
        'DisableLogTypes': [
            'string',
        ]
    },
    EngineVersion='string',
    AllowMajorVersionUpgrade=True|False,
    DBInstanceParameterGroupName='string',
    DeletionProtection=True|False,
    CopyTagsToSnapshot=True|False,
    ServerlessV2ScalingConfiguration={
        'MinCapacity': 123.0,
        'MaxCapacity': 123.0
    },
    StorageType='string'
)

type DBClusterIdentifier:

string

param DBClusterIdentifier:

[REQUIRED]

The DB cluster identifier for the cluster being modified. This parameter is not case-sensitive.

Constraints:

• Must match the identifier of an existing DBCluster.

type NewDBClusterIdentifier:

string

param NewDBClusterIdentifier:

The new DB cluster identifier for the DB cluster when renaming a DB cluster. This value 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-cluster2

type ApplyImmediately:

boolean

param ApplyImmediately:

A value that specifies whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, regardless of the PreferredMaintenanceWindow setting for the DB cluster. If this parameter is set to false, changes to the DB cluster are applied during the next maintenance window.

The ApplyImmediately parameter only affects NewDBClusterIdentifier values. If you set the ApplyImmediately parameter value to false, then changes to NewDBClusterIdentifier values are applied during the next maintenance window. All other changes are applied immediately, regardless of the value of the ApplyImmediately parameter.

Default: false

type BackupRetentionPeriod:

integer

param BackupRetentionPeriod:

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

type DBClusterParameterGroupName:

string

param DBClusterParameterGroupName:

The name of the DB cluster parameter group to use for the DB cluster.

type VpcSecurityGroupIds:

list

param VpcSecurityGroupIds:

A list of VPC security groups that the DB cluster will belong to.

• (string) --

type Port:

integer

param Port:

The port number on which the DB cluster accepts connections.

Constraints: Value must be 1150-65535

Default: The same port as the original DB cluster.

type MasterUserPassword:

string

param MasterUserPassword:

Not supported by Neptune.

type OptionGroupName:

string

param OptionGroupName:

Not supported by Neptune.

type PreferredBackupWindow:

string

param PreferredBackupWindow:

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

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

The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Region, occurring on a random day of the week.

Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.

Constraints: Minimum 30-minute window.

type EnableIAMDatabaseAuthentication:

boolean

param EnableIAMDatabaseAuthentication:

True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

type CloudwatchLogsExportConfiguration:

dict

param CloudwatchLogsExportConfiguration:

The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster. See Using the CLI to publish Neptune audit logs to CloudWatch Logs.

• EnableLogTypes (list) --

  The list of log types to enable.

  • (string) --

• DisableLogTypes (list) --

  The list of log types to disable.

  • (string) --

type EngineVersion:

string

param EngineVersion:

The version number of the database engine to which you want to upgrade. Changing this parameter results in an outage. The change is applied during the next maintenance window unless the ApplyImmediately parameter is set to true.

For a list of valid engine versions, see Engine Releases for Amazon Neptune, or call DescribeDBEngineVersions.

type AllowMajorVersionUpgrade:

boolean

param AllowMajorVersionUpgrade:

A value that indicates whether upgrades between different major versions are allowed.

Constraints: You must set the allow-major-version-upgrade flag when providing an EngineVersion parameter that uses a different major version than the DB cluster's current version.

type DBInstanceParameterGroupName:

string

param DBInstanceParameterGroupName:

The name of the DB parameter group to apply to all instances of the DB cluster.

Default: The existing name setting

Constraints:

• The DB parameter group must be in the same DB parameter group family as the target DB cluster version.

• The DBInstanceParameterGroupName parameter is only valid in combination with the AllowMajorVersionUpgrade parameter.

type DeletionProtection:

boolean

param DeletionProtection:

A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.

type CopyTagsToSnapshot:

boolean

param CopyTagsToSnapshot:

If set to true, tags are copied to any snapshot of the DB cluster that is created.

type ServerlessV2ScalingConfiguration:

dict

param ServerlessV2ScalingConfiguration:

Contains the scaling configuration of a Neptune Serverless DB cluster.

For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.

• MinCapacity (float) --

  The minimum number of Neptune capacity units (NCUs) for a DB instance in a Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 8, 8.5, 9, and so on.

• MaxCapacity (float) --

  The maximum number of Neptune capacity units (NCUs) for a DB instance in a Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 40, 40.5, 41, and so on.

type StorageType:

string

param StorageType:

The storage type to associate with the DB cluster.

Valid Values:

• standard | iopt1

Default:

• standard

rtype:

dict

returns:

Response Syntax

{
    'DBCluster': {
        'AllocatedStorage': 123,
        'AvailabilityZones': [
            'string',
        ],
        'BackupRetentionPeriod': 123,
        'CharacterSetName': 'string',
        'DatabaseName': 'string',
        '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',
        'DBClusterOptionGroupMemberships': [
            {
                'DBClusterOptionGroupName': 'string',
                'Status': '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',
                'FeatureName': 'string'
            },
        ],
        'IAMDatabaseAuthenticationEnabled': True|False,
        'CloneGroupId': 'string',
        'ClusterCreateTime': datetime(2015, 1, 1),
        'CopyTagsToSnapshot': True|False,
        'EnabledCloudwatchLogsExports': [
            'string',
        ],
        'PendingModifiedValues': {
            'PendingCloudwatchLogsExports': {
                'LogTypesToEnable': [
                    'string',
                ],
                'LogTypesToDisable': [
                    'string',
                ]
            },
            'DBClusterIdentifier': 'string',
            'IAMDatabaseAuthenticationEnabled': True|False,
            'EngineVersion': 'string',
            'BackupRetentionPeriod': 123,
            'StorageType': 'string',
            'AllocatedStorage': 123,
            'Iops': 123
        },
        'DeletionProtection': True|False,
        'CrossAccountClone': True|False,
        'AutomaticRestartTime': datetime(2015, 1, 1),
        'ServerlessV2ScalingConfiguration': {
            'MinCapacity': 123.0,
            'MaxCapacity': 123.0
        },
        'GlobalClusterIdentifier': 'string',
        'IOOptimizedNextAllowedModificationTime': datetime(2015, 1, 1),
        'StorageType': 'string'
    }
}

Response Structure

• (dict) --

  • DBCluster (dict) --

    Contains the details of an Amazon Neptune DB cluster.

    This data type is used as a response element in the DescribeDBClusters.

    • AllocatedStorage (integer) --

      AllocatedStorage always returns 1, because Neptune DB cluster storage size is not fixed, but instead automatically adjusts as needed.

    • AvailabilityZones (list) --

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

      • (string) --

    • BackupRetentionPeriod (integer) --

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

    • CharacterSetName (string) --

      Not supported by Neptune.

    • DatabaseName (string) --

      Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.

    • DBClusterIdentifier (string) --

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

    • DBClusterParameterGroup (string) --

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

    • DBSubnetGroup (string) --

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

    • Status (string) --

      Specifies the current state of this DB cluster.

    • PercentProgress (string) --

      Specifies the progress of the operation as a percentage.

    • EarliestRestorableTime (datetime) --

      Specifies 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 DB cluster.

    • ReaderEndpoint (string) --

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

      If a failover occurs, and the Read 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 Read Replicas in the cluster, you can then reconnect to the reader endpoint.

    • MultiAZ (boolean) --

      Specifies whether the DB cluster has instances in multiple Availability Zones.

    • Engine (string) --

      Provides the name of the database engine to be used for this DB 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) --

      Not supported by Neptune.

    • DBClusterOptionGroupMemberships (list) --

      Not supported by Neptune.

      • (dict) --

        Not supported by Neptune.

        • DBClusterOptionGroupName (string) --

          Not supported by Neptune.

        • Status (string) --

          Not supported by Neptune.

    • 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) --

      Not supported by Neptune.

    • ReadReplicaIdentifiers (list) --

      Contains one or more identifiers of the Read Replicas associated with this DB cluster.

      • (string) --

    • DBClusterMembers (list) --

      Provides the list of instances that make up the DB cluster.

      • (dict) --

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

        • DBInstanceIdentifier (string) --

          Specifies the instance identifier for this member of the DB cluster.

        • IsClusterWriter (boolean) --

          Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.

        • DBClusterParameterGroupStatus (string) --

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

        • PromotionTier (integer) --

          A value that specifies the order in which a Read Replica is promoted to the primary instance after a failure of the existing primary instance.

    • VpcSecurityGroups (list) --

      Provides a list of VPC security groups that the DB cluster belongs to.

      • (dict) --

        This data type is used as a response element for queries on 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 DB cluster is encrypted.

    • KmsKeyId (string) --

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

    • DbClusterResourceId (string) --

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

    • DBClusterArn (string) --

      The Amazon Resource Name (ARN) for the DB cluster.

    • AssociatedRoles (list) --

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

      • (dict) --

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

        • RoleArn (string) --

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

        • Status (string) --

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

          • ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to access other Amazon services on your behalf.

          • PENDING - the IAM role ARN is being associated with the DB cluster.

          • INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other Amazon services on your behalf.

        • FeatureName (string) --

          The name of the feature associated with the Amazon Identity and Access Management (IAM) role. For the list of supported feature names, see DescribeDBEngineVersions.

    • IAMDatabaseAuthenticationEnabled (boolean) --

      True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

    • CloneGroupId (string) --

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

    • ClusterCreateTime (datetime) --

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

    • CopyTagsToSnapshot (boolean) --

      If set to true, tags are copied to any snapshot of the DB cluster that is created.

    • EnabledCloudwatchLogsExports (list) --

      A list of the log types that this DB cluster is configured to export to CloudWatch Logs. Valid log types are: audit (to publish audit logs to CloudWatch) and slowquery (to publish slow-query logs to CloudWatch). See Publishing Neptune logs to Amazon CloudWatch logs.

      • (string) --

    • PendingModifiedValues (dict) --

      This data type is used as a response element in the ModifyDBCluster operation and contains changes that will be applied during the next maintenance window.

      • PendingCloudwatchLogsExports (dict) --

        This PendingCloudwatchLogsExports structure specifies pending changes to which CloudWatch logs are enabled and which are disabled.

        • LogTypesToEnable (list) --

          Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.

          • (string) --

        • LogTypesToDisable (list) --

          Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.

          • (string) --

      • DBClusterIdentifier (string) --

        The DBClusterIdentifier value for the DB cluster.

      • IAMDatabaseAuthenticationEnabled (boolean) --

        A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

      • EngineVersion (string) --

        The database engine version.

      • BackupRetentionPeriod (integer) --

        The number of days for which automatic DB snapshots are retained.

      • StorageType (string) --

        The storage type for the DB cluster.

      • AllocatedStorage (integer) --

        The allocated storage size in gibibytes (GiB) for database engines. For Neptune, AllocatedStorage always returns 1, because Neptune DB cluster storage size isn't fixed, but instead automatically adjusts as needed.

      • Iops (integer) --

        The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters.

    • DeletionProtection (boolean) --

      Indicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.

    • CrossAccountClone (boolean) --

      If set to true, the DB cluster can be cloned across accounts.

    • AutomaticRestartTime (datetime) --

      Time at which the DB cluster will be automatically restarted.

    • ServerlessV2ScalingConfiguration (dict) --

      Shows the scaling configuration for a Neptune Serverless DB cluster.

      For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.

      • MinCapacity (float) --

        The minimum number of Neptune capacity units (NCUs) for a DB instance in a Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 8, 8.5, 9, and so on.

      • MaxCapacity (float) --

        The maximum number of Neptune capacity units (NCUs) for a DB instance in a Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 40, 40.5, 41, and so on.

    • GlobalClusterIdentifier (string) --

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

    • IOOptimizedNextAllowedModificationTime (datetime) --

      The next time you can modify the DB cluster to use the iopt1 storage type.

    • StorageType (string) --

      The storage type associated with the DB cluster.

{'DBCluster': {'IOOptimizedNextAllowedModificationTime': 'timestamp',
               'PendingModifiedValues': {'StorageType': 'string'},
               'StorageType': 'string'}}

Not supported.

See also: AWS API Documentation

Request Syntax

client.promote_read_replica_db_cluster(
    DBClusterIdentifier='string'
)

type DBClusterIdentifier:

string

param DBClusterIdentifier:

[REQUIRED]

Not supported.

rtype:

dict

returns:

Response Syntax

{
    'DBCluster': {
        'AllocatedStorage': 123,
        'AvailabilityZones': [
            'string',
        ],
        'BackupRetentionPeriod': 123,
        'CharacterSetName': 'string',
        'DatabaseName': 'string',
        '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',
        'DBClusterOptionGroupMemberships': [
            {
                'DBClusterOptionGroupName': 'string',
                'Status': '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',
                'FeatureName': 'string'
            },
        ],
        'IAMDatabaseAuthenticationEnabled': True|False,
        'CloneGroupId': 'string',
        'ClusterCreateTime': datetime(2015, 1, 1),
        'CopyTagsToSnapshot': True|False,
        'EnabledCloudwatchLogsExports': [
            'string',
        ],
        'PendingModifiedValues': {
            'PendingCloudwatchLogsExports': {
                'LogTypesToEnable': [
                    'string',
                ],
                'LogTypesToDisable': [
                    'string',
                ]
            },
            'DBClusterIdentifier': 'string',
            'IAMDatabaseAuthenticationEnabled': True|False,
            'EngineVersion': 'string',
            'BackupRetentionPeriod': 123,
            'StorageType': 'string',
            'AllocatedStorage': 123,
            'Iops': 123
        },
        'DeletionProtection': True|False,
        'CrossAccountClone': True|False,
        'AutomaticRestartTime': datetime(2015, 1, 1),
        'ServerlessV2ScalingConfiguration': {
            'MinCapacity': 123.0,
            'MaxCapacity': 123.0
        },
        'GlobalClusterIdentifier': 'string',
        'IOOptimizedNextAllowedModificationTime': datetime(2015, 1, 1),
        'StorageType': 'string'
    }
}

Response Structure

• (dict) --

  • DBCluster (dict) --

    Contains the details of an Amazon Neptune DB cluster.

    This data type is used as a response element in the DescribeDBClusters.

    • AllocatedStorage (integer) --

      AllocatedStorage always returns 1, because Neptune DB cluster storage size is not fixed, but instead automatically adjusts as needed.

    • AvailabilityZones (list) --

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

      • (string) --

    • BackupRetentionPeriod (integer) --

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

    • CharacterSetName (string) --

      Not supported by Neptune.

    • DatabaseName (string) --

      Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.

    • DBClusterIdentifier (string) --

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

    • DBClusterParameterGroup (string) --

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

    • DBSubnetGroup (string) --

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

    • Status (string) --

      Specifies the current state of this DB cluster.

    • PercentProgress (string) --

      Specifies the progress of the operation as a percentage.

    • EarliestRestorableTime (datetime) --

      Specifies 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 DB cluster.

    • ReaderEndpoint (string) --

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

      If a failover occurs, and the Read 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 Read Replicas in the cluster, you can then reconnect to the reader endpoint.

    • MultiAZ (boolean) --

      Specifies whether the DB cluster has instances in multiple Availability Zones.

    • Engine (string) --

      Provides the name of the database engine to be used for this DB 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) --

      Not supported by Neptune.

    • DBClusterOptionGroupMemberships (list) --

      Not supported by Neptune.

      • (dict) --

        Not supported by Neptune.

        • DBClusterOptionGroupName (string) --

          Not supported by Neptune.

        • Status (string) --

          Not supported by Neptune.

    • 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) --

      Not supported by Neptune.

    • ReadReplicaIdentifiers (list) --

      Contains one or more identifiers of the Read Replicas associated with this DB cluster.

      • (string) --

    • DBClusterMembers (list) --

      Provides the list of instances that make up the DB cluster.

      • (dict) --

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

        • DBInstanceIdentifier (string) --

          Specifies the instance identifier for this member of the DB cluster.

        • IsClusterWriter (boolean) --

          Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.

        • DBClusterParameterGroupStatus (string) --

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

        • PromotionTier (integer) --

          A value that specifies the order in which a Read Replica is promoted to the primary instance after a failure of the existing primary instance.

    • VpcSecurityGroups (list) --

      Provides a list of VPC security groups that the DB cluster belongs to.

      • (dict) --

        This data type is used as a response element for queries on 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 DB cluster is encrypted.

    • KmsKeyId (string) --

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

    • DbClusterResourceId (string) --

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

    • DBClusterArn (string) --

      The Amazon Resource Name (ARN) for the DB cluster.

    • AssociatedRoles (list) --

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

      • (dict) --

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

        • RoleArn (string) --

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

        • Status (string) --

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

          • ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to access other Amazon services on your behalf.

          • PENDING - the IAM role ARN is being associated with the DB cluster.

          • INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other Amazon services on your behalf.

        • FeatureName (string) --

          The name of the feature associated with the Amazon Identity and Access Management (IAM) role. For the list of supported feature names, see DescribeDBEngineVersions.

    • IAMDatabaseAuthenticationEnabled (boolean) --

      True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

    • CloneGroupId (string) --

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

    • ClusterCreateTime (datetime) --

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

    • CopyTagsToSnapshot (boolean) --

      If set to true, tags are copied to any snapshot of the DB cluster that is created.

    • EnabledCloudwatchLogsExports (list) --

      A list of the log types that this DB cluster is configured to export to CloudWatch Logs. Valid log types are: audit (to publish audit logs to CloudWatch) and slowquery (to publish slow-query logs to CloudWatch). See Publishing Neptune logs to Amazon CloudWatch logs.

      • (string) --

    • PendingModifiedValues (dict) --

      This data type is used as a response element in the ModifyDBCluster operation and contains changes that will be applied during the next maintenance window.

      • PendingCloudwatchLogsExports (dict) --

        This PendingCloudwatchLogsExports structure specifies pending changes to which CloudWatch logs are enabled and which are disabled.

        • LogTypesToEnable (list) --

          Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.

          • (string) --

        • LogTypesToDisable (list) --

          Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.

          • (string) --

      • DBClusterIdentifier (string) --

        The DBClusterIdentifier value for the DB cluster.

      • IAMDatabaseAuthenticationEnabled (boolean) --

        A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

      • EngineVersion (string) --

        The database engine version.

      • BackupRetentionPeriod (integer) --

        The number of days for which automatic DB snapshots are retained.

      • StorageType (string) --

        The storage type for the DB cluster.

      • AllocatedStorage (integer) --

        The allocated storage size in gibibytes (GiB) for database engines. For Neptune, AllocatedStorage always returns 1, because Neptune DB cluster storage size isn't fixed, but instead automatically adjusts as needed.

      • Iops (integer) --

        The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters.

    • DeletionProtection (boolean) --

      Indicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.

    • CrossAccountClone (boolean) --

      If set to true, the DB cluster can be cloned across accounts.

    • AutomaticRestartTime (datetime) --

      Time at which the DB cluster will be automatically restarted.

    • ServerlessV2ScalingConfiguration (dict) --

      Shows the scaling configuration for a Neptune Serverless DB cluster.

      For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.

      • MinCapacity (float) --

        The minimum number of Neptune capacity units (NCUs) for a DB instance in a Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 8, 8.5, 9, and so on.

      • MaxCapacity (float) --

        The maximum number of Neptune capacity units (NCUs) for a DB instance in a Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 40, 40.5, 41, and so on.

    • GlobalClusterIdentifier (string) --

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

    • IOOptimizedNextAllowedModificationTime (datetime) --

      The next time you can modify the DB cluster to use the iopt1 storage type.

    • StorageType (string) --

      The storage type associated with the DB cluster.

{'StorageType': 'string'}

{'DBCluster': {'IOOptimizedNextAllowedModificationTime': 'timestamp',
               'PendingModifiedValues': {'StorageType': 'string'},
               'StorageType': 'string'}}

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.

If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.

See also: AWS API Documentation

Request Syntax

client.restore_db_cluster_from_snapshot(
    AvailabilityZones=[
        'string',
    ],
    DBClusterIdentifier='string',
    SnapshotIdentifier='string',
    Engine='string',
    EngineVersion='string',
    Port=123,
    DBSubnetGroupName='string',
    DatabaseName='string',
    OptionGroupName='string',
    VpcSecurityGroupIds=[
        'string',
    ],
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    KmsKeyId='string',
    EnableIAMDatabaseAuthentication=True|False,
    EnableCloudwatchLogsExports=[
        'string',
    ],
    DBClusterParameterGroupName='string',
    DeletionProtection=True|False,
    CopyTagsToSnapshot=True|False,
    ServerlessV2ScalingConfiguration={
        'MinCapacity': 123.0,
        'MaxCapacity': 123.0
    },
    StorageType='string'
)

type AvailabilityZones:

list

param AvailabilityZones:

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

• (string) --

type DBClusterIdentifier:

string

param DBClusterIdentifier:

[REQUIRED]

The name of the DB cluster to create from the DB snapshot or DB cluster snapshot. This parameter isn't case-sensitive.

Constraints:

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

• First character must be a letter

• Cannot end with a hyphen or contain two consecutive hyphens

Example: my-snapshot-id

type SnapshotIdentifier:

string

param SnapshotIdentifier:

[REQUIRED]

The identifier for the DB snapshot or DB cluster snapshot to restore from.

You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.

Constraints:

• Must match the identifier of an existing Snapshot.

type Engine:

string

param Engine:

[REQUIRED]

The database engine to use for the new DB cluster.

Default: The same as source

Constraint: Must be compatible with the engine of the source

type EngineVersion:

string

param EngineVersion:

The version of the database engine to use for the new DB cluster.

type Port:

integer

param Port:

The port number on which the new DB cluster accepts connections.

Constraints: Value must be 1150-65535

Default: The same port as the original DB cluster.

type DBSubnetGroupName:

string

param DBSubnetGroupName:

The name of the DB subnet group to use for the new DB cluster.

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

Example: mySubnetgroup

type DatabaseName:

string

param DatabaseName:

Not supported.

type OptionGroupName:

string

param OptionGroupName:

(Not supported by Neptune)

type VpcSecurityGroupIds:

list

param VpcSecurityGroupIds:

A list of VPC security groups that the new DB cluster will belong to.

• (string) --

type Tags:

list

param Tags:

The tags to be assigned to the restored DB cluster.

• (dict) --

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

  • Key (string) --

    A key is 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 only contain the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").

  • Value (string) --

    A value is 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 only contain the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").

type KmsKeyId:

string

param KmsKeyId:

The Amazon KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same Amazon account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.

If you do not specify a value for the KmsKeyId parameter, then the following will occur:

• If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the DB snapshot or DB cluster snapshot.

• If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is not encrypted, then the restored DB cluster is not encrypted.

type EnableIAMDatabaseAuthentication:

boolean

param EnableIAMDatabaseAuthentication:

True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

type EnableCloudwatchLogsExports:

list

param EnableCloudwatchLogsExports:

The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs.

• (string) --

type DBClusterParameterGroupName:

string

param DBClusterParameterGroupName:

The name of the DB cluster parameter group to associate with the new DB cluster.

Constraints:

• If supplied, must match the name of an existing DBClusterParameterGroup.

type DeletionProtection:

boolean

param DeletionProtection:

A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.

type CopyTagsToSnapshot:

boolean

param CopyTagsToSnapshot:

If set to true, tags are copied to any snapshot of the restored DB cluster that is created.

type ServerlessV2ScalingConfiguration:

dict

param ServerlessV2ScalingConfiguration:

Contains the scaling configuration of a Neptune Serverless DB cluster.

For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.

• MinCapacity (float) --

  The minimum number of Neptune capacity units (NCUs) for a DB instance in a Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 8, 8.5, 9, and so on.

• MaxCapacity (float) --

  The maximum number of Neptune capacity units (NCUs) for a DB instance in a Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 40, 40.5, 41, and so on.

type StorageType:

string

param StorageType:

Specifies the storage type to be associated with the DB cluster.

Valid values: standard, iopt1

Default: standard

rtype:

dict

returns:

Response Syntax

{
    'DBCluster': {
        'AllocatedStorage': 123,
        'AvailabilityZones': [
            'string',
        ],
        'BackupRetentionPeriod': 123,
        'CharacterSetName': 'string',
        'DatabaseName': 'string',
        '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',
        'DBClusterOptionGroupMemberships': [
            {
                'DBClusterOptionGroupName': 'string',
                'Status': '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',
                'FeatureName': 'string'
            },
        ],
        'IAMDatabaseAuthenticationEnabled': True|False,
        'CloneGroupId': 'string',
        'ClusterCreateTime': datetime(2015, 1, 1),
        'CopyTagsToSnapshot': True|False,
        'EnabledCloudwatchLogsExports': [
            'string',
        ],
        'PendingModifiedValues': {
            'PendingCloudwatchLogsExports': {
                'LogTypesToEnable': [
                    'string',
                ],
                'LogTypesToDisable': [
                    'string',
                ]
            },
            'DBClusterIdentifier': 'string',
            'IAMDatabaseAuthenticationEnabled': True|False,
            'EngineVersion': 'string',
            'BackupRetentionPeriod': 123,
            'StorageType': 'string',
            'AllocatedStorage': 123,
            'Iops': 123
        },
        'DeletionProtection': True|False,
        'CrossAccountClone': True|False,
        'AutomaticRestartTime': datetime(2015, 1, 1),
        'ServerlessV2ScalingConfiguration': {
            'MinCapacity': 123.0,
            'MaxCapacity': 123.0
        },
        'GlobalClusterIdentifier': 'string',
        'IOOptimizedNextAllowedModificationTime': datetime(2015, 1, 1),
        'StorageType': 'string'
    }
}

Response Structure

• (dict) --

  • DBCluster (dict) --

    Contains the details of an Amazon Neptune DB cluster.

    This data type is used as a response element in the DescribeDBClusters.

    • AllocatedStorage (integer) --

      AllocatedStorage always returns 1, because Neptune DB cluster storage size is not fixed, but instead automatically adjusts as needed.

    • AvailabilityZones (list) --

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

      • (string) --

    • BackupRetentionPeriod (integer) --

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

    • CharacterSetName (string) --

      Not supported by Neptune.

    • DatabaseName (string) --

      Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.

    • DBClusterIdentifier (string) --

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

    • DBClusterParameterGroup (string) --

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

    • DBSubnetGroup (string) --

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

    • Status (string) --

      Specifies the current state of this DB cluster.

    • PercentProgress (string) --

      Specifies the progress of the operation as a percentage.

    • EarliestRestorableTime (datetime) --

      Specifies 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 DB cluster.

    • ReaderEndpoint (string) --

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

      If a failover occurs, and the Read 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 Read Replicas in the cluster, you can then reconnect to the reader endpoint.

    • MultiAZ (boolean) --

      Specifies whether the DB cluster has instances in multiple Availability Zones.

    • Engine (string) --

      Provides the name of the database engine to be used for this DB 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) --

      Not supported by Neptune.

    • DBClusterOptionGroupMemberships (list) --

      Not supported by Neptune.

      • (dict) --

        Not supported by Neptune.

        • DBClusterOptionGroupName (string) --

          Not supported by Neptune.

        • Status (string) --

          Not supported by Neptune.

    • 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) --

      Not supported by Neptune.

    • ReadReplicaIdentifiers (list) --

      Contains one or more identifiers of the Read Replicas associated with this DB cluster.

      • (string) --

    • DBClusterMembers (list) --

      Provides the list of instances that make up the DB cluster.

      • (dict) --

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

        • DBInstanceIdentifier (string) --

          Specifies the instance identifier for this member of the DB cluster.

        • IsClusterWriter (boolean) --

          Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.

        • DBClusterParameterGroupStatus (string) --

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

        • PromotionTier (integer) --

          A value that specifies the order in which a Read Replica is promoted to the primary instance after a failure of the existing primary instance.

    • VpcSecurityGroups (list) --

      Provides a list of VPC security groups that the DB cluster belongs to.

      • (dict) --

        This data type is used as a response element for queries on 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 DB cluster is encrypted.

    • KmsKeyId (string) --

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

    • DbClusterResourceId (string) --

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

    • DBClusterArn (string) --

      The Amazon Resource Name (ARN) for the DB cluster.

    • AssociatedRoles (list) --

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

      • (dict) --

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

        • RoleArn (string) --

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

        • Status (string) --

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

          • ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to access other Amazon services on your behalf.

          • PENDING - the IAM role ARN is being associated with the DB cluster.

          • INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other Amazon services on your behalf.

        • FeatureName (string) --

          The name of the feature associated with the Amazon Identity and Access Management (IAM) role. For the list of supported feature names, see DescribeDBEngineVersions.

    • IAMDatabaseAuthenticationEnabled (boolean) --

      True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

    • CloneGroupId (string) --

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

    • ClusterCreateTime (datetime) --

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

    • CopyTagsToSnapshot (boolean) --

      If set to true, tags are copied to any snapshot of the DB cluster that is created.

    • EnabledCloudwatchLogsExports (list) --

      A list of the log types that this DB cluster is configured to export to CloudWatch Logs. Valid log types are: audit (to publish audit logs to CloudWatch) and slowquery (to publish slow-query logs to CloudWatch). See Publishing Neptune logs to Amazon CloudWatch logs.

      • (string) --

    • PendingModifiedValues (dict) --

      This data type is used as a response element in the ModifyDBCluster operation and contains changes that will be applied during the next maintenance window.

      • PendingCloudwatchLogsExports (dict) --

        This PendingCloudwatchLogsExports structure specifies pending changes to which CloudWatch logs are enabled and which are disabled.

        • LogTypesToEnable (list) --

          Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.

          • (string) --

        • LogTypesToDisable (list) --

          Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.

          • (string) --

      • DBClusterIdentifier (string) --

        The DBClusterIdentifier value for the DB cluster.

      • IAMDatabaseAuthenticationEnabled (boolean) --

        A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

      • EngineVersion (string) --

        The database engine version.

      • BackupRetentionPeriod (integer) --

        The number of days for which automatic DB snapshots are retained.

      • StorageType (string) --

        The storage type for the DB cluster.

      • AllocatedStorage (integer) --

        The allocated storage size in gibibytes (GiB) for database engines. For Neptune, AllocatedStorage always returns 1, because Neptune DB cluster storage size isn't fixed, but instead automatically adjusts as needed.

      • Iops (integer) --

        The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters.

    • DeletionProtection (boolean) --

      Indicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.

    • CrossAccountClone (boolean) --

      If set to true, the DB cluster can be cloned across accounts.

    • AutomaticRestartTime (datetime) --

      Time at which the DB cluster will be automatically restarted.

    • ServerlessV2ScalingConfiguration (dict) --

      Shows the scaling configuration for a Neptune Serverless DB cluster.

      For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.

      • MinCapacity (float) --

        The minimum number of Neptune capacity units (NCUs) for a DB instance in a Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 8, 8.5, 9, and so on.

      • MaxCapacity (float) --

        The maximum number of Neptune capacity units (NCUs) for a DB instance in a Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 40, 40.5, 41, and so on.

    • GlobalClusterIdentifier (string) --

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

    • IOOptimizedNextAllowedModificationTime (datetime) --

      The next time you can modify the DB cluster to use the iopt1 storage type.

    • StorageType (string) --

      The storage type associated with the DB cluster.

{'StorageType': 'string'}

{'DBCluster': {'IOOptimizedNextAllowedModificationTime': 'timestamp',
               'PendingModifiedValues': {'StorageType': 'string'},
               'StorageType': 'string'}}

Restores a DB cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB security group.

See also: AWS API Documentation

Request Syntax

client.restore_db_cluster_to_point_in_time(
    DBClusterIdentifier='string',
    RestoreType='string',
    SourceDBClusterIdentifier='string',
    RestoreToTime=datetime(2015, 1, 1),
    UseLatestRestorableTime=True|False,
    Port=123,
    DBSubnetGroupName='string',
    OptionGroupName='string',
    VpcSecurityGroupIds=[
        'string',
    ],
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    KmsKeyId='string',
    EnableIAMDatabaseAuthentication=True|False,
    EnableCloudwatchLogsExports=[
        'string',
    ],
    DBClusterParameterGroupName='string',
    DeletionProtection=True|False,
    ServerlessV2ScalingConfiguration={
        'MinCapacity': 123.0,
        'MaxCapacity': 123.0
    },
    StorageType='string'
)

type DBClusterIdentifier:

string

param DBClusterIdentifier:

[REQUIRED]

The name of the new DB cluster to be created.

Constraints:

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

• First character must be a letter

• Cannot end with a hyphen or contain two consecutive hyphens

type RestoreType:

string

param RestoreType:

The type of restore to be performed. You can specify one of the following values:

• full-copy - The new DB cluster is restored as a full copy of the source DB cluster.

• copy-on-write - The new DB cluster is restored as a clone of the source DB cluster.

If you don't specify a RestoreType value, then the new DB cluster is restored as a full copy of the source DB cluster.

type SourceDBClusterIdentifier:

string

param SourceDBClusterIdentifier:

[REQUIRED]

The identifier of the source DB cluster from which to restore.

Constraints:

• Must match the identifier of an existing DBCluster.

type RestoreToTime:

datetime

param RestoreToTime:

The date and time to restore the DB cluster to.

Valid Values: Value must be a time in Universal Coordinated Time (UTC) format

Constraints:

• Must be before the latest restorable time for the DB instance

• Must be specified if UseLatestRestorableTime parameter is not provided

• Cannot be specified if UseLatestRestorableTime parameter is true

• Cannot be specified if RestoreType parameter is copy-on-write

Example: 2015-03-07T23:45:00Z

type UseLatestRestorableTime:

boolean

param UseLatestRestorableTime:

A value that is set to true to restore the DB cluster to the latest restorable backup time, and false otherwise.

Default: false

Constraints: Cannot be specified if RestoreToTime parameter is provided.

type Port:

integer

param Port:

The port number on which the new DB cluster accepts connections.

Constraints: Value must be 1150-65535

Default: The same port as the original DB cluster.

type DBSubnetGroupName:

string

param DBSubnetGroupName:

The DB subnet group name to use for the new DB cluster.

Constraints: If supplied, must match the name of an existing DBSubnetGroup.

Example: mySubnetgroup

type OptionGroupName:

string

param OptionGroupName:

(Not supported by Neptune)

type VpcSecurityGroupIds:

list

param VpcSecurityGroupIds:

A list of VPC security groups that the new DB cluster belongs to.

• (string) --

type Tags:

list

param Tags:

The tags to be applied to the restored DB cluster.

• (dict) --

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

  • Key (string) --

    A key is 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 only contain the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").

  • Value (string) --

    A value is 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 only contain the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").

type KmsKeyId:

string

param KmsKeyId:

The Amazon KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster.

The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are restoring a DB cluster with the same Amazon account that owns the KMS encryption key used to encrypt the new DB cluster, then you can use the KMS key alias instead of the ARN for the KMS encryption key.

You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different than the KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the KMS key identified by the KmsKeyId parameter.

If you do not specify a value for the KmsKeyId parameter, then the following will occur:

• If the DB cluster is encrypted, then the restored DB cluster is encrypted using the KMS key that was used to encrypt the source DB cluster.

• If the DB cluster is not encrypted, then the restored DB cluster is not encrypted.

If DBClusterIdentifier refers to a DB cluster that is not encrypted, then the restore request is rejected.

type EnableIAMDatabaseAuthentication:

boolean

param EnableIAMDatabaseAuthentication:

True to enable mapping of Amazon Identity and Access Management (IAM) accounts to database accounts, and otherwise false.

Default: false

type EnableCloudwatchLogsExports:

list

param EnableCloudwatchLogsExports:

The list of logs that the restored DB cluster is to export to CloudWatch Logs.

• (string) --

type DBClusterParameterGroupName:

string

param DBClusterParameterGroupName:

The name of the DB cluster parameter group to associate with the new DB cluster.

Constraints:

• If supplied, must match the name of an existing DBClusterParameterGroup.

type DeletionProtection:

boolean

param DeletionProtection:

A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.

type ServerlessV2ScalingConfiguration:

dict

param ServerlessV2ScalingConfiguration:

Contains the scaling configuration of a Neptune Serverless DB cluster.

For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.

• MinCapacity (float) --

  The minimum number of Neptune capacity units (NCUs) for a DB instance in a Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 8, 8.5, 9, and so on.

• MaxCapacity (float) --

  The maximum number of Neptune capacity units (NCUs) for a DB instance in a Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 40, 40.5, 41, and so on.

type StorageType:

string

param StorageType:

Specifies the storage type to be associated with the DB cluster.

Valid values: standard, iopt1

Default: standard

rtype:

dict

returns:

Response Syntax

{
    'DBCluster': {
        'AllocatedStorage': 123,
        'AvailabilityZones': [
            'string',
        ],
        'BackupRetentionPeriod': 123,
        'CharacterSetName': 'string',
        'DatabaseName': 'string',
        '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',
        'DBClusterOptionGroupMemberships': [
            {
                'DBClusterOptionGroupName': 'string',
                'Status': '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',
                'FeatureName': 'string'
            },
        ],
        'IAMDatabaseAuthenticationEnabled': True|False,
        'CloneGroupId': 'string',
        'ClusterCreateTime': datetime(2015, 1, 1),
        'CopyTagsToSnapshot': True|False,
        'EnabledCloudwatchLogsExports': [
            'string',
        ],
        'PendingModifiedValues': {
            'PendingCloudwatchLogsExports': {
                'LogTypesToEnable': [
                    'string',
                ],
                'LogTypesToDisable': [
                    'string',
                ]
            },
            'DBClusterIdentifier': 'string',
            'IAMDatabaseAuthenticationEnabled': True|False,
            'EngineVersion': 'string',
            'BackupRetentionPeriod': 123,
            'StorageType': 'string',
            'AllocatedStorage': 123,
            'Iops': 123
        },
        'DeletionProtection': True|False,
        'CrossAccountClone': True|False,
        'AutomaticRestartTime': datetime(2015, 1, 1),
        'ServerlessV2ScalingConfiguration': {
            'MinCapacity': 123.0,
            'MaxCapacity': 123.0
        },
        'GlobalClusterIdentifier': 'string',
        'IOOptimizedNextAllowedModificationTime': datetime(2015, 1, 1),
        'StorageType': 'string'
    }
}

Response Structure

• (dict) --

  • DBCluster (dict) --

    Contains the details of an Amazon Neptune DB cluster.

    This data type is used as a response element in the DescribeDBClusters.

    • AllocatedStorage (integer) --

      AllocatedStorage always returns 1, because Neptune DB cluster storage size is not fixed, but instead automatically adjusts as needed.

    • AvailabilityZones (list) --

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

      • (string) --

    • BackupRetentionPeriod (integer) --

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

    • CharacterSetName (string) --

      Not supported by Neptune.

    • DatabaseName (string) --

      Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.

    • DBClusterIdentifier (string) --

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

    • DBClusterParameterGroup (string) --

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

    • DBSubnetGroup (string) --

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

    • Status (string) --

      Specifies the current state of this DB cluster.

    • PercentProgress (string) --

      Specifies the progress of the operation as a percentage.

    • EarliestRestorableTime (datetime) --

      Specifies 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 DB cluster.

    • ReaderEndpoint (string) --

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

      If a failover occurs, and the Read 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 Read Replicas in the cluster, you can then reconnect to the reader endpoint.

    • MultiAZ (boolean) --

      Specifies whether the DB cluster has instances in multiple Availability Zones.

    • Engine (string) --

      Provides the name of the database engine to be used for this DB 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) --

      Not supported by Neptune.

    • DBClusterOptionGroupMemberships (list) --

      Not supported by Neptune.

      • (dict) --

        Not supported by Neptune.

        • DBClusterOptionGroupName (string) --

          Not supported by Neptune.

        • Status (string) --

          Not supported by Neptune.

    • 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) --

      Not supported by Neptune.

    • ReadReplicaIdentifiers (list) --

      Contains one or more identifiers of the Read Replicas associated with this DB cluster.

      • (string) --

    • DBClusterMembers (list) --

      Provides the list of instances that make up the DB cluster.

      • (dict) --

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

        • DBInstanceIdentifier (string) --

          Specifies the instance identifier for this member of the DB cluster.

        • IsClusterWriter (boolean) --

          Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.

        • DBClusterParameterGroupStatus (string) --

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

        • PromotionTier (integer) --

          A value that specifies the order in which a Read Replica is promoted to the primary instance after a failure of the existing primary instance.

    • VpcSecurityGroups (list) --

      Provides a list of VPC security groups that the DB cluster belongs to.

      • (dict) --

        This data type is used as a response element for queries on 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 DB cluster is encrypted.

    • KmsKeyId (string) --

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

    • DbClusterResourceId (string) --

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

    • DBClusterArn (string) --

      The Amazon Resource Name (ARN) for the DB cluster.

    • AssociatedRoles (list) --

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

      • (dict) --

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

        • RoleArn (string) --

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

        • Status (string) --

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

          • ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to access other Amazon services on your behalf.

          • PENDING - the IAM role ARN is being associated with the DB cluster.

          • INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other Amazon services on your behalf.

        • FeatureName (string) --

          The name of the feature associated with the Amazon Identity and Access Management (IAM) role. For the list of supported feature names, see DescribeDBEngineVersions.

    • IAMDatabaseAuthenticationEnabled (boolean) --

      True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

    • CloneGroupId (string) --

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

    • ClusterCreateTime (datetime) --

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

    • CopyTagsToSnapshot (boolean) --

      If set to true, tags are copied to any snapshot of the DB cluster that is created.

    • EnabledCloudwatchLogsExports (list) --

      A list of the log types that this DB cluster is configured to export to CloudWatch Logs. Valid log types are: audit (to publish audit logs to CloudWatch) and slowquery (to publish slow-query logs to CloudWatch). See Publishing Neptune logs to Amazon CloudWatch logs.

      • (string) --

    • PendingModifiedValues (dict) --

      This data type is used as a response element in the ModifyDBCluster operation and contains changes that will be applied during the next maintenance window.

      • PendingCloudwatchLogsExports (dict) --

        This PendingCloudwatchLogsExports structure specifies pending changes to which CloudWatch logs are enabled and which are disabled.

        • LogTypesToEnable (list) --

          Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.

          • (string) --

        • LogTypesToDisable (list) --

          Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.

          • (string) --

      • DBClusterIdentifier (string) --

        The DBClusterIdentifier value for the DB cluster.

      • IAMDatabaseAuthenticationEnabled (boolean) --

        A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

      • EngineVersion (string) --

        The database engine version.

      • BackupRetentionPeriod (integer) --

        The number of days for which automatic DB snapshots are retained.

      • StorageType (string) --

        The storage type for the DB cluster.

      • AllocatedStorage (integer) --

        The allocated storage size in gibibytes (GiB) for database engines. For Neptune, AllocatedStorage always returns 1, because Neptune DB cluster storage size isn't fixed, but instead automatically adjusts as needed.

      • Iops (integer) --

        The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters.

    • DeletionProtection (boolean) --

      Indicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.

    • CrossAccountClone (boolean) --

      If set to true, the DB cluster can be cloned across accounts.

    • AutomaticRestartTime (datetime) --

      Time at which the DB cluster will be automatically restarted.

    • ServerlessV2ScalingConfiguration (dict) --

      Shows the scaling configuration for a Neptune Serverless DB cluster.

      For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.

      • MinCapacity (float) --

        The minimum number of Neptune capacity units (NCUs) for a DB instance in a Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 8, 8.5, 9, and so on.

      • MaxCapacity (float) --

        The maximum number of Neptune capacity units (NCUs) for a DB instance in a Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 40, 40.5, 41, and so on.

    • GlobalClusterIdentifier (string) --

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

    • IOOptimizedNextAllowedModificationTime (datetime) --

      The next time you can modify the DB cluster to use the iopt1 storage type.

    • StorageType (string) --

      The storage type associated with the DB cluster.

{'DBCluster': {'IOOptimizedNextAllowedModificationTime': 'timestamp',
               'PendingModifiedValues': {'StorageType': 'string'},
               'StorageType': 'string'}}

Starts an Amazon Neptune DB cluster that was stopped using the Amazon console, the Amazon CLI stop-db-cluster command, or the StopDBCluster API.

See also: AWS API Documentation

Request Syntax

client.start_db_cluster(
    DBClusterIdentifier='string'
)

type DBClusterIdentifier:

string

param DBClusterIdentifier:

[REQUIRED]

The DB cluster identifier of the Neptune DB cluster to be started. This parameter is stored as a lowercase string.

rtype:

dict

returns:

Response Syntax

{
    'DBCluster': {
        'AllocatedStorage': 123,
        'AvailabilityZones': [
            'string',
        ],
        'BackupRetentionPeriod': 123,
        'CharacterSetName': 'string',
        'DatabaseName': 'string',
        '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',
        'DBClusterOptionGroupMemberships': [
            {
                'DBClusterOptionGroupName': 'string',
                'Status': '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',
                'FeatureName': 'string'
            },
        ],
        'IAMDatabaseAuthenticationEnabled': True|False,
        'CloneGroupId': 'string',
        'ClusterCreateTime': datetime(2015, 1, 1),
        'CopyTagsToSnapshot': True|False,
        'EnabledCloudwatchLogsExports': [
            'string',
        ],
        'PendingModifiedValues': {
            'PendingCloudwatchLogsExports': {
                'LogTypesToEnable': [
                    'string',
                ],
                'LogTypesToDisable': [
                    'string',
                ]
            },
            'DBClusterIdentifier': 'string',
            'IAMDatabaseAuthenticationEnabled': True|False,
            'EngineVersion': 'string',
            'BackupRetentionPeriod': 123,
            'StorageType': 'string',
            'AllocatedStorage': 123,
            'Iops': 123
        },
        'DeletionProtection': True|False,
        'CrossAccountClone': True|False,
        'AutomaticRestartTime': datetime(2015, 1, 1),
        'ServerlessV2ScalingConfiguration': {
            'MinCapacity': 123.0,
            'MaxCapacity': 123.0
        },
        'GlobalClusterIdentifier': 'string',
        'IOOptimizedNextAllowedModificationTime': datetime(2015, 1, 1),
        'StorageType': 'string'
    }
}

Response Structure

• (dict) --

  • DBCluster (dict) --

    Contains the details of an Amazon Neptune DB cluster.

    This data type is used as a response element in the DescribeDBClusters.

    • AllocatedStorage (integer) --

      AllocatedStorage always returns 1, because Neptune DB cluster storage size is not fixed, but instead automatically adjusts as needed.

    • AvailabilityZones (list) --

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

      • (string) --

    • BackupRetentionPeriod (integer) --

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

    • CharacterSetName (string) --

      Not supported by Neptune.

    • DatabaseName (string) --

      Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.

    • DBClusterIdentifier (string) --

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

    • DBClusterParameterGroup (string) --

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

    • DBSubnetGroup (string) --

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

    • Status (string) --

      Specifies the current state of this DB cluster.

    • PercentProgress (string) --

      Specifies the progress of the operation as a percentage.

    • EarliestRestorableTime (datetime) --

      Specifies 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 DB cluster.

    • ReaderEndpoint (string) --

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

      If a failover occurs, and the Read 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 Read Replicas in the cluster, you can then reconnect to the reader endpoint.

    • MultiAZ (boolean) --

      Specifies whether the DB cluster has instances in multiple Availability Zones.

    • Engine (string) --

      Provides the name of the database engine to be used for this DB 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) --

      Not supported by Neptune.

    • DBClusterOptionGroupMemberships (list) --

      Not supported by Neptune.

      • (dict) --

        Not supported by Neptune.

        • DBClusterOptionGroupName (string) --

          Not supported by Neptune.

        • Status (string) --

          Not supported by Neptune.

    • 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) --

      Not supported by Neptune.

    • ReadReplicaIdentifiers (list) --

      Contains one or more identifiers of the Read Replicas associated with this DB cluster.

      • (string) --

    • DBClusterMembers (list) --

      Provides the list of instances that make up the DB cluster.

      • (dict) --

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

        • DBInstanceIdentifier (string) --

          Specifies the instance identifier for this member of the DB cluster.

        • IsClusterWriter (boolean) --

          Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.

        • DBClusterParameterGroupStatus (string) --

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

        • PromotionTier (integer) --

          A value that specifies the order in which a Read Replica is promoted to the primary instance after a failure of the existing primary instance.

    • VpcSecurityGroups (list) --

      Provides a list of VPC security groups that the DB cluster belongs to.

      • (dict) --

        This data type is used as a response element for queries on 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 DB cluster is encrypted.

    • KmsKeyId (string) --

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

    • DbClusterResourceId (string) --

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

    • DBClusterArn (string) --

      The Amazon Resource Name (ARN) for the DB cluster.

    • AssociatedRoles (list) --

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

      • (dict) --

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

        • RoleArn (string) --

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

        • Status (string) --

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

          • ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to access other Amazon services on your behalf.

          • PENDING - the IAM role ARN is being associated with the DB cluster.

          • INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other Amazon services on your behalf.

        • FeatureName (string) --

          The name of the feature associated with the Amazon Identity and Access Management (IAM) role. For the list of supported feature names, see DescribeDBEngineVersions.

    • IAMDatabaseAuthenticationEnabled (boolean) --

      True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

    • CloneGroupId (string) --

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

    • ClusterCreateTime (datetime) --

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

    • CopyTagsToSnapshot (boolean) --

      If set to true, tags are copied to any snapshot of the DB cluster that is created.

    • EnabledCloudwatchLogsExports (list) --

      A list of the log types that this DB cluster is configured to export to CloudWatch Logs. Valid log types are: audit (to publish audit logs to CloudWatch) and slowquery (to publish slow-query logs to CloudWatch). See Publishing Neptune logs to Amazon CloudWatch logs.

      • (string) --

    • PendingModifiedValues (dict) --

      This data type is used as a response element in the ModifyDBCluster operation and contains changes that will be applied during the next maintenance window.

      • PendingCloudwatchLogsExports (dict) --

        This PendingCloudwatchLogsExports structure specifies pending changes to which CloudWatch logs are enabled and which are disabled.

        • LogTypesToEnable (list) --

          Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.

          • (string) --

        • LogTypesToDisable (list) --

          Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.

          • (string) --

      • DBClusterIdentifier (string) --

        The DBClusterIdentifier value for the DB cluster.

      • IAMDatabaseAuthenticationEnabled (boolean) --

        A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

      • EngineVersion (string) --

        The database engine version.

      • BackupRetentionPeriod (integer) --

        The number of days for which automatic DB snapshots are retained.

      • StorageType (string) --

        The storage type for the DB cluster.

      • AllocatedStorage (integer) --

        The allocated storage size in gibibytes (GiB) for database engines. For Neptune, AllocatedStorage always returns 1, because Neptune DB cluster storage size isn't fixed, but instead automatically adjusts as needed.

      • Iops (integer) --

        The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters.

    • DeletionProtection (boolean) --

      Indicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.

    • CrossAccountClone (boolean) --

      If set to true, the DB cluster can be cloned across accounts.

    • AutomaticRestartTime (datetime) --

      Time at which the DB cluster will be automatically restarted.

    • ServerlessV2ScalingConfiguration (dict) --

      Shows the scaling configuration for a Neptune Serverless DB cluster.

      For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.

      • MinCapacity (float) --

        The minimum number of Neptune capacity units (NCUs) for a DB instance in a Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 8, 8.5, 9, and so on.

      • MaxCapacity (float) --

        The maximum number of Neptune capacity units (NCUs) for a DB instance in a Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 40, 40.5, 41, and so on.

    • GlobalClusterIdentifier (string) --

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

    • IOOptimizedNextAllowedModificationTime (datetime) --

      The next time you can modify the DB cluster to use the iopt1 storage type.

    • StorageType (string) --

      The storage type associated with the DB cluster.

{'DBCluster': {'IOOptimizedNextAllowedModificationTime': 'timestamp',
               'PendingModifiedValues': {'StorageType': 'string'},
               'StorageType': 'string'}}

Stops an Amazon Neptune DB cluster. When you stop a DB cluster, Neptune retains the DB cluster's metadata, including its endpoints and DB parameter groups.

Neptune also retains the transaction logs so you can do a point-in-time restore if necessary.

See also: AWS API Documentation

Request Syntax

client.stop_db_cluster(
    DBClusterIdentifier='string'
)

type DBClusterIdentifier:

string

param DBClusterIdentifier:

[REQUIRED]

The DB cluster identifier of the Neptune DB cluster to be stopped. This parameter is stored as a lowercase string.

rtype:

dict

returns:

Response Syntax

{
    'DBCluster': {
        'AllocatedStorage': 123,
        'AvailabilityZones': [
            'string',
        ],
        'BackupRetentionPeriod': 123,
        'CharacterSetName': 'string',
        'DatabaseName': 'string',
        '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',
        'DBClusterOptionGroupMemberships': [
            {
                'DBClusterOptionGroupName': 'string',
                'Status': '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',
                'FeatureName': 'string'
            },
        ],
        'IAMDatabaseAuthenticationEnabled': True|False,
        'CloneGroupId': 'string',
        'ClusterCreateTime': datetime(2015, 1, 1),
        'CopyTagsToSnapshot': True|False,
        'EnabledCloudwatchLogsExports': [
            'string',
        ],
        'PendingModifiedValues': {
            'PendingCloudwatchLogsExports': {
                'LogTypesToEnable': [
                    'string',
                ],
                'LogTypesToDisable': [
                    'string',
                ]
            },
            'DBClusterIdentifier': 'string',
            'IAMDatabaseAuthenticationEnabled': True|False,
            'EngineVersion': 'string',
            'BackupRetentionPeriod': 123,
            'StorageType': 'string',
            'AllocatedStorage': 123,
            'Iops': 123
        },
        'DeletionProtection': True|False,
        'CrossAccountClone': True|False,
        'AutomaticRestartTime': datetime(2015, 1, 1),
        'ServerlessV2ScalingConfiguration': {
            'MinCapacity': 123.0,
            'MaxCapacity': 123.0
        },
        'GlobalClusterIdentifier': 'string',
        'IOOptimizedNextAllowedModificationTime': datetime(2015, 1, 1),
        'StorageType': 'string'
    }
}

Response Structure

• (dict) --

  • DBCluster (dict) --

    Contains the details of an Amazon Neptune DB cluster.

    This data type is used as a response element in the DescribeDBClusters.

    • AllocatedStorage (integer) --

      AllocatedStorage always returns 1, because Neptune DB cluster storage size is not fixed, but instead automatically adjusts as needed.

    • AvailabilityZones (list) --

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

      • (string) --

    • BackupRetentionPeriod (integer) --

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

    • CharacterSetName (string) --

      Not supported by Neptune.

    • DatabaseName (string) --

      Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.

    • DBClusterIdentifier (string) --

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

    • DBClusterParameterGroup (string) --

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

    • DBSubnetGroup (string) --

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

    • Status (string) --

      Specifies the current state of this DB cluster.

    • PercentProgress (string) --

      Specifies the progress of the operation as a percentage.

    • EarliestRestorableTime (datetime) --

      Specifies 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 DB cluster.

    • ReaderEndpoint (string) --

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

      If a failover occurs, and the Read 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 Read Replicas in the cluster, you can then reconnect to the reader endpoint.

    • MultiAZ (boolean) --

      Specifies whether the DB cluster has instances in multiple Availability Zones.

    • Engine (string) --

      Provides the name of the database engine to be used for this DB 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) --

      Not supported by Neptune.

    • DBClusterOptionGroupMemberships (list) --

      Not supported by Neptune.

      • (dict) --

        Not supported by Neptune.

        • DBClusterOptionGroupName (string) --

          Not supported by Neptune.

        • Status (string) --

          Not supported by Neptune.

    • 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) --

      Not supported by Neptune.

    • ReadReplicaIdentifiers (list) --

      Contains one or more identifiers of the Read Replicas associated with this DB cluster.

      • (string) --

    • DBClusterMembers (list) --

      Provides the list of instances that make up the DB cluster.

      • (dict) --

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

        • DBInstanceIdentifier (string) --

          Specifies the instance identifier for this member of the DB cluster.

        • IsClusterWriter (boolean) --

          Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.

        • DBClusterParameterGroupStatus (string) --

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

        • PromotionTier (integer) --

          A value that specifies the order in which a Read Replica is promoted to the primary instance after a failure of the existing primary instance.

    • VpcSecurityGroups (list) --

      Provides a list of VPC security groups that the DB cluster belongs to.

      • (dict) --

        This data type is used as a response element for queries on 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 DB cluster is encrypted.

    • KmsKeyId (string) --

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

    • DbClusterResourceId (string) --

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

    • DBClusterArn (string) --

      The Amazon Resource Name (ARN) for the DB cluster.

    • AssociatedRoles (list) --

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

      • (dict) --

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

        • RoleArn (string) --

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

        • Status (string) --

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

          • ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to access other Amazon services on your behalf.

          • PENDING - the IAM role ARN is being associated with the DB cluster.

          • INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other Amazon services on your behalf.

        • FeatureName (string) --

          The name of the feature associated with the Amazon Identity and Access Management (IAM) role. For the list of supported feature names, see DescribeDBEngineVersions.

    • IAMDatabaseAuthenticationEnabled (boolean) --

      True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

    • CloneGroupId (string) --

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

    • ClusterCreateTime (datetime) --

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

    • CopyTagsToSnapshot (boolean) --

      If set to true, tags are copied to any snapshot of the DB cluster that is created.

    • EnabledCloudwatchLogsExports (list) --

      A list of the log types that this DB cluster is configured to export to CloudWatch Logs. Valid log types are: audit (to publish audit logs to CloudWatch) and slowquery (to publish slow-query logs to CloudWatch). See Publishing Neptune logs to Amazon CloudWatch logs.

      • (string) --

    • PendingModifiedValues (dict) --

      This data type is used as a response element in the ModifyDBCluster operation and contains changes that will be applied during the next maintenance window.

      • PendingCloudwatchLogsExports (dict) --

        This PendingCloudwatchLogsExports structure specifies pending changes to which CloudWatch logs are enabled and which are disabled.

        • LogTypesToEnable (list) --

          Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs.

          • (string) --

        • LogTypesToDisable (list) --

          Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs.

          • (string) --

      • DBClusterIdentifier (string) --

        The DBClusterIdentifier value for the DB cluster.

      • IAMDatabaseAuthenticationEnabled (boolean) --

        A value that indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

      • EngineVersion (string) --

        The database engine version.

      • BackupRetentionPeriod (integer) --

        The number of days for which automatic DB snapshots are retained.

      • StorageType (string) --

        The storage type for the DB cluster.

      • AllocatedStorage (integer) --

        The allocated storage size in gibibytes (GiB) for database engines. For Neptune, AllocatedStorage always returns 1, because Neptune DB cluster storage size isn't fixed, but instead automatically adjusts as needed.

      • Iops (integer) --

        The Provisioned IOPS (I/O operations per second) value. This setting is only for non-Aurora Multi-AZ DB clusters.

    • DeletionProtection (boolean) --

      Indicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.

    • CrossAccountClone (boolean) --

      If set to true, the DB cluster can be cloned across accounts.

    • AutomaticRestartTime (datetime) --

      Time at which the DB cluster will be automatically restarted.

    • ServerlessV2ScalingConfiguration (dict) --

      Shows the scaling configuration for a Neptune Serverless DB cluster.

      For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.

      • MinCapacity (float) --

        The minimum number of Neptune capacity units (NCUs) for a DB instance in a Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 8, 8.5, 9, and so on.

      • MaxCapacity (float) --

        The maximum number of Neptune capacity units (NCUs) for a DB instance in a Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 40, 40.5, 41, and so on.

    • GlobalClusterIdentifier (string) --

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

    • IOOptimizedNextAllowedModificationTime (datetime) --

      The next time you can modify the DB cluster to use the iopt1 storage type.

    • StorageType (string) --

      The storage type associated with the DB cluster.