crls
Creates, updates, deletes, gets or lists a crls resource.
Overview
| Name | crls |
| Type | Resource |
| Id | aws.rolesanywhere.crls |
Fields
The following fields are returned by SELECT queries:
- get_crl
- list_crls
| Name | Datatype | Description |
|---|---|---|
name | string | The name of the certificate revocation list (CRL). |
created_at | string (date-time) | The ISO-8601 timestamp when the certificate revocation list (CRL) was created. |
crl_arn | string | The ARN of the certificate revocation list (CRL). |
crl_data | string (byte) | The state of the certificate revocation list (CRL) after a read or write operation. |
crl_id | string | The unique identifier of the certificate revocation list (CRL). (pattern: <code>.[a-f0-9]{8}-([a-z0-9]{4}-){3}[a-z0-9]{12}.</code>) |
enabled | boolean | Indicates whether the certificate revocation list (CRL) is enabled. |
trust_anchor_arn | string | The ARN of the TrustAnchor the certificate revocation list (CRL) will provide revocation for. |
updated_at | string (date-time) | The ISO-8601 timestamp when the certificate revocation list (CRL) was last updated. |
| Name | Datatype | Description |
|---|---|---|
name | string | The name of the certificate revocation list (CRL). |
created_at | string (date-time) | The ISO-8601 timestamp when the certificate revocation list (CRL) was created. |
crl_arn | string | The ARN of the certificate revocation list (CRL). |
crl_data | string (byte) | The state of the certificate revocation list (CRL) after a read or write operation. |
crl_id | string | The unique identifier of the certificate revocation list (CRL). (pattern: <code>.[a-f0-9]{8}-([a-z0-9]{4}-){3}[a-z0-9]{12}.</code>) |
enabled | boolean | Indicates whether the certificate revocation list (CRL) is enabled. |
trust_anchor_arn | string | The ARN of the TrustAnchor the certificate revocation list (CRL) will provide revocation for. |
updated_at | string (date-time) | The ISO-8601 timestamp when the certificate revocation list (CRL) was last updated. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_crl | select | crl_id, region | Gets a certificate revocation list (CRL). Required permissions: rolesanywhere:GetCrl. | |
list_crls | select | region | nextToken, pageSize | Lists all certificate revocation lists (CRL) in the authenticated account and Amazon Web Services Region. Required permissions: rolesanywhere:ListCrls. |
update_crl | update | crl_id, region | Updates the certificate revocation list (CRL). A CRL is a list of certificates that have been revoked by the issuing certificate authority (CA). IAM Roles Anywhere validates against the CRL before issuing credentials. Required permissions: rolesanywhere:UpdateCrl. | |
delete_crl | delete | crl_id, region | Deletes a certificate revocation list (CRL). Required permissions: rolesanywhere:DeleteCrl. |
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 |
|---|---|---|
crl_id | string | The unique identifier of the certificate revocation list (CRL). |
region | string | AWS region (default: us-east-1) |
nextToken | string | A token that indicates where the output should continue from, if a previous request did not show all results. To get the next results, make the request again with this value. |
pageSize | integer | The number of resources in the paginated list. |
SELECT examples
- get_crl
- list_crls
Gets a certificate revocation list (CRL). Required permissions: rolesanywhere:GetCrl.
SELECT
name,
created_at,
crl_arn,
crl_data,
crl_id,
enabled,
trust_anchor_arn,
updated_at
FROM aws.rolesanywhere.crls
WHERE crl_id = '{{ crl_id }}' -- required
AND region = '{{ region }}' -- required
;
Lists all certificate revocation lists (CRL) in the authenticated account and Amazon Web Services Region. Required permissions: rolesanywhere:ListCrls.
SELECT
name,
created_at,
crl_arn,
crl_data,
crl_id,
enabled,
trust_anchor_arn,
updated_at
FROM aws.rolesanywhere.crls
WHERE region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND pageSize = '{{ pageSize }}'
;
UPDATE examples
- update_crl
Updates the certificate revocation list (CRL). A CRL is a list of certificates that have been revoked by the issuing certificate authority (CA). IAM Roles Anywhere validates against the CRL before issuing credentials. Required permissions: rolesanywhere:UpdateCrl.
UPDATE aws.rolesanywhere.crls
SET
name = '{{ name }}',
crlData = '{{ crlData }}'
WHERE
crl_id = '{{ crl_id }}' --required
AND region = '{{ region }}' --required
RETURNING
crl;
DELETE examples
- delete_crl
Deletes a certificate revocation list (CRL). Required permissions: rolesanywhere:DeleteCrl.
DELETE FROM aws.rolesanywhere.crls
WHERE crl_id = '{{ crl_id }}' --required
AND region = '{{ region }}' --required
;