modifyCertificates method

Future<ModifyCertificatesResult> modifyCertificates({ String? certificateIdentifier, bool? removeCustomerOverride, })

Override the system-default Secure Sockets Layer/Transport Layer Security (SSL/TLS) certificate for Amazon RDS for new DB instances temporarily, 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.

May throw CertificateNotFoundFault.

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

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

Implementation

Future<ModifyCertificatesResult> modifyCertificates({
  String? certificateIdentifier,
  bool? removeCustomerOverride,
}) async {
  final $request = <String, dynamic>{};
  certificateIdentifier
      ?.also((arg) => $request['CertificateIdentifier'] = arg);
  removeCustomerOverride
      ?.also((arg) => $request['RemoveCustomerOverride'] = arg);
  final $result = await _protocol.send(
    $request,
    action: 'ModifyCertificates',
    version: '2014-10-31',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['ModifyCertificatesMessage'],
    shapes: shapes,
    resultWrapper: 'ModifyCertificatesResult',
  );
  return ModifyCertificatesResult.fromXml($result);
}