software.amazon.awssdk.services.pinpointsmsvoicev2.model

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 Summary

Modifier and Type	Method and Description
CreatePoolRequest.Builder	clientToken(String clientToken) Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
CreatePoolRequest.Builder	deletionProtectionEnabled(Boolean deletionProtectionEnabled) By default this is set to false.
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.
CreatePoolRequest.Builder	messageType(MessageType messageType) The type of message.
CreatePoolRequest.Builder	messageType(String messageType) The type of message.
CreatePoolRequest.Builder	originationIdentity(String originationIdentity) The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn.
CreatePoolRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreatePoolRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreatePoolRequest.Builder	tags(Collection<Tag> tags) An array of tags (key and value pairs) associated with the pool.
CreatePoolRequest.Builder	tags(Consumer<Tag.Builder>... tags) An array of tags (key and value pairs) associated with the pool.
CreatePoolRequest.Builder	tags(Tag... tags) An array of tags (key and value pairs) associated with the pool.

Methods inherited from interface software.amazon.awssdk.services.pinpointsmsvoicev2.model.PinpointSmsVoiceV2Request.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

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.

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.

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.

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.

Returns:

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

See Also:

MessageType, MessageType

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.

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.

Returns:

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

See Also:

MessageType, MessageType

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

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:

#tags(java.util.Collection)

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)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

CreatePoolRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder