class CfnPhoneNumber (construct)

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

Implements IConstruct, IDependable, IInspectable, IPhoneNumberRef, ITaggableV2

Request an origination phone number for use in your account.

For more information on phone number request see Request a phone number in the End User Messaging User Guide .

Registering phone numbers is not supported by AWS CloudFormation . You can import phone numbers and sender IDs that are automatically provisioned at registration.

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

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 cfnPhoneNumber = new smsvoice.CfnPhoneNumber(this, 'MyCfnPhoneNumber', {
  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',
  },
});

Initializer

new CfnPhoneNumber(scope: Construct, id: string, props: CfnPhoneNumberProps)

Parameters

• scope Construct — Scope in which this resource is defined.
• id string — Construct identifier for this resource (unique in its scope).
• props CfnPhoneNumberProps — Resource properties.

Construct Props

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-phonenumber.html#cfn-smsvoice-phonenumber-isocountrycode

---

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-phonenumber.html#cfn-smsvoice-phonenumber-mandatorykeywords

---

numberCapabilities

Type: string[]

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-phonenumber.html#cfn-smsvoice-phonenumber-numbercapabilities

---

numberType

Type: string

The type of phone number to request.

The ShortCode number type is not supported in AWS CloudFormation .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-phonenumber.html#cfn-smsvoice-phonenumber-numbertype

---

deletionProtectionEnabled?

Type: boolean | IResolvable (optional)

By default this is set to false.

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-phonenumber.html#cfn-smsvoice-phonenumber-deletionprotectionenabled

---

optOutListName?

Type: string (optional)

The name of the OptOutList associated with the phone number.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-phonenumber.html#cfn-smsvoice-phonenumber-optoutlistname

---

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-phonenumber.html#cfn-smsvoice-phonenumber-optionalkeywords

---

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-phonenumber.html#cfn-smsvoice-phonenumber-selfmanagedoptoutsenabled

---

tags?

Type: CfnTag[] (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-phonenumber.html#cfn-smsvoice-phonenumber-tags

---

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-smsvoice-phonenumber.html#cfn-smsvoice-phonenumber-twoway

Properties

Name	Type	Description
attrArn	string	The PhoneNumber 's Amazon Resource Name (ARN).
attrPhoneNumber	string	The phone number in E.164 format.
attrPhoneNumberId	string	The unique identifier for the phone number.
cdkTagManager	TagManager	Tag Manager which manages the tags for this resource.
cfnOptions	ICfnResourceOptions	Options for this resource, such as condition, update policy etc.
cfnProperties	{ [string]: any }
cfnResourceType	string	AWS resource type.
creationStack	string[]
isoCountryCode	string	The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
logicalId	string	The logical ID for this CloudFormation stack element.
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.
node	Node	The tree node.
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.
phoneNumberRef	PhoneNumberReference	A reference to a PhoneNumber resource.
ref	string	Return a string that will be resolved to a CloudFormation { Ref } for this element.
stack	Stack	The stack in which this element is defined.
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.
static CFN_RESOURCE_TYPE_NAME	string	The CloudFormation resource type name for this resource class.

---

attrArn

Type: string

The PhoneNumber 's Amazon Resource Name (ARN).

---

attrPhoneNumber

Type: string

The phone number in E.164 format.

---

attrPhoneNumberId

Type: string

The unique identifier for the phone number.

---

cdkTagManager

Type: TagManager

Tag Manager which manages the tags for this resource.

---

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

---

cfnProperties

Type: { [string]: any }

---

cfnResourceType

Type: string

AWS resource type.

---

creationStack

Type: string[]

---

isoCountryCode

Type: string

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

---

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

---

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.

---

node

Type: Node

The tree node.

---

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.

---

phoneNumberRef

Type: PhoneNumberReference

A reference to a PhoneNumber resource.

---

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

---

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

---

deletionProtectionEnabled?

Type: boolean | IResolvable (optional)

By default this is set to false.

---

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.

---

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.

---

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.

---

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for addOverride(path, undefined).
addDependency(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDependsOn(target)⚠️	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName, typeHint?)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
obtainDependencies()	Retrieves an array of resources this resource depends on.
obtainResourceDependencies()	Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)	Indicates that this resource no longer depends on another resource.
replaceDependency(target, newTarget)	Replaces one dependency with another.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

---

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

• path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

---

addDependency(target)

public addDependency(target: CfnResource): void

Parameters

• target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

---

addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: use addDependency

Parameters

• target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

---

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

• key string
• value any

Add a value to the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

---

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

• path string — - The path of the property, you can use dot notation to override values in complex types.
• value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

---

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

• propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

---

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

• propertyPath string — The path of the property.
• value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

---

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

• policy RemovalPolicy
• options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

---

getAtt(attributeName, typeHint?)

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference

Parameters

• attributeName string — The name of the attribute.
• typeHint ResolutionTypeHint

Returns

• Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

---

getMetadata(key)

public getMetadata(key: string): any

Parameters

• key string

Returns

• any

Retrieve a value value from the CloudFormation Resource Metadata.

See also: [https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

---

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

• inspector TreeInspector — tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

---

obtainDependencies()

public obtainDependencies(): Stack | CfnResource[]

Returns

• Stack | CfnResource[]

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

---

obtainResourceDependencies()

public obtainResourceDependencies(): CfnResource[]

Returns

• CfnResource[]

Get a shallow copy of dependencies between this resource and other resources in the same stack.

---

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

• newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

---

removeDependency(target)

public removeDependency(target: CfnResource): void

Parameters

• target CfnResource

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

---

replaceDependency(target, newTarget)

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Parameters

• target CfnResource — The dependency to replace.
• newTarget CfnResource — The new dependency to add.

Replaces one dependency with another.

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

• props { [string]: any }

Returns

• { [string]: any }