Interface CreatePoolRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreatePoolRequest.Builder,CreatePoolRequest>, PinpointSmsVoiceV2Request.Builder, SdkBuilder<CreatePoolRequest.Builder,CreatePoolRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreatePoolRequest
public static interface CreatePoolRequest.Builder extends PinpointSmsVoiceV2Request.Builder, SdkPojo, CopyableBuilder<CreatePoolRequest.Builder,CreatePoolRequest>

  • Method Details

    • originationIdentity

      CreatePoolRequest.Builder originationIdentity(String originationIdentity)

      The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.

      After the pool is created you can add more origination identities to the pool by using AssociateOriginationIdentity.

      If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

      Parameters:
      originationIdentity - The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.

      After the pool is created you can add more origination identities to the pool by using AssociateOriginationIdentity.

      If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

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

    • isoCountryCode

      CreatePoolRequest.Builder isoCountryCode(String isoCountryCode)

      The new two-character code, in ISO 3166-1 alpha-2 format, for the country or region of the new pool.

      Parameters:
      isoCountryCode - The new two-character code, in ISO 3166-1 alpha-2 format, for the country or region of the new pool.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • messageType

      CreatePoolRequest.Builder messageType(String messageType)

      The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive. After the pool is created the MessageType can't be changed.

      Parameters:
      messageType - The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive. After the pool is created the MessageType can't be changed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • messageType

      CreatePoolRequest.Builder messageType(MessageType messageType)

      The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive. After the pool is created the MessageType can't be changed.

      Parameters:
      messageType - The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive. After the pool is created the MessageType can't be changed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • deletionProtectionEnabled

      CreatePoolRequest.Builder deletionProtectionEnabled(Boolean deletionProtectionEnabled)

      By default this is set to false. When set to true the pool can't be deleted. You can change this value using the UpdatePool action.

      Parameters:
      deletionProtectionEnabled - By default this is set to false. When set to true the pool can't be deleted. You can change this value using the UpdatePool action.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

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

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

      CreatePoolRequest.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:

    • clientToken

      CreatePoolRequest.Builder clientToken(String clientToken)

      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.

      Parameters:
      clientToken - Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      CreatePoolRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreatePoolRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.