Interface Handshake.Builder

All Superinterfaces:

Buildable, CopyableBuilder<Handshake.Builder,Handshake>, SdkBuilder<Handshake.Builder,Handshake>, SdkPojo

Enclosing class:

Handshake

@Mutable
@NotThreadSafe
public static interface Handshake.Builder
extends SdkPojo, CopyableBuilder<Handshake.Builder,Handshake>

Method Summary

Modifier and Type	Method	Description
Handshake.Builder	action(String action)	The type of handshake:
Handshake.Builder	action(ActionType action)	The type of handshake:
Handshake.Builder	arn(String arn)	Amazon Resource Name (ARN) for the handshake.
Handshake.Builder	expirationTimestamp(Instant expirationTimestamp)	Timestamp when the handshake expires.
Handshake.Builder	id(String id)	ID for the handshake.
Handshake.Builder	parties(Collection<HandshakeParty> parties)	An array of HandshakeParty objects.
Handshake.Builder	parties(Consumer<HandshakeParty.Builder>... parties)	An array of HandshakeParty objects.
Handshake.Builder	parties(HandshakeParty... parties)	An array of HandshakeParty objects.
Handshake.Builder	requestedTimestamp(Instant requestedTimestamp)	Timestamp when the handshake request was made.
Handshake.Builder	resources(Collection<HandshakeResource> resources)	An array of HandshakeResource objects.
Handshake.Builder	resources(Consumer<HandshakeResource.Builder>... resources)	An array of HandshakeResource objects.
Handshake.Builder	resources(HandshakeResource... resources)	An array of HandshakeResource objects.
Handshake.Builder	state(String state)	Current state for the handshake.
Handshake.Builder	state(HandshakeState state)	Current state for the handshake.

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

id

Handshake.Builder id(String id)

ID for the handshake.

The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lowercase letters or digits.

Parameters:

id - ID for the handshake.

The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lowercase letters or digits.

Returns:

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

arn

Handshake.Builder arn(String arn)

Amazon Resource Name (ARN) for the handshake.

For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference.

Parameters:

arn - Amazon Resource Name (ARN) for the handshake.

For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the Amazon Web Services Service Authorization Reference.

Returns:

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

parties

Handshake.Builder parties(Collection<HandshakeParty> parties)

An array of HandshakeParty objects. Contains details for participant in a handshake.

Parameters:

parties - An array of HandshakeParty objects. Contains details for participant in a handshake.

Returns:

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

parties

Handshake.Builder parties(HandshakeParty... parties)

An array of HandshakeParty objects. Contains details for participant in a handshake.

Parameters:

parties - An array of HandshakeParty objects. Contains details for participant in a handshake.

Returns:

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

parties

Handshake.Builder parties(Consumer<HandshakeParty.Builder>... parties)

An array of HandshakeParty objects. Contains details for participant in a handshake.

This is a convenience method 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 parties(List<HandshakeParty>).

Parameters:

parties - 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:

• parties(java.util.Collection<HandshakeParty>)

state

Handshake.Builder state(String state)

Current state for the handshake.

• REQUESTED: Handshake awaiting a response from the recipient.

• OPEN: Handshake sent to multiple recipients and all recipients have responded. The sender can now complete the handshake action.

• CANCELED: Handshake canceled by the sender.

• ACCEPTED: Handshake accepted by the recipient.

• DECLINED: Handshake declined by the recipient.

• EXPIRED: Handshake has expired.

Parameters:

state - Current state for the handshake.

• REQUESTED: Handshake awaiting a response from the recipient.

• OPEN: Handshake sent to multiple recipients and all recipients have responded. The sender can now complete the handshake action.

• CANCELED: Handshake canceled by the sender.

• ACCEPTED: Handshake accepted by the recipient.

• DECLINED: Handshake declined by the recipient.

• EXPIRED: Handshake has expired.

Returns:

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

See Also:

• HandshakeState
• HandshakeState

state

Handshake.Builder state(HandshakeState state)

Current state for the handshake.

• REQUESTED: Handshake awaiting a response from the recipient.

• OPEN: Handshake sent to multiple recipients and all recipients have responded. The sender can now complete the handshake action.

• CANCELED: Handshake canceled by the sender.

• ACCEPTED: Handshake accepted by the recipient.

• DECLINED: Handshake declined by the recipient.

• EXPIRED: Handshake has expired.

Parameters:

state - Current state for the handshake.

• REQUESTED: Handshake awaiting a response from the recipient.

• OPEN: Handshake sent to multiple recipients and all recipients have responded. The sender can now complete the handshake action.

• CANCELED: Handshake canceled by the sender.

• ACCEPTED: Handshake accepted by the recipient.

• DECLINED: Handshake declined by the recipient.

• EXPIRED: Handshake has expired.

Returns:

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

See Also:

• HandshakeState
• HandshakeState

requestedTimestamp

Handshake.Builder requestedTimestamp(Instant requestedTimestamp)

Timestamp when the handshake request was made.

Parameters:

requestedTimestamp - Timestamp when the handshake request was made.

Returns:

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

expirationTimestamp

Handshake.Builder expirationTimestamp(Instant expirationTimestamp)

Timestamp when the handshake expires.

Parameters:

expirationTimestamp - Timestamp when the handshake expires.

Returns:

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

action

Handshake.Builder action(String action)

The type of handshake:

• INVITE: Handshake sent to a standalone account requesting that it to join the sender's organization.

• ENABLE_ALL_FEATURES: Handshake sent to invited member accounts to enable all features for the organization.

• APPROVE_ALL_FEATURES: Handshake sent to the management account when all invited member accounts have approved to enable all features.

• TRANSFER_RESPONSIBILITY: Handshake sent to another organization's management account requesting that it designate the sender with the specified responsibilities for recipient's organization.

Parameters:

action - The type of handshake:

• INVITE: Handshake sent to a standalone account requesting that it to join the sender's organization.

• ENABLE_ALL_FEATURES: Handshake sent to invited member accounts to enable all features for the organization.

• APPROVE_ALL_FEATURES: Handshake sent to the management account when all invited member accounts have approved to enable all features.

• TRANSFER_RESPONSIBILITY: Handshake sent to another organization's management account requesting that it designate the sender with the specified responsibilities for recipient's organization.

Returns:

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

See Also:

• ActionType
• ActionType

action

Handshake.Builder action(ActionType action)

The type of handshake:

• INVITE: Handshake sent to a standalone account requesting that it to join the sender's organization.

• ENABLE_ALL_FEATURES: Handshake sent to invited member accounts to enable all features for the organization.

• APPROVE_ALL_FEATURES: Handshake sent to the management account when all invited member accounts have approved to enable all features.

• TRANSFER_RESPONSIBILITY: Handshake sent to another organization's management account requesting that it designate the sender with the specified responsibilities for recipient's organization.

Parameters:

action - The type of handshake:

• INVITE: Handshake sent to a standalone account requesting that it to join the sender's organization.

• ENABLE_ALL_FEATURES: Handshake sent to invited member accounts to enable all features for the organization.

• APPROVE_ALL_FEATURES: Handshake sent to the management account when all invited member accounts have approved to enable all features.

• TRANSFER_RESPONSIBILITY: Handshake sent to another organization's management account requesting that it designate the sender with the specified responsibilities for recipient's organization.

Returns:

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

See Also:

• ActionType
• ActionType

resources

Handshake.Builder resources(Collection<HandshakeResource> resources)

An array of HandshakeResource objects. When needed, contains additional details for a handshake. For example, the email address for the sender.

Parameters:

resources - An array of HandshakeResource objects. When needed, contains additional details for a handshake. For example, the email address for the sender.

Returns:

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

resources

Handshake.Builder resources(HandshakeResource... resources)

An array of HandshakeResource objects. When needed, contains additional details for a handshake. For example, the email address for the sender.

Parameters:

resources - An array of HandshakeResource objects. When needed, contains additional details for a handshake. For example, the email address for the sender.

Returns:

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

resources

Handshake.Builder resources(Consumer<HandshakeResource.Builder>... resources)

An array of HandshakeResource objects. When needed, contains additional details for a handshake. For example, the email address for the sender.

This is a convenience method that creates an instance of the HandshakeResource.Builder avoiding the need to create one manually via HandshakeResource.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to resources(List<HandshakeResource>).

Parameters:

resources - a consumer that will call methods on HandshakeResource.Builder

Returns:

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

See Also:

• resources(java.util.Collection<HandshakeResource>)