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

Interface PoolInformation.Builder

    • Method Detail

      • poolArn

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

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

        PoolInformation.Builder status​(String status)

        The current status of the pool.

        Parameters:
        status - The current status of the pool.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        PoolStatus, PoolStatus

      • status

        PoolInformation.Builder status​(PoolStatus status)

        The current status of the pool.

        Parameters:
        status - The current status of the pool.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        PoolStatus, PoolStatus

      • messageType

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

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

      • twoWayEnabled

        PoolInformation.Builder twoWayEnabled​(Boolean twoWayEnabled)

        When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.

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

      • twoWayChannelArn

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

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

        PoolInformation.Builder selfManagedOptOutsEnabled​(Boolean selfManagedOptOutsEnabled)

        When set to false, an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint 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. For more information see Self-managed opt-outs

        Parameters:
        selfManagedOptOutsEnabled - When set to false, an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, Amazon Pinpoint 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. For more information see Self-managed opt-outs
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • optOutListName

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

        PoolInformation.Builder sharedRoutesEnabled​(Boolean sharedRoutesEnabled)

        Allows you to enable shared routes on your pool.

        By default, this is set to False. If you set this value to True, your messages are sent using phone numbers or sender IDs (depending on the country) that are shared with other Amazon Pinpoint users. In some countries, such as the United States, senders aren't allowed to use shared routes and must use a dedicated phone number or short code.

        Parameters:
        sharedRoutesEnabled - Allows you to enable shared routes on your pool.

        By default, this is set to False. If you set this value to True, your messages are sent using phone numbers or sender IDs (depending on the country) that are shared with other Amazon Pinpoint users. In some countries, such as the United States, senders aren't allowed to use shared routes and must use a dedicated phone number or short code.

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

      • deletionProtectionEnabled

        PoolInformation.Builder deletionProtectionEnabled​(Boolean deletionProtectionEnabled)

        When set to true the pool can't be deleted.

        Parameters:
        deletionProtectionEnabled - When set to true the pool can't be deleted.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • createdTimestamp

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