role_aliases

Creates, updates, deletes or gets a role_alias resource or lists role_aliases in a region

Overview

Name	role_aliases
Type	Resource
Description	Use the AWS::IoT::RoleAlias resource to declare an AWS IoT RoleAlias.
Id	awscc.iot.role_aliases

Fields

get (all properties)

Name	Datatype	Description
role_alias	string
role_alias_arn	string
role_arn	string
credential_duration_seconds	integer
▶tags	array
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
role_alias	string
region	string	AWS region.

For more information, see AWS::IoT::RoleAlias.

Methods

Name	Resource	Accessible by	Required Params
create_resource	role_aliases	INSERT	RoleArn, region
delete_resource	role_aliases	DELETE	Identifier, region
update_resource	role_aliases	UPDATE	Identifier, PatchDocument, region
list_resources	role_aliases_list_only	SELECT	region
get_resource	role_aliases	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual role_alias.

SELECT
  region,
  role_alias,
  role_alias_arn,
  role_arn,
  credential_duration_seconds,
  tags
FROM awscc.iot.role_aliases
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ role_alias }}';

list (identifiers only)

Lists all role_aliases in a region.

SELECT
  region,
  role_alias
FROM awscc.iot.role_aliases_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.iot.role_aliases (
  RoleArn,
  region
)
SELECT
  '{{ role_arn }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.iot.role_aliases (
  RoleAlias,
  RoleArn,
  CredentialDurationSeconds,
  Tags,
  region
)
SELECT
  '{{ role_alias }}',
  '{{ role_arn }}',
  '{{ credential_duration_seconds }}',
  '{{ tags }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: role_alias
    props:
      - name: role_alias
        value: '{{ role_alias }}'
      - name: role_arn
        value: '{{ role_arn }}'
      - name: credential_duration_seconds
        value: '{{ credential_duration_seconds }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.iot.role_aliases
SET PatchDocument = string('{{ {
    "RoleArn": role_arn,
    "CredentialDurationSeconds": credential_duration_seconds,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ role_alias }}';

DELETE example

/*+ delete */
DELETE FROM awscc.iot.role_aliases
WHERE
  Identifier = '{{ role_alias }}' AND
  region = 'us-east-1';

Permissions

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

Create

iam:GetRole,
iam:PassRole,
iot:CreateRoleAlias,
iot:DescribeRoleAlias,
iot:TagResource,
iot:ListTagsForResource,
kms:Decrypt

Read

iam:GetRole,
iam:PassRole,
iot:DescribeRoleAlias,
iot:ListTagsForResource,
kms:Decrypt

Update

iam:GetRole,
iam:PassRole,
iot:UpdateRoleAlias,
iot:DescribeRoleAlias,
iot:TagResource,
iot:UntagResource,
iot:ListTagsForResource,
kms:Decrypt

Delete

iot:DeleteRoleAlias,
iot:DescribeRoleAlias,
kms:Decrypt

List

iot:ListRoleAliases