class Amazonite::Iam::Role

Overview

Contains information about an IAM role. This structure is returned as a response element in several API operations that interact with roles.

Defined in:

iam/role.cr

Constructors

Instance Method Summary

Constructor Detail

def self.from_xml(node : XML::Node) : self #

[View source]
def self.new(path : String, role_name : String, role_id : String, arn : String, create_date : Time, assume_role_policy_document : String | Nil = nil, description : String | Nil = nil, max_session_duration : Int32 | Nil = nil, permissions_boundary : AttachedPermissionsBoundary | Nil = nil, tags : Array(Tag) | Nil = nil, role_last_used : RoleLastUsed | Nil = nil, source_role_template : SourceRoleTemplate | Nil = nil) #

[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def arn : String #

The Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how to use them in policies, see IAM identifiers in the IAM User Guide guide.


[View source]
def arn=(arn : String) #

The Amazon Resource Name (ARN) specifying the role. For more information about ARNs and how to use them in policies, see IAM identifiers in the IAM User Guide guide.


[View source]
def assume_role_policy_document : String | Nil #

The policy that grants an entity permission to assume the role.


[View source]
def assume_role_policy_document=(assume_role_policy_document : String | Nil) #

The policy that grants an entity permission to assume the role.


[View source]
def create_date : Time #

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


[View source]
def create_date=(create_date : Time) #

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


[View source]
def description : String | Nil #

A description of the role that you provide.


[View source]
def description=(description : String | Nil) #

A description of the role that you provide.


[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def max_session_duration : Int32 | Nil #

The maximum session duration (in seconds) for the specified role. Anyone who uses the CLI, or API to assume the role can specify the duration using the optional DurationSeconds API parameter or duration-seconds CLI parameter.


[View source]
def max_session_duration=(max_session_duration : Int32 | Nil) #

The maximum session duration (in seconds) for the specified role. Anyone who uses the CLI, or API to assume the role can specify the duration using the optional DurationSeconds API parameter or duration-seconds CLI parameter.


[View source]
def path : String #

The path to the role. For more information about paths, see IAM identifiers in the IAM User Guide.


[View source]
def path=(path : String) #

The path to the role. For more information about paths, see IAM identifiers in the IAM User Guide.


[View source]
def permissions_boundary : AttachedPermissionsBoundary | Nil #

The ARN of the policy used to set the permissions boundary for the role.

For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.


[View source]
def permissions_boundary=(permissions_boundary : AttachedPermissionsBoundary | Nil) #

The ARN of the policy used to set the permissions boundary for the role.

For more information about permissions boundaries, see Permissions boundaries for IAM identities in the IAM User Guide.


[View source]
def role_id : String #

The stable and unique string identifying the role. For more information about IDs, see IAM identifiers in the IAM User Guide.


[View source]
def role_id=(role_id : String) #

The stable and unique string identifying the role. For more information about IDs, see IAM identifiers in the IAM User Guide.


[View source]
def role_last_used : RoleLastUsed | Nil #

Contains information about the last time that an IAM role was used. This includes the date and time and the Region in which the role was last used. Activity is only reported for the trailing 400 days. This period can be shorter if your Region began supporting these features within the last year. The role might have been used more than 400 days ago. For more information, see Regions where data is tracked in the IAM user Guide.


[View source]
def role_last_used=(role_last_used : RoleLastUsed | Nil) #

Contains information about the last time that an IAM role was used. This includes the date and time and the Region in which the role was last used. Activity is only reported for the trailing 400 days. This period can be shorter if your Region began supporting these features within the last year. The role might have been used more than 400 days ago. For more information, see Regions where data is tracked in the IAM user Guide.


[View source]
def role_name : String #

The friendly name that identifies the role.


[View source]
def role_name=(role_name : String) #

The friendly name that identifies the role.


[View source]
def source_role_template : SourceRoleTemplate | Nil #

Contains information about the role template that this role was created from. This member is present only for roles created with AcquireRole.


[View source]
def source_role_template=(source_role_template : SourceRoleTemplate | Nil) #

Contains information about the role template that this role was created from. This member is present only for roles created with AcquireRole.


[View source]
def tags : Array(Tag) | Nil #

A list of tags that are attached to the role. For more information about tagging, see Tagging IAM resources in the IAM User Guide.


[View source]
def tags=(tags : Array(Tag) | Nil) #

A list of tags that are attached to the role. For more information about tagging, see Tagging IAM resources in the IAM User Guide.


[View source]
def to_query_params(prefix : String) : Array(Tuple(String, String)) #

[View source]
def validate! : Nil #

[View source]