software.amazon.awssdk.services.organizations.model

Interface InviteAccountToOrganizationRequest.Builder

All Superinterfaces:

AwsRequest.Builder, CopyableBuilder<InviteAccountToOrganizationRequest.Builder,InviteAccountToOrganizationRequest>, OrganizationsRequest.Builder, SdkBuilder<InviteAccountToOrganizationRequest.Builder,InviteAccountToOrganizationRequest>, SdkRequest.Builder

Enclosing class:

InviteAccountToOrganizationRequest

public static interface InviteAccountToOrganizationRequest.Builder
extends OrganizationsRequest.Builder, CopyableBuilder<InviteAccountToOrganizationRequest.Builder,InviteAccountToOrganizationRequest>

Method Summary

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	requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig) Add an optional request override configuration.
InviteAccountToOrganizationRequest.Builder	requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer) Add an optional request override configuration.
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.

Methods inherited from interface software.amazon.awssdk.services.organizations.model.OrganizationsRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

requestOverrideConfig

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

apply, build

Method Detail

target

InviteAccountToOrganizationRequest.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", then you must provide the AWS account ID number as the Id. If you specify "Type": "EMAIL", then you must specify the email address that is associated with the account.

--target Id=bill@example.com,Type=EMAIL

Parameters:

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", then you must provide the AWS account ID number as the Id. If you specify "Type": "EMAIL", then you must specify the email address that is associated with the account.

--target Id=bill@example.com,Type=EMAIL

Returns:

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

target

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", then you must provide the AWS account ID number as the Id. If you specify "Type": "EMAIL", then you must specify the email address that is associated with the account.

--target Id=bill@example.com,Type=EMAIL

This is a convenience that creates an instance of the 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).

Parameters:

target - a consumer that will call methods on HandshakeParty.Builder

Returns:

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

See Also:

target(HandshakeParty)

notes

InviteAccountToOrganizationRequest.Builder notes(String 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.

requestOverrideConfig

InviteAccountToOrganizationRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

awsRequestOverrideConfig - The override configuration.

Returns:

This object for method chaining.

requestOverrideConfig

InviteAccountToOrganizationRequest.Builder requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfig.Builder will be given.

Returns:

This object for method chaining.