Class: Aws::IAM::Types::RoleTemplateVersion

Inherits:

Struct

• Object
• Struct
• Aws::IAM::Types::RoleTemplateVersion

Includes:

Structure

Defined in:

lib/aws-sdk-iam/types.rb

Overview

Contains information about a version of an IAM role template, including the configuration that is used to create roles with AcquireRole. This structure is returned as a response element by the GetRoleTemplateVersion operation.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #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 ⇒ Time

  The date and time, in [ISO 8601 date-time format][1], 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.

• #inline_policy_templates ⇒ Array<Types::InlinePolicy>

  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 ⇒ Array<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 ⇒ Array<Types::ParameterDefinition>

  A list of the parameters that are defined for this role template version.

• #permission_boundary_arn ⇒ String

  The ARN of the policy that sets the permissions boundary for roles that you create from this template.

• #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.

• #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 ⇒ Array<Types::TagTemplate>

  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.

• #template_name ⇒ String

  The friendly name that identifies the role template.

• #template_version_id ⇒ String

  The identifier of the role template version.

• #update_timestamp ⇒ Time

  The date and time, in [ISO 8601 date-time format][1], when the role template version was last updated.

• #version_enabled ⇒ Boolean

  Specifies whether this specific minor version of the role template is enabled.

Instance Attribute Details

#assume_role_policy_document_template ⇒ String

The trust policy template that grants an entity permission to assume roles that you create from this template.

Returns:

• (String)

# File 'lib/aws-sdk-iam/types.rb', line 10925

