AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::Connect::PhoneNumber

CfnPhoneNumber

Claims a phone number to the specified Amazon Connect instance or traffic distribution group.

Import

import { CfnPhoneNumber } from 'aws-cdk-lib/aws-connect';

Or use the module namespace:

import * as connect from 'aws-cdk-lib/aws-connect';
// connect.CfnPhoneNumber

Properties

Configuration passed to the constructor as CfnPhoneNumberProps.

targetArnRequired
string

The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution group that phone numbers are claimed to.

countryCodeOptional
string

The ISO country code.

descriptionOptional
string

The description of the phone number.

prefixOptional
string

The prefix of the phone number. If provided, it must contain `+` as part of the country code. *Pattern* : `^\\+[0-9]{1,15}`

sourcePhoneNumberArnOptional
string

The claimed phone number ARN that was previously imported from the external service, such as AWS End User Messaging. If it is from AWS End User Messaging, it looks like the ARN of the phone number that was imported from AWS End User Messaging.

tagsOptional
CfnTag[]

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

typeOptional
string

The type of phone number.

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