Class: Aws::Organizations::Types::CreateGovCloudAccountRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-organizations/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:email, :account_name]

Instance Attribute Summary collapse

Instance Attribute Details

#account_name ⇒ String

The friendly name of the member account.

The account name can consist of only the characters [a-z],,[0-9], hyphen (-), or dot (.) You can’t separate characters with a dash (–).

Returns:

  • (String) 


1041
1042
1043
1044
1045
1046
1047
1048
1049
 
# File 'lib/aws-sdk-organizations/types.rb', line 1041

class CreateGovCloudAccountRequest < Struct.new(
  :email,
  :account_name,
  :role_name,
  :iam_user_access_to_billing,
  :tags)
  SENSITIVE = [:email, :account_name]
  include Aws::Structure
end

#email ⇒ String

Specifies 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 Amazon Web Services account. You must use a valid email address to complete account creation.

The rules for a valid email address:

  • The address must be a minimum of 6 and a maximum of 64 characters long.

  • All characters must be 7-bit ASCII characters.

  • There must be one and only one @ symbol, which separates the local name from the domain name.

  • The local name can’t contain any of the following characters:

    whitespace, “ ‘ ( ) &lt; &gt; [ ] : ; , \ | % &amp;

  • The local name can’t begin with a dot (.)

  • The domain name can consist of only the characters [a-z],,[0-9], hyphen (-), or dot (.)

  • The domain name can’t begin or end with a hyphen (-) or dot (.)

  • The domain name must contain at least one dot

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 Amazon Web Services GovCloud (US) account originates from the commercial Region, not from the Amazon Web Services GovCloud (US) Region.

Returns:

  • (String) 


1041
1042
1043
1044
1045
1046
1047
1048
1049
 
# File 'lib/aws-sdk-organizations/types.rb', line 1041

class CreateGovCloudAccountRequest < Struct.new(
  :email,
  :account_name,
  :role_name,
  :iam_user_access_to_billing,
  :tags)
  SENSITIVE = [:email, :account_name]
  include Aws::Structure
end

#iam_user_access_to_billing ⇒ String

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 [About IAM access to the Billing and Cost Management console] in the *Amazon Web Services 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]: docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/grantaccess.html#ControllingAccessWebsite-Activate

Returns:

  • (String) 


1041
1042
1043
1044
1045
1046
1047
1048
1049
 
# File 'lib/aws-sdk-organizations/types.rb', line 1041

class CreateGovCloudAccountRequest < Struct.new(
  :email,
  :account_name,
  :role_name,
  :iam_user_access_to_billing,
  :tags)
  SENSITIVE = [:email, :account_name]
  include Aws::Structure
end

#role_name ⇒ String

(Optional)

The name of an IAM role that Organizations automatically preconfigures in the new member accounts in both the Amazon Web Services 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 the following links:

  • [Creating the OrganizationAccountAccessRole in an invited member account] in the *Organizations User Guide*

  • Steps 2 and 3 in [IAM Tutorial: Delegate access across Amazon Web Services accounts using IAM roles] in the *IAM User Guide*

The [regex pattern] 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]: docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html#orgs_manage_accounts_create-cross-account-role [2]: docs.aws.amazon.com/IAM/latest/UserGuide/tutorial_cross-account-with-roles.html [3]: wikipedia.org/wiki/regex

Returns:

  • (String) 


1041
1042
1043
1044
1045
1046
1047
1048
1049
 
# File 'lib/aws-sdk-organizations/types.rb', line 1041

class CreateGovCloudAccountRequest < Struct.new(
  :email,
  :account_name,
  :role_name,
  :iam_user_access_to_billing,
  :tags)
  SENSITIVE = [:email, :account_name]
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

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 Organizations resources] in the Organizations User Guide.

<note markdown=“1”> If any one of the tags is not valid or if you exceed the maximum allowed number of tags for an account, then the entire request fails and the account is not created.

</note>

[1]: docs.aws.amazon.com/organizations/latest/userguide/orgs_tagging.html

Returns:



1041
1042
1043
1044
1045
1046
1047
1048
1049
 
# File 'lib/aws-sdk-organizations/types.rb', line 1041

class CreateGovCloudAccountRequest < Struct.new(
  :email,
  :account_name,
  :role_name,
  :iam_user_access_to_billing,
  :tags)
  SENSITIVE = [:email, :account_name]
  include Aws::Structure
end