Class: Aws::Organizations::Types::CreateAccountRequest

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

Overview

Note:

When making an API call, you may pass CreateAccountRequest 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
    },
  ],
}

Constant Summary collapse

SENSITIVE =
[:email, :account_name]

Instance Attribute Summary collapse

Instance Attribute Details

#account_nameString

The friendly name of the member account.

Returns:

  • (String)


690
691
692
693
694
695
696
697
698
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 690

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

#emailString

The email address of the owner to assign to the new member account. 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.

Returns:

  • (String)


690
691
692
693
694
695
696
697
698
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 690

class CreateAccountRequest < 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_billingString

If set to ALLOW, the new account 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 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.

Returns:

  • (String)


690
691
692
693
694
695
696
697
698
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 690

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

#role_nameString

(Optional)

The name of an IAM role that AWS Organizations automatically preconfigures in the new member account. 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:

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: =,.@-

Returns:

  • (String)


690
691
692
693
694
695
696
697
698
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 690

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

#tagsArray<Types::Tag>

A list of tags that you want to attach to the newly created account. 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 in the AWS Organizations User Guide.

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.

Returns:



690
691
692
693
694
695
696
697
698
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 690

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