Skip to content

Describe Certificates

rds_describe_certificates R Documentation

Lists the set of certificate authority (CA) certificates provided by Amazon RDS for this Amazon Web Services account

Description

Lists the set of certificate authority (CA) certificates provided by Amazon RDS for this 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.

Usage

rds_describe_certificates(CertificateIdentifier, Filters, MaxRecords,
  Marker)

Arguments

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

This parameter isn't currently supported.
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.
Marker

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

Value

A list with the following syntax:

list(
  DefaultCertificateForNewLaunches = "string",
  Certificates = list(
    list(
      CertificateIdentifier = "string",
      CertificateType = "string",
      Thumbprint = "string",
      ValidFrom = as.POSIXct(
        "2015-01-01"
      ),
      ValidTill = as.POSIXct(
        "2015-01-01"
      ),
      CertificateArn = "string",
      CustomerOverride = TRUE|FALSE,
      CustomerOverrideValidTill = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  Marker = "string"
)

Request syntax

svc$describe_certificates(
  CertificateIdentifier = "string",
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  MaxRecords = 123,
  Marker = "string"
)

Examples

## Not run: 
# This example lists up to 20 certificates for the specified certificate
# identifier.
svc$describe_certificates(
  CertificateIdentifier = "rds-ca-2015",
  MaxRecords = 20L
)

## End(Not run)