Interface CreateGovCloudAccountRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateGovCloudAccountRequest.Builder,
,CreateGovCloudAccountRequest> OrganizationsRequest.Builder
,SdkBuilder<CreateGovCloudAccountRequest.Builder,
,CreateGovCloudAccountRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateGovCloudAccountRequest
-
Method Summary
Modifier and TypeMethodDescriptionaccountName
(String accountName) The friendly name of the member account.Specifies the email address of the owner to assign to the new member account in the commercial Region.iamUserAccessToBilling
(String iamUserAccessToBilling) If set toALLOW
, the new linked account in the commercial Region enables IAM users to access account billing information if they have the required permissions.iamUserAccessToBilling
(IAMUserAccessToBilling iamUserAccessToBilling) If set toALLOW
, the new linked account in the commercial Region enables IAM users to access account billing information if they have the required permissions.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.(Optional)tags
(Collection<Tag> tags) A list of tags that you want to attach to the newly created account.tags
(Consumer<Tag.Builder>... tags) A list of tags that you want to attach to the newly created account.A list of tags that you want to attach to the newly created account.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.organizations.model.OrganizationsRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
email
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, " ' ( ) < > [ ] : ; , \ | % &
-
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. 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.- Parameters:
email
- 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, " ' ( ) < > [ ] : ; , \ | % &
-
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. 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:
- Returns a reference to this object so that method calls can be chained together.
-
-
accountName
The friendly name of the member account.
The account name can consist of only the characters [a-z],[A-Z],[0-9], hyphen (-), or dot (.) You can't separate characters with a dash (–).
- Parameters:
accountName
- The friendly name of the member account.The account name can consist of only the characters [a-z],[A-Z],[0-9], hyphen (-), or dot (.) You can't separate characters with a dash (–).
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
roleName
(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: =,.@-
- Parameters:
roleName
- (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: =,.@-
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
iamUserAccessToBilling
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 toDENY
, 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 toALLOW
, the new linked account in the commercial Region enables IAM users to access account billing information if they have the required permissions. If set toDENY
, 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
CreateGovCloudAccountRequest.Builder iamUserAccessToBilling(IAMUserAccessToBilling iamUserAccessToBilling) 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 toDENY
, 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 toALLOW
, the new linked account in the commercial Region enables IAM users to access account billing information if they have the required permissions. If set toDENY
, 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
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.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. 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.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
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.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. 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.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
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.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.
Tag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<Tag>)
.- Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
CreateGovCloudAccountRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateGovCloudAccountRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-