2022/06/08 - Amazon Neptune - 6 new3 updated api methods
Changes This release adds support for Neptune to be configured as a global database, with a primary DB cluster in one region, and up to five secondary DB clusters in other regions.
Initiates the failover process for a Neptune global database.
A failover for a Neptune global database promotes one of secondary read-only DB clusters to be the primary DB cluster and demotes the primary DB cluster to being a secondary (read-only) DB cluster. In other words, the role of the current primary DB cluster and the selected target secondary DB cluster are switched. The selected secondary DB cluster assumes full read/write capabilities for the Neptune global database.
See also: AWS API Documentation
Request Syntax
client.failover_global_cluster(
GlobalClusterIdentifier='string',
TargetDbClusterIdentifier='string'
)
string
[REQUIRED]
Identifier of the Neptune global database that should be failed over. The identifier is the unique key assigned by the user when the Neptune global database was created. In other words, it's the name of the global database that you want to fail over.
Constraints: Must match the identifier of an existing Neptune global database.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the secondary Neptune DB cluster that you want to promote to primary for the global database.
dict
Response Syntax
{
'GlobalCluster': {
'GlobalClusterIdentifier': 'string',
'GlobalClusterResourceId': 'string',
'GlobalClusterArn': 'string',
'Status': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'StorageEncrypted': True|False,
'DeletionProtection': True|False,
'GlobalClusterMembers': [
{
'DBClusterArn': 'string',
'Readers': [
'string',
],
'IsWriter': True|False
},
]
}
}
Response Structure
(dict) --
GlobalCluster (dict) --
Contains the details of an Amazon Neptune global database.
This data type is used as a response element for the CreateGlobalCluster, DescribeGlobalClusters, ModifyGlobalCluster, DeleteGlobalCluster, FailoverGlobalCluster, and RemoveFromGlobalCluster actions.
GlobalClusterIdentifier (string) --
Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database.
GlobalClusterResourceId (string) --
An immutable identifier for the global database that is unique within in all regions. This identifier is found in CloudTrail log entries whenever the KMS key for the DB cluster is accessed.
GlobalClusterArn (string) --
The Amazon Resource Name (ARN) for the global database.
Status (string) --
Specifies the current state of this global database.
Engine (string) --
The Neptune database engine used by the global database ( "neptune").
EngineVersion (string) --
The Neptune engine version used by the global database.
StorageEncrypted (boolean) --
The storage encryption setting for the global database.
DeletionProtection (boolean) --
The deletion protection setting for the global database.
GlobalClusterMembers (list) --
A list of cluster ARNs and instance ARNs for all the DB clusters that are part of the global database.
(dict) --
A data structure with information about any primary and secondary clusters associated with an Neptune global database.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for each Neptune cluster.
Readers (list) --
The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Neptune global database.
(string) --
IsWriter (boolean) --
Specifies whether the Neptune cluster is the primary cluster (that is, has read-write capability) for the Neptune global database with which it is associated.
Creates a Neptune global database spread across multiple Amazon Regions. The global database contains a single primary cluster with read-write capability, and read-only secondary clusters that receive data from the primary cluster through high-speed replication performed by the Neptune storage subsystem.
You can create a global database that is initially empty, and then add a primary cluster and secondary clusters to it, or you can specify an existing Neptune cluster during the create operation to become the primary cluster of the global database.
See also: AWS API Documentation
Request Syntax
client.create_global_cluster(
GlobalClusterIdentifier='string',
SourceDBClusterIdentifier='string',
Engine='string',
EngineVersion='string',
DeletionProtection=True|False,
StorageEncrypted=True|False
)
string
[REQUIRED]
The cluster identifier of the new global database cluster.
string
(Optional) The Amazon Resource Name (ARN) of an existing Neptune DB cluster to use as the primary cluster of the new global database.
string
The name of the database engine to be used in the global database.
Valid values: neptune
string
The Neptune engine version to be used by the global database.
Valid values: 1.2.0.0 or above.
boolean
The deletion protection setting for the new global database. The global database can't be deleted when deletion protection is enabled.
boolean
The storage encryption setting for the new global database cluster.
dict
Response Syntax
{
'GlobalCluster': {
'GlobalClusterIdentifier': 'string',
'GlobalClusterResourceId': 'string',
'GlobalClusterArn': 'string',
'Status': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'StorageEncrypted': True|False,
'DeletionProtection': True|False,
'GlobalClusterMembers': [
{
'DBClusterArn': 'string',
'Readers': [
'string',
],
'IsWriter': True|False
},
]
}
}
Response Structure
(dict) --
GlobalCluster (dict) --
Contains the details of an Amazon Neptune global database.
This data type is used as a response element for the CreateGlobalCluster, DescribeGlobalClusters, ModifyGlobalCluster, DeleteGlobalCluster, FailoverGlobalCluster, and RemoveFromGlobalCluster actions.
GlobalClusterIdentifier (string) --
Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database.
GlobalClusterResourceId (string) --
An immutable identifier for the global database that is unique within in all regions. This identifier is found in CloudTrail log entries whenever the KMS key for the DB cluster is accessed.
GlobalClusterArn (string) --
The Amazon Resource Name (ARN) for the global database.
Status (string) --
Specifies the current state of this global database.
Engine (string) --
The Neptune database engine used by the global database ( "neptune").
EngineVersion (string) --
The Neptune engine version used by the global database.
StorageEncrypted (boolean) --
The storage encryption setting for the global database.
DeletionProtection (boolean) --
The deletion protection setting for the global database.
GlobalClusterMembers (list) --
A list of cluster ARNs and instance ARNs for all the DB clusters that are part of the global database.
(dict) --
A data structure with information about any primary and secondary clusters associated with an Neptune global database.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for each Neptune cluster.
Readers (list) --
The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Neptune global database.
(string) --
IsWriter (boolean) --
Specifies whether the Neptune cluster is the primary cluster (that is, has read-write capability) for the Neptune global database with which it is associated.
Deletes a global database. The primary and all secondary clusters must already be detached or deleted first.
See also: AWS API Documentation
Request Syntax
client.delete_global_cluster(
GlobalClusterIdentifier='string'
)
string
[REQUIRED]
The cluster identifier of the global database cluster being deleted.
dict
Response Syntax
{
'GlobalCluster': {
'GlobalClusterIdentifier': 'string',
'GlobalClusterResourceId': 'string',
'GlobalClusterArn': 'string',
'Status': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'StorageEncrypted': True|False,
'DeletionProtection': True|False,
'GlobalClusterMembers': [
{
'DBClusterArn': 'string',
'Readers': [
'string',
],
'IsWriter': True|False
},
]
}
}
Response Structure
(dict) --
GlobalCluster (dict) --
Contains the details of an Amazon Neptune global database.
This data type is used as a response element for the CreateGlobalCluster, DescribeGlobalClusters, ModifyGlobalCluster, DeleteGlobalCluster, FailoverGlobalCluster, and RemoveFromGlobalCluster actions.
GlobalClusterIdentifier (string) --
Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database.
GlobalClusterResourceId (string) --
An immutable identifier for the global database that is unique within in all regions. This identifier is found in CloudTrail log entries whenever the KMS key for the DB cluster is accessed.
GlobalClusterArn (string) --
The Amazon Resource Name (ARN) for the global database.
Status (string) --
Specifies the current state of this global database.
Engine (string) --
The Neptune database engine used by the global database ( "neptune").
EngineVersion (string) --
The Neptune engine version used by the global database.
StorageEncrypted (boolean) --
The storage encryption setting for the global database.
DeletionProtection (boolean) --
The deletion protection setting for the global database.
GlobalClusterMembers (list) --
A list of cluster ARNs and instance ARNs for all the DB clusters that are part of the global database.
(dict) --
A data structure with information about any primary and secondary clusters associated with an Neptune global database.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for each Neptune cluster.
Readers (list) --
The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Neptune global database.
(string) --
IsWriter (boolean) --
Specifies whether the Neptune cluster is the primary cluster (that is, has read-write capability) for the Neptune global database with which it is associated.
Detaches a Neptune DB cluster from a Neptune global database. A secondary cluster becomes a normal standalone cluster with read-write capability instead of being read-only, and no longer receives data from a the primary cluster.
See also: AWS API Documentation
Request Syntax
client.remove_from_global_cluster(
GlobalClusterIdentifier='string',
DbClusterIdentifier='string'
)
string
[REQUIRED]
The identifier of the Neptune global database from which to detach the specified Neptune DB cluster.
string
[REQUIRED]
The Amazon Resource Name (ARN) identifying the cluster to be detached from the Neptune global database cluster.
dict
Response Syntax
{
'GlobalCluster': {
'GlobalClusterIdentifier': 'string',
'GlobalClusterResourceId': 'string',
'GlobalClusterArn': 'string',
'Status': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'StorageEncrypted': True|False,
'DeletionProtection': True|False,
'GlobalClusterMembers': [
{
'DBClusterArn': 'string',
'Readers': [
'string',
],
'IsWriter': True|False
},
]
}
}
Response Structure
(dict) --
GlobalCluster (dict) --
Contains the details of an Amazon Neptune global database.
This data type is used as a response element for the CreateGlobalCluster, DescribeGlobalClusters, ModifyGlobalCluster, DeleteGlobalCluster, FailoverGlobalCluster, and RemoveFromGlobalCluster actions.
GlobalClusterIdentifier (string) --
Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database.
GlobalClusterResourceId (string) --
An immutable identifier for the global database that is unique within in all regions. This identifier is found in CloudTrail log entries whenever the KMS key for the DB cluster is accessed.
GlobalClusterArn (string) --
The Amazon Resource Name (ARN) for the global database.
Status (string) --
Specifies the current state of this global database.
Engine (string) --
The Neptune database engine used by the global database ( "neptune").
EngineVersion (string) --
The Neptune engine version used by the global database.
StorageEncrypted (boolean) --
The storage encryption setting for the global database.
DeletionProtection (boolean) --
The deletion protection setting for the global database.
GlobalClusterMembers (list) --
A list of cluster ARNs and instance ARNs for all the DB clusters that are part of the global database.
(dict) --
A data structure with information about any primary and secondary clusters associated with an Neptune global database.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for each Neptune cluster.
Readers (list) --
The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Neptune global database.
(string) --
IsWriter (boolean) --
Specifies whether the Neptune cluster is the primary cluster (that is, has read-write capability) for the Neptune global database with which it is associated.
Modify a setting for an Amazon Neptune global cluster. You can change one or more database configuration parameters by specifying these parameters and their new values in the request.
See also: AWS API Documentation
Request Syntax
client.modify_global_cluster(
GlobalClusterIdentifier='string',
NewGlobalClusterIdentifier='string',
DeletionProtection=True|False,
EngineVersion='string',
AllowMajorVersionUpgrade=True|False
)
string
[REQUIRED]
The DB cluster identifier for the global cluster being modified. This parameter is not case-sensitive.
Constraints: Must match the identifier of an existing global database cluster.
string
A new cluster identifier to assign to the global database. 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.
Can't end with a hyphen or contain two consecutive hyphens
Example: my-cluster2
boolean
Indicates whether the global database has deletion protection enabled. The global database cannot be deleted when deletion protection is enabled.
string
The version number of the database engine to which you want to upgrade. Changing this parameter will result in an outage. The change is applied during the next maintenance window unless ApplyImmediately is enabled.
To list all of the available Neptune engine versions, use the following command:
boolean
A value that indicates whether major version upgrades are allowed.
Constraints: You must allow major version upgrades if you specify a value for the EngineVersion parameter that is a different major version than the DB cluster's current version.
If you upgrade the major version of a global database, the cluster and DB instance parameter groups are set to the default parameter groups for the new version, so you will need to apply any custom parameter groups after completing the upgrade.
dict
Response Syntax
{
'GlobalCluster': {
'GlobalClusterIdentifier': 'string',
'GlobalClusterResourceId': 'string',
'GlobalClusterArn': 'string',
'Status': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'StorageEncrypted': True|False,
'DeletionProtection': True|False,
'GlobalClusterMembers': [
{
'DBClusterArn': 'string',
'Readers': [
'string',
],
'IsWriter': True|False
},
]
}
}
Response Structure
(dict) --
GlobalCluster (dict) --
Contains the details of an Amazon Neptune global database.
This data type is used as a response element for the CreateGlobalCluster, DescribeGlobalClusters, ModifyGlobalCluster, DeleteGlobalCluster, FailoverGlobalCluster, and RemoveFromGlobalCluster actions.
GlobalClusterIdentifier (string) --
Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database.
GlobalClusterResourceId (string) --
An immutable identifier for the global database that is unique within in all regions. This identifier is found in CloudTrail log entries whenever the KMS key for the DB cluster is accessed.
GlobalClusterArn (string) --
The Amazon Resource Name (ARN) for the global database.
Status (string) --
Specifies the current state of this global database.
Engine (string) --
The Neptune database engine used by the global database ( "neptune").
EngineVersion (string) --
The Neptune engine version used by the global database.
StorageEncrypted (boolean) --
The storage encryption setting for the global database.
DeletionProtection (boolean) --
The deletion protection setting for the global database.
GlobalClusterMembers (list) --
A list of cluster ARNs and instance ARNs for all the DB clusters that are part of the global database.
(dict) --
A data structure with information about any primary and secondary clusters associated with an Neptune global database.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for each Neptune cluster.
Readers (list) --
The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Neptune global database.
(string) --
IsWriter (boolean) --
Specifies whether the Neptune cluster is the primary cluster (that is, has read-write capability) for the Neptune global database with which it is associated.
Returns information about Neptune global database clusters. This API supports pagination.
See also: AWS API Documentation
Request Syntax
client.describe_global_clusters(
GlobalClusterIdentifier='string',
MaxRecords=123,
Marker='string'
)
string
The user-supplied DB cluster identifier. If this parameter is specified, only information about the specified DB cluster is returned. This parameter is not case-sensitive.
Constraints: If supplied, must match an existing DB cluster identifier.
integer
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination marker token is included in the response that you can use to retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
string
(Optional) A pagination token returned by a previous call to DescribeGlobalClusters. If this parameter is specified, the response will only include records beyond the marker, up to the number specified by MaxRecords.
dict
Response Syntax
{
'Marker': 'string',
'GlobalClusters': [
{
'GlobalClusterIdentifier': 'string',
'GlobalClusterResourceId': 'string',
'GlobalClusterArn': 'string',
'Status': 'string',
'Engine': 'string',
'EngineVersion': 'string',
'StorageEncrypted': True|False,
'DeletionProtection': True|False,
'GlobalClusterMembers': [
{
'DBClusterArn': 'string',
'Readers': [
'string',
],
'IsWriter': True|False
},
]
},
]
}
Response Structure
(dict) --
Marker (string) --
A pagination token. If this parameter is returned in the response, more records are available, which can be retrieved by one or more additional calls to DescribeGlobalClusters.
GlobalClusters (list) --
The list of global clusters and instances returned by this request.
(dict) --
Contains the details of an Amazon Neptune global database.
This data type is used as a response element for the CreateGlobalCluster, DescribeGlobalClusters, ModifyGlobalCluster, DeleteGlobalCluster, FailoverGlobalCluster, and RemoveFromGlobalCluster actions.
GlobalClusterIdentifier (string) --
Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database.
GlobalClusterResourceId (string) --
An immutable identifier for the global database that is unique within in all regions. This identifier is found in CloudTrail log entries whenever the KMS key for the DB cluster is accessed.
GlobalClusterArn (string) --
The Amazon Resource Name (ARN) for the global database.
Status (string) --
Specifies the current state of this global database.
Engine (string) --
The Neptune database engine used by the global database ( "neptune").
EngineVersion (string) --
The Neptune engine version used by the global database.
StorageEncrypted (boolean) --
The storage encryption setting for the global database.
DeletionProtection (boolean) --
The deletion protection setting for the global database.
GlobalClusterMembers (list) --
A list of cluster ARNs and instance ARNs for all the DB clusters that are part of the global database.
(dict) --
A data structure with information about any primary and secondary clusters associated with an Neptune global database.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for each Neptune cluster.
Readers (list) --
The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Neptune global database.
(string) --
IsWriter (boolean) --
Specifies whether the Neptune cluster is the primary cluster (that is, has read-write capability) for the Neptune global database with which it is associated.
{'GlobalClusterIdentifier': 'string'}
Creates a new Amazon Neptune DB cluster.
You can use the ReplicationSourceIdentifier parameter to create the DB cluster as a Read Replica of another DB cluster or Amazon Neptune DB instance.
Note that when you create a new cluster using CreateDBCluster directly, deletion protection is disabled by default (when you create a new production cluster in the console, deletion protection is enabled by default). You can only delete a DB cluster if its DeletionProtection field is set to false.
See also: AWS API Documentation
Request Syntax
client.create_db_cluster(
AvailabilityZones=[
'string',
],
BackupRetentionPeriod=123,
CharacterSetName='string',
CopyTagsToSnapshot=True|False,
DatabaseName='string',
DBClusterIdentifier='string',
DBClusterParameterGroupName='string',
VpcSecurityGroupIds=[
'string',
],
DBSubnetGroupName='string',
Engine='string',
EngineVersion='string',
Port=123,
MasterUsername='string',
MasterUserPassword='string',
OptionGroupName='string',
PreferredBackupWindow='string',
PreferredMaintenanceWindow='string',
ReplicationSourceIdentifier='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
StorageEncrypted=True|False,
KmsKeyId='string',
PreSignedUrl='string',
EnableIAMDatabaseAuthentication=True|False,
EnableCloudwatchLogsExports=[
'string',
],
DeletionProtection=True|False,
GlobalClusterIdentifier='string'
)
list
A list of EC2 Availability Zones that instances in the DB cluster can be created in.
(string) --
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
string
(Not supported by Neptune)
boolean
If set to true, tags are copied to any snapshot of the DB cluster that is created.
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.
string
[REQUIRED]
The DB cluster identifier. This parameter is stored as a lowercase string.
Constraints:
Must contain from 1 to 63 letters, numbers, or hyphens.
First character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.
Example: my-cluster1
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.
list
A list of EC2 VPC security groups to associate with this DB cluster.
(string) --
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
string
[REQUIRED]
The name of the database engine to be used for this DB cluster.
Valid Values: neptune
string
The version number of the database engine to use for the new DB cluster.
Example: 1.0.2.1
integer
The port number on which the instances in the DB cluster accept connections.
Default: 8182
string
Not supported by Neptune.
string
Not supported by Neptune.
string
(Not supported by Neptune)
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.
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.
string
The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica.
list
The tags to assign to the new DB cluster.
(dict) --
Metadata assigned to an Amazon Neptune resource consisting of a key-value pair.
Key (string) --
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").
Value (string) --
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with aws: or rds:. The string can only contain the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").
boolean
Specifies whether the DB cluster is encrypted.
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.
string
This parameter is not currently supported.
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.
list
The list of log types that need to be enabled for exporting to CloudWatch Logs.
(string) --
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.
string
The ID of the Neptune global database to which this new DB cluster should be added.
dict
Response Syntax
{
'DBCluster': {
'AllocatedStorage': 123,
'AvailabilityZones': [
'string',
],
'BackupRetentionPeriod': 123,
'CharacterSetName': 'string',
'DatabaseName': 'string',
'DBClusterIdentifier': 'string',
'DBClusterParameterGroup': 'string',
'DBSubnetGroup': 'string',
'Status': 'string',
'PercentProgress': 'string',
'EarliestRestorableTime': datetime(2015, 1, 1),
'Endpoint': 'string',
'ReaderEndpoint': 'string',
'MultiAZ': True|False,
'Engine': 'string',
'EngineVersion': 'string',
'LatestRestorableTime': datetime(2015, 1, 1),
'Port': 123,
'MasterUsername': 'string',
'DBClusterOptionGroupMemberships': [
{
'DBClusterOptionGroupName': 'string',
'Status': 'string'
},
],
'PreferredBackupWindow': 'string',
'PreferredMaintenanceWindow': 'string',
'ReplicationSourceIdentifier': 'string',
'ReadReplicaIdentifiers': [
'string',
],
'DBClusterMembers': [
{
'DBInstanceIdentifier': 'string',
'IsClusterWriter': True|False,
'DBClusterParameterGroupStatus': 'string',
'PromotionTier': 123
},
],
'VpcSecurityGroups': [
{
'VpcSecurityGroupId': 'string',
'Status': 'string'
},
],
'HostedZoneId': 'string',
'StorageEncrypted': True|False,
'KmsKeyId': 'string',
'DbClusterResourceId': 'string',
'DBClusterArn': 'string',
'AssociatedRoles': [
{
'RoleArn': 'string',
'Status': 'string',
'FeatureName': 'string'
},
],
'IAMDatabaseAuthenticationEnabled': True|False,
'CloneGroupId': 'string',
'ClusterCreateTime': datetime(2015, 1, 1),
'CopyTagsToSnapshot': True|False,
'EnabledCloudwatchLogsExports': [
'string',
],
'DeletionProtection': True|False,
'CrossAccountClone': True|False,
'AutomaticRestartTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
DBCluster (dict) --
Contains the details of an Amazon Neptune DB cluster.
This data type is used as a response element in the DescribeDBClusters action.
AllocatedStorage (integer) --
AllocatedStorage always returns 1, because Neptune DB cluster storage size is not fixed, but instead automatically adjusts as needed.
AvailabilityZones (list) --
Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
(string) --
BackupRetentionPeriod (integer) --
Specifies the number of days for which automatic DB snapshots are retained.
CharacterSetName (string) --
Not supported by Neptune.
DatabaseName (string) --
Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster.
DBClusterIdentifier (string) --
Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
DBClusterParameterGroup (string) --
Specifies the name of the DB cluster parameter group for the DB cluster.
DBSubnetGroup (string) --
Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
Status (string) --
Specifies the current state of this DB cluster.
PercentProgress (string) --
Specifies the progress of the operation as a percentage.
EarliestRestorableTime (datetime) --
Specifies the earliest time to which a database can be restored with point-in-time restore.
Endpoint (string) --
Specifies the connection endpoint for the primary instance of the DB cluster.
ReaderEndpoint (string) --
The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Read Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Neptune distributes the connection requests among the Read Replicas in the DB cluster. This functionality can help balance your read workload across multiple Read Replicas in your DB cluster.
If a failover occurs, and the Read Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Read Replicas in the cluster, you can then reconnect to the reader endpoint.
MultiAZ (boolean) --
Specifies whether the DB cluster has instances in multiple Availability Zones.
Engine (string) --
Provides the name of the database engine to be used for this DB cluster.
EngineVersion (string) --
Indicates the database engine version.
LatestRestorableTime (datetime) --
Specifies the latest time to which a database can be restored with point-in-time restore.
Port (integer) --
Specifies the port that the database engine is listening on.
MasterUsername (string) --
Not supported by Neptune.
DBClusterOptionGroupMemberships (list) --
Not supported by Neptune.
(dict) --
Not supported by Neptune.
DBClusterOptionGroupName (string) --
Not supported by Neptune.
Status (string) --
Not supported by Neptune.
PreferredBackupWindow (string) --
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
PreferredMaintenanceWindow (string) --
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
ReplicationSourceIdentifier (string) --
Not supported by Neptune.
ReadReplicaIdentifiers (list) --
Contains one or more identifiers of the Read Replicas associated with this DB cluster.
(string) --
DBClusterMembers (list) --
Provides the list of instances that make up the DB cluster.
(dict) --
Contains information about an instance that is part of a DB cluster.
DBInstanceIdentifier (string) --
Specifies the instance identifier for this member of the DB cluster.
IsClusterWriter (boolean) --
Value that is true if the cluster member is the primary instance for the DB cluster and false otherwise.
DBClusterParameterGroupStatus (string) --
Specifies the status of the DB cluster parameter group for this member of the DB cluster.
PromotionTier (integer) --
A value that specifies the order in which a Read Replica is promoted to the primary instance after a failure of the existing primary instance.
VpcSecurityGroups (list) --
Provides a list of VPC security groups that the DB cluster belongs to.
(dict) --
This data type is used as a response element for queries on VPC security group membership.
VpcSecurityGroupId (string) --
The name of the VPC security group.
Status (string) --
The status of the VPC security group.
HostedZoneId (string) --
Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
StorageEncrypted (boolean) --
Specifies whether the DB cluster is encrypted.
KmsKeyId (string) --
If StorageEncrypted is true, the Amazon KMS key identifier for the encrypted DB cluster.
DbClusterResourceId (string) --
The Amazon Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon CloudTrail log entries whenever the Amazon KMS key for the DB cluster is accessed.
DBClusterArn (string) --
The Amazon Resource Name (ARN) for the DB cluster.
AssociatedRoles (list) --
Provides a list of the Amazon Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon services on your behalf.
(dict) --
Describes an Amazon Identity and Access Management (IAM) role that is associated with a DB cluster.
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.
Status (string) --
Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values:
ACTIVE - the IAM role ARN is associated with the DB cluster and can be used to access other Amazon services on your behalf.
PENDING - the IAM role ARN is being associated with the DB cluster.
INVALID - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other Amazon services on your behalf.
FeatureName (string) --
The name of the feature associated with the Amazon Identity and Access Management (IAM) role. For the list of supported feature names, see DescribeDBEngineVersions.
IAMDatabaseAuthenticationEnabled (boolean) --
True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
CloneGroupId (string) --
Identifies the clone group to which the DB cluster is associated.
ClusterCreateTime (datetime) --
Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
CopyTagsToSnapshot (boolean) --
If set to true, tags are copied to any snapshot of the DB cluster that is created.
EnabledCloudwatchLogsExports (list) --
A list of log types that this DB cluster is configured to export to CloudWatch Logs.
(string) --
DeletionProtection (boolean) --
Indicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
CrossAccountClone (boolean) --
If set to true, the DB cluster can be cloned across accounts.
AutomaticRestartTime (datetime) --
Time at which the DB cluster will be automatically restarted.
{'DBEngineVersions': {'SupportsGlobalDatabases': 'boolean',
'ValidUpgradeTarget': {'SupportsGlobalDatabases': 'boolean'}}}
Returns a list of the available DB engines.
See also: AWS API Documentation
Request Syntax
client.describe_db_engine_versions(
Engine='string',
EngineVersion='string',
DBParameterGroupFamily='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string',
DefaultOnly=True|False,
ListSupportedCharacterSets=True|False,
ListSupportedTimezones=True|False
)
string
The database engine to return.
string
The database engine version to return.
Example: 5.1.49
string
The name of a specific DB parameter group family to return details for.
Constraints:
If supplied, must match an existing DBParameterGroupFamily.
list
Not currently supported.
(dict) --
This type is not currently supported.
Name (string) -- [REQUIRED]
This parameter is not currently supported.
Values (list) -- [REQUIRED]
This parameter is not currently supported.
(string) --
integer
The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
string
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
boolean
Indicates that only the default version of the specified engine or engine and major version combination is returned.
boolean
If this parameter is specified and the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.
boolean
If this parameter is specified and the requested engine supports the TimeZone parameter for CreateDBInstance, the response includes a list of supported time zones for each engine version.
dict
Response Syntax
{
'Marker': 'string',
'DBEngineVersions': [
{
'Engine': 'string',
'EngineVersion': 'string',
'DBParameterGroupFamily': 'string',
'DBEngineDescription': 'string',
'DBEngineVersionDescription': 'string',
'DefaultCharacterSet': {
'CharacterSetName': 'string',
'CharacterSetDescription': 'string'
},
'SupportedCharacterSets': [
{
'CharacterSetName': 'string',
'CharacterSetDescription': 'string'
},
],
'ValidUpgradeTarget': [
{
'Engine': 'string',
'EngineVersion': 'string',
'Description': 'string',
'AutoUpgrade': True|False,
'IsMajorVersionUpgrade': True|False,
'SupportsGlobalDatabases': True|False
},
],
'SupportedTimezones': [
{
'TimezoneName': 'string'
},
],
'ExportableLogTypes': [
'string',
],
'SupportsLogExportsToCloudwatchLogs': True|False,
'SupportsReadReplica': True|False,
'SupportsGlobalDatabases': True|False
},
]
}
Response Structure
(dict) --
Marker (string) --
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
DBEngineVersions (list) --
A list of DBEngineVersion elements.
(dict) --
This data type is used as a response element in the action DescribeDBEngineVersions.
Engine (string) --
The name of the database engine.
EngineVersion (string) --
The version number of the database engine.
DBParameterGroupFamily (string) --
The name of the DB parameter group family for the database engine.
DBEngineDescription (string) --
The description of the database engine.
DBEngineVersionDescription (string) --
The description of the database engine version.
DefaultCharacterSet (dict) --
(Not supported by Neptune)
CharacterSetName (string) --
The name of the character set.
CharacterSetDescription (string) --
The description of the character set.
SupportedCharacterSets (list) --
(Not supported by Neptune)
(dict) --
Specifies a character set.
CharacterSetName (string) --
The name of the character set.
CharacterSetDescription (string) --
The description of the character set.
ValidUpgradeTarget (list) --
A list of engine versions that this database engine version can be upgraded to.
(dict) --
The version of the database engine that a DB instance can be upgraded to.
Engine (string) --
The name of the upgrade target database engine.
EngineVersion (string) --
The version number of the upgrade target database engine.
Description (string) --
The version of the database engine that a DB instance can be upgraded to.
AutoUpgrade (boolean) --
A value that indicates whether the target version is applied to any source DB instances that have AutoMinorVersionUpgrade set to true.
IsMajorVersionUpgrade (boolean) --
A value that indicates whether a database engine is upgraded to a major version.
SupportsGlobalDatabases (boolean) --
A value that indicates whether you can use Neptune global databases with the target engine version.
SupportedTimezones (list) --
A list of the time zones supported by this engine for the Timezone parameter of the CreateDBInstance action.
(dict) --
A time zone associated with a DBInstance.
TimezoneName (string) --
The name of the time zone.
ExportableLogTypes (list) --
The types of logs that the database engine has available for export to CloudWatch Logs.
(string) --
SupportsLogExportsToCloudwatchLogs (boolean) --
A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs.
SupportsReadReplica (boolean) --
Indicates whether the database engine version supports read replicas.
SupportsGlobalDatabases (boolean) --
A value that indicates whether you can use Aurora global databases with a specific DB engine version.
{'OrderableDBInstanceOptions': {'SupportsGlobalDatabases': 'boolean'}}
Returns a list of orderable DB instance options for the specified engine.
See also: AWS API Documentation
Request Syntax
client.describe_orderable_db_instance_options(
Engine='string',
EngineVersion='string',
DBInstanceClass='string',
LicenseModel='string',
Vpc=True|False,
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
string
[REQUIRED]
The name of the engine to retrieve DB instance options for.
string
The engine version filter value. Specify this parameter to show only the available offerings matching the specified engine version.
string
The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.
string
The license model filter value. Specify this parameter to show only the available offerings matching the specified license model.
boolean
The VPC filter value. Specify this parameter to show only the available VPC or non-VPC offerings.
list
This parameter is not currently supported.
(dict) --
This type is not currently supported.
Name (string) -- [REQUIRED]
This parameter is not currently supported.
Values (list) -- [REQUIRED]
This parameter is not currently supported.
(string) --
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.
string
An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
dict
Response Syntax
{
'OrderableDBInstanceOptions': [
{
'Engine': 'string',
'EngineVersion': 'string',
'DBInstanceClass': 'string',
'LicenseModel': 'string',
'AvailabilityZones': [
{
'Name': 'string'
},
],
'MultiAZCapable': True|False,
'ReadReplicaCapable': True|False,
'Vpc': True|False,
'SupportsStorageEncryption': True|False,
'StorageType': 'string',
'SupportsIops': True|False,
'SupportsEnhancedMonitoring': True|False,
'SupportsIAMDatabaseAuthentication': True|False,
'SupportsPerformanceInsights': True|False,
'MinStorageSize': 123,
'MaxStorageSize': 123,
'MinIopsPerDbInstance': 123,
'MaxIopsPerDbInstance': 123,
'MinIopsPerGib': 123.0,
'MaxIopsPerGib': 123.0,
'SupportsGlobalDatabases': True|False
},
],
'Marker': 'string'
}
Response Structure
(dict) --
OrderableDBInstanceOptions (list) --
An OrderableDBInstanceOption structure containing information about orderable options for the DB instance.
(dict) --
Contains a list of available options for a DB instance.
This data type is used as a response element in the DescribeOrderableDBInstanceOptions action.
Engine (string) --
The engine type of a DB instance.
EngineVersion (string) --
The engine version of a DB instance.
DBInstanceClass (string) --
The DB instance class for a DB instance.
LicenseModel (string) --
The license model for a DB instance.
AvailabilityZones (list) --
A list of Availability Zones for a DB instance.
(dict) --
Specifies an Availability Zone.
Name (string) --
The name of the availability zone.
MultiAZCapable (boolean) --
Indicates whether a DB instance is Multi-AZ capable.
ReadReplicaCapable (boolean) --
Indicates whether a DB instance can have a Read Replica.
Vpc (boolean) --
Indicates whether a DB instance is in a VPC.
SupportsStorageEncryption (boolean) --
Indicates whether a DB instance supports encrypted storage.
StorageType (string) --
Indicates the storage type for a DB instance.
SupportsIops (boolean) --
Indicates whether a DB instance supports provisioned IOPS.
SupportsEnhancedMonitoring (boolean) --
Indicates whether a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds.
SupportsIAMDatabaseAuthentication (boolean) --
Indicates whether a DB instance supports IAM database authentication.
SupportsPerformanceInsights (boolean) --
(Not supported by Neptune)
MinStorageSize (integer) --
Minimum storage size for a DB instance.
MaxStorageSize (integer) --
Maximum storage size for a DB instance.
MinIopsPerDbInstance (integer) --
Minimum total provisioned IOPS for a DB instance.
MaxIopsPerDbInstance (integer) --
Maximum total provisioned IOPS for a DB instance.
MinIopsPerGib (float) --
Minimum provisioned IOPS per GiB for a DB instance.
MaxIopsPerGib (float) --
Maximum provisioned IOPS per GiB for a DB instance.
SupportsGlobalDatabases (boolean) --
A value that indicates whether you can use Neptune global databases with a specific combination of other DB engine attributes.
Marker (string) --
An optional pagination token provided by a previous OrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .