« blib/lib/Paws/Organizations/CreateAccountStatus.pm
↑ Summary
blib/lib/Paws/Organizations/CreateGovCloudAccountResponse.pm »
| 1 | |||
| 2 | package Paws::Organizations::CreateGovCloudAccount; | ||
| 3 | use Moose; | ||
| 4 | has AccountName => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has Email => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has IamUserAccessToBilling => (is => 'ro', isa => 'Str'); | ||
| 7 | has RoleName => (is => 'ro', isa => 'Str'); | ||
| 8 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::Organizations::Tag]'); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateGovCloudAccount'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Organizations::CreateGovCloudAccountResponse'); | ||
| 14 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::Organizations::CreateGovCloudAccount - Arguments for method CreateGovCloudAccount on L<Paws::Organizations> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method CreateGovCloudAccount on the | ||
| 26 | L<AWS Organizations|Paws::Organizations> service. Use the attributes of this class | ||
| 27 | as arguments to method CreateGovCloudAccount. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateGovCloudAccount. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $organizations = Paws->service('Organizations'); | ||
| 34 | my $CreateGovCloudAccountResponse = $organizations->CreateGovCloudAccount( | ||
| 35 | AccountName => 'MyAccountName', | ||
| 36 | Email => 'MyEmail', | ||
| 37 | IamUserAccessToBilling => 'ALLOW', # OPTIONAL | ||
| 38 | RoleName => 'MyRoleName', # OPTIONAL | ||
| 39 | Tags => [ | ||
| 40 | { | ||
| 41 | Key => 'MyTagKey', # min: 1, max: 128 | ||
| 42 | Value => 'MyTagValue', # max: 256 | ||
| 43 | |||
| 44 | }, | ||
| 45 | ... | ||
| 46 | ], # OPTIONAL | ||
| 47 | ); | ||
| 48 | |||
| 49 | # Results: | ||
| 50 | my $CreateAccountStatus = | ||
| 51 | $CreateGovCloudAccountResponse->CreateAccountStatus; | ||
| 52 | |||
| 53 | # Returns a L<Paws::Organizations::CreateGovCloudAccountResponse> object. | ||
| 54 | |||
| 55 | 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. | ||
| 56 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/organizations/CreateGovCloudAccount> | ||
| 57 | |||
| 58 | =head1 ATTRIBUTES | ||
| 59 | |||
| 60 | |||
| 61 | =head2 B<REQUIRED> AccountName => Str | ||
| 62 | |||
| 63 | The friendly name of the member account. | ||
| 64 | |||
| 65 | |||
| 66 | |||
| 67 | =head2 B<REQUIRED> Email => Str | ||
| 68 | |||
| 69 | The email address of the owner to assign to the new member account in | ||
| 70 | the commercial Region. This email address must not already be | ||
| 71 | associated with another AWS account. You must use a valid email address | ||
| 72 | to complete account creation. You can't access the root user of the | ||
| 73 | account or remove an account that was created with an invalid email | ||
| 74 | address. Like all request parameters for C<CreateGovCloudAccount>, the | ||
| 75 | request for the email address for the AWS GovCloud (US) account | ||
| 76 | originates from the commercial Region, not from the AWS GovCloud (US) | ||
| 77 | Region. | ||
| 78 | |||
| 79 | |||
| 80 | |||
| 81 | =head2 IamUserAccessToBilling => Str | ||
| 82 | |||
| 83 | If set to C<ALLOW>, the new linked account in the commercial Region | ||
| 84 | enables IAM users to access account billing information I<if> they have | ||
| 85 | the required permissions. If set to C<DENY>, only the root user of the | ||
| 86 | new account can access account billing information. For more | ||
| 87 | information, see Activating Access to the Billing and Cost Management | ||
| 88 | Console | ||
| 89 | (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/grantaccess.html#ControllingAccessWebsite-Activate) | ||
| 90 | in the I<AWS Billing and Cost Management User Guide.> | ||
| 91 | |||
| 92 | If you don't specify this parameter, the value defaults to C<ALLOW>, | ||
| 93 | and IAM users and roles with the required permissions can access | ||
| 94 | billing information for the new account. | ||
| 95 | |||
| 96 | Valid values are: C<"ALLOW">, C<"DENY"> | ||
| 97 | |||
| 98 | =head2 RoleName => Str | ||
| 99 | |||
| 100 | (Optional) | ||
| 101 | |||
| 102 | The name of an IAM role that AWS Organizations automatically | ||
| 103 | preconfigures in the new member accounts in both the AWS GovCloud (US) | ||
| 104 | Region and in the commercial Region. This role trusts the management | ||
| 105 | account, allowing users in the management account to assume the role, | ||
| 106 | as permitted by the management account administrator. The role has | ||
| 107 | administrator permissions in the new member account. | ||
| 108 | |||
| 109 | If you don't specify this parameter, the role name defaults to | ||
| 110 | C<OrganizationAccountAccessRole>. | ||
| 111 | |||
| 112 | For more information about how to use this role to access the member | ||
| 113 | account, see Accessing and Administering the Member Accounts in Your | ||
| 114 | Organization | ||
| 115 | (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html#orgs_manage_accounts_create-cross-account-role) | ||
| 116 | in the I<AWS Organizations User Guide> and steps 2 and 3 in Tutorial: | ||
| 117 | Delegate Access Across AWS Accounts Using IAM Roles | ||
| 118 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_cross-account-with-roles.html) | ||
| 119 | in the I<IAM User Guide.> | ||
| 120 | |||
| 121 | The regex pattern (http://wikipedia.org/wiki/regex) that is used to | ||
| 122 | validate this parameter. The pattern can include uppercase letters, | ||
| 123 | lowercase letters, digits with no spaces, and any of the following | ||
| 124 | characters: =,.@- | ||
| 125 | |||
| 126 | |||
| 127 | |||
| 128 | =head2 Tags => ArrayRef[L<Paws::Organizations::Tag>] | ||
| 129 | |||
| 130 | A list of tags that you want to attach to the newly created account. | ||
| 131 | These tags are attached to the commercial account associated with the | ||
| 132 | GovCloud account, and not to the GovCloud account itself. To add tags | ||
| 133 | to the actual GovCloud account, call the TagResource operation in the | ||
| 134 | GovCloud region after the new GovCloud account exists. | ||
| 135 | |||
| 136 | For each tag in the list, you must specify both a tag key and a value. | ||
| 137 | You can set the value to an empty string, but you can't set it to | ||
| 138 | C<null>. For more information about tagging, see Tagging AWS | ||
| 139 | Organizations resources | ||
| 140 | (https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html) | ||
| 141 | in the AWS Organizations User Guide. | ||
| 142 | |||
| 143 | If any one of the tags is invalid or if you exceed the allowed number | ||
| 144 | of tags for an account, then the entire request fails and the account | ||
| 145 | is not created. | ||
| 146 | |||
| 147 | |||
| 148 | |||
| 149 | |||
| 150 | =head1 SEE ALSO | ||
| 151 | |||
| 152 | This class forms part of L<Paws>, documenting arguments for method CreateGovCloudAccount in L<Paws::Organizations> | ||
| 153 | |||
| 154 | =head1 BUGS and CONTRIBUTIONS | ||
| 155 | |||
| 156 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 157 | |||
| 158 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 159 | |||
| 160 | =cut | ||
| 161 |