interface CfnPhoneNumberProps

Language	Type name
.NET	`Amazon.CDK.aws_smsvoice.CfnPhoneNumberProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awssmsvoice#CfnPhoneNumberProps`
Java	`software.amazon.awscdk.services.smsvoice.CfnPhoneNumberProps`
Python	`aws_cdk.aws_smsvoice.CfnPhoneNumberProps`
TypeScript	`aws-cdk-lib` » `aws_smsvoice` » `CfnPhoneNumberProps`

Properties for defining a CfnPhoneNumber.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_smsvoice as smsvoice } from 'aws-cdk-lib';
const cfnPhoneNumberProps: smsvoice.CfnPhoneNumberProps = {
  isoCountryCode: 'isoCountryCode',
  mandatoryKeywords: {
    help: {
      message: 'message',
    },
    stop: {
      message: 'message',
    },
  },
  numberCapabilities: ['numberCapabilities'],
  numberType: 'numberType',

  // the properties below are optional
  deletionProtectionEnabled: false,
  optionalKeywords: [{
    action: 'action',
    keyword: 'keyword',
    message: 'message',
  }],
  optOutListName: 'optOutListName',
  selfManagedOptOutsEnabled: false,
  tags: [{
    key: 'key',
    value: 'value',
  }],
  twoWay: {
    enabled: false,

    // the properties below are optional
    channelArn: 'channelArn',
    channelRole: 'channelRole',
  },
};

Properties

Name	Type	Description
isoCountryCode	`string`	The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
mandatoryKeywords	`IResolvable` `\|` `MandatoryKeywordsProperty`	Creates or updates a `MandatoryKeyword` configuration on an origination phone number For more information, see Keywords in the End User Messaging User Guide.
numberCapabilities	`string[]`	Indicates if the phone number will be used for text messages, voice messages, or both.
numberType	`string`	The type of phone number to request.
deletionProtectionEnabled?	`boolean \|` `IResolvable`	By default this is set to false.
optOutListName?	`string`	The name of the OptOutList associated with the phone number.
optionalKeywords?	`IResolvable` `\|` `IResolvable` `\|` `OptionalKeywordProperty[]`	A keyword is a word that you can search for on a particular phone number or pool.
selfManagedOptOutsEnabled?	`boolean \|` `IResolvable`	When set to false and 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.
tags?	`CfnTag[]`	An array of tags (key and value pairs) to associate with the requested phone number.
twoWay?	`IResolvable` `\|` `TwoWayProperty`	Describes the two-way SMS configuration for a phone number.

isoCountryCode

Type: string

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

mandatoryKeywords

Type: IResolvable | MandatoryKeywordsProperty

Creates or updates a MandatoryKeyword configuration on an origination phone number For more information, see Keywords in the End User Messaging User Guide.

numberCapabilities

Type: string[]

Indicates if the phone number will be used for text messages, voice messages, or both.

numberType

Type: string

The type of phone number to request.

The ShortCode number type is not supported in AWS CloudFormation .

deletionProtectionEnabled?

Type: boolean | IResolvable (optional)

By default this is set to false.

When set to true the phone number can't be deleted.

optOutListName?

Type: string (optional)

The name of the OptOutList associated with the phone number.

optionalKeywords?

Type: IResolvable | IResolvable | OptionalKeywordProperty[] (optional)

A keyword is a word that you can search for on a particular phone number or pool.

It is also a specific word or phrase that an end user can send to your number to elicit a response, such as an informational message or a special offer. When your number receives a message that begins with a keyword, End User Messaging responds with a customizable message. Optional keywords are differentiated from mandatory keywords. For more information, see Keywords in the End User Messaging User Guide.

selfManagedOptOutsEnabled?

Type: boolean | IResolvable (optional)

When set to false and 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 request. For more information see Self-managed opt-outs

tags?

Type: CfnTag[] (optional)

An array of tags (key and value pairs) to associate with the requested phone number.

twoWay?

Type: IResolvable | TwoWayProperty (optional)

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.