Package software.amazon.awssdk.services.organizations.model

Interface CreateAccountRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateAccountRequest.Builder,CreateAccountRequest>, OrganizationsRequest.Builder, SdkBuilder<CreateAccountRequest.Builder,CreateAccountRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateAccountRequest
public static interface CreateAccountRequest.Builder extends OrganizationsRequest.Builder, SdkPojo, CopyableBuilder<CreateAccountRequest.Builder,CreateAccountRequest>

  • Method Details

    • email

      CreateAccountRequest.Builder email(String email)

      The email address of the owner to assign to the new member account. 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, " ' ( ) < > [ ] : ; , \ | % &

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

      • The domain name can consist of only the characters [a-z],[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.

      Parameters:
      email - The email address of the owner to assign to the new member account. 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, " ' ( ) < > [ ] : ; , \ | % &

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

      • The domain name can consist of only the characters [a-z],[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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • accountName

      CreateAccountRequest.Builder accountName(String accountName)

      The friendly name of the member account.

      Parameters:
      accountName - The friendly name of the member account.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • roleName

      CreateAccountRequest.Builder roleName(String roleName)

      The name of an IAM role that 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: =,.@-

      Parameters:
      roleName - The name of an IAM role that 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:
      Returns a reference to this object so that method calls can be chained together.

    • iamUserAccessToBilling

      CreateAccountRequest.Builder iamUserAccessToBilling(String iamUserAccessToBilling)

      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 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.

      Parameters:
      iamUserAccessToBilling - 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 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • iamUserAccessToBilling

      CreateAccountRequest.Builder iamUserAccessToBilling(IAMUserAccessToBilling iamUserAccessToBilling)

      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 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.

      Parameters:
      iamUserAccessToBilling - 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 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tags

      CreateAccountRequest.Builder tags(Collection<Tag> tags)

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

      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.

      Parameters:
      tags - 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 Organizations resources in the Organizations User Guide.

      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateAccountRequest.Builder tags(Tag... tags)

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

      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.

      Parameters:
      tags - 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 Organizations resources in the Organizations User Guide.

      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateAccountRequest.Builder tags(Consumer<Tag.Builder>... tags)

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

      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.

      This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      CreateAccountRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateAccountRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.