crls

Creates, updates, deletes or gets a crl resource or lists crls in a region

Overview

Name	crls
Type	Resource
Description	Definition of AWS::RolesAnywhere::CRL Resource Type
Id	awscc.rolesanywhere.crls

Fields

get (all properties)

Name	Datatype	Description
crl_data	string
crl_id	string
enabled	boolean
name	string
trust_anchor_arn	string
▶tags	array
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
crl_id	string
region	string	AWS region.

For more information, see AWS::RolesAnywhere::CRL.

Methods

Name	Resource	Accessible by	Required Params
create_resource	crls	INSERT	Name, CrlData, region
delete_resource	crls	DELETE	Identifier, region
update_resource	crls	UPDATE	Identifier, PatchDocument, region
list_resources	crls_list_only	SELECT	region
get_resource	crls	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual crl.

SELECT
  region,
  crl_data,
  crl_id,
  enabled,
  name,
  trust_anchor_arn,
  tags
FROM awscc.rolesanywhere.crls
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ crl_id }}';

list (identifiers only)

Lists all crls in a region.

SELECT
  region,
  crl_id
FROM awscc.rolesanywhere.crls_list_only
WHERE
  region = '{{ region }}';

INSERT example

Use the following StackQL query and manifest file to create a new crl resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.rolesanywhere.crls (
  CrlData,
  Name,
  region
)
SELECT
  '{{ crl_data }}',
  '{{ name }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.rolesanywhere.crls (
  CrlData,
  Enabled,
  Name,
  TrustAnchorArn,
  Tags,
  region
)
SELECT
  '{{ crl_data }}',
  '{{ enabled }}',
  '{{ name }}',
  '{{ trust_anchor_arn }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: crl
  props:
    - name: crl_data
      value: '{{ crl_data }}'
    - name: enabled
      value: '{{ enabled }}'
    - name: name
      value: '{{ name }}'
    - name: trust_anchor_arn
      value: '{{ trust_anchor_arn }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

Use the following StackQL query and manifest file to update a crl resource, using stack-deploy.

/*+ update */
UPDATE awscc.rolesanywhere.crls
SET PatchDocument = string('{{ {
    "CrlData": crl_data,
    "Enabled": enabled,
    "Name": name,
    "TrustAnchorArn": trust_anchor_arn,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ crl_id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.rolesanywhere.crls
WHERE
  Identifier = '{{ crl_id }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

To operate on the crls resource, the following permissions are required:

Create

rolesanywhere:ImportCrl,
rolesanywhere:TagResource

Read

rolesanywhere:GetCrl,
rolesanywhere:ListTagsForResource

Update

rolesanywhere:EnableCrl,
rolesanywhere:DisableCrl,
rolesanywhere:UpdateCrl,
rolesanywhere:TagResource,
rolesanywhere:UntagResource,
rolesanywhere:ListTagsForResource

Delete

rolesanywhere:DeleteCrl

List

rolesanywhere:ListCrls,
rolesanywhere:ListTagsForResource