role_template_versions

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

Overview

Name	role_template_versions
Type	Resource
Id	aws.iam.role_template_versions

Fields

The following fields are returned by SELECT queries:

get_role_template_version

Name	Datatype	Description
assume_role_policy_document_template	string	The trust policy template that grants an entity permission to assume roles that you create from this template.
create_timestamp	string	The date and time, in ISO 8601 date-time format, when the role template version was created.
default_minor_version	integer	The minor version that the service uses by default when you create a role from this template without specifying a minor version.
description	string	The description of the role template.
enabled	boolean	Specifies whether the role template is enabled. When a template is disabled, you cannot create roles from it.
inline_policy_templates	string	A list of inline policy templates that the service embeds in roles that you create from this template.
major_version	integer	The major version number of the role template.
managed_by_type	string	Indicates that the role template is managed by an Amazon Web Services service.
managed_by_value	string	The identifier of the Amazon Web Services service that manages the role template.
managed_policy_arns	string	A list of the ARNs of the managed policies that the service attaches to roles that you create from this template.
max_session_duration	integer	The maximum session duration (in seconds) for roles that are created from this template.
minor_version	integer	The minor version number of this role template version.
parameters_definition	string	A list of the parameters that are defined for this role template version. You supply values for these parameters when you create a role with AcquireRole.
permission_boundary_arn	string	The ARN of the policy that sets the permissions boundary for roles that you create from this template. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
role_description_pattern	string	The pattern that is used to generate the description of a role that is created from this template.
role_name_pattern	string	The pattern that is used to generate the name of a role that is created from this template. The pattern can include @{parameter} placeholders that are replaced with the values you supply in the ReplacementValues parameter of AcquireRole.
role_path_pattern	string	The pattern that is used to generate the path of a role that is created from this template.
role_tags_template	string	A list of tag templates that are applied to roles that are created from this template.
template_arn	string	The Amazon Resource Name (ARN) that identifies the role template. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
template_name	string	The friendly name that identifies the role template.
template_version_id	string	The identifier of the role template version.
update_timestamp	string	The date and time, in ISO 8601 date-time format, when the role template version was last updated.
version_enabled	boolean	Specifies whether this specific minor version of the role template is enabled.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_role_template_version	select	TemplateArn, region	MinorVersion	Retrieves information about a version of the specified role template. Role templates define a reusable configuration—including role name and path patterns, trust policy, inline and managed policies, permissions boundary, tags, and maximum session duration—that you use to create IAM roles with AcquireRole. If you do not specify a minor version, the service returns the template's default minor version.

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
TemplateArn	string	The Amazon Resource Name (ARN) of the role template whose version you want to retrieve. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.
region	string	AWS region (default: us-east-1)
MinorVersion	integer	The minor version of the role template to retrieve. If you do not specify a minor version, the service returns the template's default minor version.

SELECT examples

get_role_template_version

Retrieves information about a version of the specified role template. Role templates define a reusable configuration—including role name and path patterns, trust policy, inline and managed policies, permissions boundary, tags, and maximum session duration—that you use to create IAM roles with AcquireRole. If you do not specify a minor version, the service returns the template's default minor version.

SELECT
assume_role_policy_document_template,
create_timestamp,
default_minor_version,
description,
enabled,
inline_policy_templates,
major_version,
managed_by_type,
managed_by_value,
managed_policy_arns,
max_session_duration,
minor_version,
parameters_definition,
permission_boundary_arn,
role_description_pattern,
role_name_pattern,
role_path_pattern,
role_tags_template,
template_arn,
template_name,
template_version_id,
update_timestamp,
version_enabled
FROM aws.iam.role_template_versions
WHERE TemplateArn = '{{ TemplateArn }}' -- required
AND region = '{{ region }}' -- required
AND MinorVersion = '{{ MinorVersion }}'
;