You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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
}

Instance Attribute Summary collapse

Instance Attribute Details

#account_nameString

The friendly name of the member account.

Returns:

  • (String)


312
313
314
315
316
317
318
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 312

class CreateAccountRequest < Struct.new(
  :email,
  :account_name,
  :role_name,
  :iam_user_access_to_billing)
  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.

Returns:

  • (String)


312
313
314
315
316
317
318
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 312

class CreateAccountRequest < Struct.new(
  :email,
  :account_name,
  :role_name,
  :iam_user_access_to_billing)
  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, then 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 do not 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)


312
313
314
315
316
317
318
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 312

class CreateAccountRequest < Struct.new(
  :email,
  :account_name,
  :role_name,
  :iam_user_access_to_billing)
  include Aws::Structure
end

#role_nameString

(Optional)

The name of an IAM role that Organizations automatically preconfigures in the new member account. This role trusts the master account, allowing users in the master account to assume the role, as permitted by the master account administrator. The role has administrator permissions in the new member account.

If you do not 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 in the AWS Organizations User Guide, and steps 2 and 3 in Tutorial: Delegate Access Across AWS Accounts Using IAM Roles in the IAM User Guide.

The regex pattern that is used to validate this parameter is a string of characters that can consist of uppercase letters, lowercase letters, digits with no spaces, and any of the following characters: =,.@-

Returns:

  • (String)


312
313
314
315
316
317
318
# File 'gems/aws-sdk-organizations/lib/aws-sdk-organizations/types.rb', line 312

class CreateAccountRequest < Struct.new(
  :email,
  :account_name,
  :role_name,
  :iam_user_access_to_billing)
  include Aws::Structure
end