Package software.amazon.awssdk.services.pinpointsmsvoicev2.model

Interface CreatePoolRequest.Builder

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

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

        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.

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