public static interface Handshake.Builder extends CopyableBuilder<Handshake.Builder,Handshake>
Modifier and Type | Method and Description |
---|---|
Handshake.Builder |
action(ActionType action)
The type of handshake, indicating what action occurs when the recipient accepts the handshake.
|
Handshake.Builder |
action(String action)
The type of handshake, indicating what action occurs when the recipient accepts the handshake.
|
Handshake.Builder |
arn(String arn)
The Amazon Resource Name (ARN) of a handshake.
|
Handshake.Builder |
expirationTimestamp(Instant expirationTimestamp)
The date and time that the handshake expires.
|
Handshake.Builder |
id(String id)
The unique identifier (ID) of a handshake.
|
Handshake.Builder |
parties(Collection<HandshakeParty> parties)
Information about the two accounts that are participating in the handshake.
|
Handshake.Builder |
parties(Consumer<HandshakeParty.Builder>... parties)
Information about the two accounts that are participating in the handshake.
|
Handshake.Builder |
parties(HandshakeParty... parties)
Information about the two accounts that are participating in the handshake.
|
Handshake.Builder |
requestedTimestamp(Instant requestedTimestamp)
The date and time that the handshake request was made.
|
Handshake.Builder |
resources(Collection<HandshakeResource> resources)
Additional information that is needed to process the handshake.
|
Handshake.Builder |
resources(Consumer<HandshakeResource.Builder>... resources)
Additional information that is needed to process the handshake.
|
Handshake.Builder |
resources(HandshakeResource... resources)
Additional information that is needed to process the handshake.
|
Handshake.Builder |
state(HandshakeState state)
The current state of the handshake.
|
Handshake.Builder |
state(String state)
The current state of the handshake.
|
copy
applyMutation, build
Handshake.Builder id(String id)
The unique identifier (ID) of a handshake. The originating account creates the ID when it initiates the handshake.
The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lower-case letters or digits.
id
- The unique identifier (ID) of a handshake. The originating account creates the ID when it initiates
the handshake.
The regex pattern for handshake ID string requires "h-" followed by from 8 to 32 lower-case letters or digits.
Handshake.Builder arn(String arn)
The Amazon Resource Name (ARN) of a handshake.
For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.
arn
- The Amazon Resource Name (ARN) of a handshake.
For more information about ARNs in Organizations, see ARN Formats Supported by Organizations in the AWS Organizations User Guide.
Handshake.Builder parties(Collection<HandshakeParty> parties)
Information about the two accounts that are participating in the handshake.
parties
- Information about the two accounts that are participating in the handshake.Handshake.Builder parties(HandshakeParty... parties)
Information about the two accounts that are participating in the handshake.
parties
- Information about the two accounts that are participating in the handshake.Handshake.Builder parties(Consumer<HandshakeParty.Builder>... parties)
Information about the two accounts that are participating in the handshake.
This is a convenience that creates an instance of theList.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 #parties(List)
.parties
- a consumer that will call methods on List.Builder
#parties(List)
Handshake.Builder state(String state)
The current state of the handshake. Use the state to trace the flow of the handshake through the process from its creation to its acceptance. The meaning of each of the valid values is as follows:
REQUESTED: This handshake was sent to multiple recipients (applicable to only some handshake types) and not all recipients have responded yet. The request stays in this state until all recipients respond.
OPEN: This handshake was sent to multiple recipients (applicable to only some policy types) and all recipients have responded, allowing the originator to complete the handshake action.
CANCELED: This handshake is no longer active because it was canceled by the originating account.
ACCEPTED: This handshake is complete because it has been accepted by the recipient.
DECLINED: This handshake is no longer active because it was declined by the recipient account.
EXPIRED: This handshake is no longer active because the originator did not receive a response of any kind from the recipient before the expiration time (15 days).
state
- The current state of the handshake. Use the state to trace the flow of the handshake through the
process from its creation to its acceptance. The meaning of each of the valid values is as
follows:
REQUESTED: This handshake was sent to multiple recipients (applicable to only some handshake types) and not all recipients have responded yet. The request stays in this state until all recipients respond.
OPEN: This handshake was sent to multiple recipients (applicable to only some policy types) and all recipients have responded, allowing the originator to complete the handshake action.
CANCELED: This handshake is no longer active because it was canceled by the originating account.
ACCEPTED: This handshake is complete because it has been accepted by the recipient.
DECLINED: This handshake is no longer active because it was declined by the recipient account.
EXPIRED: This handshake is no longer active because the originator did not receive a response of any kind from the recipient before the expiration time (15 days).
HandshakeState
,
HandshakeState
Handshake.Builder state(HandshakeState state)
The current state of the handshake. Use the state to trace the flow of the handshake through the process from its creation to its acceptance. The meaning of each of the valid values is as follows:
REQUESTED: This handshake was sent to multiple recipients (applicable to only some handshake types) and not all recipients have responded yet. The request stays in this state until all recipients respond.
OPEN: This handshake was sent to multiple recipients (applicable to only some policy types) and all recipients have responded, allowing the originator to complete the handshake action.
CANCELED: This handshake is no longer active because it was canceled by the originating account.
ACCEPTED: This handshake is complete because it has been accepted by the recipient.
DECLINED: This handshake is no longer active because it was declined by the recipient account.
EXPIRED: This handshake is no longer active because the originator did not receive a response of any kind from the recipient before the expiration time (15 days).
state
- The current state of the handshake. Use the state to trace the flow of the handshake through the
process from its creation to its acceptance. The meaning of each of the valid values is as
follows:
REQUESTED: This handshake was sent to multiple recipients (applicable to only some handshake types) and not all recipients have responded yet. The request stays in this state until all recipients respond.
OPEN: This handshake was sent to multiple recipients (applicable to only some policy types) and all recipients have responded, allowing the originator to complete the handshake action.
CANCELED: This handshake is no longer active because it was canceled by the originating account.
ACCEPTED: This handshake is complete because it has been accepted by the recipient.
DECLINED: This handshake is no longer active because it was declined by the recipient account.
EXPIRED: This handshake is no longer active because the originator did not receive a response of any kind from the recipient before the expiration time (15 days).
HandshakeState
,
HandshakeState
Handshake.Builder requestedTimestamp(Instant requestedTimestamp)
The date and time that the handshake request was made.
requestedTimestamp
- The date and time that the handshake request was made.Handshake.Builder expirationTimestamp(Instant expirationTimestamp)
The date and time that the handshake expires. If the recipient of the handshake request fails to respond before the specified date and time, the handshake becomes inactive and is no longer valid.
expirationTimestamp
- The date and time that the handshake expires. If the recipient of the handshake request fails to
respond before the specified date and time, the handshake becomes inactive and is no longer valid.Handshake.Builder action(String action)
The type of handshake, indicating what action occurs when the recipient accepts the handshake. The following handshake types are supported:
INVITE: This type of handshake represents a request to join an organization. It is always sent from the master account to only non-member accounts.
ENABLE_ALL_FEATURES: This type of handshake represents a request to enable all features in an organization. It is always sent from the master account to only invited member accounts. Created accounts do not receive this because those accounts were created by the organization's master account and approval is inferred.
APPROVE_ALL_FEATURES: This type of handshake is sent from the Organizations service when all member
accounts have approved the ENABLE_ALL_FEATURES
invitation. It is sent only to the master account
and signals the master that it can finalize the process to enable all features.
action
- The type of handshake, indicating what action occurs when the recipient accepts the handshake. The
following handshake types are supported:
INVITE: This type of handshake represents a request to join an organization. It is always sent from the master account to only non-member accounts.
ENABLE_ALL_FEATURES: This type of handshake represents a request to enable all features in an organization. It is always sent from the master account to only invited member accounts. Created accounts do not receive this because those accounts were created by the organization's master account and approval is inferred.
APPROVE_ALL_FEATURES: This type of handshake is sent from the Organizations service when all
member accounts have approved the ENABLE_ALL_FEATURES
invitation. It is sent only to the
master account and signals the master that it can finalize the process to enable all features.
ActionType
,
ActionType
Handshake.Builder action(ActionType action)
The type of handshake, indicating what action occurs when the recipient accepts the handshake. The following handshake types are supported:
INVITE: This type of handshake represents a request to join an organization. It is always sent from the master account to only non-member accounts.
ENABLE_ALL_FEATURES: This type of handshake represents a request to enable all features in an organization. It is always sent from the master account to only invited member accounts. Created accounts do not receive this because those accounts were created by the organization's master account and approval is inferred.
APPROVE_ALL_FEATURES: This type of handshake is sent from the Organizations service when all member
accounts have approved the ENABLE_ALL_FEATURES
invitation. It is sent only to the master account
and signals the master that it can finalize the process to enable all features.
action
- The type of handshake, indicating what action occurs when the recipient accepts the handshake. The
following handshake types are supported:
INVITE: This type of handshake represents a request to join an organization. It is always sent from the master account to only non-member accounts.
ENABLE_ALL_FEATURES: This type of handshake represents a request to enable all features in an organization. It is always sent from the master account to only invited member accounts. Created accounts do not receive this because those accounts were created by the organization's master account and approval is inferred.
APPROVE_ALL_FEATURES: This type of handshake is sent from the Organizations service when all
member accounts have approved the ENABLE_ALL_FEATURES
invitation. It is sent only to the
master account and signals the master that it can finalize the process to enable all features.
ActionType
,
ActionType
Handshake.Builder resources(Collection<HandshakeResource> resources)
Additional information that is needed to process the handshake.
resources
- Additional information that is needed to process the handshake.Handshake.Builder resources(HandshakeResource... resources)
Additional information that is needed to process the handshake.
resources
- Additional information that is needed to process the handshake.Handshake.Builder resources(Consumer<HandshakeResource.Builder>... resources)
Additional information that is needed to process the handshake.
This is a convenience that creates an instance of theList.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 #resources(List)
.resources
- a consumer that will call methods on List.Builder
#resources(List)
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.