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

Interface UpdatePoolRequest.Builder

    • Method Detail

      • poolId

        UpdatePoolRequest.Builder poolId​(String poolId)

        The unique identifier of the pool to update. Valid values are either the PoolId or PoolArn.

        Parameters:
        poolId - The unique identifier of the pool to update. Valid values are either the PoolId or PoolArn.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • twoWayEnabled

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

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

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

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

        UpdatePoolRequest.Builder optOutListName​(String optOutListName)

        The OptOutList to associate with the pool. Valid values are either OptOutListName or OptOutListArn.

        Parameters:
        optOutListName - The OptOutList to associate with the pool. Valid values are either OptOutListName or OptOutListArn.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sharedRoutesEnabled

        UpdatePoolRequest.Builder sharedRoutesEnabled​(Boolean sharedRoutesEnabled)

        Indicates whether shared routes are enabled for the pool.

        Parameters:
        sharedRoutesEnabled - Indicates whether shared routes are enabled for the pool.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • deletionProtectionEnabled

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