| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::IAM::Role; | ||
| 3 | 1 | ▶ | use Moose; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 4 | 1 | has Arn => (is => 'ro', isa => 'Str', required => 1); | |
| 5 | 1 | has AssumeRolePolicyDocument => (is => 'ro', isa => 'Str', decode_as => 'URLJSON', method => 'Policy', traits => ['JSONAttribute']); | |
| 6 | 1 | has CreateDate => (is => 'ro', isa => 'Str', required => 1); | |
| 7 | 1 | has Description => (is => 'ro', isa => 'Str'); | |
| 8 | 1 | has MaxSessionDuration => (is => 'ro', isa => 'Int'); | |
| 9 | 1 | has Path => (is => 'ro', isa => 'Str', required => 1); | |
| 10 | 1 | has PermissionsBoundary => (is => 'ro', isa => 'Paws::IAM::AttachedPermissionsBoundary'); | |
| 11 | 1 | has RoleId => (is => 'ro', isa => 'Str', required => 1); | |
| 12 | 1 | has RoleLastUsed => (is => 'ro', isa => 'Paws::IAM::RoleLastUsed'); | |
| 13 | 1 | has RoleName => (is => 'ro', isa => 'Str', required => 1); | |
| 14 | 1 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::IAM::Tag]'); | |
| 15 | |||
| 16 | 1 | 1; | |
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::IAM::Role | ||
| 23 | |||
| 24 | =head1 USAGE | ||
| 25 | |||
| 26 | This class represents one of two things: | ||
| 27 | |||
| 28 | =head3 Arguments in a call to a service | ||
| 29 | |||
| 30 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 31 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 32 | |||
| 33 | As an example, if Att1 is expected to be a Paws::IAM::Role object: | ||
| 34 | |||
| 35 | $service_obj->Method(Att1 => { Arn => $value, ..., Tags => $value }); | ||
| 36 | |||
| 37 | =head3 Results returned from an API call | ||
| 38 | |||
| 39 | Use accessors for each attribute. If Att1 is expected to be an Paws::IAM::Role object: | ||
| 40 | |||
| 41 | $result = $service_obj->Method(...); | ||
| 42 | $result->Att1->Arn | ||
| 43 | |||
| 44 | =head1 DESCRIPTION | ||
| 45 | |||
| 46 | Contains information about an IAM role. This structure is returned as a | ||
| 47 | response element in several API operations that interact with roles. | ||
| 48 | |||
| 49 | =head1 ATTRIBUTES | ||
| 50 | |||
| 51 | |||
| 52 | =head2 B<REQUIRED> Arn => Str | ||
| 53 | |||
| 54 | The Amazon Resource Name (ARN) specifying the role. For more | ||
| 55 | information about ARNs and how to use them in policies, see IAM | ||
| 56 | identifiers | ||
| 57 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) | ||
| 58 | in the I<IAM User Guide> guide. | ||
| 59 | |||
| 60 | |||
| 61 | =head2 AssumeRolePolicyDocument => Str | ||
| 62 | |||
| 63 | The policy that grants an entity permission to assume the role. | ||
| 64 | |||
| 65 | |||
| 66 | =head2 B<REQUIRED> CreateDate => Str | ||
| 67 | |||
| 68 | The date and time, in ISO 8601 date-time format | ||
| 69 | (http://www.iso.org/iso/iso8601), when the role was created. | ||
| 70 | |||
| 71 | |||
| 72 | =head2 Description => Str | ||
| 73 | |||
| 74 | A description of the role that you provide. | ||
| 75 | |||
| 76 | |||
| 77 | =head2 MaxSessionDuration => Int | ||
| 78 | |||
| 79 | The maximum session duration (in seconds) for the specified role. | ||
| 80 | Anyone who uses the AWS CLI, or API to assume the role can specify the | ||
| 81 | duration using the optional C<DurationSeconds> API parameter or | ||
| 82 | C<duration-seconds> CLI parameter. | ||
| 83 | |||
| 84 | |||
| 85 | =head2 B<REQUIRED> Path => Str | ||
| 86 | |||
| 87 | The path to the role. For more information about paths, see IAM | ||
| 88 | identifiers | ||
| 89 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) | ||
| 90 | in the I<IAM User Guide>. | ||
| 91 | |||
| 92 | |||
| 93 | =head2 PermissionsBoundary => L<Paws::IAM::AttachedPermissionsBoundary> | ||
| 94 | |||
| 95 | The ARN of the policy used to set the permissions boundary for the | ||
| 96 | role. | ||
| 97 | |||
| 98 | For more information about permissions boundaries, see Permissions | ||
| 99 | boundaries for IAM identities | ||
| 100 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) | ||
| 101 | in the I<IAM User Guide>. | ||
| 102 | |||
| 103 | |||
| 104 | =head2 B<REQUIRED> RoleId => Str | ||
| 105 | |||
| 106 | The stable and unique string identifying the role. For more information | ||
| 107 | about IDs, see IAM identifiers | ||
| 108 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) | ||
| 109 | in the I<IAM User Guide>. | ||
| 110 | |||
| 111 | |||
| 112 | =head2 RoleLastUsed => L<Paws::IAM::RoleLastUsed> | ||
| 113 | |||
| 114 | Contains information about the last time that an IAM role was used. | ||
| 115 | This includes the date and time and the Region in which the role was | ||
| 116 | last used. Activity is only reported for the trailing 400 days. This | ||
| 117 | period can be shorter if your Region began supporting these features | ||
| 118 | within the last year. The role might have been used more than 400 days | ||
| 119 | ago. For more information, see Regions where data is tracked | ||
| 120 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_access-advisor.html#access-advisor_tracking-period) | ||
| 121 | in the I<IAM User Guide>. | ||
| 122 | |||
| 123 | |||
| 124 | =head2 B<REQUIRED> RoleName => Str | ||
| 125 | |||
| 126 | The friendly name that identifies the role. | ||
| 127 | |||
| 128 | |||
| 129 | =head2 Tags => ArrayRef[L<Paws::IAM::Tag>] | ||
| 130 | |||
| 131 | A list of tags that are attached to the role. For more information | ||
| 132 | about tagging, see Tagging IAM resources | ||
| 133 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the | ||
| 134 | I<IAM User Guide>. | ||
| 135 | |||
| 136 | |||
| 137 | |||
| 138 | =head1 SEE ALSO | ||
| 139 | |||
| 140 | This class forms part of L<Paws>, describing an object used in L<Paws::IAM> | ||
| 141 | |||
| 142 | =head1 BUGS and CONTRIBUTIONS | ||
| 143 | |||
| 144 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 145 | |||
| 146 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 147 | |||
| 148 | =cut | ||
| 149 | |||