1. Packages
  2. AWS
  3. API Docs
  4. connect
  5. PhoneNumber
AWS v6.78.0 published on Thursday, Apr 24, 2025 by Pulumi

aws.connect.PhoneNumber

Explore with Pulumi AI

Provides an Amazon Connect Phone Number resource. For more information see Amazon Connect: Getting Started

Example Usage

Basic

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.connect.PhoneNumber("example", {
    targetArn: exampleAwsConnectInstance.arn,
    countryCode: "US",
    type: "DID",
    tags: {
        hello: "world",
    },
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.connect.PhoneNumber("example",
    target_arn=example_aws_connect_instance["arn"],
    country_code="US",
    type="DID",
    tags={
        "hello": "world",
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/connect"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := connect.NewPhoneNumber(ctx, "example", &connect.PhoneNumberArgs{
			TargetArn:   pulumi.Any(exampleAwsConnectInstance.Arn),
			CountryCode: pulumi.String("US"),
			Type:        pulumi.String("DID"),
			Tags: pulumi.StringMap{
				"hello": pulumi.String("world"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Connect.PhoneNumber("example", new()
    {
        TargetArn = exampleAwsConnectInstance.Arn,
        CountryCode = "US",
        Type = "DID",
        Tags = 
        {
            { "hello", "world" },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.connect.PhoneNumber;
import com.pulumi.aws.connect.PhoneNumberArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new PhoneNumber("example", PhoneNumberArgs.builder()
            .targetArn(exampleAwsConnectInstance.arn())
            .countryCode("US")
            .type("DID")
            .tags(Map.of("hello", "world"))
            .build());

    }
}
Copy
resources:
  example:
    type: aws:connect:PhoneNumber
    properties:
      targetArn: ${exampleAwsConnectInstance.arn}
      countryCode: US
      type: DID
      tags:
        hello: world
Copy

Description

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.connect.PhoneNumber("example", {
    targetArn: exampleAwsConnectInstance.arn,
    countryCode: "US",
    type: "DID",
    description: "example description",
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.connect.PhoneNumber("example",
    target_arn=example_aws_connect_instance["arn"],
    country_code="US",
    type="DID",
    description="example description")
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/connect"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := connect.NewPhoneNumber(ctx, "example", &connect.PhoneNumberArgs{
			TargetArn:   pulumi.Any(exampleAwsConnectInstance.Arn),
			CountryCode: pulumi.String("US"),
			Type:        pulumi.String("DID"),
			Description: pulumi.String("example description"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Connect.PhoneNumber("example", new()
    {
        TargetArn = exampleAwsConnectInstance.Arn,
        CountryCode = "US",
        Type = "DID",
        Description = "example description",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.connect.PhoneNumber;
import com.pulumi.aws.connect.PhoneNumberArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new PhoneNumber("example", PhoneNumberArgs.builder()
            .targetArn(exampleAwsConnectInstance.arn())
            .countryCode("US")
            .type("DID")
            .description("example description")
            .build());

    }
}
Copy
resources:
  example:
    type: aws:connect:PhoneNumber
    properties:
      targetArn: ${exampleAwsConnectInstance.arn}
      countryCode: US
      type: DID
      description: example description
Copy

Prefix to filter phone numbers

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.connect.PhoneNumber("example", {
    targetArn: exampleAwsConnectInstance.arn,
    countryCode: "US",
    type: "DID",
    prefix: "+18005",
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.connect.PhoneNumber("example",
    target_arn=example_aws_connect_instance["arn"],
    country_code="US",
    type="DID",
    prefix="+18005")
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/connect"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := connect.NewPhoneNumber(ctx, "example", &connect.PhoneNumberArgs{
			TargetArn:   pulumi.Any(exampleAwsConnectInstance.Arn),
			CountryCode: pulumi.String("US"),
			Type:        pulumi.String("DID"),
			Prefix:      pulumi.String("+18005"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Connect.PhoneNumber("example", new()
    {
        TargetArn = exampleAwsConnectInstance.Arn,
        CountryCode = "US",
        Type = "DID",
        Prefix = "+18005",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.connect.PhoneNumber;
import com.pulumi.aws.connect.PhoneNumberArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new PhoneNumber("example", PhoneNumberArgs.builder()
            .targetArn(exampleAwsConnectInstance.arn())
            .countryCode("US")
            .type("DID")
            .prefix("+18005")
            .build());

    }
}
Copy
resources:
  example:
    type: aws:connect:PhoneNumber
    properties:
      targetArn: ${exampleAwsConnectInstance.arn}
      countryCode: US
      type: DID
      prefix: '+18005'
Copy

Create PhoneNumber Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new PhoneNumber(name: string, args: PhoneNumberArgs, opts?: CustomResourceOptions);
@overload
def PhoneNumber(resource_name: str,
                args: PhoneNumberArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def PhoneNumber(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                country_code: Optional[str] = None,
                target_arn: Optional[str] = None,
                type: Optional[str] = None,
                description: Optional[str] = None,
                prefix: Optional[str] = None,
                tags: Optional[Mapping[str, str]] = None)
func NewPhoneNumber(ctx *Context, name string, args PhoneNumberArgs, opts ...ResourceOption) (*PhoneNumber, error)
public PhoneNumber(string name, PhoneNumberArgs args, CustomResourceOptions? opts = null)
public PhoneNumber(String name, PhoneNumberArgs args)
public PhoneNumber(String name, PhoneNumberArgs args, CustomResourceOptions options)
type: aws:connect:PhoneNumber
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. PhoneNumberArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. PhoneNumberArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. PhoneNumberArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. PhoneNumberArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. PhoneNumberArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var phoneNumberResource = new Aws.Connect.PhoneNumber("phoneNumberResource", new()
{
    CountryCode = "string",
    TargetArn = "string",
    Type = "string",
    Description = "string",
    Prefix = "string",
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := connect.NewPhoneNumber(ctx, "phoneNumberResource", &connect.PhoneNumberArgs{
	CountryCode: pulumi.String("string"),
	TargetArn:   pulumi.String("string"),
	Type:        pulumi.String("string"),
	Description: pulumi.String("string"),
	Prefix:      pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var phoneNumberResource = new PhoneNumber("phoneNumberResource", PhoneNumberArgs.builder()
    .countryCode("string")
    .targetArn("string")
    .type("string")
    .description("string")
    .prefix("string")
    .tags(Map.of("string", "string"))
    .build());
Copy
phone_number_resource = aws.connect.PhoneNumber("phoneNumberResource",
    country_code="string",
    target_arn="string",
    type="string",
    description="string",
    prefix="string",
    tags={
        "string": "string",
    })
Copy
const phoneNumberResource = new aws.connect.PhoneNumber("phoneNumberResource", {
    countryCode: "string",
    targetArn: "string",
    type: "string",
    description: "string",
    prefix: "string",
    tags: {
        string: "string",
    },
});
Copy
type: aws:connect:PhoneNumber
properties:
    countryCode: string
    description: string
    prefix: string
    tags:
        string: string
    targetArn: string
    type: string
Copy

PhoneNumber Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The PhoneNumber resource accepts the following input properties:

CountryCode
This property is required.
Changes to this property will trigger replacement.
string
The ISO country code. For a list of Valid values, refer to PhoneNumberCountryCode.
TargetArn This property is required. string
The Amazon Resource Name (ARN) for Amazon Connect instances that phone numbers are claimed to.
Type
This property is required.
Changes to this property will trigger replacement.
string
The type of phone number. Valid Values: TOLL_FREE | DID.
Description Changes to this property will trigger replacement. string
The description of the phone number.
Prefix Changes to this property will trigger replacement. string
The prefix of the phone number that is used to filter available phone numbers. If provided, it must contain + as part of the country code. Do not specify this argument when importing the resource.
Tags Dictionary<string, string>
Tags to apply to the Phone Number. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
CountryCode
This property is required.
Changes to this property will trigger replacement.
string
The ISO country code. For a list of Valid values, refer to PhoneNumberCountryCode.
TargetArn This property is required. string
The Amazon Resource Name (ARN) for Amazon Connect instances that phone numbers are claimed to.
Type
This property is required.
Changes to this property will trigger replacement.
string
The type of phone number. Valid Values: TOLL_FREE | DID.
Description Changes to this property will trigger replacement. string
The description of the phone number.
Prefix Changes to this property will trigger replacement. string
The prefix of the phone number that is used to filter available phone numbers. If provided, it must contain + as part of the country code. Do not specify this argument when importing the resource.
Tags map[string]string
Tags to apply to the Phone Number. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
countryCode
This property is required.
Changes to this property will trigger replacement.
String
The ISO country code. For a list of Valid values, refer to PhoneNumberCountryCode.
targetArn This property is required. String
The Amazon Resource Name (ARN) for Amazon Connect instances that phone numbers are claimed to.
type
This property is required.
Changes to this property will trigger replacement.
String
The type of phone number. Valid Values: TOLL_FREE | DID.
description Changes to this property will trigger replacement. String
The description of the phone number.
prefix Changes to this property will trigger replacement. String
The prefix of the phone number that is used to filter available phone numbers. If provided, it must contain + as part of the country code. Do not specify this argument when importing the resource.
tags Map<String,String>
Tags to apply to the Phone Number. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
countryCode
This property is required.
Changes to this property will trigger replacement.
string
The ISO country code. For a list of Valid values, refer to PhoneNumberCountryCode.
targetArn This property is required. string
The Amazon Resource Name (ARN) for Amazon Connect instances that phone numbers are claimed to.
type
This property is required.
Changes to this property will trigger replacement.
string
The type of phone number. Valid Values: TOLL_FREE | DID.
description Changes to this property will trigger replacement. string
The description of the phone number.
prefix Changes to this property will trigger replacement. string
The prefix of the phone number that is used to filter available phone numbers. If provided, it must contain + as part of the country code. Do not specify this argument when importing the resource.
tags {[key: string]: string}
Tags to apply to the Phone Number. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
country_code
This property is required.
Changes to this property will trigger replacement.
str
The ISO country code. For a list of Valid values, refer to PhoneNumberCountryCode.
target_arn This property is required. str
The Amazon Resource Name (ARN) for Amazon Connect instances that phone numbers are claimed to.
type
This property is required.
Changes to this property will trigger replacement.
str
The type of phone number. Valid Values: TOLL_FREE | DID.
description Changes to this property will trigger replacement. str
The description of the phone number.
prefix Changes to this property will trigger replacement. str
The prefix of the phone number that is used to filter available phone numbers. If provided, it must contain + as part of the country code. Do not specify this argument when importing the resource.
tags Mapping[str, str]
Tags to apply to the Phone Number. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
countryCode
This property is required.
Changes to this property will trigger replacement.
String
The ISO country code. For a list of Valid values, refer to PhoneNumberCountryCode.
targetArn This property is required. String
The Amazon Resource Name (ARN) for Amazon Connect instances that phone numbers are claimed to.
type
This property is required.
Changes to this property will trigger replacement.
String
The type of phone number. Valid Values: TOLL_FREE | DID.
description Changes to this property will trigger replacement. String
The description of the phone number.
prefix Changes to this property will trigger replacement. String
The prefix of the phone number that is used to filter available phone numbers. If provided, it must contain + as part of the country code. Do not specify this argument when importing the resource.
tags Map<String>
Tags to apply to the Phone Number. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Outputs

All input properties are implicitly available as output properties. Additionally, the PhoneNumber resource produces the following output properties:

Arn string
The ARN of the phone number.
Id string
The provider-assigned unique ID for this managed resource.
PhoneNumberValue string
The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code].
Statuses List<PhoneNumberStatus>
The status of the phone number. Valid Values: CLAIMED | IN_PROGRESS | FAILED.
TagsAll Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Arn string
The ARN of the phone number.
Id string
The provider-assigned unique ID for this managed resource.
PhoneNumber string
The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code].
Statuses []PhoneNumberStatus
The status of the phone number. Valid Values: CLAIMED | IN_PROGRESS | FAILED.
TagsAll map[string]string
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
The ARN of the phone number.
id String
The provider-assigned unique ID for this managed resource.
phoneNumber String
The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code].
statuses List<PhoneNumberStatus>
The status of the phone number. Valid Values: CLAIMED | IN_PROGRESS | FAILED.
tagsAll Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn string
The ARN of the phone number.
id string
The provider-assigned unique ID for this managed resource.
phoneNumber string
The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code].
statuses PhoneNumberStatus[]
The status of the phone number. Valid Values: CLAIMED | IN_PROGRESS | FAILED.
tagsAll {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn str
The ARN of the phone number.
id str
The provider-assigned unique ID for this managed resource.
phone_number str
The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code].
statuses Sequence[PhoneNumberStatus]
The status of the phone number. Valid Values: CLAIMED | IN_PROGRESS | FAILED.
tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
The ARN of the phone number.
id String
The provider-assigned unique ID for this managed resource.
phoneNumber String
The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code].
statuses List<Property Map>
The status of the phone number. Valid Values: CLAIMED | IN_PROGRESS | FAILED.
tagsAll Map<String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Look up Existing PhoneNumber Resource

Get an existing PhoneNumber resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: PhoneNumberState, opts?: CustomResourceOptions): PhoneNumber
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        country_code: Optional[str] = None,
        description: Optional[str] = None,
        phone_number: Optional[str] = None,
        prefix: Optional[str] = None,
        statuses: Optional[Sequence[PhoneNumberStatusArgs]] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        target_arn: Optional[str] = None,
        type: Optional[str] = None) -> PhoneNumber
func GetPhoneNumber(ctx *Context, name string, id IDInput, state *PhoneNumberState, opts ...ResourceOption) (*PhoneNumber, error)
public static PhoneNumber Get(string name, Input<string> id, PhoneNumberState? state, CustomResourceOptions? opts = null)
public static PhoneNumber get(String name, Output<String> id, PhoneNumberState state, CustomResourceOptions options)
resources:  _:    type: aws:connect:PhoneNumber    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Arn string
The ARN of the phone number.
CountryCode Changes to this property will trigger replacement. string
The ISO country code. For a list of Valid values, refer to PhoneNumberCountryCode.
Description Changes to this property will trigger replacement. string
The description of the phone number.
PhoneNumberValue string
The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code].
Prefix Changes to this property will trigger replacement. string
The prefix of the phone number that is used to filter available phone numbers. If provided, it must contain + as part of the country code. Do not specify this argument when importing the resource.
Statuses List<PhoneNumberStatus>
The status of the phone number. Valid Values: CLAIMED | IN_PROGRESS | FAILED.
Tags Dictionary<string, string>
Tags to apply to the Phone Number. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TagsAll Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

TargetArn string
The Amazon Resource Name (ARN) for Amazon Connect instances that phone numbers are claimed to.
Type Changes to this property will trigger replacement. string
The type of phone number. Valid Values: TOLL_FREE | DID.
Arn string
The ARN of the phone number.
CountryCode Changes to this property will trigger replacement. string
The ISO country code. For a list of Valid values, refer to PhoneNumberCountryCode.
Description Changes to this property will trigger replacement. string
The description of the phone number.
PhoneNumber string
The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code].
Prefix Changes to this property will trigger replacement. string
The prefix of the phone number that is used to filter available phone numbers. If provided, it must contain + as part of the country code. Do not specify this argument when importing the resource.
Statuses []PhoneNumberStatusArgs
The status of the phone number. Valid Values: CLAIMED | IN_PROGRESS | FAILED.
Tags map[string]string
Tags to apply to the Phone Number. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TagsAll map[string]string
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

TargetArn string
The Amazon Resource Name (ARN) for Amazon Connect instances that phone numbers are claimed to.
Type Changes to this property will trigger replacement. string
The type of phone number. Valid Values: TOLL_FREE | DID.
arn String
The ARN of the phone number.
countryCode Changes to this property will trigger replacement. String
The ISO country code. For a list of Valid values, refer to PhoneNumberCountryCode.
description Changes to this property will trigger replacement. String
The description of the phone number.
phoneNumber String
The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code].
prefix Changes to this property will trigger replacement. String
The prefix of the phone number that is used to filter available phone numbers. If provided, it must contain + as part of the country code. Do not specify this argument when importing the resource.
statuses List<PhoneNumberStatus>
The status of the phone number. Valid Values: CLAIMED | IN_PROGRESS | FAILED.
tags Map<String,String>
Tags to apply to the Phone Number. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

targetArn String
The Amazon Resource Name (ARN) for Amazon Connect instances that phone numbers are claimed to.
type Changes to this property will trigger replacement. String
The type of phone number. Valid Values: TOLL_FREE | DID.
arn string
The ARN of the phone number.
countryCode Changes to this property will trigger replacement. string
The ISO country code. For a list of Valid values, refer to PhoneNumberCountryCode.
description Changes to this property will trigger replacement. string
The description of the phone number.
phoneNumber string
The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code].
prefix Changes to this property will trigger replacement. string
The prefix of the phone number that is used to filter available phone numbers. If provided, it must contain + as part of the country code. Do not specify this argument when importing the resource.
statuses PhoneNumberStatus[]
The status of the phone number. Valid Values: CLAIMED | IN_PROGRESS | FAILED.
tags {[key: string]: string}
Tags to apply to the Phone Number. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

targetArn string
The Amazon Resource Name (ARN) for Amazon Connect instances that phone numbers are claimed to.
type Changes to this property will trigger replacement. string
The type of phone number. Valid Values: TOLL_FREE | DID.
arn str
The ARN of the phone number.
country_code Changes to this property will trigger replacement. str
The ISO country code. For a list of Valid values, refer to PhoneNumberCountryCode.
description Changes to this property will trigger replacement. str
The description of the phone number.
phone_number str
The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code].
prefix Changes to this property will trigger replacement. str
The prefix of the phone number that is used to filter available phone numbers. If provided, it must contain + as part of the country code. Do not specify this argument when importing the resource.
statuses Sequence[PhoneNumberStatusArgs]
The status of the phone number. Valid Values: CLAIMED | IN_PROGRESS | FAILED.
tags Mapping[str, str]
Tags to apply to the Phone Number. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

target_arn str
The Amazon Resource Name (ARN) for Amazon Connect instances that phone numbers are claimed to.
type Changes to this property will trigger replacement. str
The type of phone number. Valid Values: TOLL_FREE | DID.
arn String
The ARN of the phone number.
countryCode Changes to this property will trigger replacement. String
The ISO country code. For a list of Valid values, refer to PhoneNumberCountryCode.
description Changes to this property will trigger replacement. String
The description of the phone number.
phoneNumber String
The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code].
prefix Changes to this property will trigger replacement. String
The prefix of the phone number that is used to filter available phone numbers. If provided, it must contain + as part of the country code. Do not specify this argument when importing the resource.
statuses List<Property Map>
The status of the phone number. Valid Values: CLAIMED | IN_PROGRESS | FAILED.
tags Map<String>
Tags to apply to the Phone Number. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll Map<String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

targetArn String
The Amazon Resource Name (ARN) for Amazon Connect instances that phone numbers are claimed to.
type Changes to this property will trigger replacement. String
The type of phone number. Valid Values: TOLL_FREE | DID.

Supporting Types

PhoneNumberStatus
, PhoneNumberStatusArgs

Message string
The status message.
Status string
The status of the phone number. Valid Values: CLAIMED | IN_PROGRESS | FAILED.
Message string
The status message.
Status string
The status of the phone number. Valid Values: CLAIMED | IN_PROGRESS | FAILED.
message String
The status message.
status String
The status of the phone number. Valid Values: CLAIMED | IN_PROGRESS | FAILED.
message string
The status message.
status string
The status of the phone number. Valid Values: CLAIMED | IN_PROGRESS | FAILED.
message str
The status message.
status str
The status of the phone number. Valid Values: CLAIMED | IN_PROGRESS | FAILED.
message String
The status message.
status String
The status of the phone number. Valid Values: CLAIMED | IN_PROGRESS | FAILED.

Import

Using pulumi import, import Amazon Connect Phone Numbers using its id. For example:

$ pulumi import aws:connect/phoneNumber:PhoneNumber example 12345678-abcd-1234-efgh-9876543210ab
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.