Amazon Relational Database Service

Override the system-default Secure Sockets Layer/Transport Layer Security (SSL/TLS) certificate for Amazon RDS for new DB instances, or remove the override.

By using this operation, you can specify an RDS-approved SSL/TLS certificate for new DB instances that is different from the default certificate provided by RDS. You can also use this operation to remove the override, so that new DB instances use the default certificate provided by RDS.

You might need to override the default certificate in the following situations:

• You already migrated your applications to support the latest certificate authority (CA) certificate, but the new CA certificate is not yet the RDS default CA certificate for the specified AWS Region.

• RDS has already moved to a new default CA certificate for the specified AWS Region, but you are still in the process of supporting the new CA certificate. In this case, you temporarily need additional time to finish your application changes.

For more information about rotating your SSL/TLS certificate for RDS DB engines, see Rotating Your SSL/TLS Certificate in the Amazon RDS User Guide.

For more information about rotating your SSL/TLS certificate for Aurora DB engines, see Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide.

See also: AWS API Documentation

Request Syntax

client.modify_certificates(
    CertificateIdentifier='string',
    RemoveCustomerOverride=True|False
)

type CertificateIdentifier:

string

param CertificateIdentifier:

The new default certificate identifier to override the current one with.

To determine the valid values, use the describe-certificates AWS CLI command or the DescribeCertificates API operation.

type RemoveCustomerOverride:

boolean

param RemoveCustomerOverride:

A value that indicates whether to remove the override for the default certificate. If the override is removed, the default certificate is the system default.

rtype:

dict

returns:

Response Syntax

{
    'Certificate': {
        'CertificateIdentifier': 'string',
        'CertificateType': 'string',
        'Thumbprint': 'string',
        'ValidFrom': datetime(2015, 1, 1),
        'ValidTill': datetime(2015, 1, 1),
        'CertificateArn': 'string',
        'CustomerOverride': True|False,
        'CustomerOverrideValidTill': datetime(2015, 1, 1)
    }
}

Response Structure

• (dict) --

  • Certificate (dict) --

    A CA certificate for an AWS account.

    • CertificateIdentifier (string) --

      The unique key that identifies a certificate.

    • CertificateType (string) --

      The type of the certificate.

    • Thumbprint (string) --

      The thumbprint of the certificate.

    • ValidFrom (datetime) --

      The starting date from which the certificate is valid.

    • ValidTill (datetime) --

      The final date that the certificate continues to be valid.

    • CertificateArn (string) --

      The Amazon Resource Name (ARN) for the certificate.

    • CustomerOverride (boolean) --

      Whether there is an override for the default certificate identifier.

    • CustomerOverrideValidTill (datetime) --

      If there is an override for the default certificate identifier, when the override expires.

{'Certificates': {'CustomerOverride': 'boolean',
                  'CustomerOverrideValidTill': 'timestamp'}}

Lists the set of CA certificates provided by Amazon RDS for this AWS account.

See also: AWS API Documentation

Request Syntax

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

type CertificateIdentifier:

string

param CertificateIdentifier:

The user-supplied certificate identifier. If this parameter is specified, information for only the identified certificate is returned. This parameter isn't case-sensitive.

Constraints:

• Must match an existing CertificateIdentifier.

type Filters:

list

param Filters:

This parameter isn't currently supported.

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

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

type MaxRecords:

integer

param MaxRecords:

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

Default: 100

Constraints: Minimum 20, maximum 100.

type Marker:

string

param Marker:

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

rtype:

dict

returns:

Response Syntax

{
    'Certificates': [
        {
            'CertificateIdentifier': 'string',
            'CertificateType': 'string',
            'Thumbprint': 'string',
            'ValidFrom': datetime(2015, 1, 1),
            'ValidTill': datetime(2015, 1, 1),
            'CertificateArn': 'string',
            'CustomerOverride': True|False,
            'CustomerOverrideValidTill': datetime(2015, 1, 1)
        },
    ],
    'Marker': 'string'
}

Response Structure

• (dict) --

  Data returned by the DescribeCertificates action.

  • Certificates (list) --

    The list of Certificate objects for the AWS account.

    • (dict) --

      A CA certificate for an AWS account.

      • CertificateIdentifier (string) --

        The unique key that identifies a certificate.

      • CertificateType (string) --

        The type of the certificate.

      • Thumbprint (string) --

        The thumbprint of the certificate.

      • ValidFrom (datetime) --

        The starting date from which the certificate is valid.

      • ValidTill (datetime) --

        The final date that the certificate continues to be valid.

      • CertificateArn (string) --

        The Amazon Resource Name (ARN) for the certificate.

      • CustomerOverride (boolean) --

        Whether there is an override for the default certificate identifier.

      • CustomerOverrideValidTill (datetime) --

        If there is an override for the default certificate identifier, when the override expires.

  • Marker (string) --

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