class CfnOptOutListPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.SMSVOICE.Mixins.CfnOptOutListPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awssmsvoice/mixins#CfnOptOutListPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.smsvoice.mixins.CfnOptOutListPropsMixin
Python	aws_cdk.mixins_preview.aws_smsvoice.mixins.CfnOptOutListPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_smsvoice » mixins » CfnOptOutListPropsMixin

Implements IMixin

Extends Mixin

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-optoutlist.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as smsvoice_mixins } from '@aws-cdk/mixins-preview/aws-smsvoice';
const cfnOptOutListPropsMixin = new smsvoice_mixins.CfnOptOutListPropsMixin({
  optOutListName: 'optOutListName',
  tags: [{
    key: 'key',
    value: 'value',
  }],
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnOptOutListPropsMixin(props: CfnOptOutListMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnOptOutListMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::SMSVOICE::OptOutList.

Properties

Name	Type	Description
props	CfnOptOutListMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnOptOutListMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.