Interface InviteAccountToOrganizationRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<InviteAccountToOrganizationRequest.Builder,
,InviteAccountToOrganizationRequest> OrganizationsRequest.Builder
,SdkBuilder<InviteAccountToOrganizationRequest.Builder,
,InviteAccountToOrganizationRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
InviteAccountToOrganizationRequest
-
Method Summary
Modifier and TypeMethodDescriptionAdditional information that you want to include in the generated email to the recipient account owner.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.tags
(Collection<Tag> tags) A list of tags that you want to attach to the account when it becomes a member of the organization.tags
(Consumer<Tag.Builder>... tags) A list of tags that you want to attach to the account when it becomes a member of the organization.A list of tags that you want to attach to the account when it becomes a member of the organization.target
(Consumer<HandshakeParty.Builder> target) The identifier (ID) of the Amazon Web Services account that you want to invite to join your organization.target
(HandshakeParty target) The identifier (ID) of the Amazon Web Services account that you want to invite to join your organization.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
-
target
The identifier (ID) of the Amazon Web Services account that you want to invite to join your organization. This is a JSON object that contains the following elements:
{ "Type": "ACCOUNT", "Id": "< account id number >" }
If you use the CLI, you can submit this as a single string, similar to the following example:
--target Id=123456789012,Type=ACCOUNT
If you specify
"Type": "ACCOUNT"
, you must provide the Amazon Web Services account ID number as theId
. If you specify"Type": "EMAIL"
, you must specify the email address that is associated with the account.--target Id=diego@example.com,Type=EMAIL
- Parameters:
target
- The identifier (ID) of the Amazon Web Services account that you want to invite to join your organization. This is a JSON object that contains the following elements:{ "Type": "ACCOUNT", "Id": "< account id number >" }
If you use the CLI, you can submit this as a single string, similar to the following example:
--target Id=123456789012,Type=ACCOUNT
If you specify
"Type": "ACCOUNT"
, you must provide the Amazon Web Services account ID number as theId
. If you specify"Type": "EMAIL"
, you must specify the email address that is associated with the account.--target Id=diego@example.com,Type=EMAIL
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
target
The identifier (ID) of the Amazon Web Services account that you want to invite to join your organization. This is a JSON object that contains the following elements:
{ "Type": "ACCOUNT", "Id": "< account id number >" }
If you use the CLI, you can submit this as a single string, similar to the following example:
--target Id=123456789012,Type=ACCOUNT
If you specify
"Type": "ACCOUNT"
, you must provide the Amazon Web Services account ID number as theId
. If you specify"Type": "EMAIL"
, you must specify the email address that is associated with the account.--target Id=diego@example.com,Type=EMAIL
HandshakeParty.Builder
avoiding the need to create one manually viaHandshakeParty.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totarget(HandshakeParty)
.- Parameters:
target
- a consumer that will call methods onHandshakeParty.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
notes
Additional information that you want to include in the generated email to the recipient account owner.
- Parameters:
notes
- Additional information that you want to include in the generated email to the recipient account owner.- 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 account when it becomes a member of the organization. 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.Any tags in the request are checked for compliance with any applicable tag policies when the request is made. The request is rejected if the tags in the request don't match the requirements of the policy at that time. Tag policy compliance is not checked again when the invitation is accepted and the tags are actually attached to the account. That means that if the tag policy changes between the invitation and the acceptance, then that tags could potentially be non-compliant.
If any one of the tags is not valid or if you exceed the allowed number of tags for an account, then the entire request fails and invitations are not sent.
- Parameters:
tags
- A list of tags that you want to attach to the account when it becomes a member of the organization. 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 tonull
. For more information about tagging, see Tagging Organizations resources in the Organizations User Guide.Any tags in the request are checked for compliance with any applicable tag policies when the request is made. The request is rejected if the tags in the request don't match the requirements of the policy at that time. Tag policy compliance is not checked again when the invitation is accepted and the tags are actually attached to the account. That means that if the tag policy changes between the invitation and the acceptance, then that tags could potentially be non-compliant.
If any one of the tags is not valid or if you exceed the allowed number of tags for an account, then the entire request fails and invitations are not sent.
- 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 account when it becomes a member of the organization. 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.Any tags in the request are checked for compliance with any applicable tag policies when the request is made. The request is rejected if the tags in the request don't match the requirements of the policy at that time. Tag policy compliance is not checked again when the invitation is accepted and the tags are actually attached to the account. That means that if the tag policy changes between the invitation and the acceptance, then that tags could potentially be non-compliant.
If any one of the tags is not valid or if you exceed the allowed number of tags for an account, then the entire request fails and invitations are not sent.
- Parameters:
tags
- A list of tags that you want to attach to the account when it becomes a member of the organization. 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 tonull
. For more information about tagging, see Tagging Organizations resources in the Organizations User Guide.Any tags in the request are checked for compliance with any applicable tag policies when the request is made. The request is rejected if the tags in the request don't match the requirements of the policy at that time. Tag policy compliance is not checked again when the invitation is accepted and the tags are actually attached to the account. That means that if the tag policy changes between the invitation and the acceptance, then that tags could potentially be non-compliant.
If any one of the tags is not valid or if you exceed the allowed number of tags for an account, then the entire request fails and invitations are not sent.
- 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 account when it becomes a member of the organization. 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.Any tags in the request are checked for compliance with any applicable tag policies when the request is made. The request is rejected if the tags in the request don't match the requirements of the policy at that time. Tag policy compliance is not checked again when the invitation is accepted and the tags are actually attached to the account. That means that if the tag policy changes between the invitation and the acceptance, then that tags could potentially be non-compliant.
If any one of the tags is not valid or if you exceed the allowed number of tags for an account, then the entire request fails and invitations are not sent.
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
InviteAccountToOrganizationRequest.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
InviteAccountToOrganizationRequest.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.
-