@Generated(value="software.amazon.awssdk:codegen") public final class CreateGovCloudAccountRequest extends OrganizationsRequest implements ToCopyableBuilder<CreateGovCloudAccountRequest.Builder,CreateGovCloudAccountRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
CreateGovCloudAccountRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
String |
accountName()
The friendly name of the member account.
|
static CreateGovCloudAccountRequest.Builder |
builder() |
String |
email()
Specifies the email address of the owner to assign to the new member account in the commercial Region.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
boolean |
hasTags()
For responses, this returns true if the service returned a value for the Tags property.
|
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. |
String |
iamUserAccessToBillingAsString()
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. |
String |
roleName()
(Optional)
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends CreateGovCloudAccountRequest.Builder> |
serializableBuilderClass() |
List<Tag> |
tags()
A list of tags that you want to attach to the newly created account.
|
CreateGovCloudAccountRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String 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.
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.
public final String 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 (–).
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 (–).
public final String 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: =,.@-
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: =,.@-
public final 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 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.
If the service returns an enum value that is not available in the current SDK version,
iamUserAccessToBilling will return IAMUserAccessToBilling.UNKNOWN_TO_SDK_VERSION. The raw value
returned by the service is available from iamUserAccessToBillingAsString().
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.
IAMUserAccessToBillingpublic final String iamUserAccessToBillingAsString()
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.
If the service returns an enum value that is not available in the current SDK version,
iamUserAccessToBilling will return IAMUserAccessToBilling.UNKNOWN_TO_SDK_VERSION. The raw value
returned by the service is available from iamUserAccessToBillingAsString().
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.
IAMUserAccessToBillingpublic final boolean hasTags()
isEmpty() method on the property). This is useful
because the SDK will never return a null collection or map, but you may need to differentiate between the service
returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true
if a value for the property was specified in the request builder, and false if a value was not specified.public final List<Tag> 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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasTags() method.
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.
public CreateGovCloudAccountRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<CreateGovCloudAccountRequest.Builder,CreateGovCloudAccountRequest>toBuilder in class OrganizationsRequestpublic static CreateGovCloudAccountRequest.Builder builder()
public static Class<? extends CreateGovCloudAccountRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2023. All rights reserved.