1. Packages
  2. AWS Classic
  3. API Docs
  4. chime
  5. VoiceConnector

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.41.0 published on Tuesday, Jun 18, 2024 by Pulumi

aws.chime.VoiceConnector

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.41.0 published on Tuesday, Jun 18, 2024 by Pulumi

    Enables you to connect your phone system to the telephone network at a substantial cost savings by using SIP trunking.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const test = new aws.chime.VoiceConnector("test", {
        name: "connector-test-1",
        requireEncryption: true,
        awsRegion: "us-east-1",
    });
    
    import pulumi
    import pulumi_aws as aws
    
    test = aws.chime.VoiceConnector("test",
        name="connector-test-1",
        require_encryption=True,
        aws_region="us-east-1")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/chime"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := chime.NewVoiceConnector(ctx, "test", &chime.VoiceConnectorArgs{
    			Name:              pulumi.String("connector-test-1"),
    			RequireEncryption: pulumi.Bool(true),
    			AwsRegion:         pulumi.String("us-east-1"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var test = new Aws.Chime.VoiceConnector("test", new()
        {
            Name = "connector-test-1",
            RequireEncryption = true,
            AwsRegion = "us-east-1",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.chime.VoiceConnector;
    import com.pulumi.aws.chime.VoiceConnectorArgs;
    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 test = new VoiceConnector("test", VoiceConnectorArgs.builder()
                .name("connector-test-1")
                .requireEncryption(true)
                .awsRegion("us-east-1")
                .build());
    
        }
    }
    
    resources:
      test:
        type: aws:chime:VoiceConnector
        properties:
          name: connector-test-1
          requireEncryption: true
          awsRegion: us-east-1
    

    Create VoiceConnector Resource

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

    Constructor syntax

    new VoiceConnector(name: string, args: VoiceConnectorArgs, opts?: CustomResourceOptions);
    @overload
    def VoiceConnector(resource_name: str,
                       args: VoiceConnectorArgs,
                       opts: Optional[ResourceOptions] = None)
    
    @overload
    def VoiceConnector(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       require_encryption: Optional[bool] = None,
                       aws_region: Optional[str] = None,
                       name: Optional[str] = None,
                       tags: Optional[Mapping[str, str]] = None)
    func NewVoiceConnector(ctx *Context, name string, args VoiceConnectorArgs, opts ...ResourceOption) (*VoiceConnector, error)
    public VoiceConnector(string name, VoiceConnectorArgs args, CustomResourceOptions? opts = null)
    public VoiceConnector(String name, VoiceConnectorArgs args)
    public VoiceConnector(String name, VoiceConnectorArgs args, CustomResourceOptions options)
    
    type: aws:chime:VoiceConnector
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

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

    Example

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

    var voiceConnectorResource = new Aws.Chime.VoiceConnector("voiceConnectorResource", new()
    {
        RequireEncryption = false,
        AwsRegion = "string",
        Name = "string",
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := chime.NewVoiceConnector(ctx, "voiceConnectorResource", &chime.VoiceConnectorArgs{
    	RequireEncryption: pulumi.Bool(false),
    	AwsRegion:         pulumi.String("string"),
    	Name:              pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var voiceConnectorResource = new VoiceConnector("voiceConnectorResource", VoiceConnectorArgs.builder()
        .requireEncryption(false)
        .awsRegion("string")
        .name("string")
        .tags(Map.of("string", "string"))
        .build());
    
    voice_connector_resource = aws.chime.VoiceConnector("voiceConnectorResource",
        require_encryption=False,
        aws_region="string",
        name="string",
        tags={
            "string": "string",
        })
    
    const voiceConnectorResource = new aws.chime.VoiceConnector("voiceConnectorResource", {
        requireEncryption: false,
        awsRegion: "string",
        name: "string",
        tags: {
            string: "string",
        },
    });
    
    type: aws:chime:VoiceConnector
    properties:
        awsRegion: string
        name: string
        requireEncryption: false
        tags:
            string: string
    

    VoiceConnector Resource Properties

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

    Inputs

    The VoiceConnector resource accepts the following input properties:

    RequireEncryption bool

    When enabled, requires encryption for the Amazon Chime Voice Connector.

    The following arguments are optional:

    AwsRegion string
    The AWS Region in which the Amazon Chime Voice Connector is created. Default value: us-east-1
    Name string
    The name of the Amazon Chime Voice Connector.
    Tags Dictionary<string, string>
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    RequireEncryption bool

    When enabled, requires encryption for the Amazon Chime Voice Connector.

    The following arguments are optional:

    AwsRegion string
    The AWS Region in which the Amazon Chime Voice Connector is created. Default value: us-east-1
    Name string
    The name of the Amazon Chime Voice Connector.
    Tags map[string]string
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    requireEncryption Boolean

    When enabled, requires encryption for the Amazon Chime Voice Connector.

    The following arguments are optional:

    awsRegion String
    The AWS Region in which the Amazon Chime Voice Connector is created. Default value: us-east-1
    name String
    The name of the Amazon Chime Voice Connector.
    tags Map<String,String>
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    requireEncryption boolean

    When enabled, requires encryption for the Amazon Chime Voice Connector.

    The following arguments are optional:

    awsRegion string
    The AWS Region in which the Amazon Chime Voice Connector is created. Default value: us-east-1
    name string
    The name of the Amazon Chime Voice Connector.
    tags {[key: string]: string}
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    require_encryption bool

    When enabled, requires encryption for the Amazon Chime Voice Connector.

    The following arguments are optional:

    aws_region str
    The AWS Region in which the Amazon Chime Voice Connector is created. Default value: us-east-1
    name str
    The name of the Amazon Chime Voice Connector.
    tags Mapping[str, str]
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    requireEncryption Boolean

    When enabled, requires encryption for the Amazon Chime Voice Connector.

    The following arguments are optional:

    awsRegion String
    The AWS Region in which the Amazon Chime Voice Connector is created. Default value: us-east-1
    name String
    The name of the Amazon Chime Voice Connector.
    tags Map<String>
    Key-value mapping of resource tags. 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 VoiceConnector resource produces the following output properties:

    Arn string
    ARN (Amazon Resource Name) of the Amazon Chime Voice Connector.
    Id string
    The provider-assigned unique ID for this managed resource.
    OutboundHostName string
    The outbound host name for the Amazon Chime Voice Connector.
    TagsAll Dictionary<string, string>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    ARN (Amazon Resource Name) of the Amazon Chime Voice Connector.
    Id string
    The provider-assigned unique ID for this managed resource.
    OutboundHostName string
    The outbound host name for the Amazon Chime Voice Connector.
    TagsAll map[string]string
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    ARN (Amazon Resource Name) of the Amazon Chime Voice Connector.
    id String
    The provider-assigned unique ID for this managed resource.
    outboundHostName String
    The outbound host name for the Amazon Chime Voice Connector.
    tagsAll Map<String,String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    ARN (Amazon Resource Name) of the Amazon Chime Voice Connector.
    id string
    The provider-assigned unique ID for this managed resource.
    outboundHostName string
    The outbound host name for the Amazon Chime Voice Connector.
    tagsAll {[key: string]: string}
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    ARN (Amazon Resource Name) of the Amazon Chime Voice Connector.
    id str
    The provider-assigned unique ID for this managed resource.
    outbound_host_name str
    The outbound host name for the Amazon Chime Voice Connector.
    tags_all Mapping[str, str]
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    ARN (Amazon Resource Name) of the Amazon Chime Voice Connector.
    id String
    The provider-assigned unique ID for this managed resource.
    outboundHostName String
    The outbound host name for the Amazon Chime Voice Connector.
    tagsAll Map<String>
    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 VoiceConnector Resource

    Get an existing VoiceConnector 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?: VoiceConnectorState, opts?: CustomResourceOptions): VoiceConnector
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            arn: Optional[str] = None,
            aws_region: Optional[str] = None,
            name: Optional[str] = None,
            outbound_host_name: Optional[str] = None,
            require_encryption: Optional[bool] = None,
            tags: Optional[Mapping[str, str]] = None,
            tags_all: Optional[Mapping[str, str]] = None) -> VoiceConnector
    func GetVoiceConnector(ctx *Context, name string, id IDInput, state *VoiceConnectorState, opts ...ResourceOption) (*VoiceConnector, error)
    public static VoiceConnector Get(string name, Input<string> id, VoiceConnectorState? state, CustomResourceOptions? opts = null)
    public static VoiceConnector get(String name, Output<String> id, VoiceConnectorState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    ARN (Amazon Resource Name) of the Amazon Chime Voice Connector.
    AwsRegion string
    The AWS Region in which the Amazon Chime Voice Connector is created. Default value: us-east-1
    Name string
    The name of the Amazon Chime Voice Connector.
    OutboundHostName string
    The outbound host name for the Amazon Chime Voice Connector.
    RequireEncryption bool

    When enabled, requires encryption for the Amazon Chime Voice Connector.

    The following arguments are optional:

    Tags Dictionary<string, string>
    Key-value mapping of resource tags. 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>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    ARN (Amazon Resource Name) of the Amazon Chime Voice Connector.
    AwsRegion string
    The AWS Region in which the Amazon Chime Voice Connector is created. Default value: us-east-1
    Name string
    The name of the Amazon Chime Voice Connector.
    OutboundHostName string
    The outbound host name for the Amazon Chime Voice Connector.
    RequireEncryption bool

    When enabled, requires encryption for the Amazon Chime Voice Connector.

    The following arguments are optional:

    Tags map[string]string
    Key-value mapping of resource tags. 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
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    ARN (Amazon Resource Name) of the Amazon Chime Voice Connector.
    awsRegion String
    The AWS Region in which the Amazon Chime Voice Connector is created. Default value: us-east-1
    name String
    The name of the Amazon Chime Voice Connector.
    outboundHostName String
    The outbound host name for the Amazon Chime Voice Connector.
    requireEncryption Boolean

    When enabled, requires encryption for the Amazon Chime Voice Connector.

    The following arguments are optional:

    tags Map<String,String>
    Key-value mapping of resource tags. 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>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    ARN (Amazon Resource Name) of the Amazon Chime Voice Connector.
    awsRegion string
    The AWS Region in which the Amazon Chime Voice Connector is created. Default value: us-east-1
    name string
    The name of the Amazon Chime Voice Connector.
    outboundHostName string
    The outbound host name for the Amazon Chime Voice Connector.
    requireEncryption boolean

    When enabled, requires encryption for the Amazon Chime Voice Connector.

    The following arguments are optional:

    tags {[key: string]: string}
    Key-value mapping of resource tags. 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}
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    ARN (Amazon Resource Name) of the Amazon Chime Voice Connector.
    aws_region str
    The AWS Region in which the Amazon Chime Voice Connector is created. Default value: us-east-1
    name str
    The name of the Amazon Chime Voice Connector.
    outbound_host_name str
    The outbound host name for the Amazon Chime Voice Connector.
    require_encryption bool

    When enabled, requires encryption for the Amazon Chime Voice Connector.

    The following arguments are optional:

    tags Mapping[str, str]
    Key-value mapping of resource tags. 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]
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    ARN (Amazon Resource Name) of the Amazon Chime Voice Connector.
    awsRegion String
    The AWS Region in which the Amazon Chime Voice Connector is created. Default value: us-east-1
    name String
    The name of the Amazon Chime Voice Connector.
    outboundHostName String
    The outbound host name for the Amazon Chime Voice Connector.
    requireEncryption Boolean

    When enabled, requires encryption for the Amazon Chime Voice Connector.

    The following arguments are optional:

    tags Map<String>
    Key-value mapping of resource tags. 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>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Import

    Using pulumi import, import Configuration Recorder using the name. For example:

    $ pulumi import aws:chime/voiceConnector:VoiceConnector test example
    

    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.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.41.0 published on Tuesday, Jun 18, 2024 by Pulumi