certificates
Creates, updates, deletes, gets or lists a certificates resource.
Overview
| Name | certificates |
| Type | Resource |
| Id | aws.docdb.certificates |
Fields
The following fields are returned by SELECT queries:
- describe_certificates
| Name | Datatype | Description |
|---|---|---|
certificate_arn | string | The Amazon Resource Name (ARN) for the certificate. Example: arn:aws:rds:us-east-1::cert:rds-ca-2019 |
certificate_identifier | string | The unique key that identifies a certificate. Example: rds-ca-2019 |
certificate_type | string | The type of the certificate. Example: CA |
thumbprint | string | The thumbprint of the certificate. |
valid_from | string | The starting date-time from which the certificate is valid. Example: 2019-07-31T17:57:09Z |
valid_till | string | The date-time after which the certificate is no longer valid. Example: 2024-07-31T17:57:09Z |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_certificates | select | region | CertificateIdentifier, Filters, MaxRecords, Marker | Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this Amazon Web Services account. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
CertificateIdentifier | string | The user-supplied certificate identifier. If this parameter is specified, information for only the specified certificate is returned. If this parameter is omitted, a list of up to MaxRecords certificates is returned. This parameter is not case sensitive. Constraints Must match an existing CertificateIdentifier. |
Filters | array | This parameter is not currently supported. |
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. |
MaxRecords | integer | 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 that the remaining results can be retrieved. Default: 100 Constraints: Minimum: 20 Maximum: 100 |
SELECT examples
- describe_certificates
Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this Amazon Web Services account.
SELECT
certificate_arn,
certificate_identifier,
certificate_type,
thumbprint,
valid_from,
valid_till
FROM aws.docdb.certificates
WHERE region = '{{ region }}' -- required
AND CertificateIdentifier = '{{ CertificateIdentifier }}'
AND Filters = '{{ Filters }}'
AND MaxRecords = '{{ MaxRecords }}'
AND Marker = '{{ Marker }}'
;