AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::SMSVOICE::OptOutList

CfnOptOutList

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](https://docs.aws.amazon.com/sms-voice/latest/userguide/opt-out-list-keywords.html) in the End User Messaging User Guide.

Import

import { CfnOptOutList } from 'aws-cdk-lib/aws-smsvoice';

Or use the module namespace:

import * as smsvoice from 'aws-cdk-lib/aws-smsvoice';
// smsvoice.CfnOptOutList

Properties

Configuration passed to the constructor as CfnOptOutListProps.

optOutListNameOptional
string

The name of the OptOutList.

tagsOptional
CfnTag[]

An array of tags (key and value pairs) to associate with the new OptOutList.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-smsvoice
CFN TypeAWS::SMSVOICE::OptOutList
Properties2

External Links