Interface CreatePoolResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<CreatePoolResponse.Builder,CreatePoolResponse>, PinpointSmsVoiceV2Response.Builder, SdkBuilder<CreatePoolResponse.Builder,CreatePoolResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
CreatePoolResponse
@Mutable @NotThreadSafe public static interface CreatePoolResponse.Builder extends PinpointSmsVoiceV2Response.Builder, SdkPojo, CopyableBuilder<CreatePoolResponse.Builder,CreatePoolResponse>

  • Method Details

    • poolArn

      CreatePoolResponse.Builder poolArn(String poolArn)

      The Amazon Resource Name (ARN) for the pool.

      Parameters:
      poolArn - The Amazon Resource Name (ARN) for the pool.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • poolId

      CreatePoolResponse.Builder poolId(String poolId)

      The unique identifier for the pool.

      Parameters:
      poolId - The unique identifier for the pool.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      CreatePoolResponse.Builder status(String status)

      The current status of the pool.

      • CREATING: The pool is currently being created and isn't yet available for use.

      • ACTIVE: The pool is active and available for use.

      • DELETING: The pool is being deleted.

      Parameters:
      status - The current status of the pool.

      • CREATING: The pool is currently being created and isn't yet available for use.

      • ACTIVE: The pool is active and available for use.

      • DELETING: The pool is being deleted.

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

    • status

      CreatePoolResponse.Builder status(PoolStatus status)

      The current status of the pool.

      • CREATING: The pool is currently being created and isn't yet available for use.

      • ACTIVE: The pool is active and available for use.

      • DELETING: The pool is being deleted.

      Parameters:
      status - The current status of the pool.

      • CREATING: The pool is currently being created and isn't yet available for use.

      • ACTIVE: The pool is active and available for use.

      • DELETING: The pool is being deleted.

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

    • messageType

      CreatePoolResponse.Builder messageType(String messageType)

      The type of message for the pool to use.

      Parameters:
      messageType - The type of message for the pool to use.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • messageType

      CreatePoolResponse.Builder messageType(MessageType messageType)

      The type of message for the pool to use.

      Parameters:
      messageType - The type of message for the pool to use.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • twoWayEnabled

      CreatePoolResponse.Builder twoWayEnabled(Boolean twoWayEnabled)

      By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

      Parameters:
      twoWayEnabled - By default this is set to false. When set to true you can receive incoming text messages from your end recipients.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • twoWayChannelArn

      CreatePoolResponse.Builder twoWayChannelArn(String twoWayChannelArn)

      The Amazon Resource Name (ARN) of the two way channel.

      Parameters:
      twoWayChannelArn - The Amazon Resource Name (ARN) of the two way channel.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • twoWayChannelRole

      CreatePoolResponse.Builder twoWayChannelRole(String twoWayChannelRole)

      An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

      Parameters:
      twoWayChannelRole - An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • selfManagedOptOutsEnabled

      CreatePoolResponse.Builder selfManagedOptOutsEnabled(Boolean selfManagedOptOutsEnabled)

      By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.

      Parameters:
      selfManagedOptOutsEnabled - By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • optOutListName

      CreatePoolResponse.Builder optOutListName(String optOutListName)

      The name of the OptOutList associated with the pool.

      Parameters:
      optOutListName - The name of the OptOutList associated with the pool.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sharedRoutesEnabled

      CreatePoolResponse.Builder sharedRoutesEnabled(Boolean sharedRoutesEnabled)

      Indicates whether shared routes are enabled for the pool. Set to false and only origination identities in this pool are used to send messages.

      Parameters:
      sharedRoutesEnabled - Indicates whether shared routes are enabled for the pool. Set to false and only origination identities in this pool are used to send messages.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • deletionProtectionEnabled

      CreatePoolResponse.Builder deletionProtectionEnabled(Boolean deletionProtectionEnabled)

      When set to true deletion protection is enabled. By default this is set to false.

      Parameters:
      deletionProtectionEnabled - When set to true deletion protection is enabled. By default this is set to false.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreatePoolResponse.Builder tags(Collection<Tag> tags)

      An array of tags (key and value pairs) associated with the pool.

      Parameters:
      tags - An array of tags (key and value pairs) associated with the pool.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreatePoolResponse.Builder tags(Tag... tags)

      An array of tags (key and value pairs) associated with the pool.

      Parameters:
      tags - An array of tags (key and value pairs) associated with the pool.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreatePoolResponse.Builder tags(Consumer<Tag.Builder>... tags)

      An array of tags (key and value pairs) associated with the pool.

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

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

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • createdTimestamp

      CreatePoolResponse.Builder createdTimestamp(Instant createdTimestamp)

      The time when the pool was created, in UNIX epoch time format.

      Parameters:
      createdTimestamp - The time when the pool was created, in UNIX epoch time format.
      Returns:
      Returns a reference to this object so that method calls can be chained together.