VoiceConnectorGroup class

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", {
    connectors: [
        {
            voiceConnectorId: vc1.id,
            priority: 1,
        },
        {
            voiceConnectorId: vc2.id,
            priority: 3,
        },
    ],
    name: "test-group",
});
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",
    connectors=[
        {
            "voice_connector_id": vc1.id,
            "priority": 1,
        },
        {
            "voice_connector_id": vc2.id,
            "priority": 3,
        },
    ],
    name="test-group")
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()
    {
        Connectors = new[]
        {
            new Aws.Chime.Inputs.VoiceConnectorGroupConnectorArgs
            {
                VoiceConnectorId = vc1.Id,
                Priority = 1,
            },
            new Aws.Chime.Inputs.VoiceConnectorGroupConnectorArgs
            {
                VoiceConnectorId = vc2.Id,
                Priority = 3,
            },
        },
        Name = "test-group",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/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{
			Connectors: chime.VoiceConnectorGroupConnectorArray{
				&chime.VoiceConnectorGroupConnectorArgs{
					VoiceConnectorId: vc1.ID().ToIDOutput().ToStringOutput(),
					Priority:         pulumi.Int(1),
				},
				&chime.VoiceConnectorGroupConnectorArgs{
					VoiceConnectorId: vc2.ID().ToIDOutput().ToStringOutput(),
					Priority:         pulumi.Int(3),
				},
			},
			Name: pulumi.String("test-group"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_chime_voiceconnector" "vc1" {
  name               = "connector-test-1"
  require_encryption = true
  aws_region         = "us-east-1"
}
resource "aws_chime_voiceconnector" "vc2" {
  name               = "connector-test-2"
  require_encryption = true
  aws_region         = "us-west-2"
}
resource "aws_chime_voiceconnectorgroup" "group" {
  connectors {
    voice_connector_id = aws_chime_voiceconnector.vc1.id
    priority           = 1
  }
  connectors {
    voice_connector_id = aws_chime_voiceconnector.vc2.id
    priority           = 3
  }
  name = "test-group"
}
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.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 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()
            .connectors(
                VoiceConnectorGroupConnectorArgs.builder()
                    .voiceConnectorId(vc1.id())
                    .priority(1)
                    .build(),
                VoiceConnectorGroupConnectorArgs.builder()
                    .voiceConnectorId(vc2.id())
                    .priority(3)
                    .build())
            .name("test-group")
            .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:
      connectors:
        - voiceConnectorId: ${vc1.id}
          priority: 1
        - voiceConnectorId: ${vc2.id}
          priority: 3
      name: test-group

Import

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

$ pulumi import aws:chime/voiceConnectorGroup:VoiceConnectorGroup default example

Constructors

VoiceConnectorGroup(String name, {VoiceConnectorGroupArgs? args, CustomResourceOptions? options})
Creates a new VoiceConnectorGroup. name The Pulumi resource name. args Arguments used to configure this VoiceConnectorGroup. The set of arguments for VoiceConnectorGroup. options Resource options controlling this resource's behavior.
VoiceConnectorGroup.reference(String urn)
Creates a typed reference to an existing VoiceConnectorGroup resource.

Properties

childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
connectors ↔ Output<List<VoiceConnectorGroupConnector>?>
The Amazon Chime Voice Connectors to route inbound calls to.
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
name ↔ Output<String>
The name of the Amazon Chime Voice Connector group.
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
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
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, {VoiceConnectorGroupState? state, CustomResourceOptions? options}) → VoiceConnectorGroup
Gets an existing VoiceConnectorGroup resource's state with the given name and id.