AWS::Connect::PhoneNumber

Connect PhoneNumber

Resource Type definition for AWS::Connect::PhoneNumber

Properties

7 configurable properties. 1 required. Click a row to see details.

Filter:

Property	Type	Flags
`TargetArn`	`string`	Required
`CountryCode`	`string`	Create-only
`Description`	`string`
`Prefix`	`string`	Create-onlyWrite-only
`SourcePhoneNumberArn`	`string`	Create-only
`Tags`	`Array<Tag>`
`Type`	`string`	Create-only

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`Address`	`string`	The phone number e164 address.
`PhoneNumberArn`	`string`	The phone number ARN

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::Connect::PhoneNumber

Resources:
  MyResource:
    Type: AWS::Connect::PhoneNumber
    Properties:
      TargetArn: "arn:aws:service:region:account:resource"
      Tags:
        - Key: Environment
          Value: Production
      Description: !Ref "AWS::StackName"

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

connect:ClaimPhoneNumberconnect:SearchAvailablePhoneNumbersconnect:DescribePhoneNumberconnect:TagResourceconnect:ImportPhoneNumbersms-voice:DescribePhoneNumberssocial-messaging:GetLinkedWhatsAppBusinessAccountPhoneNumbersocial-messaging:TagResource

read

connect:DescribePhoneNumber

delete

connect:ReleasePhoneNumberconnect:UntagResource

update

connect:UpdatePhoneNumberconnect:UpdatePhoneNumberMetadataconnect:DescribePhoneNumberconnect:TagResourceconnect:UntagResource

list

connect:ListPhoneNumbersV2

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

ServiceConnect

Properties9

Required1

TaggingSupported

Primary IDPhoneNumberArn

Supported Operations

CreateReadDeleteUpdateList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

TypeCountryCodePrefixSourcePhoneNumberArn

Related Resources

External Links

AWS Documentation