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

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

AWS Classic v6.40.0 published on Wednesday, Jun 12, 2024 by Pulumi

aws.chime.VoiceConnectorGroup

Explore with Pulumi AI

aws logo

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

AWS Classic v6.40.0 published on Wednesday, Jun 12, 2024 by Pulumi

    Creates an Amazon Chime Voice Connector group under the administrator’s AWS account. You can associate Amazon Chime Voice Connectors with the Amazon Chime Voice Connector group by including VoiceConnectorItems in the request.

    You can include Amazon Chime Voice Connectors from different AWS Regions in your group. This creates a fault tolerant mechanism for fallback in case of availability events.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const vc1 = new aws.chime.VoiceConnector("vc1", {
        name: "connector-test-1",
        requireEncryption: true,
        awsRegion: "us-east-1",
    });
    const vc2 = new aws.chime.VoiceConnector("vc2", {
        name: "connector-test-2",
        requireEncryption: true,
        awsRegion: "us-west-2",
    });
    const group = new aws.chime.VoiceConnectorGroup("group", {
        name: "test-group",
        connectors: [
            {
                voiceConnectorId: vc1.id,
                priority: 1,
            },
            {
                voiceConnectorId: vc2.id,
                priority: 3,
            },
        ],
    });
    
    import pulumi
    import pulumi_aws as aws
    
    vc1 = aws.chime.VoiceConnector("vc1",
        name="connector-test-1",
        require_encryption=True,
        aws_region="us-east-1")
    vc2 = aws.chime.VoiceConnector("vc2",
        name="connector-test-2",
        require_encryption=True,
        aws_region="us-west-2")
    group = aws.chime.VoiceConnectorGroup("group",
        name="test-group",
        connectors=[
            aws.chime.VoiceConnectorGroupConnectorArgs(
                voice_connector_id=vc1.id,
                priority=1,
            ),
            aws.chime.VoiceConnectorGroupConnectorArgs(
                voice_connector_id=vc2.id,
                priority=3,
            ),
        ])
    
    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 {
    		vc1, err := chime.NewVoiceConnector(ctx, "vc1", &chime.VoiceConnectorArgs{
    			Name:              pulumi.String("connector-test-1"),
    			RequireEncryption: pulumi.Bool(true),
    			AwsRegion:         pulumi.String("us-east-1"),
    		})
    		if err != nil {
    			return err
    		}
    		vc2, err := chime.NewVoiceConnector(ctx, "vc2", &chime.VoiceConnectorArgs{
    			Name:              pulumi.String("connector-test-2"),
    			RequireEncryption: pulumi.Bool(true),
    			AwsRegion:         pulumi.String("us-west-2"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = chime.NewVoiceConnectorGroup(ctx, "group", &chime.VoiceConnectorGroupArgs{
    			Name: pulumi.String("test-group"),
    			Connectors: chime.VoiceConnectorGroupConnectorArray{
    				&chime.VoiceConnectorGroupConnectorArgs{
    					VoiceConnectorId: vc1.ID(),
    					Priority:         pulumi.Int(1),
    				},
    				&chime.VoiceConnectorGroupConnectorArgs{
    					VoiceConnectorId: vc2.ID(),
    					Priority:         pulumi.Int(3),
    				},
    			},
    		})
    		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 vc1 = new Aws.Chime.VoiceConnector("vc1", new()
        {
            Name = "connector-test-1",
            RequireEncryption = true,
            AwsRegion = "us-east-1",
        });
    
        var vc2 = new Aws.Chime.VoiceConnector("vc2", new()
        {
            Name = "connector-test-2",
            RequireEncryption = true,
            AwsRegion = "us-west-2",
        });
    
        var @group = new Aws.Chime.VoiceConnectorGroup("group", new()
        {
            Name = "test-group",
            Connectors = new[]
            {
                new Aws.Chime.Inputs.VoiceConnectorGroupConnectorArgs
                {
                    VoiceConnectorId = vc1.Id,
                    Priority = 1,
                },
                new Aws.Chime.Inputs.VoiceConnectorGroupConnectorArgs
                {
                    VoiceConnectorId = vc2.Id,
                    Priority = 3,
                },
            },
        });
    
    });
    
    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 com.pulumi.aws.chime.VoiceConnectorGroup;
    import com.pulumi.aws.chime.VoiceConnectorGroupArgs;
    import com.pulumi.aws.chime.inputs.VoiceConnectorGroupConnectorArgs;
    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 vc1 = new VoiceConnector("vc1", VoiceConnectorArgs.builder()
                .name("connector-test-1")
                .requireEncryption(true)
                .awsRegion("us-east-1")
                .build());
    
            var vc2 = new VoiceConnector("vc2", VoiceConnectorArgs.builder()
                .name("connector-test-2")
                .requireEncryption(true)
                .awsRegion("us-west-2")
                .build());
    
            var group = new VoiceConnectorGroup("group", VoiceConnectorGroupArgs.builder()
                .name("test-group")
                .connectors(            
                    VoiceConnectorGroupConnectorArgs.builder()
                        .voiceConnectorId(vc1.id())
                        .priority(1)
                        .build(),
                    VoiceConnectorGroupConnectorArgs.builder()
                        .voiceConnectorId(vc2.id())
                        .priority(3)
                        .build())
                .build());
    
        }
    }
    
    resources:
      vc1:
        type: aws:chime:VoiceConnector
        properties:
          name: connector-test-1
          requireEncryption: true
          awsRegion: us-east-1
      vc2:
        type: aws:chime:VoiceConnector
        properties:
          name: connector-test-2
          requireEncryption: true
          awsRegion: us-west-2
      group:
        type: aws:chime:VoiceConnectorGroup
        properties:
          name: test-group
          connectors:
            - voiceConnectorId: ${vc1.id}
              priority: 1
            - voiceConnectorId: ${vc2.id}
              priority: 3
    

    Create VoiceConnectorGroup Resource

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

    Constructor syntax

    new VoiceConnectorGroup(name: string, args?: VoiceConnectorGroupArgs, opts?: CustomResourceOptions);
    @overload
    def VoiceConnectorGroup(resource_name: str,
                            args: Optional[VoiceConnectorGroupArgs] = None,
                            opts: Optional[ResourceOptions] = None)
    
    @overload
    def VoiceConnectorGroup(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            connectors: Optional[Sequence[VoiceConnectorGroupConnectorArgs]] = None,
                            name: Optional[str] = None)
    func NewVoiceConnectorGroup(ctx *Context, name string, args *VoiceConnectorGroupArgs, opts ...ResourceOption) (*VoiceConnectorGroup, error)
    public VoiceConnectorGroup(string name, VoiceConnectorGroupArgs? args = null, CustomResourceOptions? opts = null)
    public VoiceConnectorGroup(String name, VoiceConnectorGroupArgs args)
    public VoiceConnectorGroup(String name, VoiceConnectorGroupArgs args, CustomResourceOptions options)
    
    type: aws:chime:VoiceConnectorGroup
    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 VoiceConnectorGroupArgs
    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 VoiceConnectorGroupArgs
    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 VoiceConnectorGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VoiceConnectorGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VoiceConnectorGroupArgs
    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 voiceConnectorGroupResource = new Aws.Chime.VoiceConnectorGroup("voiceConnectorGroupResource", new()
    {
        Connectors = new[]
        {
            new Aws.Chime.Inputs.VoiceConnectorGroupConnectorArgs
            {
                Priority = 0,
                VoiceConnectorId = "string",
            },
        },
        Name = "string",
    });
    
    example, err := chime.NewVoiceConnectorGroup(ctx, "voiceConnectorGroupResource", &chime.VoiceConnectorGroupArgs{
    	Connectors: chime.VoiceConnectorGroupConnectorArray{
    		&chime.VoiceConnectorGroupConnectorArgs{
    			Priority:         pulumi.Int(0),
    			VoiceConnectorId: pulumi.String("string"),
    		},
    	},
    	Name: pulumi.String("string"),
    })
    
    var voiceConnectorGroupResource = new VoiceConnectorGroup("voiceConnectorGroupResource", VoiceConnectorGroupArgs.builder()
        .connectors(VoiceConnectorGroupConnectorArgs.builder()
            .priority(0)
            .voiceConnectorId("string")
            .build())
        .name("string")
        .build());
    
    voice_connector_group_resource = aws.chime.VoiceConnectorGroup("voiceConnectorGroupResource",
        connectors=[aws.chime.VoiceConnectorGroupConnectorArgs(
            priority=0,
            voice_connector_id="string",
        )],
        name="string")
    
    const voiceConnectorGroupResource = new aws.chime.VoiceConnectorGroup("voiceConnectorGroupResource", {
        connectors: [{
            priority: 0,
            voiceConnectorId: "string",
        }],
        name: "string",
    });
    
    type: aws:chime:VoiceConnectorGroup
    properties:
        connectors:
            - priority: 0
              voiceConnectorId: string
        name: string
    

    VoiceConnectorGroup 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 VoiceConnectorGroup resource accepts the following input properties:

    Connectors List<VoiceConnectorGroupConnector>
    The Amazon Chime Voice Connectors to route inbound calls to.
    Name string
    The name of the Amazon Chime Voice Connector group.
    Connectors []VoiceConnectorGroupConnectorArgs
    The Amazon Chime Voice Connectors to route inbound calls to.
    Name string
    The name of the Amazon Chime Voice Connector group.
    connectors List<VoiceConnectorGroupConnector>
    The Amazon Chime Voice Connectors to route inbound calls to.
    name String
    The name of the Amazon Chime Voice Connector group.
    connectors VoiceConnectorGroupConnector[]
    The Amazon Chime Voice Connectors to route inbound calls to.
    name string
    The name of the Amazon Chime Voice Connector group.
    connectors Sequence[VoiceConnectorGroupConnectorArgs]
    The Amazon Chime Voice Connectors to route inbound calls to.
    name str
    The name of the Amazon Chime Voice Connector group.
    connectors List<Property Map>
    The Amazon Chime Voice Connectors to route inbound calls to.
    name String
    The name of the Amazon Chime Voice Connector group.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing VoiceConnectorGroup Resource

    Get an existing VoiceConnectorGroup 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?: VoiceConnectorGroupState, opts?: CustomResourceOptions): VoiceConnectorGroup
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            connectors: Optional[Sequence[VoiceConnectorGroupConnectorArgs]] = None,
            name: Optional[str] = None) -> VoiceConnectorGroup
    func GetVoiceConnectorGroup(ctx *Context, name string, id IDInput, state *VoiceConnectorGroupState, opts ...ResourceOption) (*VoiceConnectorGroup, error)
    public static VoiceConnectorGroup Get(string name, Input<string> id, VoiceConnectorGroupState? state, CustomResourceOptions? opts = null)
    public static VoiceConnectorGroup get(String name, Output<String> id, VoiceConnectorGroupState 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:
    Connectors List<VoiceConnectorGroupConnector>
    The Amazon Chime Voice Connectors to route inbound calls to.
    Name string
    The name of the Amazon Chime Voice Connector group.
    Connectors []VoiceConnectorGroupConnectorArgs
    The Amazon Chime Voice Connectors to route inbound calls to.
    Name string
    The name of the Amazon Chime Voice Connector group.
    connectors List<VoiceConnectorGroupConnector>
    The Amazon Chime Voice Connectors to route inbound calls to.
    name String
    The name of the Amazon Chime Voice Connector group.
    connectors VoiceConnectorGroupConnector[]
    The Amazon Chime Voice Connectors to route inbound calls to.
    name string
    The name of the Amazon Chime Voice Connector group.
    connectors Sequence[VoiceConnectorGroupConnectorArgs]
    The Amazon Chime Voice Connectors to route inbound calls to.
    name str
    The name of the Amazon Chime Voice Connector group.
    connectors List<Property Map>
    The Amazon Chime Voice Connectors to route inbound calls to.
    name String
    The name of the Amazon Chime Voice Connector group.

    Supporting Types

    VoiceConnectorGroupConnector, VoiceConnectorGroupConnectorArgs

    Priority int
    The priority associated with the Amazon Chime Voice Connector, with 1 being the highest priority. Higher priority Amazon Chime Voice Connectors are attempted first.
    VoiceConnectorId string
    The Amazon Chime Voice Connector ID.
    Priority int
    The priority associated with the Amazon Chime Voice Connector, with 1 being the highest priority. Higher priority Amazon Chime Voice Connectors are attempted first.
    VoiceConnectorId string
    The Amazon Chime Voice Connector ID.
    priority Integer
    The priority associated with the Amazon Chime Voice Connector, with 1 being the highest priority. Higher priority Amazon Chime Voice Connectors are attempted first.
    voiceConnectorId String
    The Amazon Chime Voice Connector ID.
    priority number
    The priority associated with the Amazon Chime Voice Connector, with 1 being the highest priority. Higher priority Amazon Chime Voice Connectors are attempted first.
    voiceConnectorId string
    The Amazon Chime Voice Connector ID.
    priority int
    The priority associated with the Amazon Chime Voice Connector, with 1 being the highest priority. Higher priority Amazon Chime Voice Connectors are attempted first.
    voice_connector_id str
    The Amazon Chime Voice Connector ID.
    priority Number
    The priority associated with the Amazon Chime Voice Connector, with 1 being the highest priority. Higher priority Amazon Chime Voice Connectors are attempted first.
    voiceConnectorId String
    The Amazon Chime Voice Connector ID.

    Import

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

    $ pulumi import aws:chime/voiceConnectorGroup:VoiceConnectorGroup default 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.40.0 published on Wednesday, Jun 12, 2024 by Pulumi