Neptune DB Clusters API - Amazon Neptune

Neptune DB Clusters API

Structures:

Actions:

DBCluster (structure)

Contains the details of an Amazon Neptune DB cluster.

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

Fields

  • AllocatedStorage – Number (integer).

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

  • AssociatedRoles – An array of DBClusterRole DBClusterRole objects.

    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.

  • AutomaticRestartTime – Timestamp.

    Time at which the DB cluster will be automatically restarted.

  • AvailabilityZones – An array of AvailabilityZone— UTF-8 strings.

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

  • BacktrackConsumedChangeRecords – Number (long).

    Not supported by Neptune.

  • BacktrackWindow – Number (long).

    Not supported by Neptune.

  • BackupRetentionPeriod – Number (integer).

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

  • Capacity – Number (integer).

    Not supported by Neptune.

  • CloneGroupId – UTF-8 string.

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

  • ClusterCreateTime – Timestamp.

    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.

  • CrossAccountClone – Boolean.

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

  • DatabaseName – UTF-8 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.

  • DBClusterArn – UTF-8 string.

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

  • DBClusterIdentifier – UTF-8 string.

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

  • DBClusterMembers – An array of DBClusterMember DBClusterMember objects.

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

  • DBClusterParameterGroup – UTF-8 string.

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

  • DbClusterResourceId – UTF-8 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.

  • DBSubnetGroup – UTF-8 string.

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

  • DeletionProtection – Boolean.

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

  • EarliestBacktrackTime – Timestamp.

    Not supported by Neptune.

  • EarliestRestorableTime – Timestamp.

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

  • EnabledCloudwatchLogsExports – An array of UTF-8 strings.

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

  • Endpoint – UTF-8 string.

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

  • Engine – UTF-8 string.

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

  • EngineVersion – UTF-8 string.

    Indicates the database engine version.

  • HostedZoneId – UTF-8 string.

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

  • IAMDatabaseAuthenticationEnabled – Boolean.

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

  • KmsKeyId – UTF-8 string.

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

  • LatestRestorableTime – Timestamp.

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

  • MultiAZ – Boolean.

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

  • PendingModifiedValues – A ClusterPendingModifiedValues object.

    Not supported by Neptune.

  • PercentProgress – UTF-8 string.

    Specifies the progress of the operation as a percentage.

  • Port – Number (integer).

    Specifies the port that the database engine is listening on.

  • PreferredBackupWindow – UTF-8 string.

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

  • PreferredMaintenanceWindow – UTF-8 string.

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

  • ReaderEndpoint – UTF-8 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.

  • ReadReplicaIdentifiers – An array of ReadReplicaIdentifier— UTF-8 strings.

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

  • ReplicationSourceIdentifier – UTF-8 string.

    Not supported by Neptune.

  • ReplicationType – UTF-8 string.

    Not supported by Neptune.

  • Status – UTF-8 string.

    Specifies the current state of this DB cluster.

  • StorageEncrypted – Boolean.

    Specifies whether the DB cluster is encrypted.

  • VpcSecurityGroups – An array of VpcSecurityGroupMembership VpcSecurityGroupMembership objects.

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

DBCluster is used as the response element for:

DBClusterMember (structure)

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

Fields

  • DBClusterParameterGroupStatus – UTF-8 string.

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

  • DBInstanceIdentifier – UTF-8 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.

  • PromotionTier – Number (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.

DBClusterRole (structure)

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

Fields

  • FeatureName – UTF-8 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.

  • RoleArn – UTF-8 string.

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

  • Status – UTF-8 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.

ClusterPendingModifiedValues (structure)

Defines pending changes to a DB Cluster.

Fields

  • PendingCloudwatchLogsExports – A PendingCloudwatchLogsExports object.

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

CreateDBCluster (action)

        The Amazon CLI name for this API is: create-db-cluster,  and the Python name is: create_db_cluster.

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.

Request

  • AvailabilityZones  (in the CLI: --availability-zones,  or in Python: availability_zones) – An array of AvailabilityZone— UTF-8 strings.

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

  • BackupRetentionPeriod  (in the CLI: --backup-retention-period,  or in Python: backup_retention_period) – Number (integer).

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

    Default: 1

    Constraints:

    • Must be a value from 1 to 35

  • CopyTagsToSnapshot  (in the CLI: --copy-tags-to-snapshot,  or in Python: copy_tags_to_snapshot) – Boolean.

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

  • DatabaseName  (in the CLI: --database-name,  or in Python: database_name) – UTF-8 string.

    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.

  • DBClusterIdentifier  (in the CLI: --db-cluster-identifier,  or in Python: db_cluster_identifier) – Required: UTF-8 string.

    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

  • DBClusterParameterGroupName  (in the CLI: --db-cluster-parameter-group-name,  or in Python: db_cluster_parameter_group_name) – UTF-8 string.

    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.

  • DBSubnetGroupName  (in the CLI: --db-subnet-group-name,  or in Python: db_subnet_group_name) – UTF-8 string.

    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

  • DeletionProtection  (in the CLI: --deletion-protection,  or in Python: deletion_protection) – Boolean.

    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.

  • EnableCloudwatchLogsExports  (in the CLI: --enable-cloudwatch-logs-exports,  or in Python: enable_cloudwatch_logs_exports) – An array of UTF-8 strings.

    The list of log types that need to be enabled for exporting to CloudWatch Logs.

  • EnableIAMDatabaseAuthentication  (in the CLI: --enable-iam-database-authentication,  or in Python: enable_iam_database_authentication) – Boolean.

    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.

  • Engine  (in the CLI: --engine,  or in Python: engine) – Required: UTF-8 string.

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

    Valid Values: neptune

  • EngineVersion  (in the CLI: --engine-version,  or in Python: engine_version) – UTF-8 string.

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

    Example: 1.0.2.1

  • GlobalClusterIdentifier  (in the CLI: --global-cluster-identifier,  or in Python: global_cluster_identifier) – UTF-8 string, not less than 1 or more than 255 bytes long, matching the regular expression: '[A-Za-z][0-9A-Za-z-:._]*'.

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

  • KmsKeyId  (in the CLI: --kms-key-id,  or in Python: kms_key_id) – UTF-8 string.

    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.

  • Port  (in the CLI: --port,  or in Python: port) – Number (integer).

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

    Default: 8182

  • PreferredBackupWindow  (in the CLI: --preferred-backup-window,  or in Python: preferred_backup_window) – UTF-8 string.

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

    The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Region. To see the time blocks available, see Adjusting the Preferred 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.

  • PreferredMaintenanceWindow  (in the CLI: --preferred-maintenance-window,  or in Python: preferred_maintenance_window) – UTF-8 string.

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

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

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

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

    Constraints: Minimum 30-minute window.

  • PreSignedUrl  (in the CLI: --pre-signed-url,  or in Python: pre_signed_url) – UTF-8 string.

    This parameter is not currently supported.

  • ReplicationSourceIdentifier  (in the CLI: --replication-source-identifier,  or in Python: replication_source_identifier) – UTF-8 string.

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

  • StorageEncrypted  (in the CLI: --storage-encrypted,  or in Python: storage_encrypted) – Boolean.

    Specifies whether the DB cluster is encrypted.

  • Tags  (in the CLI: --tags,  or in Python: tags) – An array of Tag Tag objects.

    The tags to assign to the new DB cluster.

  • VpcSecurityGroupIds  (in the CLI: --vpc-security-group-ids,  or in Python: vpc_security_group_ids) – An array of VpcSecurityGroupId— UTF-8 strings.

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

Response

Contains the details of an Amazon Neptune DB cluster.

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

  • AllocatedStorage  (in the CLI: --allocated-storage,  or in Python: allocated_storage) – Number (integer).

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

  • AssociatedRoles  (in the CLI: --associated-roles,  or in Python: associated_roles) – An array of DBClusterRole DBClusterRole objects.

    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.

  • AutomaticRestartTime  (in the CLI: --automatic-restart-time,  or in Python: automatic_restart_time) – Timestamp.

    Time at which the DB cluster will be automatically restarted.

  • AvailabilityZones  (in the CLI: --availability-zones,  or in Python: availability_zones) – An array of AvailabilityZone— UTF-8 strings.

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

  • BacktrackConsumedChangeRecords  (in the CLI: --backtrack-consumed-change-records,  or in Python: backtrack_consumed_change_records) – Number (long).

    Not supported by Neptune.

  • BacktrackWindow  (in the CLI: --backtrack-window,  or in Python: backtrack_window) – Number (long).

    Not supported by Neptune.

  • BackupRetentionPeriod  (in the CLI: --backup-retention-period,  or in Python: backup_retention_period) – Number (integer).

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

  • Capacity  (in the CLI: --capacity,  or in Python: capacity) – Number (integer).

    Not supported by Neptune.

  • CloneGroupId  (in the CLI: --clone-group-id,  or in Python: clone_group_id) – UTF-8 string.

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

  • ClusterCreateTime  (in the CLI: --cluster-create-time,  or in Python: cluster_create_time) – Timestamp.

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

  • CopyTagsToSnapshot  (in the CLI: --copy-tags-to-snapshot,  or in Python: copy_tags_to_snapshot) – Boolean.

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

  • CrossAccountClone  (in the CLI: --cross-account-clone,  or in Python: cross_account_clone) – Boolean.

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

  • DatabaseName  (in the CLI: --database-name,  or in Python: database_name) – UTF-8 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.

  • DBClusterArn  (in the CLI: --db-cluster-arn,  or in Python: db_cluster_arn) – UTF-8 string.

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

  • DBClusterIdentifier  (in the CLI: --db-cluster-identifier,  or in Python: db_cluster_identifier) – UTF-8 string.

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

  • DBClusterMembers  (in the CLI: --db-cluster-members,  or in Python: db_cluster_members) – An array of DBClusterMember DBClusterMember objects.

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

  • DBClusterParameterGroup  (in the CLI: --db-cluster-parameter-group,  or in Python: db_cluster_parameter_group) – UTF-8 string.

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

  • DbClusterResourceId  (in the CLI: --db-cluster-resource-id,  or in Python: db_cluster_resource_id) – UTF-8 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.

  • DBSubnetGroup  (in the CLI: --db-subnet-group,  or in Python: db_subnet_group) – UTF-8 string.

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

  • DeletionProtection  (in the CLI: --deletion-protection,  or in Python: deletion_protection) – Boolean.

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

  • EarliestBacktrackTime  (in the CLI: --earliest-backtrack-time,  or in Python: earliest_backtrack_time) – Timestamp.

    Not supported by Neptune.

  • EarliestRestorableTime  (in the CLI: --earliest-restorable-time,  or in Python: earliest_restorable_time) – Timestamp.

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

  • EnabledCloudwatchLogsExports  (in the CLI: --enabled-cloudwatch-logs-exports,  or in Python: enabled_cloudwatch_logs_exports) – An array of UTF-8 strings.

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

  • Endpoint  (in the CLI: --endpoint,  or in Python: endpoint) – UTF-8 string.

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

  • Engine  (in the CLI: --engine,  or in Python: engine) – UTF-8 string.

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

  • EngineVersion  (in the CLI: --engine-version,  or in Python: engine_version) – UTF-8 string.

    Indicates the database engine version.

  • HostedZoneId  (in the CLI: --hosted-zone-id,  or in Python: hosted_zone_id) – UTF-8 string.

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

  • IAMDatabaseAuthenticationEnabled  (in the CLI: --iam-database-authentication-enabled,  or in Python: iam_database_authentication_enabled) – Boolean.

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

  • KmsKeyId  (in the CLI: --kms-key-id,  or in Python: kms_key_id) – UTF-8 string.

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

  • LatestRestorableTime  (in the CLI: --latest-restorable-time,  or in Python: latest_restorable_time) – Timestamp.

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

  • MultiAZ  (in the CLI: --multi-az,  or in Python: multi_az) – Boolean.

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

  • PendingModifiedValues  (in the CLI: --pending-modified-values,  or in Python: pending_modified_values) – A ClusterPendingModifiedValues object.

    Not supported by Neptune.

  • PercentProgress  (in the CLI: --percent-progress,  or in Python: percent_progress) – UTF-8 string.

    Specifies the progress of the operation as a percentage.

  • Port  (in the CLI: --port,  or in Python: port) – Number (integer).

    Specifies the port that the database engine is listening on.

  • PreferredBackupWindow  (in the CLI: --preferred-backup-window,  or in Python: preferred_backup_window) – UTF-8 string.

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

  • PreferredMaintenanceWindow  (in the CLI: --preferred-maintenance-window,  or in Python: preferred_maintenance_window) – UTF-8 string.

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

  • ReaderEndpoint  (in the CLI: --reader-endpoint,  or in Python: reader_endpoint) – UTF-8 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.

  • ReadReplicaIdentifiers  (in the CLI: --read-replica-identifiers,  or in Python: read_replica_identifiers) – An array of ReadReplicaIdentifier— UTF-8 strings.

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

  • ReplicationSourceIdentifier  (in the CLI: --replication-source-identifier,  or in Python: replication_source_identifier) – UTF-8 string.

    Not supported by Neptune.

  • ReplicationType  (in the CLI: --replication-type,  or in Python: replication_type) – UTF-8 string.

    Not supported by Neptune.

  • Status  (in the CLI: --status,  or in Python: status) – UTF-8 string.

    Specifies the current state of this DB cluster.

  • StorageEncrypted  (in the CLI: --storage-encrypted,  or in Python: storage_encrypted) – Boolean.

    Specifies whether the DB cluster is encrypted.

  • VpcSecurityGroups  (in the CLI: --vpc-security-groups,  or in Python: vpc_security_groups) – An array of VpcSecurityGroupMembership VpcSecurityGroupMembership objects.

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

DeleteDBCluster (action)

        The Amazon CLI name for this API is: delete-db-cluster,  and the Python name is: delete_db_cluster.

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.

Request

  • DBClusterIdentifier  (in the CLI: --db-cluster-identifier,  or in Python: db_cluster_identifier) – Required: UTF-8 string.

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

    Constraints:

    • Must match an existing DBClusterIdentifier.

  • FinalDBSnapshotIdentifier  (in the CLI: --final-db-snapshot-identifier,  or in Python: final_db_snapshot_identifier) – UTF-8 string.

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

    Note

    Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error.

    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

  • SkipFinalSnapshot  (in the CLI: --skip-final-snapshot,  or in Python: skip_final_snapshot) – Boolean.

    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.

    Note

    You must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is false.

    Default: false

Response

Contains the details of an Amazon Neptune DB cluster.

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

  • AllocatedStorage  (in the CLI: --allocated-storage,  or in Python: allocated_storage) – Number (integer).

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

  • AssociatedRoles  (in the CLI: --associated-roles,  or in Python: associated_roles) – An array of DBClusterRole DBClusterRole objects.

    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.

  • AutomaticRestartTime  (in the CLI: --automatic-restart-time,  or in Python: automatic_restart_time) – Timestamp.

    Time at which the DB cluster will be automatically restarted.

  • AvailabilityZones  (in the CLI: --availability-zones,  or in Python: availability_zones) – An array of AvailabilityZone— UTF-8 strings.

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

  • BacktrackConsumedChangeRecords  (in the CLI: --backtrack-consumed-change-records,  or in Python: backtrack_consumed_change_records) – Number (long).

    Not supported by Neptune.

  • BacktrackWindow  (in the CLI: --backtrack-window,  or in Python: backtrack_window) – Number (long).

    Not supported by Neptune.

  • BackupRetentionPeriod  (in the CLI: --backup-retention-period,  or in Python: backup_retention_period) – Number (integer).

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

  • Capacity  (in the CLI: --capacity,  or in Python: capacity) – Number (integer).

    Not supported by Neptune.

  • CloneGroupId  (in the CLI: --clone-group-id,  or in Python: clone_group_id) – UTF-8 string.

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

  • ClusterCreateTime  (in the CLI: --cluster-create-time,  or in Python: cluster_create_time) – Timestamp.

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

  • CopyTagsToSnapshot  (in the CLI: --copy-tags-to-snapshot,  or in Python: copy_tags_to_snapshot) – Boolean.

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

  • CrossAccountClone  (in the CLI: --cross-account-clone,  or in Python: cross_account_clone) – Boolean.

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

  • DatabaseName  (in the CLI: --database-name,  or in Python: database_name) – UTF-8 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.

  • DBClusterArn  (in the CLI: --db-cluster-arn,  or in Python: db_cluster_arn) – UTF-8 string.

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

  • DBClusterIdentifier  (in the CLI: --db-cluster-identifier,  or in Python: db_cluster_identifier) – UTF-8 string.

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

  • DBClusterMembers  (in the CLI: --db-cluster-members,  or in Python: db_cluster_members) – An array of DBClusterMember DBClusterMember objects.

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

  • DBClusterParameterGroup  (in the CLI: --db-cluster-parameter-group,  or in Python: db_cluster_parameter_group) – UTF-8 string.

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

  • DbClusterResourceId  (in the CLI: --db-cluster-resource-id,  or in Python: db_cluster_resource_id) – UTF-8 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.

  • DBSubnetGroup  (in the CLI: --db-subnet-group,  or in Python: db_subnet_group) – UTF-8 string.

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

  • DeletionProtection  (in the CLI: --deletion-protection,  or in Python: deletion_protection) – Boolean.

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

  • EarliestBacktrackTime  (in the CLI: --earliest-backtrack-time,  or in Python: earliest_backtrack_time) – Timestamp.

    Not supported by Neptune.

  • EarliestRestorableTime  (in the CLI: --earliest-restorable-time,  or in Python: earliest_restorable_time) – Timestamp.

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

  • EnabledCloudwatchLogsExports  (in the CLI: --enabled-cloudwatch-logs-exports,  or in Python: enabled_cloudwatch_logs_exports) – An array of UTF-8 strings.

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

  • Endpoint  (in the CLI: --endpoint,  or in Python: endpoint) – UTF-8 string.

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

  • Engine  (in the CLI: --engine,  or in Python: engine) – UTF-8 string.

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

  • EngineVersion  (in the CLI: --engine-version,  or in Python: engine_version) – UTF-8 string.

    Indicates the database engine version.

  • HostedZoneId  (in the CLI: --hosted-zone-id,  or in Python: hosted_zone_id) – UTF-8 string.

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

  • IAMDatabaseAuthenticationEnabled  (in the CLI: --iam-database-authentication-enabled,  or in Python: iam_database_authentication_enabled) – Boolean.

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

  • KmsKeyId  (in the CLI: --kms-key-id,  or in Python: kms_key_id) – UTF-8 string.

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

  • LatestRestorableTime  (in the CLI: --latest-restorable-time,  or in Python: latest_restorable_time) – Timestamp.

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

  • MultiAZ  (in the CLI: --multi-az,  or in Python: multi_az) – Boolean.

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

  • PendingModifiedValues  (in the CLI: --pending-modified-values,  or in Python: pending_modified_values) – A ClusterPendingModifiedValues object.

    Not supported by Neptune.

  • PercentProgress  (in the CLI: --percent-progress,  or in Python: percent_progress) – UTF-8 string.

    Specifies the progress of the operation as a percentage.

  • Port  (in the CLI: --port,  or in Python: port) – Number (integer).

    Specifies the port that the database engine is listening on.

  • PreferredBackupWindow  (in the CLI: --preferred-backup-window,  or in Python: preferred_backup_window) – UTF-8 string.

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

  • PreferredMaintenanceWindow  (in the CLI: --preferred-maintenance-window,  or in Python: preferred_maintenance_window) – UTF-8 string.

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

  • ReaderEndpoint  (in the CLI: --reader-endpoint,  or in Python: reader_endpoint) – UTF-8 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.

  • ReadReplicaIdentifiers  (in the CLI: --read-replica-identifiers,  or in Python: read_replica_identifiers) – An array of ReadReplicaIdentifier— UTF-8 strings.

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

  • ReplicationSourceIdentifier  (in the CLI: --replication-source-identifier,  or in Python: replication_source_identifier) – UTF-8 string.

    Not supported by Neptune.

  • ReplicationType  (in the CLI: --replication-type,  or in Python: replication_type) – UTF-8 string.

    Not supported by Neptune.

  • Status  (in the CLI: --status,  or in Python: status) – UTF-8 string.

    Specifies the current state of this DB cluster.

  • StorageEncrypted  (in the CLI: --storage-encrypted,  or in Python: storage_encrypted) – Boolean.

    Specifies whether the DB cluster is encrypted.

  • VpcSecurityGroups  (in the CLI: --vpc-security-groups,  or in Python: vpc_security_groups) – An array of VpcSecurityGroupMembership VpcSecurityGroupMembership objects.

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

ModifyDBCluster (action)

        The Amazon CLI name for this API is: modify-db-cluster,  and the Python name is: modify_db_cluster.

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.

Request

  • AllowMajorVersionUpgrade  (in the CLI: --allow-major-version-upgrade,  or in Python: allow_major_version_upgrade) – Boolean.

    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.

  • ApplyImmediately  (in the CLI: --apply-immediately,  or in Python: apply_immediately) – Boolean.

    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

  • BackupRetentionPeriod  (in the CLI: --backup-retention-period,  or in Python: backup_retention_period) – Number (integer).

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

    Default: 1

    Constraints:

    • Must be a value from 1 to 35

  • CloudwatchLogsExportConfiguration  (in the CLI: --cloudwatch-logs-export-configuration,  or in Python: cloudwatch_logs_export_configuration) – A CloudwatchLogsExportConfiguration object.

    The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB cluster.

  • CopyTagsToSnapshot  (in the CLI: --copy-tags-to-snapshot,  or in Python: copy_tags_to_snapshot) – Boolean.

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

  • DBClusterIdentifier  (in the CLI: --db-cluster-identifier,  or in Python: db_cluster_identifier) – Required: UTF-8 string.

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

    Constraints:

    • Must match the identifier of an existing DBCluster.

  • DBClusterParameterGroupName  (in the CLI: --db-cluster-parameter-group-name,  or in Python: db_cluster_parameter_group_name) – UTF-8 string.

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

  • DBInstanceParameterGroupName  (in the CLI: --db-instance-parameter-group-name,  or in Python: db_instance_parameter_group_name) – UTF-8 string.

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

    Note

    When you apply a parameter group using DBInstanceParameterGroupName, parameter changes aren't applied during the next maintenance window but instead are applied immediately.

    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.

  • DeletionProtection  (in the CLI: --deletion-protection,  or in Python: deletion_protection) – Boolean.

    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.

  • EnableIAMDatabaseAuthentication  (in the CLI: --enable-iam-database-authentication,  or in Python: enable_iam_database_authentication) – Boolean.

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

    Default: false

  • EngineVersion  (in the CLI: --engine-version,  or in Python: engine_version) – UTF-8 string.

    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.

  • NewDBClusterIdentifier  (in the CLI: --new-db-cluster-identifier,  or in Python: new_db_cluster_identifier) – UTF-8 string.

    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

  • Port  (in the CLI: --port,  or in Python: port) – Number (integer).

    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.

  • PreferredBackupWindow  (in the CLI: --preferred-backup-window,  or in Python: preferred_backup_window) – UTF-8 string.

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

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

    Constraints:

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

    • Must be in Universal Coordinated Time (UTC).

    • Must not conflict with the preferred maintenance window.

    • Must be at least 30 minutes.

  • PreferredMaintenanceWindow  (in the CLI: --preferred-maintenance-window,  or in Python: preferred_maintenance_window) – UTF-8 string.

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

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

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

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

    Constraints: Minimum 30-minute window.

  • VpcSecurityGroupIds  (in the CLI: --vpc-security-group-ids,  or in Python: vpc_security_group_ids) – An array of VpcSecurityGroupId— UTF-8 strings.

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

Response

Contains the details of an Amazon Neptune DB cluster.

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

  • AllocatedStorage  (in the CLI: --allocated-storage,  or in Python: allocated_storage) – Number (integer).

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

  • AssociatedRoles  (in the CLI: --associated-roles,  or in Python: associated_roles) – An array of DBClusterRole DBClusterRole objects.

    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.

  • AutomaticRestartTime  (in the CLI: --automatic-restart-time,  or in Python: automatic_restart_time) – Timestamp.

    Time at which the DB cluster will be automatically restarted.

  • AvailabilityZones  (in the CLI: --availability-zones,  or in Python: availability_zones) – An array of AvailabilityZone— UTF-8 strings.

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

  • BacktrackConsumedChangeRecords  (in the CLI: --backtrack-consumed-change-records,  or in Python: backtrack_consumed_change_records) – Number (long).

    Not supported by Neptune.

  • BacktrackWindow  (in the CLI: --backtrack-window,  or in Python: backtrack_window) – Number (long).

    Not supported by Neptune.

  • BackupRetentionPeriod  (in the CLI: --backup-retention-period,  or in Python: backup_retention_period) – Number (integer).

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

  • Capacity  (in the CLI: --capacity,  or in Python: capacity) – Number (integer).

    Not supported by Neptune.

  • CloneGroupId  (in the CLI: --clone-group-id,  or in Python: clone_group_id) – UTF-8 string.

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

  • ClusterCreateTime  (in the CLI: --cluster-create-time,  or in Python: cluster_create_time) – Timestamp.

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

  • CopyTagsToSnapshot  (in the CLI: --copy-tags-to-snapshot,  or in Python: copy_tags_to_snapshot) – Boolean.

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

  • CrossAccountClone  (in the CLI: --cross-account-clone,  or in Python: cross_account_clone) – Boolean.

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

  • DatabaseName  (in the CLI: --database-name,  or in Python: database_name) – UTF-8 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.

  • DBClusterArn  (in the CLI: --db-cluster-arn,  or in Python: db_cluster_arn) – UTF-8 string.

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

  • DBClusterIdentifier  (in the CLI: --db-cluster-identifier,  or in Python: db_cluster_identifier) – UTF-8 string.

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

  • DBClusterMembers  (in the CLI: --db-cluster-members,  or in Python: db_cluster_members) – An array of DBClusterMember DBClusterMember objects.

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

  • DBClusterParameterGroup  (in the CLI: --db-cluster-parameter-group,  or in Python: db_cluster_parameter_group) – UTF-8 string.

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

  • DbClusterResourceId  (in the CLI: --db-cluster-resource-id,  or in Python: db_cluster_resource_id) – UTF-8 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.

  • DBSubnetGroup  (in the CLI: --db-subnet-group,  or in Python: db_subnet_group) – UTF-8 string.

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

  • DeletionProtection  (in the CLI: --deletion-protection,  or in Python: deletion_protection) – Boolean.

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

  • EarliestBacktrackTime  (in the CLI: --earliest-backtrack-time,  or in Python: earliest_backtrack_time) – Timestamp.

    Not supported by Neptune.

  • EarliestRestorableTime  (in the CLI: --earliest-restorable-time,  or in Python: earliest_restorable_time) – Timestamp.

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

  • EnabledCloudwatchLogsExports  (in the CLI: --enabled-cloudwatch-logs-exports,  or in Python: enabled_cloudwatch_logs_exports) – An array of UTF-8 strings.

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

  • Endpoint  (in the CLI: --endpoint,  or in Python: endpoint) – UTF-8 string.

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

  • Engine  (in the CLI: --engine,  or in Python: engine) – UTF-8 string.

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

  • EngineVersion  (in the CLI: --engine-version,  or in Python: engine_version) – UTF-8 string.

    Indicates the database engine version.

  • HostedZoneId  (in the CLI: --hosted-zone-id,  or in Python: hosted_zone_id) – UTF-8 string.

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

  • IAMDatabaseAuthenticationEnabled  (in the CLI: --iam-database-authentication-enabled,  or in Python: iam_database_authentication_enabled) – Boolean.

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

  • KmsKeyId  (in the CLI: --kms-key-id,  or in Python: kms_key_id) – UTF-8 string.

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

  • LatestRestorableTime  (in the CLI: --latest-restorable-time,  or in Python: latest_restorable_time) – Timestamp.

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

  • MultiAZ  (in the CLI: --multi-az,  or in Python: multi_az) – Boolean.

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

  • PendingModifiedValues  (in the CLI: --pending-modified-values,  or in Python: pending_modified_values) – A ClusterPendingModifiedValues object.

    Not supported by Neptune.

  • PercentProgress  (in the CLI: --percent-progress,  or in Python: percent_progress) – UTF-8 string.

    Specifies the progress of the operation as a percentage.

  • Port  (in the CLI: --port,  or in Python: port) – Number (integer).

    Specifies the port that the database engine is listening on.

  • PreferredBackupWindow  (in the CLI: --preferred-backup-window,  or in Python: preferred_backup_window) – UTF-8 string.

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

  • PreferredMaintenanceWindow  (in the CLI: --preferred-maintenance-window,  or in Python: preferred_maintenance_window) – UTF-8 string.

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

  • ReaderEndpoint  (in the CLI: --reader-endpoint,  or in Python: reader_endpoint) – UTF-8 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.

  • ReadReplicaIdentifiers  (in the CLI: --read-replica-identifiers,  or in Python: read_replica_identifiers) – An array of ReadReplicaIdentifier— UTF-8 strings.

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

  • ReplicationSourceIdentifier  (in the CLI: --replication-source-identifier,  or in Python: replication_source_identifier) – UTF-8 string.

    Not supported by Neptune.

  • ReplicationType  (in the CLI: --replication-type,  or in Python: replication_type) – UTF-8 string.

    Not supported by Neptune.

  • Status  (in the CLI: --status,  or in Python: status) – UTF-8 string.

    Specifies the current state of this DB cluster.

  • StorageEncrypted  (in the CLI: --storage-encrypted,  or in Python: storage_encrypted) – Boolean.

    Specifies whether the DB cluster is encrypted.

  • VpcSecurityGroups  (in the CLI: --vpc-security-groups,  or in Python: vpc_security_groups) – An array of VpcSecurityGroupMembership VpcSecurityGroupMembership objects.

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

StartDBCluster (action)

        The Amazon CLI name for this API is: start-db-cluster,  and the Python name is: start_db_cluster.

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

Request

  • DBClusterIdentifier  (in the CLI: --db-cluster-identifier,  or in Python: db_cluster_identifier) – Required: UTF-8 string.

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

Response

Contains the details of an Amazon Neptune DB cluster.

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

  • AllocatedStorage  (in the CLI: --allocated-storage,  or in Python: allocated_storage) – Number (integer).

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

  • AssociatedRoles  (in the CLI: --associated-roles,  or in Python: associated_roles) – An array of DBClusterRole DBClusterRole objects.

    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.

  • AutomaticRestartTime  (in the CLI: --automatic-restart-time,  or in Python: automatic_restart_time) – Timestamp.

    Time at which the DB cluster will be automatically restarted.

  • AvailabilityZones  (in the CLI: --availability-zones,  or in Python: availability_zones) – An array of AvailabilityZone— UTF-8 strings.

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

  • BacktrackConsumedChangeRecords  (in the CLI: --backtrack-consumed-change-records,  or in Python: backtrack_consumed_change_records) – Number (long).

    Not supported by Neptune.

  • BacktrackWindow  (in the CLI: --backtrack-window,  or in Python: backtrack_window) – Number (long).

    Not supported by Neptune.

  • BackupRetentionPeriod  (in the CLI: --backup-retention-period,  or in Python: backup_retention_period) – Number (integer).

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

  • Capacity  (in the CLI: --capacity,  or in Python: capacity) – Number (integer).

    Not supported by Neptune.

  • CloneGroupId  (in the CLI: --clone-group-id,  or in Python: clone_group_id) – UTF-8 string.

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

  • ClusterCreateTime  (in the CLI: --cluster-create-time,  or in Python: cluster_create_time) – Timestamp.

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

  • CopyTagsToSnapshot  (in the CLI: --copy-tags-to-snapshot,  or in Python: copy_tags_to_snapshot) – Boolean.

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

  • CrossAccountClone  (in the CLI: --cross-account-clone,  or in Python: cross_account_clone) – Boolean.

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

  • DatabaseName  (in the CLI: --database-name,  or in Python: database_name) – UTF-8 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.

  • DBClusterArn  (in the CLI: --db-cluster-arn,  or in Python: db_cluster_arn) – UTF-8 string.

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

  • DBClusterIdentifier  (in the CLI: --db-cluster-identifier,  or in Python: db_cluster_identifier) – UTF-8 string.

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

  • DBClusterMembers  (in the CLI: --db-cluster-members,  or in Python: db_cluster_members) – An array of DBClusterMember DBClusterMember objects.

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

  • DBClusterParameterGroup  (in the CLI: --db-cluster-parameter-group,  or in Python: db_cluster_parameter_group) – UTF-8 string.

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

  • DbClusterResourceId  (in the CLI: --db-cluster-resource-id,  or in Python: db_cluster_resource_id) – UTF-8 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.

  • DBSubnetGroup  (in the CLI: --db-subnet-group,  or in Python: db_subnet_group) – UTF-8 string.

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

  • DeletionProtection  (in the CLI: --deletion-protection,  or in Python: deletion_protection) – Boolean.

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

  • EarliestBacktrackTime  (in the CLI: --earliest-backtrack-time,  or in Python: earliest_backtrack_time) – Timestamp.

    Not supported by Neptune.

  • EarliestRestorableTime  (in the CLI: --earliest-restorable-time,  or in Python: earliest_restorable_time) – Timestamp.

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

  • EnabledCloudwatchLogsExports  (in the CLI: --enabled-cloudwatch-logs-exports,  or in Python: enabled_cloudwatch_logs_exports) – An array of UTF-8 strings.

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

  • Endpoint  (in the CLI: --endpoint,  or in Python: endpoint) – UTF-8 string.

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

  • Engine  (in the CLI: --engine,  or in Python: engine) – UTF-8 string.

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

  • EngineVersion  (in the CLI: --engine-version,  or in Python: engine_version) – UTF-8 string.

    Indicates the database engine version.

  • HostedZoneId  (in the CLI: --hosted-zone-id,  or in Python: hosted_zone_id) – UTF-8 string.

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

  • IAMDatabaseAuthenticationEnabled  (in the CLI: --iam-database-authentication-enabled,  or in Python: iam_database_authentication_enabled) – Boolean.

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

  • KmsKeyId  (in the CLI: --kms-key-id,  or in Python: kms_key_id) – UTF-8 string.

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

  • LatestRestorableTime  (in the CLI: --latest-restorable-time,  or in Python: latest_restorable_time) – Timestamp.

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

  • MultiAZ  (in the CLI: --multi-az,  or in Python: multi_az) – Boolean.

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

  • PendingModifiedValues  (in the CLI: --pending-modified-values,  or in Python: pending_modified_values) – A ClusterPendingModifiedValues object.

    Not supported by Neptune.

  • PercentProgress  (in the CLI: --percent-progress,  or in Python: percent_progress) – UTF-8 string.

    Specifies the progress of the operation as a percentage.

  • Port  (in the CLI: --port,  or in Python: port) – Number (integer).

    Specifies the port that the database engine is listening on.

  • PreferredBackupWindow  (in the CLI: --preferred-backup-window,  or in Python: preferred_backup_window) – UTF-8 string.

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

  • PreferredMaintenanceWindow  (in the CLI: --preferred-maintenance-window,  or in Python: preferred_maintenance_window) – UTF-8 string.

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

  • ReaderEndpoint  (in the CLI: --reader-endpoint,  or in Python: reader_endpoint) – UTF-8 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.

  • ReadReplicaIdentifiers  (in the CLI: --read-replica-identifiers,  or in Python: read_replica_identifiers) – An array of ReadReplicaIdentifier— UTF-8 strings.

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

  • ReplicationSourceIdentifier  (in the CLI: --replication-source-identifier,  or in Python: replication_source_identifier) – UTF-8 string.

    Not supported by Neptune.

  • ReplicationType  (in the CLI: --replication-type,  or in Python: replication_type) – UTF-8 string.

    Not supported by Neptune.

  • Status  (in the CLI: --status,  or in Python: status) – UTF-8 string.

    Specifies the current state of this DB cluster.

  • StorageEncrypted  (in the CLI: --storage-encrypted,  or in Python: storage_encrypted) – Boolean.

    Specifies whether the DB cluster is encrypted.

  • VpcSecurityGroups  (in the CLI: --vpc-security-groups,  or in Python: vpc_security_groups) – An array of VpcSecurityGroupMembership VpcSecurityGroupMembership objects.

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

StopDBCluster (action)

        The Amazon CLI name for this API is: stop-db-cluster,  and the Python name is: stop_db_cluster.

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.

Request

  • DBClusterIdentifier  (in the CLI: --db-cluster-identifier,  or in Python: db_cluster_identifier) – Required: UTF-8 string.

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

Response

Contains the details of an Amazon Neptune DB cluster.

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

  • AllocatedStorage  (in the CLI: --allocated-storage,  or in Python: allocated_storage) – Number (integer).

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

  • AssociatedRoles  (in the CLI: --associated-roles,  or in Python: associated_roles) – An array of DBClusterRole DBClusterRole objects.

    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.

  • AutomaticRestartTime  (in the CLI: --automatic-restart-time,  or in Python: automatic_restart_time) – Timestamp.

    Time at which the DB cluster will be automatically restarted.

  • AvailabilityZones  (in the CLI: --availability-zones,  or in Python: availability_zones) – An array of AvailabilityZone— UTF-8 strings.

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

  • BacktrackConsumedChangeRecords  (in the CLI: --backtrack-consumed-change-records,  or in Python: backtrack_consumed_change_records) – Number (long).

    Not supported by Neptune.

  • BacktrackWindow  (in the CLI: --backtrack-window,  or in Python: backtrack_window) – Number (long).

    Not supported by Neptune.

  • BackupRetentionPeriod  (in the CLI: --backup-retention-period,  or in Python: backup_retention_period) – Number (integer).

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

  • Capacity  (in the CLI: --capacity,  or in Python: capacity) – Number (integer).

    Not supported by Neptune.

  • CloneGroupId  (in the CLI: --clone-group-id,  or in Python: clone_group_id) – UTF-8 string.

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

  • ClusterCreateTime  (in the CLI: --cluster-create-time,  or in Python: cluster_create_time) – Timestamp.

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

  • CopyTagsToSnapshot  (in the CLI: --copy-tags-to-snapshot,  or in Python: copy_tags_to_snapshot) – Boolean.

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

  • CrossAccountClone  (in the CLI: --cross-account-clone,  or in Python: cross_account_clone) – Boolean.

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

  • DatabaseName  (in the CLI: --database-name,  or in Python: database_name) – UTF-8 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.

  • DBClusterArn  (in the CLI: --db-cluster-arn,  or in Python: db_cluster_arn) – UTF-8 string.

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

  • DBClusterIdentifier  (in the CLI: --db-cluster-identifier,  or in Python: db_cluster_identifier) – UTF-8 string.

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

  • DBClusterMembers  (in the CLI: --db-cluster-members,  or in Python: db_cluster_members) – An array of DBClusterMember DBClusterMember objects.

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

  • DBClusterParameterGroup  (in the CLI: --db-cluster-parameter-group,  or in Python: db_cluster_parameter_group) – UTF-8 string.

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

  • DbClusterResourceId  (in the CLI: --db-cluster-resource-id,  or in Python: db_cluster_resource_id) – UTF-8 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.

  • DBSubnetGroup  (in the CLI: --db-subnet-group,  or in Python: db_subnet_group) – UTF-8 string.

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

  • DeletionProtection  (in the CLI: --deletion-protection,  or in Python: deletion_protection) – Boolean.

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

  • EarliestBacktrackTime  (in the CLI: --earliest-backtrack-time,  or in Python: earliest_backtrack_time) – Timestamp.

    Not supported by Neptune.

  • EarliestRestorableTime  (in the CLI: --earliest-restorable-time,  or in Python: earliest_restorable_time) – Timestamp.

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

  • EnabledCloudwatchLogsExports  (in the CLI: --enabled-cloudwatch-logs-exports,  or in Python: enabled_cloudwatch_logs_exports) – An array of UTF-8 strings.

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

  • Endpoint  (in the CLI: --endpoint,  or in Python: endpoint) – UTF-8 string.

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

  • Engine  (in the CLI: --engine,  or in Python: engine) – UTF-8 string.

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

  • EngineVersion  (in the CLI: --engine-version,  or in Python: engine_version) – UTF-8 string.

    Indicates the database engine version.

  • HostedZoneId  (in the CLI: --hosted-zone-id,  or in Python: hosted_zone_id) – UTF-8 string.

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

  • IAMDatabaseAuthenticationEnabled  (in the CLI: --iam-database-authentication-enabled,  or in Python: iam_database_authentication_enabled) – Boolean.

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

  • KmsKeyId  (in the CLI: --kms-key-id,  or in Python: kms_key_id) – UTF-8 string.

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

  • LatestRestorableTime  (in the CLI: --latest-restorable-time,  or in Python: latest_restorable_time) – Timestamp.

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

  • MultiAZ  (in the CLI: --multi-az,  or in Python: multi_az) – Boolean.

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

  • PendingModifiedValues  (in the CLI: --pending-modified-values,  or in Python: pending_modified_values) – A ClusterPendingModifiedValues object.

    Not supported by Neptune.

  • PercentProgress  (in the CLI: --percent-progress,  or in Python: percent_progress) – UTF-8 string.

    Specifies the progress of the operation as a percentage.

  • Port  (in the CLI: --port,  or in Python: port) – Number (integer).

    Specifies the port that the database engine is listening on.

  • PreferredBackupWindow  (in the CLI: --preferred-backup-window,  or in Python: preferred_backup_window) – UTF-8 string.

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

  • PreferredMaintenanceWindow  (in the CLI: --preferred-maintenance-window,  or in Python: preferred_maintenance_window) – UTF-8 string.

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

  • ReaderEndpoint  (in the CLI: --reader-endpoint,  or in Python: reader_endpoint) – UTF-8 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.

  • ReadReplicaIdentifiers  (in the CLI: --read-replica-identifiers,  or in Python: read_replica_identifiers) – An array of ReadReplicaIdentifier— UTF-8 strings.

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

  • ReplicationSourceIdentifier  (in the CLI: --replication-source-identifier,  or in Python: replication_source_identifier) – UTF-8 string.

    Not supported by Neptune.

  • ReplicationType  (in the CLI: --replication-type,  or in Python: replication_type) – UTF-8 string.

    Not supported by Neptune.

  • Status  (in the CLI: --status,  or in Python: status) – UTF-8 string.

    Specifies the current state of this DB cluster.

  • StorageEncrypted  (in the CLI: --storage-encrypted,  or in Python: storage_encrypted) – Boolean.

    Specifies whether the DB cluster is encrypted.

  • VpcSecurityGroups  (in the CLI: --vpc-security-groups,  or in Python: vpc_security_groups) – An array of VpcSecurityGroupMembership VpcSecurityGroupMembership objects.

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

AddRoleToDBCluster (action)

        The Amazon CLI name for this API is: add-role-to-db-cluster,  and the Python name is: add_role_to_db_cluster.

Associates an Identity and Access Management (IAM) role with an Neptune DB cluster.

Request

  • DBClusterIdentifier  (in the CLI: --db-cluster-identifier,  or in Python: db_cluster_identifier) – Required: UTF-8 string.

    The name of the DB cluster to associate the IAM role with.

  • FeatureName  (in the CLI: --feature-name,  or in Python: feature_name) – UTF-8 string.

    The name of the feature for the Neptune DB cluster that the IAM role is to be associated with. For the list of supported feature names, see DBEngineVersion.

  • RoleArn  (in the CLI: --role-arn,  or in Python: role_arn) – Required: UTF-8 string.

    The Amazon Resource Name (ARN) of the IAM role to associate with the Neptune DB cluster, for example arn:aws:iam::123456789012:role/NeptuneAccessRole.

Response

  • No Response parameters.

RemoveRoleFromDBCluster (action)

        The Amazon CLI name for this API is: remove-role-from-db-cluster,  and the Python name is: remove_role_from_db_cluster.

Disassociates an Identity and Access Management (IAM) role from a DB cluster.

Request

  • DBClusterIdentifier  (in the CLI: --db-cluster-identifier,  or in Python: db_cluster_identifier) – Required: UTF-8 string.

    The name of the DB cluster to disassociate the IAM role from.

  • FeatureName  (in the CLI: --feature-name,  or in Python: feature_name) – UTF-8 string.

    The name of the feature for the DB cluster that the IAM role is to be disassociated from. For the list of supported feature names, see DescribeDBEngineVersions.

  • RoleArn  (in the CLI: --role-arn,  or in Python: role_arn) – Required: UTF-8 string.

    The Amazon Resource Name (ARN) of the IAM role to disassociate from the DB cluster, for example arn:aws:iam::123456789012:role/NeptuneAccessRole.

Response

  • No Response parameters.

FailoverDBCluster (action)

        The Amazon CLI name for this API is: failover-db-cluster,  and the Python name is: failover_db_cluster.

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.

Request

  • DBClusterIdentifier  (in the CLI: --db-cluster-identifier,  or in Python: db_cluster_identifier) – UTF-8 string.

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

    Constraints:

    • Must match the identifier of an existing DBCluster.

  • TargetDBInstanceIdentifier  (in the CLI: --target-db-instance-identifier,  or in Python: target_db_instance_identifier) – UTF-8 string.

    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.

Response

Contains the details of an Amazon Neptune DB cluster.

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

  • AllocatedStorage  (in the CLI: --allocated-storage,  or in Python: allocated_storage) – Number (integer).

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

  • AssociatedRoles  (in the CLI: --associated-roles,  or in Python: associated_roles) – An array of DBClusterRole DBClusterRole objects.

    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.

  • AutomaticRestartTime  (in the CLI: --automatic-restart-time,  or in Python: automatic_restart_time) – Timestamp.

    Time at which the DB cluster will be automatically restarted.

  • AvailabilityZones  (in the CLI: --availability-zones,  or in Python: availability_zones) – An array of AvailabilityZone— UTF-8 strings.

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

  • BacktrackConsumedChangeRecords  (in the CLI: --backtrack-consumed-change-records,  or in Python: backtrack_consumed_change_records) – Number (long).

    Not supported by Neptune.

  • BacktrackWindow  (in the CLI: --backtrack-window,  or in Python: backtrack_window) – Number (long).

    Not supported by Neptune.

  • BackupRetentionPeriod  (in the CLI: --backup-retention-period,  or in Python: backup_retention_period) – Number (integer).

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

  • Capacity  (in the CLI: --capacity,  or in Python: capacity) – Number (integer).

    Not supported by Neptune.

  • CloneGroupId  (in the CLI: --clone-group-id,  or in Python: clone_group_id) – UTF-8 string.

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

  • ClusterCreateTime  (in the CLI: --cluster-create-time,  or in Python: cluster_create_time) – Timestamp.

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

  • CopyTagsToSnapshot  (in the CLI: --copy-tags-to-snapshot,  or in Python: copy_tags_to_snapshot) – Boolean.

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

  • CrossAccountClone  (in the CLI: --cross-account-clone,  or in Python: cross_account_clone) – Boolean.

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

  • DatabaseName  (in the CLI: --database-name,  or in Python: database_name) – UTF-8 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.

  • DBClusterArn  (in the CLI: --db-cluster-arn,  or in Python: db_cluster_arn) – UTF-8 string.

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

  • DBClusterIdentifier  (in the CLI: --db-cluster-identifier,  or in Python: db_cluster_identifier) – UTF-8 string.

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

  • DBClusterMembers  (in the CLI: --db-cluster-members,  or in Python: db_cluster_members) – An array of DBClusterMember DBClusterMember objects.

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

  • DBClusterParameterGroup  (in the CLI: --db-cluster-parameter-group,  or in Python: db_cluster_parameter_group) – UTF-8 string.

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

  • DbClusterResourceId  (in the CLI: --db-cluster-resource-id,  or in Python: db_cluster_resource_id) – UTF-8 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.

  • DBSubnetGroup  (in the CLI: --db-subnet-group,  or in Python: db_subnet_group) – UTF-8 string.

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

  • DeletionProtection  (in the CLI: --deletion-protection,  or in Python: deletion_protection) – Boolean.

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

  • EarliestBacktrackTime  (in the CLI: --earliest-backtrack-time,  or in Python: earliest_backtrack_time) – Timestamp.

    Not supported by Neptune.

  • EarliestRestorableTime  (in the CLI: --earliest-restorable-time,  or in Python: earliest_restorable_time) – Timestamp.

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

  • EnabledCloudwatchLogsExports  (in the CLI: --enabled-cloudwatch-logs-exports,  or in Python: enabled_cloudwatch_logs_exports) – An array of UTF-8 strings.

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

  • Endpoint  (in the CLI: --endpoint,  or in Python: endpoint) – UTF-8 string.

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

  • Engine  (in the CLI: --engine,  or in Python: engine) – UTF-8 string.

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

  • EngineVersion  (in the CLI: --engine-version,  or in Python: engine_version) – UTF-8 string.

    Indicates the database engine version.

  • HostedZoneId  (in the CLI: --hosted-zone-id,  or in Python: hosted_zone_id) – UTF-8 string.

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

  • IAMDatabaseAuthenticationEnabled  (in the CLI: --iam-database-authentication-enabled,  or in Python: iam_database_authentication_enabled) – Boolean.

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

  • KmsKeyId  (in the CLI: --kms-key-id,  or in Python: kms_key_id) – UTF-8 string.

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

  • LatestRestorableTime  (in the CLI: --latest-restorable-time,  or in Python: latest_restorable_time) – Timestamp.

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

  • MultiAZ  (in the CLI: --multi-az,  or in Python: multi_az) – Boolean.

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

  • PendingModifiedValues  (in the CLI: --pending-modified-values,  or in Python: pending_modified_values) – A ClusterPendingModifiedValues object.

    Not supported by Neptune.

  • PercentProgress  (in the CLI: --percent-progress,  or in Python: percent_progress) – UTF-8 string.

    Specifies the progress of the operation as a percentage.

  • Port  (in the CLI: --port,  or in Python: port) – Number (integer).

    Specifies the port that the database engine is listening on.

  • PreferredBackupWindow  (in the CLI: --preferred-backup-window,  or in Python: preferred_backup_window) – UTF-8 string.

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

  • PreferredMaintenanceWindow  (in the CLI: --preferred-maintenance-window,  or in Python: preferred_maintenance_window) – UTF-8 string.

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

  • ReaderEndpoint  (in the CLI: --reader-endpoint,  or in Python: reader_endpoint) – UTF-8 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.

  • ReadReplicaIdentifiers  (in the CLI: --read-replica-identifiers,  or in Python: read_replica_identifiers) – An array of ReadReplicaIdentifier— UTF-8 strings.

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

  • ReplicationSourceIdentifier  (in the CLI: --replication-source-identifier,  or in Python: replication_source_identifier) – UTF-8 string.

    Not supported by Neptune.

  • ReplicationType  (in the CLI: --replication-type,  or in Python: replication_type) – UTF-8 string.

    Not supported by Neptune.

  • Status  (in the CLI: --status,  or in Python: status) – UTF-8 string.

    Specifies the current state of this DB cluster.

  • StorageEncrypted  (in the CLI: --storage-encrypted,  or in Python: storage_encrypted) – Boolean.

    Specifies whether the DB cluster is encrypted.

  • VpcSecurityGroups  (in the CLI: --vpc-security-groups,  or in Python: vpc_security_groups) – An array of VpcSecurityGroupMembership VpcSecurityGroupMembership objects.

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

PromoteReadReplicaDBCluster (action)

        The Amazon CLI name for this API is: promote-read-replica-db-cluster,  and the Python name is: promote_read_replica_db_cluster.

Not supported.

Request

  • DBClusterIdentifier  (in the CLI: --db-cluster-identifier,  or in Python: db_cluster_identifier) – Required: UTF-8 string.

    Not supported.

Response

Contains the details of an Amazon Neptune DB cluster.

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

  • AllocatedStorage  (in the CLI: --allocated-storage,  or in Python: allocated_storage) – Number (integer).

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

  • AssociatedRoles  (in the CLI: --associated-roles,  or in Python: associated_roles) – An array of DBClusterRole DBClusterRole objects.

    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.

  • AutomaticRestartTime  (in the CLI: --automatic-restart-time,  or in Python: automatic_restart_time) – Timestamp.

    Time at which the DB cluster will be automatically restarted.

  • AvailabilityZones  (in the CLI: --availability-zones,  or in Python: availability_zones) – An array of AvailabilityZone— UTF-8 strings.

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

  • BacktrackConsumedChangeRecords  (in the CLI: --backtrack-consumed-change-records,  or in Python: backtrack_consumed_change_records) – Number (long).

    Not supported by Neptune.

  • BacktrackWindow  (in the CLI: --backtrack-window,  or in Python: backtrack_window) – Number (long).

    Not supported by Neptune.

  • BackupRetentionPeriod  (in the CLI: --backup-retention-period,  or in Python: backup_retention_period) – Number (integer).

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

  • Capacity  (in the CLI: --capacity,  or in Python: capacity) – Number (integer).

    Not supported by Neptune.

  • CloneGroupId  (in the CLI: --clone-group-id,  or in Python: clone_group_id) – UTF-8 string.

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

  • ClusterCreateTime  (in the CLI: --cluster-create-time,  or in Python: cluster_create_time) – Timestamp.

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

  • CopyTagsToSnapshot  (in the CLI: --copy-tags-to-snapshot,  or in Python: copy_tags_to_snapshot) – Boolean.

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

  • CrossAccountClone  (in the CLI: --cross-account-clone,  or in Python: cross_account_clone) – Boolean.

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

  • DatabaseName  (in the CLI: --database-name,  or in Python: database_name) – UTF-8 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.

  • DBClusterArn  (in the CLI: --db-cluster-arn,  or in Python: db_cluster_arn) – UTF-8 string.

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

  • DBClusterIdentifier  (in the CLI: --db-cluster-identifier,  or in Python: db_cluster_identifier) – UTF-8 string.

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

  • DBClusterMembers  (in the CLI: --db-cluster-members,  or in Python: db_cluster_members) – An array of DBClusterMember DBClusterMember objects.

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

  • DBClusterParameterGroup  (in the CLI: --db-cluster-parameter-group,  or in Python: db_cluster_parameter_group) – UTF-8 string.

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

  • DbClusterResourceId  (in the CLI: --db-cluster-resource-id,  or in Python: db_cluster_resource_id) – UTF-8 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.

  • DBSubnetGroup  (in the CLI: --db-subnet-group,  or in Python: db_subnet_group) – UTF-8 string.

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

  • DeletionProtection  (in the CLI: --deletion-protection,  or in Python: deletion_protection) – Boolean.

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

  • EarliestBacktrackTime  (in the CLI: --earliest-backtrack-time,  or in Python: earliest_backtrack_time) – Timestamp.

    Not supported by Neptune.

  • EarliestRestorableTime  (in the CLI: --earliest-restorable-time,  or in Python: earliest_restorable_time) – Timestamp.

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

  • EnabledCloudwatchLogsExports  (in the CLI: --enabled-cloudwatch-logs-exports,  or in Python: enabled_cloudwatch_logs_exports) – An array of UTF-8 strings.

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

  • Endpoint  (in the CLI: --endpoint,  or in Python: endpoint) – UTF-8 string.

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

  • Engine  (in the CLI: --engine,  or in Python: engine) – UTF-8 string.

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

  • EngineVersion  (in the CLI: --engine-version,  or in Python: engine_version) – UTF-8 string.

    Indicates the database engine version.

  • HostedZoneId  (in the CLI: --hosted-zone-id,  or in Python: hosted_zone_id) – UTF-8 string.

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

  • IAMDatabaseAuthenticationEnabled  (in the CLI: --iam-database-authentication-enabled,  or in Python: iam_database_authentication_enabled) – Boolean.

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

  • KmsKeyId  (in the CLI: --kms-key-id,  or in Python: kms_key_id) – UTF-8 string.

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

  • LatestRestorableTime  (in the CLI: --latest-restorable-time,  or in Python: latest_restorable_time) – Timestamp.

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

  • MultiAZ  (in the CLI: --multi-az,  or in Python: multi_az) – Boolean.

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

  • PendingModifiedValues  (in the CLI: --pending-modified-values,  or in Python: pending_modified_values) – A ClusterPendingModifiedValues object.

    Not supported by Neptune.

  • PercentProgress  (in the CLI: --percent-progress,  or in Python: percent_progress) – UTF-8 string.

    Specifies the progress of the operation as a percentage.

  • Port  (in the CLI: --port,  or in Python: port) – Number (integer).

    Specifies the port that the database engine is listening on.

  • PreferredBackupWindow  (in the CLI: --preferred-backup-window,  or in Python: preferred_backup_window) – UTF-8 string.

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

  • PreferredMaintenanceWindow  (in the CLI: --preferred-maintenance-window,  or in Python: preferred_maintenance_window) – UTF-8 string.

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

  • ReaderEndpoint  (in the CLI: --reader-endpoint,  or in Python: reader_endpoint) – UTF-8 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.

  • ReadReplicaIdentifiers  (in the CLI: --read-replica-identifiers,  or in Python: read_replica_identifiers) – An array of ReadReplicaIdentifier— UTF-8 strings.

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

  • ReplicationSourceIdentifier  (in the CLI: --replication-source-identifier,  or in Python: replication_source_identifier) – UTF-8 string.

    Not supported by Neptune.

  • ReplicationType  (in the CLI: --replication-type,  or in Python: replication_type) – UTF-8 string.

    Not supported by Neptune.

  • Status  (in the CLI: --status,  or in Python: status) – UTF-8 string.

    Specifies the current state of this DB cluster.

  • StorageEncrypted  (in the CLI: --storage-encrypted,  or in Python: storage_encrypted) – Boolean.

    Specifies whether the DB cluster is encrypted.

  • VpcSecurityGroups  (in the CLI: --vpc-security-groups,  or in Python: vpc_security_groups) – An array of VpcSecurityGroupMembership VpcSecurityGroupMembership objects.

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

DescribeDBClusters (action)

        The Amazon CLI name for this API is: describe-db-clusters,  and the Python name is: describe_db_clusters.

Returns information about provisioned DB clusters, and supports pagination.

Note

This operation can also return information for Amazon RDS clusters and Amazon DocDB clusters.

Request

  • DBClusterIdentifier  (in the CLI: --db-cluster-identifier,  or in Python: db_cluster_identifier) – UTF-8 string.

    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.

  • Filters  (in the CLI: --filters,  or in Python: filters) – An array of Filter Filter objects.

    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:

    aws neptune describe-db-clusters \ --filters Name=engine,Values=neptune
  • Marker  (in the CLI: --marker,  or in Python: marker) – UTF-8 string.

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

  • MaxRecords  (in the CLI: --max-records,  or in Python: max_records) – Number (integer).

    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.

Response

  • DBClusters  (in the CLI: --db-clusters,  or in Python: db_clusters) – An array of DBCluster DBCluster objects.

    Contains a list of DB clusters for the user.

  • Marker  (in the CLI: --marker,  or in Python: marker) – UTF-8 string.

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