Package software.amazon.awscdk.services.smsvoice

Class CfnPoolProps.Builder

java.lang.Object
software.amazon.awscdk.services.smsvoice.CfnPoolProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnPoolProps>
Enclosing interface:
CfnPoolProps
@Stability(Stable) public static final class CfnPoolProps.Builder extends Object implements software.amazon.jsii.Builder<CfnPoolProps>
A builder for CfnPoolProps

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • mandatoryKeywords

      @Stability(Stable) public CfnPoolProps.Builder mandatoryKeywords(IResolvable mandatoryKeywords)
      Sets the value of CfnPoolProps.getMandatoryKeywords()
      Parameters:
      mandatoryKeywords - Creates or updates the pool's MandatoryKeyword configuration. This parameter is required. For more information, see Keywords in the End User Messaging User Guide.
      Returns:
      this

    • mandatoryKeywords

      @Stability(Stable) public CfnPoolProps.Builder mandatoryKeywords(CfnPool.MandatoryKeywordsProperty mandatoryKeywords)
      Sets the value of CfnPoolProps.getMandatoryKeywords()
      Parameters:
      mandatoryKeywords - Creates or updates the pool's MandatoryKeyword configuration. This parameter is required. For more information, see Keywords in the End User Messaging User Guide.
      Returns:
      this

    • originationIdentities

      @Stability(Stable) public CfnPoolProps.Builder originationIdentities(List<String> originationIdentities)
      Sets the value of CfnPoolProps.getOriginationIdentities()
      Parameters:
      originationIdentities - The list of origination identities to apply to the pool, either PhoneNumberArn or SenderIdArn . This parameter is required. For more information, see Registrations in the End User Messaging User Guide.

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

      Returns:
      this

    • deletionProtectionEnabled

      @Stability(Stable) public CfnPoolProps.Builder deletionProtectionEnabled(Boolean deletionProtectionEnabled)
      Sets the value of CfnPoolProps.getDeletionProtectionEnabled()
      Parameters:
      deletionProtectionEnabled - When set to true the pool can't be deleted.
      Returns:
      this

    • deletionProtectionEnabled

      @Stability(Stable) public CfnPoolProps.Builder deletionProtectionEnabled(IResolvable deletionProtectionEnabled)
      Sets the value of CfnPoolProps.getDeletionProtectionEnabled()
      Parameters:
      deletionProtectionEnabled - When set to true the pool can't be deleted.
      Returns:
      this

    • optionalKeywords

      @Stability(Stable) public CfnPoolProps.Builder optionalKeywords(IResolvable optionalKeywords)
      Sets the value of CfnPoolProps.getOptionalKeywords()
      Parameters:
      optionalKeywords - Specifies any optional keywords to associate with the pool. For more information, see Keywords in the End User Messaging User Guide.
      Returns:
      this

    • optionalKeywords

      @Stability(Stable) public CfnPoolProps.Builder optionalKeywords(List<? extends Object> optionalKeywords)
      Sets the value of CfnPoolProps.getOptionalKeywords()
      Parameters:
      optionalKeywords - Specifies any optional keywords to associate with the pool. For more information, see Keywords in the End User Messaging User Guide.
      Returns:
      this

    • optOutListName

      @Stability(Stable) public CfnPoolProps.Builder optOutListName(String optOutListName)
      Sets the value of CfnPoolProps.getOptOutListName()
      Parameters:
      optOutListName - The name of the OptOutList associated with the pool.
      Returns:
      this

    • selfManagedOptOutsEnabled

      @Stability(Stable) public CfnPoolProps.Builder selfManagedOptOutsEnabled(Boolean selfManagedOptOutsEnabled)
      Sets the value of CfnPoolProps.getSelfManagedOptOutsEnabled()
      Parameters:
      selfManagedOptOutsEnabled - When set to false, an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, End User Messaging 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:
      this

    • selfManagedOptOutsEnabled

      @Stability(Stable) public CfnPoolProps.Builder selfManagedOptOutsEnabled(IResolvable selfManagedOptOutsEnabled)
      Sets the value of CfnPoolProps.getSelfManagedOptOutsEnabled()
      Parameters:
      selfManagedOptOutsEnabled - When set to false, an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, End User Messaging 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:
      this

    • sharedRoutesEnabled

      @Stability(Stable) public CfnPoolProps.Builder sharedRoutesEnabled(Boolean sharedRoutesEnabled)
      Sets the value of CfnPoolProps.getSharedRoutesEnabled()
      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 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:
      this

    • sharedRoutesEnabled

      @Stability(Stable) public CfnPoolProps.Builder sharedRoutesEnabled(IResolvable sharedRoutesEnabled)
      Sets the value of CfnPoolProps.getSharedRoutesEnabled()
      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 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:
      this

    • tags

      @Stability(Stable) public CfnPoolProps.Builder tags(List<? extends CfnTag> tags)
      Sets the value of CfnPoolProps.getTags()
      Parameters:
      tags - An array of tags (key and value pairs) associated with the pool.
      Returns:
      this

    • twoWay

      @Stability(Stable) public CfnPoolProps.Builder twoWay(IResolvable twoWay)
      Sets the value of CfnPoolProps.getTwoWay()
      Parameters:
      twoWay - Describes the two-way SMS configuration for a phone number. For more information, see Two-way SMS messaging in the End User Messaging User Guide.
      Returns:
      this

    • twoWay

      @Stability(Stable) public CfnPoolProps.Builder twoWay(CfnPool.TwoWayProperty twoWay)
      Sets the value of CfnPoolProps.getTwoWay()
      Parameters:
      twoWay - Describes the two-way SMS configuration for a phone number. For more information, see Two-way SMS messaging in the End User Messaging User Guide.
      Returns:
      this

    • build

      @Stability(Stable) public CfnPoolProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnPoolProps>
      Returns:
      a new instance of CfnPoolProps
      Throws:
      NullPointerException - if any required attribute was not provided