class RoleTemplateVersion < Struct.new(
  :template_arn,
  :template_name,
  :template_version_id,
  :description,
  :major_version,
  :default_minor_version,
  :managed_by_type,
  :managed_by_value,
  :enabled,
  :minor_version,
  :role_name_pattern,
  :role_path_pattern,
  :role_description_pattern,
  :assume_role_policy_document_template,
  :inline_policy_templates,
  :managed_policy_arns,
  :permission_boundary_arn,
  :parameters_definition,
  :role_tags_template,
  :max_session_duration,
  :version_enabled,
  :create_timestamp,
  :update_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#create_timestamp ⇒ Time

The date and time, in ISO 8601 date-time format, when the role template version was created.

Returns:

• (Time)

# File 'lib/aws-sdk-iam/types.rb', line 10925

class RoleTemplateVersion < Struct.new(
  :template_arn,
  :template_name,
  :template_version_id,
  :description,
  :major_version,
  :default_minor_version,
  :managed_by_type,
  :managed_by_value,
  :enabled,
  :minor_version,
  :role_name_pattern,
  :role_path_pattern,
  :role_description_pattern,
  :assume_role_policy_document_template,
  :inline_policy_templates,
  :managed_policy_arns,
  :permission_boundary_arn,
  :parameters_definition,
  :role_tags_template,
  :max_session_duration,
  :version_enabled,
  :create_timestamp,
  :update_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#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.

Returns:

• (Integer)

# File 'lib/aws-sdk-iam/types.rb', line 10925

class RoleTemplateVersion < Struct.new(
  :template_arn,
  :template_name,
  :template_version_id,
  :description,
  :major_version,
  :default_minor_version,
  :managed_by_type,
  :managed_by_value,
  :enabled,
  :minor_version,
  :role_name_pattern,
  :role_path_pattern,
  :role_description_pattern,
  :assume_role_policy_document_template,
  :inline_policy_templates,
  :managed_policy_arns,
  :permission_boundary_arn,
  :parameters_definition,
  :role_tags_template,
  :max_session_duration,
  :version_enabled,
  :create_timestamp,
  :update_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of the role template.

Returns:

• (String)

# File 'lib/aws-sdk-iam/types.rb', line 10925

class RoleTemplateVersion < Struct.new(
  :template_arn,
  :template_name,
  :template_version_id,
  :description,
  :major_version,
  :default_minor_version,
  :managed_by_type,
  :managed_by_value,
  :enabled,
  :minor_version,
  :role_name_pattern,
  :role_path_pattern,
  :role_description_pattern,
  :assume_role_policy_document_template,
  :inline_policy_templates,
  :managed_policy_arns,
  :permission_boundary_arn,
  :parameters_definition,
  :role_tags_template,
  :max_session_duration,
  :version_enabled,
  :create_timestamp,
  :update_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#enabled ⇒ Boolean

Specifies whether the role template is enabled. When a template is disabled, you cannot create roles from it.

Returns:

• (Boolean)

# File 'lib/aws-sdk-iam/types.rb', line 10925

class RoleTemplateVersion < Struct.new(
  :template_arn,
  :template_name,
  :template_version_id,
  :description,
  :major_version,
  :default_minor_version,
  :managed_by_type,
  :managed_by_value,
  :enabled,
  :minor_version,
  :role_name_pattern,
  :role_path_pattern,
  :role_description_pattern,
  :assume_role_policy_document_template,
  :inline_policy_templates,
  :managed_policy_arns,
  :permission_boundary_arn,
  :parameters_definition,
  :role_tags_template,
  :max_session_duration,
  :version_enabled,
  :create_timestamp,
  :update_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#inline_policy_templates ⇒ Array<Types::InlinePolicy>

A list of inline policy templates that the service embeds in roles that you create from this template.

Returns:

• (Array<Types::InlinePolicy>)

# File 'lib/aws-sdk-iam/types.rb', line 10925

class RoleTemplateVersion < Struct.new(
  :template_arn,
  :template_name,
  :template_version_id,
  :description,
  :major_version,
  :default_minor_version,
  :managed_by_type,
  :managed_by_value,
  :enabled,
  :minor_version,
  :role_name_pattern,
  :role_path_pattern,
  :role_description_pattern,
  :assume_role_policy_document_template,
  :inline_policy_templates,
  :managed_policy_arns,
  :permission_boundary_arn,
  :parameters_definition,
  :role_tags_template,
  :max_session_duration,
  :version_enabled,
  :create_timestamp,
  :update_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#major_version ⇒ Integer

The major version number of the role template.

Returns:

• (Integer)

# File 'lib/aws-sdk-iam/types.rb', line 10925

class RoleTemplateVersion < Struct.new(
  :template_arn,
  :template_name,
  :template_version_id,
  :description,
  :major_version,
  :default_minor_version,
  :managed_by_type,
  :managed_by_value,
  :enabled,
  :minor_version,
  :role_name_pattern,
  :role_path_pattern,
  :role_description_pattern,
  :assume_role_policy_document_template,
  :inline_policy_templates,
  :managed_policy_arns,
  :permission_boundary_arn,
  :parameters_definition,
  :role_tags_template,
  :max_session_duration,
  :version_enabled,
  :create_timestamp,
  :update_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#managed_by_type ⇒ String

Indicates that the role template is managed by an Amazon Web Services service.

Returns:

• (String)

# File 'lib/aws-sdk-iam/types.rb', line 10925

class RoleTemplateVersion < Struct.new(
  :template_arn,
  :template_name,
  :template_version_id,
  :description,
  :major_version,
  :default_minor_version,
  :managed_by_type,
  :managed_by_value,
  :enabled,
  :minor_version,
  :role_name_pattern,
  :role_path_pattern,
  :role_description_pattern,
  :assume_role_policy_document_template,
  :inline_policy_templates,
  :managed_policy_arns,
  :permission_boundary_arn,
  :parameters_definition,
  :role_tags_template,
  :max_session_duration,
  :version_enabled,
  :create_timestamp,
  :update_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#managed_by_value ⇒ String

The identifier of the Amazon Web Services service that manages the role template.

Returns:

• (String)

# File 'lib/aws-sdk-iam/types.rb', line 10925

class RoleTemplateVersion < Struct.new(
  :template_arn,
  :template_name,
  :template_version_id,
  :description,
  :major_version,
  :default_minor_version,
  :managed_by_type,
  :managed_by_value,
  :enabled,
  :minor_version,
  :role_name_pattern,
  :role_path_pattern,
  :role_description_pattern,
  :assume_role_policy_document_template,
  :inline_policy_templates,
  :managed_policy_arns,
  :permission_boundary_arn,
  :parameters_definition,
  :role_tags_template,
  :max_session_duration,
  :version_enabled,
  :create_timestamp,
  :update_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#managed_policy_arns ⇒ Array<String>

A list of the ARNs of the managed policies that the service attaches to roles that you create from this template.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-iam/types.rb', line 10925

class RoleTemplateVersion < Struct.new(
  :template_arn,
  :template_name,
  :template_version_id,
  :description,
  :major_version,
  :default_minor_version,
  :managed_by_type,
  :managed_by_value,
  :enabled,
  :minor_version,
  :role_name_pattern,
  :role_path_pattern,
  :role_description_pattern,
  :assume_role_policy_document_template,
  :inline_policy_templates,
  :managed_policy_arns,
  :permission_boundary_arn,
  :parameters_definition,
  :role_tags_template,
  :max_session_duration,
  :version_enabled,
  :create_timestamp,
  :update_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#max_session_duration ⇒ Integer

The maximum session duration (in seconds) for roles that are created from this template.

Returns:

• (Integer)

# File 'lib/aws-sdk-iam/types.rb', line 10925

class RoleTemplateVersion < Struct.new(
  :template_arn,
  :template_name,
  :template_version_id,
  :description,
  :major_version,
  :default_minor_version,
  :managed_by_type,
  :managed_by_value,
  :enabled,
  :minor_version,
  :role_name_pattern,
  :role_path_pattern,
  :role_description_pattern,
  :assume_role_policy_document_template,
  :inline_policy_templates,
  :managed_policy_arns,
  :permission_boundary_arn,
  :parameters_definition,
  :role_tags_template,
  :max_session_duration,
  :version_enabled,
  :create_timestamp,
  :update_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#minor_version ⇒ Integer

The minor version number of this role template version.

Returns:

• (Integer)

# File 'lib/aws-sdk-iam/types.rb', line 10925

class RoleTemplateVersion < Struct.new(
  :template_arn,
  :template_name,
  :template_version_id,
  :description,
  :major_version,
  :default_minor_version,
  :managed_by_type,
  :managed_by_value,
  :enabled,
  :minor_version,
  :role_name_pattern,
  :role_path_pattern,
  :role_description_pattern,
  :assume_role_policy_document_template,
  :inline_policy_templates,
  :managed_policy_arns,
  :permission_boundary_arn,
  :parameters_definition,
  :role_tags_template,
  :max_session_duration,
  :version_enabled,
  :create_timestamp,
  :update_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#parameters_definition ⇒ Array<Types::ParameterDefinition>

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.

Returns:

• (Array<Types::ParameterDefinition>)

# File 'lib/aws-sdk-iam/types.rb', line 10925

class RoleTemplateVersion < Struct.new(
  :template_arn,
  :template_name,
  :template_version_id,
  :description,
  :major_version,
  :default_minor_version,
  :managed_by_type,
  :managed_by_value,
  :enabled,
  :minor_version,
  :role_name_pattern,
  :role_path_pattern,
  :role_description_pattern,
  :assume_role_policy_document_template,
  :inline_policy_templates,
  :managed_policy_arns,
  :permission_boundary_arn,
  :parameters_definition,
  :role_tags_template,
  :max_session_duration,
  :version_enabled,
  :create_timestamp,
  :update_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#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.

Returns:

• (String)

# File 'lib/aws-sdk-iam/types.rb', line 10925

class RoleTemplateVersion < Struct.new(
  :template_arn,
  :template_name,
  :template_version_id,
  :description,
  :major_version,
  :default_minor_version,
  :managed_by_type,
  :managed_by_value,
  :enabled,
  :minor_version,
  :role_name_pattern,
  :role_path_pattern,
  :role_description_pattern,
  :assume_role_policy_document_template,
  :inline_policy_templates,
  :managed_policy_arns,
  :permission_boundary_arn,
  :parameters_definition,
  :role_tags_template,
  :max_session_duration,
  :version_enabled,
  :create_timestamp,
  :update_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#role_description_pattern ⇒ String

The pattern that is used to generate the description of a role that is created from this template.

Returns:

• (String)

# File 'lib/aws-sdk-iam/types.rb', line 10925

class RoleTemplateVersion < Struct.new(
  :template_arn,
  :template_name,
  :template_version_id,
  :description,
  :major_version,
  :default_minor_version,
  :managed_by_type,
  :managed_by_value,
  :enabled,
  :minor_version,
  :role_name_pattern,
  :role_path_pattern,
  :role_description_pattern,
  :assume_role_policy_document_template,
  :inline_policy_templates,
  :managed_policy_arns,
  :permission_boundary_arn,
  :parameters_definition,
  :role_tags_template,
  :max_session_duration,
  :version_enabled,
  :create_timestamp,
  :update_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#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.

Returns:

• (String)

# File 'lib/aws-sdk-iam/types.rb', line 10925

class RoleTemplateVersion < Struct.new(
  :template_arn,
  :template_name,
  :template_version_id,
  :description,
  :major_version,
  :default_minor_version,
  :managed_by_type,
  :managed_by_value,
  :enabled,
  :minor_version,
  :role_name_pattern,
  :role_path_pattern,
  :role_description_pattern,
  :assume_role_policy_document_template,
  :inline_policy_templates,
  :managed_policy_arns,
  :permission_boundary_arn,
  :parameters_definition,
  :role_tags_template,
  :max_session_duration,
  :version_enabled,
  :create_timestamp,
  :update_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#role_path_pattern ⇒ String

The pattern that is used to generate the path of a role that is created from this template.

Returns:

• (String)

# File 'lib/aws-sdk-iam/types.rb', line 10925

class RoleTemplateVersion < Struct.new(
  :template_arn,
  :template_name,
  :template_version_id,
  :description,
  :major_version,
  :default_minor_version,
  :managed_by_type,
  :managed_by_value,
  :enabled,
  :minor_version,
  :role_name_pattern,
  :role_path_pattern,
  :role_description_pattern,
  :assume_role_policy_document_template,
  :inline_policy_templates,
  :managed_policy_arns,
  :permission_boundary_arn,
  :parameters_definition,
  :role_tags_template,
  :max_session_duration,
  :version_enabled,
  :create_timestamp,
  :update_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#role_tags_template ⇒ Array<Types::TagTemplate>

A list of tag templates that are applied to roles that are created from this template.

Returns:

• (Array<Types::TagTemplate>)

# File 'lib/aws-sdk-iam/types.rb', line 10925

class RoleTemplateVersion < Struct.new(
  :template_arn,
  :template_name,
  :template_version_id,
  :description,
  :major_version,
  :default_minor_version,
  :managed_by_type,
  :managed_by_value,
  :enabled,
  :minor_version,
  :role_name_pattern,
  :role_path_pattern,
  :role_description_pattern,
  :assume_role_policy_document_template,
  :inline_policy_templates,
  :managed_policy_arns,
  :permission_boundary_arn,
  :parameters_definition,
  :role_tags_template,
  :max_session_duration,
  :version_enabled,
  :create_timestamp,
  :update_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#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.

Returns:

• (String)

# File 'lib/aws-sdk-iam/types.rb', line 10925

class RoleTemplateVersion < Struct.new(
  :template_arn,
  :template_name,
  :template_version_id,
  :description,
  :major_version,
  :default_minor_version,
  :managed_by_type,
  :managed_by_value,
  :enabled,
  :minor_version,
  :role_name_pattern,
  :role_path_pattern,
  :role_description_pattern,
  :assume_role_policy_document_template,
  :inline_policy_templates,
  :managed_policy_arns,
  :permission_boundary_arn,
  :parameters_definition,
  :role_tags_template,
  :max_session_duration,
  :version_enabled,
  :create_timestamp,
  :update_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#template_name ⇒ String

The friendly name that identifies the role template.

Returns:

• (String)

# File 'lib/aws-sdk-iam/types.rb', line 10925

class RoleTemplateVersion < Struct.new(
  :template_arn,
  :template_name,
  :template_version_id,
  :description,
  :major_version,
  :default_minor_version,
  :managed_by_type,
  :managed_by_value,
  :enabled,
  :minor_version,
  :role_name_pattern,
  :role_path_pattern,
  :role_description_pattern,
  :assume_role_policy_document_template,
  :inline_policy_templates,
  :managed_policy_arns,
  :permission_boundary_arn,
  :parameters_definition,
  :role_tags_template,
  :max_session_duration,
  :version_enabled,
  :create_timestamp,
  :update_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#template_version_id ⇒ String

The identifier of the role template version.

Returns:

• (String)

# File 'lib/aws-sdk-iam/types.rb', line 10925

class RoleTemplateVersion < Struct.new(
  :template_arn,
  :template_name,
  :template_version_id,
  :description,
  :major_version,
  :default_minor_version,
  :managed_by_type,
  :managed_by_value,
  :enabled,
  :minor_version,
  :role_name_pattern,
  :role_path_pattern,
  :role_description_pattern,
  :assume_role_policy_document_template,
  :inline_policy_templates,
  :managed_policy_arns,
  :permission_boundary_arn,
  :parameters_definition,
  :role_tags_template,
  :max_session_duration,
  :version_enabled,
  :create_timestamp,
  :update_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#update_timestamp ⇒ Time

The date and time, in ISO 8601 date-time format, when the role template version was last updated.

Returns:

• (Time)

# File 'lib/aws-sdk-iam/types.rb', line 10925

class RoleTemplateVersion < Struct.new(
  :template_arn,
  :template_name,
  :template_version_id,
  :description,
  :major_version,
  :default_minor_version,
  :managed_by_type,
  :managed_by_value,
  :enabled,
  :minor_version,
  :role_name_pattern,
  :role_path_pattern,
  :role_description_pattern,
  :assume_role_policy_document_template,
  :inline_policy_templates,
  :managed_policy_arns,
  :permission_boundary_arn,
  :parameters_definition,
  :role_tags_template,
  :max_session_duration,
  :version_enabled,
  :create_timestamp,
  :update_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#version_enabled ⇒ Boolean

Specifies whether this specific minor version of the role template is enabled.

Returns:

• (Boolean)

# File 'lib/aws-sdk-iam/types.rb', line 10925

class RoleTemplateVersion < Struct.new(
  :template_arn,
  :template_name,
  :template_version_id,
  :description,
  :major_version,
  :default_minor_version,
  :managed_by_type,
  :managed_by_value,
  :enabled,
  :minor_version,
  :role_name_pattern,
  :role_path_pattern,
  :role_description_pattern,
  :assume_role_policy_document_template,
  :inline_policy_templates,
  :managed_policy_arns,
  :permission_boundary_arn,
  :parameters_definition,
  :role_tags_template,
  :max_session_duration,
  :version_enabled,
  :create_timestamp,
  :update_timestamp)
  SENSITIVE = []
  include Aws::Structure
end