pulumi-aws-kotlin/com.pulumi.aws.connect.kotlin/PhoneNumber

PhoneNumber

class PhoneNumber : KotlinCustomResource

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

Example Usage

Basic

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(aws_connect_instance.example().arn())
            .countryCode("US")
            .type("DID")
            .tags(Map.of("hello", "world"))
            .build());
    }
}

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.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(aws_connect_instance.example().arn())
            .countryCode("US")
            .type("DID")
            .description("example description")
            .build());
    }
}

Prefix to filter phone numbers

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(aws_connect_instance.example().arn())
            .countryCode("US")
            .type("DID")
            .prefix("+18005")
            .build());
    }
}

Import

Amazon Connect Phone Numbers can be imported using its id e.g.,

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

Properties

arn

val arn: Output<String>

The ARN of the phone number.

countryCode

val countryCode: Output<String>

The ISO country code. For a list of Valid values, refer to PhoneNumberCountryCode.

description

val description: Output<String>?

The description of the phone number.

val id: Output<String>

phoneNumber

val phoneNumber: Output<String>

The phone number. Phone numbers are formatted [+] [country code] [subscriber number including area code].

prefix

val 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.

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

statuses

val statuses: Output<List<PhoneNumberStatus>>

The status of the phone number. Valid Values: CLAIMED | IN_PROGRESS | FAILED.