Package software.amazon.awscdk.cfnpropertymixins.services.smsvoice

Class CfnOptOutListPropsMixin

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.Mixin
software.amazon.awscdk.cfnpropertymixins.services.smsvoice.CfnOptOutListPropsMixin
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable, software.constructs.IMixin
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-03-11T13:20:05.616Z") @Stability(Stable) public class CfnOptOutListPropsMixin extends Mixin implements software.constructs.IMixin
Creates a new opt-out list.

If the opt-out list name already exists, an error is returned.

An opt-out list is a list of phone numbers that are opted out, meaning you can't send SMS or voice messages to them. If end user replies with the keyword "STOP," an entry for the phone number is added to the opt-out list. In addition to STOP, your recipients can use any supported opt-out keyword, such as CANCEL or OPTOUT. For a list of supported opt-out keywords, see SMS opt out in the End User Messaging User Guide.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.smsvoice.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnOptOutListPropsMixin cfnOptOutListPropsMixin = CfnOptOutListPropsMixin.Builder.create(CfnOptOutListMixinProps.builder()
         .optOutListName("optOutListName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build())
 .strategy(mergeStrategy)
 .build();

See Also:

  • Field Details

    • CFN_PROPERTY_KEYS

      @Stability(Stable) protected static final List<String> CFN_PROPERTY_KEYS

  • Constructor Details

    • CfnOptOutListPropsMixin

      protected CfnOptOutListPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnOptOutListPropsMixin

      protected CfnOptOutListPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnOptOutListPropsMixin

      @Stability(Stable) public CfnOptOutListPropsMixin(@NotNull CfnOptOutListMixinProps props, @Nullable CfnPropertyMixinOptions options)
      Create a mixin to apply properties to AWS::SMSVOICE::OptOutList.

      Parameters:
      props - L1 properties to apply. This parameter is required.
      options - Mixin options.

    • CfnOptOutListPropsMixin

      @Stability(Stable) public CfnOptOutListPropsMixin(@NotNull CfnOptOutListMixinProps props)
      Create a mixin to apply properties to AWS::SMSVOICE::OptOutList.

      Parameters:
      props - L1 properties to apply. This parameter is required.

  • Method Details

    • applyTo

      @Stability(Stable) public void applyTo(@NotNull software.constructs.IConstruct construct)
      Apply the mixin properties to the construct.

      Specified by:
      applyTo in interface software.constructs.IMixin
      Specified by:
      applyTo in class Mixin
      Parameters:
      construct - This parameter is required.

    • supports

      @Stability(Stable) @NotNull public Boolean supports(@NotNull software.constructs.IConstruct construct)
      Check if this mixin supports the given construct.

      Specified by:
      supports in interface software.constructs.IMixin
      Overrides:
      supports in class Mixin
      Parameters:
      construct - This parameter is required.

    • getProps

      @Stability(Stable) @NotNull protected CfnOptOutListMixinProps getProps()

    • getStrategy

      @Stability(Stable) @NotNull protected IMergeStrategy getStrategy()