« blib/lib/Paws/IAM/CreatePolicyResponse.pm
↑ Summary
blib/lib/Paws/IAM/CreatePolicyVersionResponse.pm »
| 1 | |||
| 2 | package Paws::IAM::CreatePolicyVersion; | ||
| 3 | use Moose; | ||
| 4 | has PolicyArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has PolicyDocument => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has SetAsDefault => (is => 'ro', isa => 'Bool'); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreatePolicyVersion'); | ||
| 11 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::IAM::CreatePolicyVersionResponse'); | ||
| 12 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'CreatePolicyVersionResult'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::IAM::CreatePolicyVersion - Arguments for method CreatePolicyVersion on L<Paws::IAM> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method CreatePolicyVersion on the | ||
| 24 | L<AWS Identity and Access Management|Paws::IAM> service. Use the attributes of this class | ||
| 25 | as arguments to method CreatePolicyVersion. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreatePolicyVersion. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $iam = Paws->service('IAM'); | ||
| 32 | my $CreatePolicyVersionResponse = $iam->CreatePolicyVersion( | ||
| 33 | PolicyArn => 'MyarnType', | ||
| 34 | PolicyDocument => 'MypolicyDocumentType', | ||
| 35 | SetAsDefault => 1, # OPTIONAL | ||
| 36 | ); | ||
| 37 | |||
| 38 | # Results: | ||
| 39 | my $PolicyVersion = $CreatePolicyVersionResponse->PolicyVersion; | ||
| 40 | |||
| 41 | # Returns a L<Paws::IAM::CreatePolicyVersionResponse> object. | ||
| 42 | |||
| 43 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 44 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/iam/CreatePolicyVersion> | ||
| 45 | |||
| 46 | =head1 ATTRIBUTES | ||
| 47 | |||
| 48 | |||
| 49 | =head2 B<REQUIRED> PolicyArn => Str | ||
| 50 | |||
| 51 | The Amazon Resource Name (ARN) of the IAM policy to which you want to | ||
| 52 | add a new version. | ||
| 53 | |||
| 54 | For more information about ARNs, see Amazon Resource Names (ARNs) | ||
| 55 | (https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) | ||
| 56 | in the I<AWS General Reference>. | ||
| 57 | |||
| 58 | |||
| 59 | |||
| 60 | =head2 B<REQUIRED> PolicyDocument => Str | ||
| 61 | |||
| 62 | The JSON policy document that you want to use as the content for this | ||
| 63 | new version of the policy. | ||
| 64 | |||
| 65 | You must provide policies in JSON format in IAM. However, for AWS | ||
| 66 | CloudFormation templates formatted in YAML, you can provide the policy | ||
| 67 | in JSON or YAML format. AWS CloudFormation always converts a YAML | ||
| 68 | policy to JSON format before submitting it to IAM. | ||
| 69 | |||
| 70 | The regex pattern (http://wikipedia.org/wiki/regex) used to validate | ||
| 71 | this parameter is a string of characters consisting of the following: | ||
| 72 | |||
| 73 | =over | ||
| 74 | |||
| 75 | =item * | ||
| 76 | |||
| 77 | Any printable ASCII character ranging from the space character | ||
| 78 | (C<\u0020>) through the end of the ASCII character range | ||
| 79 | |||
| 80 | =item * | ||
| 81 | |||
| 82 | The printable characters in the Basic Latin and Latin-1 Supplement | ||
| 83 | character set (through C<\u00FF>) | ||
| 84 | |||
| 85 | =item * | ||
| 86 | |||
| 87 | The special characters tab (C<\u0009>), line feed (C<\u000A>), and | ||
| 88 | carriage return (C<\u000D>) | ||
| 89 | |||
| 90 | =back | ||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | |||
| 95 | =head2 SetAsDefault => Bool | ||
| 96 | |||
| 97 | Specifies whether to set this version as the policy's default version. | ||
| 98 | |||
| 99 | When this parameter is C<true>, the new policy version becomes the | ||
| 100 | operative version. That is, it becomes the version that is in effect | ||
| 101 | for the IAM users, groups, and roles that the policy is attached to. | ||
| 102 | |||
| 103 | For more information about managed policy versions, see Versioning for | ||
| 104 | managed policies | ||
| 105 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-versions.html) | ||
| 106 | in the I<IAM User Guide>. | ||
| 107 | |||
| 108 | |||
| 109 | |||
| 110 | |||
| 111 | =head1 SEE ALSO | ||
| 112 | |||
| 113 | This class forms part of L<Paws>, documenting arguments for method CreatePolicyVersion in L<Paws::IAM> | ||
| 114 | |||
| 115 | =head1 BUGS and CONTRIBUTIONS | ||
| 116 | |||
| 117 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 118 | |||
| 119 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 120 | |||
| 121 | =cut | ||
| 122 |