« blib/lib/Paws/DocDB/DBClusterParameterGroupsMessage.pm
↑ Summary
blib/lib/Paws/DocDB/DBClusterSnapshot.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::DocDB::DBClusterRole; | ||
| 3 | use Moose; | ||
| 4 | has RoleArn => (is => 'ro', isa => 'Str'); | ||
| 5 | has Status => (is => 'ro', isa => 'Str'); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::DocDB::DBClusterRole | ||
| 14 | |||
| 15 | =head1 USAGE | ||
| 16 | |||
| 17 | This class represents one of two things: | ||
| 18 | |||
| 19 | =head3 Arguments in a call to a service | ||
| 20 | |||
| 21 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 22 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 23 | |||
| 24 | As an example, if Att1 is expected to be a Paws::DocDB::DBClusterRole object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { RoleArn => $value, ..., Status => $value }); | ||
| 27 | |||
| 28 | =head3 Results returned from an API call | ||
| 29 | |||
| 30 | Use accessors for each attribute. If Att1 is expected to be an Paws::DocDB::DBClusterRole object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->RoleArn | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | Describes an Identity and Access Management (IAM) role that is | ||
| 38 | associated with a cluster. | ||
| 39 | |||
| 40 | =head1 ATTRIBUTES | ||
| 41 | |||
| 42 | |||
| 43 | =head2 RoleArn => Str | ||
| 44 | |||
| 45 | The Amazon Resource Name (ARN) of the IAMrole that is associated with | ||
| 46 | the DB cluster. | ||
| 47 | |||
| 48 | |||
| 49 | =head2 Status => Str | ||
| 50 | |||
| 51 | Describes the state of association between the IAMrole and the cluster. | ||
| 52 | The C<Status> property returns one of the following values: | ||
| 53 | |||
| 54 | =over | ||
| 55 | |||
| 56 | =item * | ||
| 57 | |||
| 58 | C<ACTIVE> - The IAMrole ARN is associated with the cluster and can be | ||
| 59 | used to access other Amazon Web Services services on your behalf. | ||
| 60 | |||
| 61 | =item * | ||
| 62 | |||
| 63 | C<PENDING> - The IAMrole ARN is being associated with the cluster. | ||
| 64 | |||
| 65 | =item * | ||
| 66 | |||
| 67 | C<INVALID> - The IAMrole ARN is associated with the cluster, but the | ||
| 68 | cluster cannot assume the IAMrole to access other Amazon Web Services | ||
| 69 | services on your behalf. | ||
| 70 | |||
| 71 | =back | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | |||
| 76 | =head1 SEE ALSO | ||
| 77 | |||
| 78 | This class forms part of L<Paws>, describing an object used in L<Paws::DocDB> | ||
| 79 | |||
| 80 | =head1 BUGS and CONTRIBUTIONS | ||
| 81 | |||
| 82 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 83 | |||
| 84 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 85 | |||
| 86 | =cut | ||
| 87 |