RDS / Client / modify_certificates

modify_certificates#

RDS.Client.modify_certificates(**kwargs)#

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 Amazon Web Services Region.

  • RDS has already moved to a new default CA certificate for the specified Amazon Web Services 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

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

  • CertificateIdentifier (string) –

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

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

  • RemoveCustomerOverride (boolean) – Specifies whether to remove the override for the default certificate. If the override is removed, the default certificate is the system default.

Return type:

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 Amazon Web Services account.

      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.

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

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

Exceptions

  • RDS.Client.exceptions.CertificateNotFoundFault