class Aws::Organizations::Types::CreateGovCloudAccountRequest
@note When making an API call, you may pass CreateGovCloudAccountRequest
data as a hash: { email: "Email", # required account_name: "AccountName", # required role_name: "RoleName", iam_user_access_to_billing: "ALLOW", # accepts ALLOW, DENY tags: [ { key: "TagKey", # required value: "TagValue", # required }, ], }
@!attribute [rw] email
The email address of the owner to assign to the new member account in the commercial Region. This email address must not already be associated with another AWS account. You must use a valid email address to complete account creation. You can't access the root user of the account or remove an account that was created with an invalid email address. Like all request parameters for `CreateGovCloudAccount`, the request for the email address for the AWS GovCloud (US) account originates from the commercial Region, not from the AWS GovCloud (US) Region. @return [String]
@!attribute [rw] account_name
The friendly name of the member account. @return [String]
@!attribute [rw] role_name
(Optional) The name of an IAM role that AWS Organizations automatically preconfigures in the new member accounts in both the AWS GovCloud (US) Region and in the commercial Region. This role trusts the management account, allowing users in the management account to assume the role, as permitted by the management account administrator. The role has administrator permissions in the new member account. If you don't specify this parameter, the role name defaults to `OrganizationAccountAccessRole`. For more information about how to use this role to access the member account, see [Accessing and Administering the Member Accounts in Your Organization][1] in the *AWS Organizations User Guide* and steps 2 and 3 in [Tutorial: Delegate Access Across AWS Accounts Using IAM Roles][2] in the *IAM User Guide.* The [regex pattern][3] that is used to validate this parameter. The pattern can include uppercase letters, lowercase letters, digits with no spaces, and any of the following characters: =,.@- [1]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html#orgs_manage_accounts_create-cross-account-role [2]: https://docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_cross-account-with-roles.html [3]: http://wikipedia.org/wiki/regex @return [String]
@!attribute [rw] iam_user_access_to_billing
If set to `ALLOW`, the new linked account in the commercial Region enables IAM users to access account billing information *if* they have the required permissions. If set to `DENY`, only the root user of the new account can access account billing information. For more information, see [Activating Access to the Billing and Cost Management Console][1] in the *AWS Billing and Cost Management User Guide.* If you don't specify this parameter, the value defaults to `ALLOW`, and IAM users and roles with the required permissions can access billing information for the new account. [1]: https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/grantaccess.html#ControllingAccessWebsite-Activate @return [String]
@!attribute [rw] tags
A list of tags that you want to attach to the newly created account. These tags are attached to the commercial account associated with the GovCloud account, and not to the GovCloud account itself. To add tags to the actual GovCloud account, call the TagResource operation in the GovCloud region after the new GovCloud account exists. For each tag in the list, you must specify both a tag key and a value. You can set the value to an empty string, but you can't set it to `null`. For more information about tagging, see [Tagging AWS Organizations resources][1] in the AWS Organizations User Guide. <note markdown="1"> If any one of the tags is invalid or if you exceed the allowed number of tags for an account, then the entire request fails and the account is not created. </note> [1]: https://docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html @return [Array<Types::Tag>]
@see docs.aws.amazon.com/goto/WebAPI/organizations-2016-11-28/CreateGovCloudAccountRequest AWS API Documentation
Constants
- SENSITIVE