2023/10/30 - Amazon Relational Database Service - 3 new 4 updated api methods
Changes This release launches the CreateIntegration, DeleteIntegration, and DescribeIntegrations APIs to manage zero-ETL Integrations.
Deletes a zero-ETL integration with Amazon Redshift. For more information, see Deleting Amazon Aurora zero-ETL integrations with Amazon Redshift in the Amazon Aurora User Guide
See also: AWS API Documentation
Request Syntax
client.delete_integration(
IntegrationIdentifier='string'
)
string
[REQUIRED]
The unique identifier of the integration.
dict
Response Syntax
{
'SourceArn': 'string',
'TargetArn': 'string',
'IntegrationName': 'string',
'IntegrationArn': 'string',
'KMSKeyId': 'string',
'AdditionalEncryptionContext': {
'string': 'string'
},
'Status': 'creating'|'active'|'modifying'|'failed'|'deleting'|'syncing'|'needs_attention',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'CreateTime': datetime(2015, 1, 1),
'Errors': [
{
'ErrorCode': 'string',
'ErrorMessage': 'string'
},
]
}
Response Structure
(dict) --
An Aurora zero-ETL integration with Amazon Redshift. For more information, see Working with Amazon Aurora zero-ETL integrations with Amazon Redshift in the Amazon Aurora User Guide .
SourceArn (string) --
The Amazon Resource Name (ARN) of the Aurora DB cluster used as the source for replication.
TargetArn (string) --
The ARN of the Redshift data warehouse used as the target for replication.
IntegrationName (string) --
The name of the integration.
IntegrationArn (string) --
The ARN of the integration.
KMSKeyId (string) --
The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key used to to encrypt the integration.
AdditionalEncryptionContext (dict) --
The encryption context for the integration. For more information, see Encryption context in the Amazon Web Services Key Management Service Developer Guide .
(string) --
(string) --
Status (string) --
The current status of the integration.
Tags (list) --
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
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 only 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 only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
CreateTime (datetime) --
The time when the integration was created, in Universal Coordinated Time (UTC).
Errors (list) --
Any errors associated with the integration.
(dict) --
An error associated with a zero-ETL integration with Amazon Redshift.
ErrorCode (string) --
The error code associated with the integration.
ErrorMessage (string) --
A message explaining the error.
Describe one or more zero-ETL integration with Amazon Redshift. For more information, see Viewing and monitoring Amazon Aurora zero-ETL integrations with Amazon Redshift in the Amazon Aurora User Guide
See also: AWS API Documentation
Request Syntax
client.describe_integrations(
IntegrationIdentifier='string',
Filters=[
{
'Name': 'string',
'Values': [
'string',
]
},
],
MaxRecords=123,
Marker='string'
)
string
The unique identifier of the integration.
list
A filter that specifies one or more resources to return.
(dict) --
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracks
DescribeDBClusterEndpoints
DescribeDBClusters
DescribeDBInstances
DescribePendingMaintenanceActions
Name (string) -- [REQUIRED]
The name of the filter. Filter names are case-sensitive.
Values (list) -- [REQUIRED]
One or more filter values. Filter values are case-sensitive.
(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 you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
string
An optional pagination token provided by a previous DescribeIntegrations request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
dict
Response Syntax
{
'Marker': 'string',
'Integrations': [
{
'SourceArn': 'string',
'TargetArn': 'string',
'IntegrationName': 'string',
'IntegrationArn': 'string',
'KMSKeyId': 'string',
'AdditionalEncryptionContext': {
'string': 'string'
},
'Status': 'creating'|'active'|'modifying'|'failed'|'deleting'|'syncing'|'needs_attention',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'CreateTime': datetime(2015, 1, 1),
'Errors': [
{
'ErrorCode': 'string',
'ErrorMessage': 'string'
},
]
},
]
}
Response Structure
(dict) --
Marker (string) --
A pagination token that can be used in a later DescribeIntegrations request.
Integrations (list) --
A list of integrations.
(dict) --
An Aurora zero-ETL integration with Amazon Redshift. For more information, see Working with Amazon Aurora zero-ETL integrations with Amazon Redshift in the Amazon Aurora User Guide .
SourceArn (string) --
The Amazon Resource Name (ARN) of the Aurora DB cluster used as the source for replication.
TargetArn (string) --
The ARN of the Redshift data warehouse used as the target for replication.
IntegrationName (string) --
The name of the integration.
IntegrationArn (string) --
The ARN of the integration.
KMSKeyId (string) --
The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key used to to encrypt the integration.
AdditionalEncryptionContext (dict) --
The encryption context for the integration. For more information, see Encryption context in the Amazon Web Services Key Management Service Developer Guide .
(string) --
(string) --
Status (string) --
The current status of the integration.
Tags (list) --
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
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 only 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 only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
CreateTime (datetime) --
The time when the integration was created, in Universal Coordinated Time (UTC).
Errors (list) --
Any errors associated with the integration.
(dict) --
An error associated with a zero-ETL integration with Amazon Redshift.
ErrorCode (string) --
The error code associated with the integration.
ErrorMessage (string) --
A message explaining the error.
Creates a zero-ETL integration with Amazon Redshift. For more information, see Working with Amazon Aurora zero-ETL integrations with Amazon Redshift in the Amazon Aurora User Guide .
See also: AWS API Documentation
Request Syntax
client.create_integration(
SourceArn='string',
TargetArn='string',
IntegrationName='string',
KMSKeyId='string',
AdditionalEncryptionContext={
'string': 'string'
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the Aurora DB cluster to use as the source for replication.
string
[REQUIRED]
The ARN of the Redshift data warehouse to use as the target for replication.
string
[REQUIRED]
The name of the integration.
string
The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key to use to encrypt the integration. If you don't specify an encryption key, Aurora uses a default Amazon Web Services owned key.
dict
An optional set of non-secret key–value pairs that contains additional contextual information about the data. For more information, see Encryption context in the Amazon Web Services Key Management Service Developer Guide .
You can only include this parameter if you specify the KMSKeyId parameter.
(string) --
(string) --
list
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
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 only 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 only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
dict
Response Syntax
{
'SourceArn': 'string',
'TargetArn': 'string',
'IntegrationName': 'string',
'IntegrationArn': 'string',
'KMSKeyId': 'string',
'AdditionalEncryptionContext': {
'string': 'string'
},
'Status': 'creating'|'active'|'modifying'|'failed'|'deleting'|'syncing'|'needs_attention',
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'CreateTime': datetime(2015, 1, 1),
'Errors': [
{
'ErrorCode': 'string',
'ErrorMessage': 'string'
},
]
}
Response Structure
(dict) --
An Aurora zero-ETL integration with Amazon Redshift. For more information, see Working with Amazon Aurora zero-ETL integrations with Amazon Redshift in the Amazon Aurora User Guide .
SourceArn (string) --
The Amazon Resource Name (ARN) of the Aurora DB cluster used as the source for replication.
TargetArn (string) --
The ARN of the Redshift data warehouse used as the target for replication.
IntegrationName (string) --
The name of the integration.
IntegrationArn (string) --
The ARN of the integration.
KMSKeyId (string) --
The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key used to to encrypt the integration.
AdditionalEncryptionContext (dict) --
The encryption context for the integration. For more information, see Encryption context in the Amazon Web Services Key Management Service Developer Guide .
(string) --
(string) --
Status (string) --
The current status of the integration.
Tags (list) --
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
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 only 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 only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
CreateTime (datetime) --
The time when the integration was created, in Universal Coordinated Time (UTC).
Errors (list) --
Any errors associated with the integration.
(dict) --
An error associated with a zero-ETL integration with Amazon Redshift.
ErrorCode (string) --
The error code associated with the integration.
ErrorMessage (string) --
A message explaining the error.
{'SupportsIntegrations': 'boolean',
'ValidUpgradeTarget': {'SupportsIntegrations': 'boolean'}}
Creates a custom DB engine version (CEV).
See also: AWS API Documentation
Request Syntax
client.create_custom_db_engine_version(
Engine='string',
EngineVersion='string',
DatabaseInstallationFilesS3BucketName='string',
DatabaseInstallationFilesS3Prefix='string',
ImageId='string',
KMSKeyId='string',
Description='string',
Manifest='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
SourceCustomDbEngineVersionIdentifier='string',
UseAwsProvidedLatestImage=True|False
)
string
[REQUIRED]
The database engine to use for your custom engine version (CEV). The only supported value is custom-oracle-ee .
string
[REQUIRED]
The name of your CEV. The name format is 19.*customized_string* . For example, a valid CEV name is 19.my_cev1 . This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Region.
string
The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is my-custom-installation-files .
string
The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is 123456789012/cev1 . If this setting isn't specified, no prefix is assumed.
string
The ID of the Amazon Machine Image (AMI). For RDS Custom for SQL Server, an AMI ID is required to create a CEV. For RDS Custom for Oracle, the default is the most recent AMI available, but you can specify an AMI ID that was used in a different Oracle CEV. Find the AMIs used by your CEVs by calling the DescribeDBEngineVersions operation.
string
The Amazon Web Services KMS key identifier for an encrypted CEV. A symmetric encryption KMS key is required for RDS Custom, but optional for Amazon RDS.
If you have an existing symmetric encryption KMS key in your account, you can use it with RDS Custom. No further action is necessary. If you don't already have a symmetric encryption KMS key in your account, follow the instructions in Creating a symmetric encryption KMS key in the Amazon Web Services Key Management Service Developer Guide .
You can choose the same symmetric encryption key when you create a CEV and a DB instance, or choose different keys.
string
An optional description of your CEV.
string
The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which they are listed.
The following JSON fields are valid:
MediaImportTemplateVersion
Version of the CEV manifest. The date is in the format YYYY-MM-DD .
databaseInstallationFileNames
Ordered list of installation files for the CEV.
opatchFileNames
Ordered list of OPatch installers used for the Oracle DB engine.
psuRuPatchFileNames
The PSU and RU patches for this CEV.
OtherPatchFileNames
The patches that are not in the list of PSU and RU patches. Amazon RDS applies these patches after applying the PSU and RU patches.
For more information, see Creating the CEV manifest in the Amazon RDS User Guide .
list
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
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 only 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 only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
string
Reserved for future use.
boolean
Reserved for future use.
dict
Response Syntax
{
'Engine': 'string',
'EngineVersion': 'string',
'DBParameterGroupFamily': 'string',
'DBEngineDescription': 'string',
'DBEngineVersionDescription': 'string',
'DefaultCharacterSet': {
'CharacterSetName': 'string',
'CharacterSetDescription': 'string'
},
'Image': {
'ImageId': 'string',
'Status': 'string'
},
'DBEngineMediaType': 'string',
'SupportedCharacterSets': [
{
'CharacterSetName': 'string',
'CharacterSetDescription': 'string'
},
],
'SupportedNcharCharacterSets': [
{
'CharacterSetName': 'string',
'CharacterSetDescription': 'string'
},
],
'ValidUpgradeTarget': [
{
'Engine': 'string',
'EngineVersion': 'string',
'Description': 'string',
'AutoUpgrade': True|False,
'IsMajorVersionUpgrade': True|False,
'SupportedEngineModes': [
'string',
],
'SupportsParallelQuery': True|False,
'SupportsGlobalDatabases': True|False,
'SupportsBabelfish': True|False,
'SupportsLocalWriteForwarding': True|False,
'SupportsIntegrations': True|False
},
],
'SupportedTimezones': [
{
'TimezoneName': 'string'
},
],
'ExportableLogTypes': [
'string',
],
'SupportsLogExportsToCloudwatchLogs': True|False,
'SupportsReadReplica': True|False,
'SupportedEngineModes': [
'string',
],
'SupportedFeatureNames': [
'string',
],
'Status': 'string',
'SupportsParallelQuery': True|False,
'SupportsGlobalDatabases': True|False,
'MajorEngineVersion': 'string',
'DatabaseInstallationFilesS3BucketName': 'string',
'DatabaseInstallationFilesS3Prefix': 'string',
'DBEngineVersionArn': 'string',
'KMSKeyId': 'string',
'CreateTime': datetime(2015, 1, 1),
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
],
'SupportsBabelfish': True|False,
'CustomDBEngineVersionManifest': 'string',
'SupportsCertificateRotationWithoutRestart': True|False,
'SupportedCACertificateIdentifiers': [
'string',
],
'SupportsLocalWriteForwarding': True|False,
'SupportsIntegrations': True|False
}
Response Structure
(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) --
The default character set for new instances of this engine version, if the CharacterSetName parameter of the CreateDBInstance API isn't specified.
CharacterSetName (string) --
The name of the character set.
CharacterSetDescription (string) --
The description of the character set.
Image (dict) --
The EC2 image
ImageId (string) --
A value that indicates the ID of the AMI.
Status (string) --
A value that indicates the status of a custom engine version (CEV).
DBEngineMediaType (string) --
A value that indicates the source media provider of the AMI based on the usage operation. Applicable for RDS Custom for SQL Server.
SupportedCharacterSets (list) --
A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance operation.
(dict) --
This data type is used as a response element in the action DescribeDBEngineVersions .
CharacterSetName (string) --
The name of the character set.
CharacterSetDescription (string) --
The description of the character set.
SupportedNcharCharacterSets (list) --
A list of the character sets supported by the Oracle DB engine for the NcharCharacterSetName parameter of the CreateDBInstance operation.
(dict) --
This data type is used as a response element in the action DescribeDBEngineVersions .
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) --
Indicates whether the target version is applied to any source DB instances that have AutoMinorVersionUpgrade set to true.
IsMajorVersionUpgrade (boolean) --
Indicates whether upgrading to the target version requires upgrading the major version of the database engine.
SupportedEngineModes (list) --
A list of the supported DB engine modes for the target engine version.
(string) --
SupportsParallelQuery (boolean) --
Indicates whether you can use Aurora parallel query with the target engine version.
SupportsGlobalDatabases (boolean) --
Indicates whether you can use Aurora global databases with the target engine version.
SupportsBabelfish (boolean) --
Indicates whether you can use Babelfish for Aurora PostgreSQL with the target engine version.
SupportsLocalWriteForwarding (boolean) --
Indicates whether the target engine version supports forwarding write operations from reader DB instances to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.
Valid for: Aurora DB clusters only
SupportsIntegrations (boolean) --
Indicates whether the DB engine version supports Aurora zero-ETL integrations with Amazon Redshift.
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 or a DBSnapshot . This data type is an element in the response to the DescribeDBInstances , the DescribeDBSnapshots , and the DescribeDBEngineVersions actions.
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) --
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.
SupportedEngineModes (list) --
A list of the supported DB engine modes.
(string) --
SupportedFeatureNames (list) --
A list of features supported by the DB engine.
The supported features vary by DB engine and DB engine version.
To determine the supported features for a specific DB engine and DB engine version using the CLI, use the following command:
aws rds describe-db-engine-versions --engine <engine_name> --engine-version <engine_version>
For example, to determine the supported features for RDS for PostgreSQL version 13.3 using the CLI, use the following command:
aws rds describe-db-engine-versions --engine postgres --engine-version 13.3
The supported features are listed under SupportedFeatureNames in the output.
(string) --
Status (string) --
The status of the DB engine version, either available or deprecated .
SupportsParallelQuery (boolean) --
Indicates whether you can use Aurora parallel query with a specific DB engine version.
SupportsGlobalDatabases (boolean) --
Indicates whether you can use Aurora global databases with a specific DB engine version.
MajorEngineVersion (string) --
The major engine version of the CEV.
DatabaseInstallationFilesS3BucketName (string) --
The name of the Amazon S3 bucket that contains your database installation files.
DatabaseInstallationFilesS3Prefix (string) --
The Amazon S3 directory that contains the database installation files. If not specified, then no prefix is assumed.
DBEngineVersionArn (string) --
The ARN of the custom engine version.
KMSKeyId (string) --
The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter is required for RDS Custom, but optional for Amazon RDS.
CreateTime (datetime) --
The creation time of the DB engine version.
TagList (list) --
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
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 only 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 only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
SupportsBabelfish (boolean) --
Indicates whether the engine version supports Babelfish for Aurora PostgreSQL.
CustomDBEngineVersionManifest (string) --
JSON string that lists the installation files and parameters that RDS Custom uses to create a custom engine version (CEV). RDS Custom applies the patches in the order in which they're listed in the manifest. You can set the Oracle home, Oracle base, and UNIX/Linux user and group using the installation parameters. For more information, see JSON fields in the CEV manifest in the Amazon RDS User Guide .
SupportsCertificateRotationWithoutRestart (boolean) --
Indicates whether the engine version supports rotating the server certificate without rebooting the DB instance.
SupportedCACertificateIdentifiers (list) --
A list of the supported CA certificate identifiers.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide .
(string) --
SupportsLocalWriteForwarding (boolean) --
Indicates whether the DB engine version supports forwarding write operations from reader DB instances to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.
Valid for: Aurora DB clusters only
SupportsIntegrations (boolean) --
Indicates whether the DB engine version supports Aurora zero-ETL integrations with Amazon Redshift.
{'SupportsIntegrations': 'boolean',
'ValidUpgradeTarget': {'SupportsIntegrations': 'boolean'}}
Deletes a custom engine version. To run this command, make sure you meet the following prerequisites:
The CEV must not be the default for RDS Custom. If it is, change the default before running this command.
The CEV must not be associated with an RDS Custom DB instance, RDS Custom instance snapshot, or automated backup of your RDS Custom instance.
Typically, deletion takes a few minutes.
Note
The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the DeleteCustomDbEngineVersion event aren't logged. However, you might see calls from the API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for the DeleteCustomDbEngineVersion event.
For more information, see Deleting a CEV in the Amazon RDS User Guide .
See also: AWS API Documentation
Request Syntax
client.delete_custom_db_engine_version(
Engine='string',
EngineVersion='string'
)
string
[REQUIRED]
The database engine. The only supported engines are custom-oracle-ee and custom-oracle-ee-cdb .
string
[REQUIRED]
The custom engine version (CEV) for your DB instance. This option is required for RDS Custom, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Amazon Web Services Region.
dict
Response Syntax
{
'Engine': 'string',
'EngineVersion': 'string',
'DBParameterGroupFamily': 'string',
'DBEngineDescription': 'string',
'DBEngineVersionDescription': 'string',
'DefaultCharacterSet': {
'CharacterSetName': 'string',
'CharacterSetDescription': 'string'
},
'Image': {
'ImageId': 'string',
'Status': 'string'
},
'DBEngineMediaType': 'string',
'SupportedCharacterSets': [
{
'CharacterSetName': 'string',
'CharacterSetDescription': 'string'
},
],
'SupportedNcharCharacterSets': [
{
'CharacterSetName': 'string',
'CharacterSetDescription': 'string'
},
],
'ValidUpgradeTarget': [
{
'Engine': 'string',
'EngineVersion': 'string',
'Description': 'string',
'AutoUpgrade': True|False,
'IsMajorVersionUpgrade': True|False,
'SupportedEngineModes': [
'string',
],
'SupportsParallelQuery': True|False,
'SupportsGlobalDatabases': True|False,
'SupportsBabelfish': True|False,
'SupportsLocalWriteForwarding': True|False,
'SupportsIntegrations': True|False
},
],
'SupportedTimezones': [
{
'TimezoneName': 'string'
},
],
'ExportableLogTypes': [
'string',
],
'SupportsLogExportsToCloudwatchLogs': True|False,
'SupportsReadReplica': True|False,
'SupportedEngineModes': [
'string',
],
'SupportedFeatureNames': [
'string',
],
'Status': 'string',
'SupportsParallelQuery': True|False,
'SupportsGlobalDatabases': True|False,
'MajorEngineVersion': 'string',
'DatabaseInstallationFilesS3BucketName': 'string',
'DatabaseInstallationFilesS3Prefix': 'string',
'DBEngineVersionArn': 'string',
'KMSKeyId': 'string',
'CreateTime': datetime(2015, 1, 1),
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
],
'SupportsBabelfish': True|False,
'CustomDBEngineVersionManifest': 'string',
'SupportsCertificateRotationWithoutRestart': True|False,
'SupportedCACertificateIdentifiers': [
'string',
],
'SupportsLocalWriteForwarding': True|False,
'SupportsIntegrations': True|False
}
Response Structure
(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) --
The default character set for new instances of this engine version, if the CharacterSetName parameter of the CreateDBInstance API isn't specified.
CharacterSetName (string) --
The name of the character set.
CharacterSetDescription (string) --
The description of the character set.
Image (dict) --
The EC2 image
ImageId (string) --
A value that indicates the ID of the AMI.
Status (string) --
A value that indicates the status of a custom engine version (CEV).
DBEngineMediaType (string) --
A value that indicates the source media provider of the AMI based on the usage operation. Applicable for RDS Custom for SQL Server.
SupportedCharacterSets (list) --
A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance operation.
(dict) --
This data type is used as a response element in the action DescribeDBEngineVersions .
CharacterSetName (string) --
The name of the character set.
CharacterSetDescription (string) --
The description of the character set.
SupportedNcharCharacterSets (list) --
A list of the character sets supported by the Oracle DB engine for the NcharCharacterSetName parameter of the CreateDBInstance operation.
(dict) --
This data type is used as a response element in the action DescribeDBEngineVersions .
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) --
Indicates whether the target version is applied to any source DB instances that have AutoMinorVersionUpgrade set to true.
IsMajorVersionUpgrade (boolean) --
Indicates whether upgrading to the target version requires upgrading the major version of the database engine.
SupportedEngineModes (list) --
A list of the supported DB engine modes for the target engine version.
(string) --
SupportsParallelQuery (boolean) --
Indicates whether you can use Aurora parallel query with the target engine version.
SupportsGlobalDatabases (boolean) --
Indicates whether you can use Aurora global databases with the target engine version.
SupportsBabelfish (boolean) --
Indicates whether you can use Babelfish for Aurora PostgreSQL with the target engine version.
SupportsLocalWriteForwarding (boolean) --
Indicates whether the target engine version supports forwarding write operations from reader DB instances to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.
Valid for: Aurora DB clusters only
SupportsIntegrations (boolean) --
Indicates whether the DB engine version supports Aurora zero-ETL integrations with Amazon Redshift.
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 or a DBSnapshot . This data type is an element in the response to the DescribeDBInstances , the DescribeDBSnapshots , and the DescribeDBEngineVersions actions.
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) --
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.
SupportedEngineModes (list) --
A list of the supported DB engine modes.
(string) --
SupportedFeatureNames (list) --
A list of features supported by the DB engine.
The supported features vary by DB engine and DB engine version.
To determine the supported features for a specific DB engine and DB engine version using the CLI, use the following command:
aws rds describe-db-engine-versions --engine <engine_name> --engine-version <engine_version>
For example, to determine the supported features for RDS for PostgreSQL version 13.3 using the CLI, use the following command:
aws rds describe-db-engine-versions --engine postgres --engine-version 13.3
The supported features are listed under SupportedFeatureNames in the output.
(string) --
Status (string) --
The status of the DB engine version, either available or deprecated .
SupportsParallelQuery (boolean) --
Indicates whether you can use Aurora parallel query with a specific DB engine version.
SupportsGlobalDatabases (boolean) --
Indicates whether you can use Aurora global databases with a specific DB engine version.
MajorEngineVersion (string) --
The major engine version of the CEV.
DatabaseInstallationFilesS3BucketName (string) --
The name of the Amazon S3 bucket that contains your database installation files.
DatabaseInstallationFilesS3Prefix (string) --
The Amazon S3 directory that contains the database installation files. If not specified, then no prefix is assumed.
DBEngineVersionArn (string) --
The ARN of the custom engine version.
KMSKeyId (string) --
The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter is required for RDS Custom, but optional for Amazon RDS.
CreateTime (datetime) --
The creation time of the DB engine version.
TagList (list) --
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
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 only 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 only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
SupportsBabelfish (boolean) --
Indicates whether the engine version supports Babelfish for Aurora PostgreSQL.
CustomDBEngineVersionManifest (string) --
JSON string that lists the installation files and parameters that RDS Custom uses to create a custom engine version (CEV). RDS Custom applies the patches in the order in which they're listed in the manifest. You can set the Oracle home, Oracle base, and UNIX/Linux user and group using the installation parameters. For more information, see JSON fields in the CEV manifest in the Amazon RDS User Guide .
SupportsCertificateRotationWithoutRestart (boolean) --
Indicates whether the engine version supports rotating the server certificate without rebooting the DB instance.
SupportedCACertificateIdentifiers (list) --
A list of the supported CA certificate identifiers.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide .
(string) --
SupportsLocalWriteForwarding (boolean) --
Indicates whether the DB engine version supports forwarding write operations from reader DB instances to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.
Valid for: Aurora DB clusters only
SupportsIntegrations (boolean) --
Indicates whether the DB engine version supports Aurora zero-ETL integrations with Amazon Redshift.
{'DBEngineVersions': {'SupportsIntegrations': 'boolean',
'ValidUpgradeTarget': {'SupportsIntegrations': 'boolean'}}}
Describes the properties of specific versions of 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,
IncludeAll=True|False
)
string
The database engine to return version details for.
Valid Values:
aurora-mysql
aurora-postgresql
custom-oracle-ee
mariadb
mysql
oracle-ee
oracle-ee-cdb
oracle-se2
oracle-se2-cdb
postgres
sqlserver-ee
sqlserver-se
sqlserver-ex
sqlserver-web
string
A specific database engine version to return details for.
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 DB parameter group family.
list
A filter that specifies one or more DB engine versions to describe.
Supported filters:
db-parameter-group-family - Accepts parameter groups family names. The results list only includes information about the DB engine versions for these parameter group families.
engine - Accepts engine names. The results list only includes information about the DB engine versions for these engines.
engine-mode - Accepts DB engine modes. The results list only includes information about the DB engine versions for these engine modes. Valid DB engine modes are the following:
global
multimaster
parallelquery
provisioned
serverless
engine-version - Accepts engine versions. The results list only includes information about the DB engine versions for these engine versions.
status - Accepts engine version statuses. The results list only includes information about the DB engine versions for these statuses. Valid statuses are the following:
available
deprecated
(dict) --
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracks
DescribeDBClusterEndpoints
DescribeDBClusters
DescribeDBInstances
DescribePendingMaintenanceActions
Name (string) -- [REQUIRED]
The name of the filter. Filter names are case-sensitive.
Values (list) -- [REQUIRED]
One or more filter values. Filter values are case-sensitive.
(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 you can retrieve the remaining results.
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
Specifies whether to return only the default version of the specified engine or the engine and major version combination.
boolean
Specifies whether to list the supported character sets for each engine version.
If this parameter is enabled and the requested engine supports the CharacterSetName parameter for CreateDBInstance , the response includes a list of supported character sets for each engine version.
For RDS Custom, the default is not to list supported character sets. If you enable this parameter, RDS Custom returns no results.
boolean
Specifies whether to list the supported time zones for each engine version.
If this parameter is enabled and the requested engine supports the TimeZone parameter for CreateDBInstance , the response includes a list of supported time zones for each engine version.
For RDS Custom, the default is not to list supported time zones. If you enable this parameter, RDS Custom returns no results.
boolean
Specifies whether to also list the engine versions that aren't available. The default is to list only available engine versions.
dict
Response Syntax
{
'Marker': 'string',
'DBEngineVersions': [
{
'Engine': 'string',
'EngineVersion': 'string',
'DBParameterGroupFamily': 'string',
'DBEngineDescription': 'string',
'DBEngineVersionDescription': 'string',
'DefaultCharacterSet': {
'CharacterSetName': 'string',
'CharacterSetDescription': 'string'
},
'Image': {
'ImageId': 'string',
'Status': 'string'
},
'DBEngineMediaType': 'string',
'SupportedCharacterSets': [
{
'CharacterSetName': 'string',
'CharacterSetDescription': 'string'
},
],
'SupportedNcharCharacterSets': [
{
'CharacterSetName': 'string',
'CharacterSetDescription': 'string'
},
],
'ValidUpgradeTarget': [
{
'Engine': 'string',
'EngineVersion': 'string',
'Description': 'string',
'AutoUpgrade': True|False,
'IsMajorVersionUpgrade': True|False,
'SupportedEngineModes': [
'string',
],
'SupportsParallelQuery': True|False,
'SupportsGlobalDatabases': True|False,
'SupportsBabelfish': True|False,
'SupportsLocalWriteForwarding': True|False,
'SupportsIntegrations': True|False
},
],
'SupportedTimezones': [
{
'TimezoneName': 'string'
},
],
'ExportableLogTypes': [
'string',
],
'SupportsLogExportsToCloudwatchLogs': True|False,
'SupportsReadReplica': True|False,
'SupportedEngineModes': [
'string',
],
'SupportedFeatureNames': [
'string',
],
'Status': 'string',
'SupportsParallelQuery': True|False,
'SupportsGlobalDatabases': True|False,
'MajorEngineVersion': 'string',
'DatabaseInstallationFilesS3BucketName': 'string',
'DatabaseInstallationFilesS3Prefix': 'string',
'DBEngineVersionArn': 'string',
'KMSKeyId': 'string',
'CreateTime': datetime(2015, 1, 1),
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
],
'SupportsBabelfish': True|False,
'CustomDBEngineVersionManifest': 'string',
'SupportsCertificateRotationWithoutRestart': True|False,
'SupportedCACertificateIdentifiers': [
'string',
],
'SupportsLocalWriteForwarding': True|False,
'SupportsIntegrations': True|False
},
]
}
Response Structure
(dict) --
Contains the result of a successful invocation of the DescribeDBEngineVersions action.
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) --
The default character set for new instances of this engine version, if the CharacterSetName parameter of the CreateDBInstance API isn't specified.
CharacterSetName (string) --
The name of the character set.
CharacterSetDescription (string) --
The description of the character set.
Image (dict) --
The EC2 image
ImageId (string) --
A value that indicates the ID of the AMI.
Status (string) --
A value that indicates the status of a custom engine version (CEV).
DBEngineMediaType (string) --
A value that indicates the source media provider of the AMI based on the usage operation. Applicable for RDS Custom for SQL Server.
SupportedCharacterSets (list) --
A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance operation.
(dict) --
This data type is used as a response element in the action DescribeDBEngineVersions .
CharacterSetName (string) --
The name of the character set.
CharacterSetDescription (string) --
The description of the character set.
SupportedNcharCharacterSets (list) --
A list of the character sets supported by the Oracle DB engine for the NcharCharacterSetName parameter of the CreateDBInstance operation.
(dict) --
This data type is used as a response element in the action DescribeDBEngineVersions .
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) --
Indicates whether the target version is applied to any source DB instances that have AutoMinorVersionUpgrade set to true.
IsMajorVersionUpgrade (boolean) --
Indicates whether upgrading to the target version requires upgrading the major version of the database engine.
SupportedEngineModes (list) --
A list of the supported DB engine modes for the target engine version.
(string) --
SupportsParallelQuery (boolean) --
Indicates whether you can use Aurora parallel query with the target engine version.
SupportsGlobalDatabases (boolean) --
Indicates whether you can use Aurora global databases with the target engine version.
SupportsBabelfish (boolean) --
Indicates whether you can use Babelfish for Aurora PostgreSQL with the target engine version.
SupportsLocalWriteForwarding (boolean) --
Indicates whether the target engine version supports forwarding write operations from reader DB instances to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.
Valid for: Aurora DB clusters only
SupportsIntegrations (boolean) --
Indicates whether the DB engine version supports Aurora zero-ETL integrations with Amazon Redshift.
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 or a DBSnapshot . This data type is an element in the response to the DescribeDBInstances , the DescribeDBSnapshots , and the DescribeDBEngineVersions actions.
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) --
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.
SupportedEngineModes (list) --
A list of the supported DB engine modes.
(string) --
SupportedFeatureNames (list) --
A list of features supported by the DB engine.
The supported features vary by DB engine and DB engine version.
To determine the supported features for a specific DB engine and DB engine version using the CLI, use the following command:
aws rds describe-db-engine-versions --engine <engine_name> --engine-version <engine_version>
For example, to determine the supported features for RDS for PostgreSQL version 13.3 using the CLI, use the following command:
aws rds describe-db-engine-versions --engine postgres --engine-version 13.3
The supported features are listed under SupportedFeatureNames in the output.
(string) --
Status (string) --
The status of the DB engine version, either available or deprecated .
SupportsParallelQuery (boolean) --
Indicates whether you can use Aurora parallel query with a specific DB engine version.
SupportsGlobalDatabases (boolean) --
Indicates whether you can use Aurora global databases with a specific DB engine version.
MajorEngineVersion (string) --
The major engine version of the CEV.
DatabaseInstallationFilesS3BucketName (string) --
The name of the Amazon S3 bucket that contains your database installation files.
DatabaseInstallationFilesS3Prefix (string) --
The Amazon S3 directory that contains the database installation files. If not specified, then no prefix is assumed.
DBEngineVersionArn (string) --
The ARN of the custom engine version.
KMSKeyId (string) --
The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter is required for RDS Custom, but optional for Amazon RDS.
CreateTime (datetime) --
The creation time of the DB engine version.
TagList (list) --
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
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 only 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 only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
SupportsBabelfish (boolean) --
Indicates whether the engine version supports Babelfish for Aurora PostgreSQL.
CustomDBEngineVersionManifest (string) --
JSON string that lists the installation files and parameters that RDS Custom uses to create a custom engine version (CEV). RDS Custom applies the patches in the order in which they're listed in the manifest. You can set the Oracle home, Oracle base, and UNIX/Linux user and group using the installation parameters. For more information, see JSON fields in the CEV manifest in the Amazon RDS User Guide .
SupportsCertificateRotationWithoutRestart (boolean) --
Indicates whether the engine version supports rotating the server certificate without rebooting the DB instance.
SupportedCACertificateIdentifiers (list) --
A list of the supported CA certificate identifiers.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide .
(string) --
SupportsLocalWriteForwarding (boolean) --
Indicates whether the DB engine version supports forwarding write operations from reader DB instances to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.
Valid for: Aurora DB clusters only
SupportsIntegrations (boolean) --
Indicates whether the DB engine version supports Aurora zero-ETL integrations with Amazon Redshift.
{'SupportsIntegrations': 'boolean',
'ValidUpgradeTarget': {'SupportsIntegrations': 'boolean'}}
Modifies the status of a custom engine version (CEV). You can find CEVs to modify by calling DescribeDBEngineVersions .
Note
The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the ModifyCustomDbEngineVersion event aren't logged. However, you might see calls from the API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for the ModifyCustomDbEngineVersion event.
For more information, see Modifying CEV status in the Amazon RDS User Guide .
See also: AWS API Documentation
Request Syntax
client.modify_custom_db_engine_version(
Engine='string',
EngineVersion='string',
Description='string',
Status='available'|'inactive'|'inactive-except-restore'
)
string
[REQUIRED]
The DB engine. The only supported values are custom-oracle-ee and custom-oracle-ee-cdb .
string
[REQUIRED]
The custom engine version (CEV) that you want to modify. This option is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Amazon Web Services Region.
string
An optional description of your CEV.
string
The availability status to be assigned to the CEV. Valid values are as follows:
available
You can use this CEV to create a new RDS Custom DB instance.
inactive
You can create a new RDS Custom instance by restoring a DB snapshot with this CEV. You can't patch or create new instances with this CEV.
You can change any status to any status. A typical reason to change status is to prevent the accidental use of a CEV, or to make a deprecated CEV eligible for use again. For example, you might change the status of your CEV from available to inactive , and from inactive back to available . To change the availability status of the CEV, it must not currently be in use by an RDS Custom instance, snapshot, or automated backup.
dict
Response Syntax
{
'Engine': 'string',
'EngineVersion': 'string',
'DBParameterGroupFamily': 'string',
'DBEngineDescription': 'string',
'DBEngineVersionDescription': 'string',
'DefaultCharacterSet': {
'CharacterSetName': 'string',
'CharacterSetDescription': 'string'
},
'Image': {
'ImageId': 'string',
'Status': 'string'
},
'DBEngineMediaType': 'string',
'SupportedCharacterSets': [
{
'CharacterSetName': 'string',
'CharacterSetDescription': 'string'
},
],
'SupportedNcharCharacterSets': [
{
'CharacterSetName': 'string',
'CharacterSetDescription': 'string'
},
],
'ValidUpgradeTarget': [
{
'Engine': 'string',
'EngineVersion': 'string',
'Description': 'string',
'AutoUpgrade': True|False,
'IsMajorVersionUpgrade': True|False,
'SupportedEngineModes': [
'string',
],
'SupportsParallelQuery': True|False,
'SupportsGlobalDatabases': True|False,
'SupportsBabelfish': True|False,
'SupportsLocalWriteForwarding': True|False,
'SupportsIntegrations': True|False
},
],
'SupportedTimezones': [
{
'TimezoneName': 'string'
},
],
'ExportableLogTypes': [
'string',
],
'SupportsLogExportsToCloudwatchLogs': True|False,
'SupportsReadReplica': True|False,
'SupportedEngineModes': [
'string',
],
'SupportedFeatureNames': [
'string',
],
'Status': 'string',
'SupportsParallelQuery': True|False,
'SupportsGlobalDatabases': True|False,
'MajorEngineVersion': 'string',
'DatabaseInstallationFilesS3BucketName': 'string',
'DatabaseInstallationFilesS3Prefix': 'string',
'DBEngineVersionArn': 'string',
'KMSKeyId': 'string',
'CreateTime': datetime(2015, 1, 1),
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
],
'SupportsBabelfish': True|False,
'CustomDBEngineVersionManifest': 'string',
'SupportsCertificateRotationWithoutRestart': True|False,
'SupportedCACertificateIdentifiers': [
'string',
],
'SupportsLocalWriteForwarding': True|False,
'SupportsIntegrations': True|False
}
Response Structure
(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) --
The default character set for new instances of this engine version, if the CharacterSetName parameter of the CreateDBInstance API isn't specified.
CharacterSetName (string) --
The name of the character set.
CharacterSetDescription (string) --
The description of the character set.
Image (dict) --
The EC2 image
ImageId (string) --
A value that indicates the ID of the AMI.
Status (string) --
A value that indicates the status of a custom engine version (CEV).
DBEngineMediaType (string) --
A value that indicates the source media provider of the AMI based on the usage operation. Applicable for RDS Custom for SQL Server.
SupportedCharacterSets (list) --
A list of the character sets supported by this engine for the CharacterSetName parameter of the CreateDBInstance operation.
(dict) --
This data type is used as a response element in the action DescribeDBEngineVersions .
CharacterSetName (string) --
The name of the character set.
CharacterSetDescription (string) --
The description of the character set.
SupportedNcharCharacterSets (list) --
A list of the character sets supported by the Oracle DB engine for the NcharCharacterSetName parameter of the CreateDBInstance operation.
(dict) --
This data type is used as a response element in the action DescribeDBEngineVersions .
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) --
Indicates whether the target version is applied to any source DB instances that have AutoMinorVersionUpgrade set to true.
IsMajorVersionUpgrade (boolean) --
Indicates whether upgrading to the target version requires upgrading the major version of the database engine.
SupportedEngineModes (list) --
A list of the supported DB engine modes for the target engine version.
(string) --
SupportsParallelQuery (boolean) --
Indicates whether you can use Aurora parallel query with the target engine version.
SupportsGlobalDatabases (boolean) --
Indicates whether you can use Aurora global databases with the target engine version.
SupportsBabelfish (boolean) --
Indicates whether you can use Babelfish for Aurora PostgreSQL with the target engine version.
SupportsLocalWriteForwarding (boolean) --
Indicates whether the target engine version supports forwarding write operations from reader DB instances to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.
Valid for: Aurora DB clusters only
SupportsIntegrations (boolean) --
Indicates whether the DB engine version supports Aurora zero-ETL integrations with Amazon Redshift.
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 or a DBSnapshot . This data type is an element in the response to the DescribeDBInstances , the DescribeDBSnapshots , and the DescribeDBEngineVersions actions.
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) --
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.
SupportedEngineModes (list) --
A list of the supported DB engine modes.
(string) --
SupportedFeatureNames (list) --
A list of features supported by the DB engine.
The supported features vary by DB engine and DB engine version.
To determine the supported features for a specific DB engine and DB engine version using the CLI, use the following command:
aws rds describe-db-engine-versions --engine <engine_name> --engine-version <engine_version>
For example, to determine the supported features for RDS for PostgreSQL version 13.3 using the CLI, use the following command:
aws rds describe-db-engine-versions --engine postgres --engine-version 13.3
The supported features are listed under SupportedFeatureNames in the output.
(string) --
Status (string) --
The status of the DB engine version, either available or deprecated .
SupportsParallelQuery (boolean) --
Indicates whether you can use Aurora parallel query with a specific DB engine version.
SupportsGlobalDatabases (boolean) --
Indicates whether you can use Aurora global databases with a specific DB engine version.
MajorEngineVersion (string) --
The major engine version of the CEV.
DatabaseInstallationFilesS3BucketName (string) --
The name of the Amazon S3 bucket that contains your database installation files.
DatabaseInstallationFilesS3Prefix (string) --
The Amazon S3 directory that contains the database installation files. If not specified, then no prefix is assumed.
DBEngineVersionArn (string) --
The ARN of the custom engine version.
KMSKeyId (string) --
The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter is required for RDS Custom, but optional for Amazon RDS.
CreateTime (datetime) --
The creation time of the DB engine version.
TagList (list) --
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
(dict) --
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
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 only 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 only the set of Unicode letters, digits, white-space, '_', '.', ':', '/', '=', '+', '-', '@' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$").
SupportsBabelfish (boolean) --
Indicates whether the engine version supports Babelfish for Aurora PostgreSQL.
CustomDBEngineVersionManifest (string) --
JSON string that lists the installation files and parameters that RDS Custom uses to create a custom engine version (CEV). RDS Custom applies the patches in the order in which they're listed in the manifest. You can set the Oracle home, Oracle base, and UNIX/Linux user and group using the installation parameters. For more information, see JSON fields in the CEV manifest in the Amazon RDS User Guide .
SupportsCertificateRotationWithoutRestart (boolean) --
Indicates whether the engine version supports rotating the server certificate without rebooting the DB instance.
SupportedCACertificateIdentifiers (list) --
A list of the supported CA certificate identifiers.
For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide .
(string) --
SupportsLocalWriteForwarding (boolean) --
Indicates whether the DB engine version supports forwarding write operations from reader DB instances to the writer DB instance in the DB cluster. By default, write operations aren't allowed on reader DB instances.
Valid for: Aurora DB clusters only
SupportsIntegrations (boolean) --
Indicates whether the DB engine version supports Aurora zero-ETL integrations with Amazon Redshift.