Package software.amazon.awssdk.services.organizations.model

Interface Handshake.Builder

All Superinterfaces:
Buildable, CopyableBuilder<Handshake.Builder,Handshake>, SdkBuilder<Handshake.Builder,Handshake>, SdkPojo
Enclosing class:
Handshake
public static interface Handshake.Builder extends SdkPojo, CopyableBuilder<Handshake.Builder,Handshake>

  • Method Details

    • id

      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 lowercase letters or digits.

      Parameters:
      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 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)

      The Amazon Resource Name (ARN) of a handshake.

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

      Parameters:
      arn - The Amazon Resource Name (ARN) of a 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)

      Information about the two accounts that are participating in the handshake.

      Parameters:
      parties - Information about the two accounts that are participating in the handshake.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • parties

      Handshake.Builder parties(HandshakeParty... parties)

      Information about the two accounts that are participating in the handshake.

      Parameters:
      parties - Information about the two accounts that are participating in the handshake.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • parties

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

      Information about the two accounts that are participating in the 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:

    • state

      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).

      Parameters:
      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).

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

    • state

      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).

      Parameters:
      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).

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

    • requestedTimestamp

      Handshake.Builder requestedTimestamp(Instant requestedTimestamp)

      The date and time that the handshake request was made.

      Parameters:
      requestedTimestamp - The date and time that 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)

      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.

      Parameters:
      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.
      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, 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 management 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 management account to only invited member accounts. Created accounts do not receive this because those accounts were created by the organization's management 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 management account and signals the master that it can finalize the process to enable all features.

      Parameters:
      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 management 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 management account to only invited member accounts. Created accounts do not receive this because those accounts were created by the organization's management 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 management account and signals the master that it can finalize the process to enable all features.

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

    • action

      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 management 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 management account to only invited member accounts. Created accounts do not receive this because those accounts were created by the organization's management 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 management account and signals the master that it can finalize the process to enable all features.

      Parameters:
      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 management 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 management account to only invited member accounts. Created accounts do not receive this because those accounts were created by the organization's management 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 management account and signals the master that it can finalize the process to enable all features.

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

    • resources

      Handshake.Builder resources(Collection<HandshakeResource> resources)

      Additional information that is needed to process the handshake.

      Parameters:
      resources - Additional information that is needed to process the handshake.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resources

      Handshake.Builder resources(HandshakeResource... resources)

      Additional information that is needed to process the handshake.

      Parameters:
      resources - Additional information that is needed to process the handshake.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • resources

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

      Additional information that is needed to process the handshake.

      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: