Skip to content

RDS  >  Operations  >  modify_certificates

modify_certificates

Operation

modify_certificates async 

modify_certificates(input: ModifyCertificatesInput, plugins: list[Plugin] | None = None) -> ModifyCertificatesOutput

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.

Parameters:

Name Type Description Default
input ModifyCertificatesInput

An instance of ModifyCertificatesInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
ModifyCertificatesOutput

An instance of ModifyCertificatesOutput.

Input

ModifyCertificatesInput dataclass

Bases: _SerdeShape

Dataclass for ModifyCertificatesInput structure.

Attributes

certificate_identifier class-attribute instance-attribute 
certificate_identifier: str | None = ...

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.

remove_customer_override class-attribute instance-attribute 
remove_customer_override: bool | None = ...

Specifies whether to remove the override for the default certificate. If the override is removed, the default certificate is the system default.

Output

ModifyCertificatesOutput dataclass

Bases: _SerdeShape

Dataclass for ModifyCertificatesOutput structure.

Attributes

certificate class-attribute instance-attribute 
certificate: Certificate | None = ...

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.

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.