public static interface InviteAccountToOrganizationRequest.Builder extends OrganizationsRequest.Builder, SdkPojo, CopyableBuilder<InviteAccountToOrganizationRequest.Builder,InviteAccountToOrganizationRequest>
| Modifier and Type | Method and Description |
|---|---|
InviteAccountToOrganizationRequest.Builder |
notes(String notes)
Additional information that you want to include in the generated email to the recipient account owner.
|
InviteAccountToOrganizationRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
InviteAccountToOrganizationRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
InviteAccountToOrganizationRequest.Builder |
tags(Collection<Tag> tags)
A list of tags that you want to attach to the account when it becomes a member of the organization.
|
InviteAccountToOrganizationRequest.Builder |
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.
|
InviteAccountToOrganizationRequest.Builder |
tags(Tag... tags)
A list of tags that you want to attach to the account when it becomes a member of the organization.
|
default InviteAccountToOrganizationRequest.Builder |
target(Consumer<HandshakeParty.Builder> target)
The identifier (ID) of the AWS account that you want to invite to join your organization.
|
InviteAccountToOrganizationRequest.Builder |
target(HandshakeParty target)
The identifier (ID) of the AWS account that you want to invite to join your organization.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildInviteAccountToOrganizationRequest.Builder target(HandshakeParty target)
The identifier (ID) of the AWS 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 AWS 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 AWS account ID number as the
Id. If you specify "Type": "EMAIL", you must specify the email address that is
associated with the account.
--target Id=diego@example.com,Type=EMAIL
target - The identifier (ID) of the AWS 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 AWS 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 AWS account ID number as the
Id. If you specify "Type": "EMAIL", you must specify the email address that
is associated with the account.
--target Id=diego@example.com,Type=EMAIL
default InviteAccountToOrganizationRequest.Builder target(Consumer<HandshakeParty.Builder> target)
The identifier (ID) of the AWS 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 AWS 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 AWS account ID number as the
Id. 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 via HandshakeParty.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to target(HandshakeParty).target - a consumer that will call methods on HandshakeParty.Buildertarget(HandshakeParty)InviteAccountToOrganizationRequest.Builder notes(String notes)
Additional information that you want to include in the generated email to the recipient account owner.
notes - Additional information that you want to include in the generated email to the recipient account owner.InviteAccountToOrganizationRequest.Builder tags(Collection<Tag> 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 AWS Organizations
resources in the AWS 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 invalid or if you exceed the allowed number of tags for an account, then the entire request fails and invitations are not sent.
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 AWS
Organizations resources in the AWS 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 invalid or if you exceed the allowed number of tags for an account, then the entire request fails and invitations are not sent.
InviteAccountToOrganizationRequest.Builder tags(Tag... 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 AWS Organizations
resources in the AWS 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 invalid or if you exceed the allowed number of tags for an account, then the entire request fails and invitations are not sent.
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 AWS
Organizations resources in the AWS 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 invalid or if you exceed the allowed number of tags for an account, then the entire request fails and invitations are not sent.
InviteAccountToOrganizationRequest.Builder 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. 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 AWS Organizations
resources in the AWS 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 invalid or if you exceed the allowed number of tags for an account, then the entire request fails and invitations are not sent.
List.Builder avoiding the need to
create one manually via List#builder() .
When the Consumer completes, List.Builder#build() is called immediately and its result
is passed to #tags(List) .tags - a consumer that will call methods on List.Builder #tags(List) InviteAccountToOrganizationRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderInviteAccountToOrganizationRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2021. All rights reserved.