role_alias

Creates, updates, deletes, gets or lists a role_alias resource.

Overview

Name	role_alias
Type	Resource
Id	aws.iot.role_alias

Fields

The following fields are returned by SELECT queries:

describe_role_alias

Name	Datatype	Description
creation_date	string (date-time)	The UNIX timestamp of when the role alias was created.
credential_duration_seconds	integer	The number of seconds for which the credential is valid.
last_modified_date	string (date-time)	The UNIX timestamp of when the role alias was last modified.
owner	string	The role alias owner. (pattern: <code>[0-9]+</code>)
role_alias	string	The role alias. (pattern: <code>[\w=,@-]+</code>)
role_alias_arn	string	The ARN of the role alias.
role_arn	string	The role ARN.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_role_alias	select	role_alias, region		Describes a role alias. Requires permission to access the DescribeRoleAlias action.
create_role_alias	insert	role_alias, region, roleArn		Creates a role alias. Requires permission to access the CreateRoleAlias action. The value of credentialDurationSeconds must be less than or equal to the maximum session duration of the IAM role that the role alias references. For more information, see Modifying a role maximum session duration (Amazon Web Services API) from the Amazon Web Services Identity and Access Management User Guide.
update_role_alias	update	role_alias, region		Updates a role alias. Requires permission to access the UpdateRoleAlias action. The value of credentialDurationSeconds must be less than or equal to the maximum session duration of the IAM role that the role alias references. For more information, see Modifying a role maximum session duration (Amazon Web Services API) from the Amazon Web Services Identity and Access Management User Guide.
delete_role_alias	delete	role_alias, region		Deletes a role alias Requires permission to access the DeleteRoleAlias action.

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)
role_alias	string	The role alias to delete.

SELECT examples

describe_role_alias

Describes a role alias. Requires permission to access the DescribeRoleAlias action.

SELECT
creation_date,
credential_duration_seconds,
last_modified_date,
owner,
role_alias,
role_alias_arn,
role_arn
FROM aws.iot.role_alias
WHERE role_alias = '{{ role_alias }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples

create_role_alias

Creates a role alias. Requires permission to access the CreateRoleAlias action. The value of credentialDurationSeconds must be less than or equal to the maximum session duration of the IAM role that the role alias references. For more information, see Modifying a role maximum session duration (Amazon Web Services API) from the Amazon Web Services Identity and Access Management User Guide.

INSERT INTO aws.iot.role_alias (
roleArn,
credentialDurationSeconds,
tags,
role_alias,
region
)
SELECT 
'{{ roleArn }}' /* required */,
{{ credentialDurationSeconds }},
'{{ tags }}',
'{{ role_alias }}',
'{{ region }}'
RETURNING
role_alias,
role_alias_arn
;

Manifest

# Description fields are for documentation purposes
- name: role_alias
props:
  - name: role_alias
    value: "{{ role_alias }}"
    description: Required parameter for the role_alias resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the role_alias resource.
  - name: roleArn
    value: "{{ roleArn }}"
  - name: credentialDurationSeconds
    value: {{ credentialDurationSeconds }}
  - name: tags
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

UPDATE examples

update_role_alias

Updates a role alias. Requires permission to access the UpdateRoleAlias action. The value of credentialDurationSeconds must be less than or equal to the maximum session duration of the IAM role that the role alias references. For more information, see Modifying a role maximum session duration (Amazon Web Services API) from the Amazon Web Services Identity and Access Management User Guide.

UPDATE aws.iot.role_alias
SET 
roleArn = '{{ roleArn }}',
credentialDurationSeconds = {{ credentialDurationSeconds }}
WHERE 
role_alias = '{{ role_alias }}' --required
AND region = '{{ region }}' --required
RETURNING
role_alias,
role_alias_arn;

DELETE examples

delete_role_alias

Deletes a role alias Requires permission to access the DeleteRoleAlias action.

DELETE FROM aws.iot.role_alias
WHERE role_alias = '{{ role_alias }}' --required
AND region = '{{ region }}' --required
;