PhoneNumber class
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",
},
});
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",
})
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" },
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/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
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_connect_phonenumber" "example" {
target_arn = exampleAwsConnectInstance.arn
country_code = "US"
type = "DID"
tags = {
"hello" = "world"
}
}
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.ArrayList;
import java.util.Arrays;
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());
}
}
resources:
example:
type: aws:connect:PhoneNumber
properties:
targetArn: ${exampleAwsConnectInstance.arn}
countryCode: US
type: DID
tags:
hello: world
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",
});
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")
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",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/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
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_connect_phonenumber" "example" {
target_arn = exampleAwsConnectInstance.arn
country_code = "US"
type = "DID"
description = "example description"
}
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.ArrayList;
import java.util.Arrays;
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());
}
}
resources:
example:
type: aws:connect:PhoneNumber
properties:
targetArn: ${exampleAwsConnectInstance.arn}
countryCode: US
type: DID
description: example description
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",
});
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")
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",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/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
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_connect_phonenumber" "example" {
target_arn = exampleAwsConnectInstance.arn
country_code = "US"
type = "DID"
prefix = "+18005"
}
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.ArrayList;
import java.util.Arrays;
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());
}
}
resources:
example:
type: aws:connect:PhoneNumber
properties:
targetArn: ${exampleAwsConnectInstance.arn}
countryCode: US
type: DID
prefix: '+18005'
Import
Identity Schema
Required
id- (String) ID of the connect phone number.
Optional
accountId(String) AWS Account where this resource is managed.region(String) Region where this resource is managed.
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
Constructors
- PhoneNumber(String name, {PhoneNumberArgs? args, CustomResourceOptions? options})
-
Creates a new PhoneNumber.
nameThe Pulumi resource name.argsArguments used to configure this PhoneNumber. The set of arguments for PhoneNumber.optionsResource options controlling this resource's behavior. - PhoneNumber.reference(String urn)
- Creates a typed reference to an existing PhoneNumber resource.
Properties
-
arn
↔ Output<
String> -
The ARN of the phone number.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
countryCode
↔ Output<
String> -
The ISO country code. For a list of Valid values, refer to PhoneNumberCountryCode.
latefinal
-
description
↔ Output<
String?> -
The description of the phone number.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
phoneNumber
↔ Output<
String> -
The phone number. Phone numbers are formatted
[+] [country code] [subscriber number including area code].latefinal -
prefix
↔ Output<
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.latefinal -
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
statuses
↔ Output<
List< PhoneNumberStatus> > -
The status of the phone number. Valid Values:
CLAIMED|IN_PROGRESS|FAILED.latefinal -
Tags to apply to the Phone Number. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
A map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.latefinal -
targetArn
↔ Output<
String> -
ARN for Amazon Connect instances that phone numbers are claimed to.
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
type
↔ Output<
String> -
The type of phone number. Valid Values:
TOLL_FREE|DID.latefinal -
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {PhoneNumberState? state, CustomResourceOptions? options}) → PhoneNumber -
Gets an existing PhoneNumber resource's state with the given
nameandid.