certificate_associations
Creates, updates, deletes, gets or lists a certificate_associations resource.
Overview
| Name | certificate_associations |
| Type | Resource |
| Id | aws.rtbfabric.certificate_associations |
Fields
The following fields are returned by SELECT queries:
- get_certificate_association
- list_certificate_associations
| Name | Datatype | Description |
|---|---|---|
acm_certificate_arn | string | The Amazon Resource Name (ARN) of the ACM certificate. (pattern: <code>arn:(aws|aws-cn|aws-us-gov):acm:[a-z0-9-]+:[0-9]{12}:certificate/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>) |
associated_at | string (date-time) | The timestamp of when the certificate was associated. |
gateway_id | string | The unique identifier of the gateway. (pattern: <code>rtb-gw-[a-z0-9-]{1,25}</code>) |
status | string | The status of the certificate association. (PENDING_ASSOCIATION, ASSOCIATED, PENDING_DISASSOCIATION, DISASSOCIATED, FAILED) |
updated_at | string (date-time) | The timestamp of when the certificate association was last updated. |
| Name | Datatype | Description |
|---|---|---|
acm_certificate_arn | string | The Amazon Resource Name (ARN) of the ACM certificate. (pattern: <code>arn:(aws|aws-cn|aws-us-gov):acm:[a-z0-9-]+:[0-9]{12}:certificate/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}</code>) |
associated_at | string (date-time) | The timestamp of when the certificate was associated. |
status | string | The status of the certificate association. (PENDING_ASSOCIATION, ASSOCIATED, PENDING_DISASSOCIATION, DISASSOCIATED, FAILED) |
updated_at | string (date-time) | The timestamp of when the certificate association was last updated. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_certificate_association | select | gateway_id, acmCertificateArn, region | Retrieves the details of a certificate association with a responder gateway. | |
list_certificate_associations | select | gateway_id, region | nextToken, maxResults | Lists the certificate associations for a responder gateway. |
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 |
|---|---|---|
acmCertificateArn | string | The Amazon Resource Name (ARN) of the ACM certificate. |
gateway_id | string | The unique identifier of the gateway. |
region | string | AWS region (default: us-east-1) |
maxResults | integer | The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum. |
nextToken | string | If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. |
SELECT examples
- get_certificate_association
- list_certificate_associations
Retrieves the details of a certificate association with a responder gateway.
SELECT
acm_certificate_arn,
associated_at,
gateway_id,
status,
updated_at
FROM aws.rtbfabric.certificate_associations
WHERE gateway_id = '{{ gateway_id }}' -- required
AND acmCertificateArn = '{{ acmCertificateArn }}' -- required
AND region = '{{ region }}' -- required
;
Lists the certificate associations for a responder gateway.
SELECT
acm_certificate_arn,
associated_at,
status,
updated_at
FROM aws.rtbfabric.certificate_associations
WHERE gateway_id = '{{ gateway_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;