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

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

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

    Enable origination settings to control inbound calling to your SIP infrastructure.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const _default = new aws.chime.VoiceConnector("default", {
        name: "test",
        requireEncryption: true,
    });
    const defaultVoiceConnectorOrganization = new aws.chime.VoiceConnectorOrganization("default", {
        disabled: false,
        voiceConnectorId: _default.id,
        routes: [
            {
                host: "127.0.0.1",
                port: 8081,
                protocol: "TCP",
                priority: 1,
                weight: 1,
            },
            {
                host: "127.0.0.2",
                port: 8082,
                protocol: "TCP",
                priority: 2,
                weight: 10,
            },
        ],
    });
    
    import pulumi
    import pulumi_aws as aws
    
    default = aws.chime.VoiceConnector("default",
        name="test",
        require_encryption=True)
    default_voice_connector_organization = aws.chime.VoiceConnectorOrganization("default",
        disabled=False,
        voice_connector_id=default.id,
        routes=[
            aws.chime.VoiceConnectorOrganizationRouteArgs(
                host="127.0.0.1",
                port=8081,
                protocol="TCP",
                priority=1,
                weight=1,
            ),
            aws.chime.VoiceConnectorOrganizationRouteArgs(
                host="127.0.0.2",
                port=8082,
                protocol="TCP",
                priority=2,
                weight=10,
            ),
        ])
    
    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, "default", &chime.VoiceConnectorArgs{
    			Name:              pulumi.String("test"),
    			RequireEncryption: pulumi.Bool(true),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = chime.NewVoiceConnectorOrganization(ctx, "default", &chime.VoiceConnectorOrganizationArgs{
    			Disabled:         pulumi.Bool(false),
    			VoiceConnectorId: _default.ID(),
    			Routes: chime.VoiceConnectorOrganizationRouteArray{
    				&chime.VoiceConnectorOrganizationRouteArgs{
    					Host:     pulumi.String("127.0.0.1"),
    					Port:     pulumi.Int(8081),
    					Protocol: pulumi.String("TCP"),
    					Priority: pulumi.Int(1),
    					Weight:   pulumi.Int(1),
    				},
    				&chime.VoiceConnectorOrganizationRouteArgs{
    					Host:     pulumi.String("127.0.0.2"),
    					Port:     pulumi.Int(8082),
    					Protocol: pulumi.String("TCP"),
    					Priority: pulumi.Int(2),
    					Weight:   pulumi.Int(10),
    				},
    			},
    		})
    		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 @default = new Aws.Chime.VoiceConnector("default", new()
        {
            Name = "test",
            RequireEncryption = true,
        });
    
        var defaultVoiceConnectorOrganization = new Aws.Chime.VoiceConnectorOrganization("default", new()
        {
            Disabled = false,
            VoiceConnectorId = @default.Id,
            Routes = new[]
            {
                new Aws.Chime.Inputs.VoiceConnectorOrganizationRouteArgs
                {
                    Host = "127.0.0.1",
                    Port = 8081,
                    Protocol = "TCP",
                    Priority = 1,
                    Weight = 1,
                },
                new Aws.Chime.Inputs.VoiceConnectorOrganizationRouteArgs
                {
                    Host = "127.0.0.2",
                    Port = 8082,
                    Protocol = "TCP",
                    Priority = 2,
                    Weight = 10,
                },
            },
        });
    
    });
    
    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.VoiceConnectorOrganization;
    import com.pulumi.aws.chime.VoiceConnectorOrganizationArgs;
    import com.pulumi.aws.chime.inputs.VoiceConnectorOrganizationRouteArgs;
    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 default_ = new VoiceConnector("default", VoiceConnectorArgs.builder()
                .name("test")
                .requireEncryption(true)
                .build());
    
            var defaultVoiceConnectorOrganization = new VoiceConnectorOrganization("defaultVoiceConnectorOrganization", VoiceConnectorOrganizationArgs.builder()
                .disabled(false)
                .voiceConnectorId(default_.id())
                .routes(            
                    VoiceConnectorOrganizationRouteArgs.builder()
                        .host("127.0.0.1")
                        .port(8081)
                        .protocol("TCP")
                        .priority(1)
                        .weight(1)
                        .build(),
                    VoiceConnectorOrganizationRouteArgs.builder()
                        .host("127.0.0.2")
                        .port(8082)
                        .protocol("TCP")
                        .priority(2)
                        .weight(10)
                        .build())
                .build());
    
        }
    }
    
    resources:
      default:
        type: aws:chime:VoiceConnector
        properties:
          name: test
          requireEncryption: true
      defaultVoiceConnectorOrganization:
        type: aws:chime:VoiceConnectorOrganization
        name: default
        properties:
          disabled: false
          voiceConnectorId: ${default.id}
          routes:
            - host: 127.0.0.1
              port: 8081
              protocol: TCP
              priority: 1
              weight: 1
            - host: 127.0.0.2
              port: 8082
              protocol: TCP
              priority: 2
              weight: 10
    

    Create VoiceConnectorOrganization Resource

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

    Constructor syntax

    new VoiceConnectorOrganization(name: string, args: VoiceConnectorOrganizationArgs, opts?: CustomResourceOptions);
    @overload
    def VoiceConnectorOrganization(resource_name: str,
                                   args: VoiceConnectorOrganizationArgs,
                                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def VoiceConnectorOrganization(resource_name: str,
                                   opts: Optional[ResourceOptions] = None,
                                   routes: Optional[Sequence[VoiceConnectorOrganizationRouteArgs]] = None,
                                   voice_connector_id: Optional[str] = None,
                                   disabled: Optional[bool] = None)
    func NewVoiceConnectorOrganization(ctx *Context, name string, args VoiceConnectorOrganizationArgs, opts ...ResourceOption) (*VoiceConnectorOrganization, error)
    public VoiceConnectorOrganization(string name, VoiceConnectorOrganizationArgs args, CustomResourceOptions? opts = null)
    public VoiceConnectorOrganization(String name, VoiceConnectorOrganizationArgs args)
    public VoiceConnectorOrganization(String name, VoiceConnectorOrganizationArgs args, CustomResourceOptions options)
    
    type: aws:chime:VoiceConnectorOrganization
    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 VoiceConnectorOrganizationArgs
    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 VoiceConnectorOrganizationArgs
    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 VoiceConnectorOrganizationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VoiceConnectorOrganizationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VoiceConnectorOrganizationArgs
    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 voiceConnectorOrganizationResource = new Aws.Chime.VoiceConnectorOrganization("voiceConnectorOrganizationResource", new()
    {
        Routes = new[]
        {
            new Aws.Chime.Inputs.VoiceConnectorOrganizationRouteArgs
            {
                Host = "string",
                Priority = 0,
                Protocol = "string",
                Weight = 0,
                Port = 0,
            },
        },
        VoiceConnectorId = "string",
        Disabled = false,
    });
    
    example, err := chime.NewVoiceConnectorOrganization(ctx, "voiceConnectorOrganizationResource", &chime.VoiceConnectorOrganizationArgs{
    	Routes: chime.VoiceConnectorOrganizationRouteArray{
    		&chime.VoiceConnectorOrganizationRouteArgs{
    			Host:     pulumi.String("string"),
    			Priority: pulumi.Int(0),
    			Protocol: pulumi.String("string"),
    			Weight:   pulumi.Int(0),
    			Port:     pulumi.Int(0),
    		},
    	},
    	VoiceConnectorId: pulumi.String("string"),
    	Disabled:         pulumi.Bool(false),
    })
    
    var voiceConnectorOrganizationResource = new VoiceConnectorOrganization("voiceConnectorOrganizationResource", VoiceConnectorOrganizationArgs.builder()
        .routes(VoiceConnectorOrganizationRouteArgs.builder()
            .host("string")
            .priority(0)
            .protocol("string")
            .weight(0)
            .port(0)
            .build())
        .voiceConnectorId("string")
        .disabled(false)
        .build());
    
    voice_connector_organization_resource = aws.chime.VoiceConnectorOrganization("voiceConnectorOrganizationResource",
        routes=[aws.chime.VoiceConnectorOrganizationRouteArgs(
            host="string",
            priority=0,
            protocol="string",
            weight=0,
            port=0,
        )],
        voice_connector_id="string",
        disabled=False)
    
    const voiceConnectorOrganizationResource = new aws.chime.VoiceConnectorOrganization("voiceConnectorOrganizationResource", {
        routes: [{
            host: "string",
            priority: 0,
            protocol: "string",
            weight: 0,
            port: 0,
        }],
        voiceConnectorId: "string",
        disabled: false,
    });
    
    type: aws:chime:VoiceConnectorOrganization
    properties:
        disabled: false
        routes:
            - host: string
              port: 0
              priority: 0
              protocol: string
              weight: 0
        voiceConnectorId: string
    

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

    Routes List<VoiceConnectorOrganizationRoute>
    Set of call distribution properties defined for your SIP hosts. See route below for more details. Minimum of 1. Maximum of 20.
    VoiceConnectorId string
    The Amazon Chime Voice Connector ID.
    Disabled bool
    When origination settings are disabled, inbound calls are not enabled for your Amazon Chime Voice Connector.
    Routes []VoiceConnectorOrganizationRouteArgs
    Set of call distribution properties defined for your SIP hosts. See route below for more details. Minimum of 1. Maximum of 20.
    VoiceConnectorId string
    The Amazon Chime Voice Connector ID.
    Disabled bool
    When origination settings are disabled, inbound calls are not enabled for your Amazon Chime Voice Connector.
    routes List<VoiceConnectorOrganizationRoute>
    Set of call distribution properties defined for your SIP hosts. See route below for more details. Minimum of 1. Maximum of 20.
    voiceConnectorId String
    The Amazon Chime Voice Connector ID.
    disabled Boolean
    When origination settings are disabled, inbound calls are not enabled for your Amazon Chime Voice Connector.
    routes VoiceConnectorOrganizationRoute[]
    Set of call distribution properties defined for your SIP hosts. See route below for more details. Minimum of 1. Maximum of 20.
    voiceConnectorId string
    The Amazon Chime Voice Connector ID.
    disabled boolean
    When origination settings are disabled, inbound calls are not enabled for your Amazon Chime Voice Connector.
    routes Sequence[VoiceConnectorOrganizationRouteArgs]
    Set of call distribution properties defined for your SIP hosts. See route below for more details. Minimum of 1. Maximum of 20.
    voice_connector_id str
    The Amazon Chime Voice Connector ID.
    disabled bool
    When origination settings are disabled, inbound calls are not enabled for your Amazon Chime Voice Connector.
    routes List<Property Map>
    Set of call distribution properties defined for your SIP hosts. See route below for more details. Minimum of 1. Maximum of 20.
    voiceConnectorId String
    The Amazon Chime Voice Connector ID.
    disabled Boolean
    When origination settings are disabled, inbound calls are not enabled for your Amazon Chime Voice Connector.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the VoiceConnectorOrganization 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 VoiceConnectorOrganization Resource

    Get an existing VoiceConnectorOrganization 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?: VoiceConnectorOrganizationState, opts?: CustomResourceOptions): VoiceConnectorOrganization
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            disabled: Optional[bool] = None,
            routes: Optional[Sequence[VoiceConnectorOrganizationRouteArgs]] = None,
            voice_connector_id: Optional[str] = None) -> VoiceConnectorOrganization
    func GetVoiceConnectorOrganization(ctx *Context, name string, id IDInput, state *VoiceConnectorOrganizationState, opts ...ResourceOption) (*VoiceConnectorOrganization, error)
    public static VoiceConnectorOrganization Get(string name, Input<string> id, VoiceConnectorOrganizationState? state, CustomResourceOptions? opts = null)
    public static VoiceConnectorOrganization get(String name, Output<String> id, VoiceConnectorOrganizationState 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:
    Disabled bool
    When origination settings are disabled, inbound calls are not enabled for your Amazon Chime Voice Connector.
    Routes List<VoiceConnectorOrganizationRoute>
    Set of call distribution properties defined for your SIP hosts. See route below for more details. Minimum of 1. Maximum of 20.
    VoiceConnectorId string
    The Amazon Chime Voice Connector ID.
    Disabled bool
    When origination settings are disabled, inbound calls are not enabled for your Amazon Chime Voice Connector.
    Routes []VoiceConnectorOrganizationRouteArgs
    Set of call distribution properties defined for your SIP hosts. See route below for more details. Minimum of 1. Maximum of 20.
    VoiceConnectorId string
    The Amazon Chime Voice Connector ID.
    disabled Boolean
    When origination settings are disabled, inbound calls are not enabled for your Amazon Chime Voice Connector.
    routes List<VoiceConnectorOrganizationRoute>
    Set of call distribution properties defined for your SIP hosts. See route below for more details. Minimum of 1. Maximum of 20.
    voiceConnectorId String
    The Amazon Chime Voice Connector ID.
    disabled boolean
    When origination settings are disabled, inbound calls are not enabled for your Amazon Chime Voice Connector.
    routes VoiceConnectorOrganizationRoute[]
    Set of call distribution properties defined for your SIP hosts. See route below for more details. Minimum of 1. Maximum of 20.
    voiceConnectorId string
    The Amazon Chime Voice Connector ID.
    disabled bool
    When origination settings are disabled, inbound calls are not enabled for your Amazon Chime Voice Connector.
    routes Sequence[VoiceConnectorOrganizationRouteArgs]
    Set of call distribution properties defined for your SIP hosts. See route below for more details. Minimum of 1. Maximum of 20.
    voice_connector_id str
    The Amazon Chime Voice Connector ID.
    disabled Boolean
    When origination settings are disabled, inbound calls are not enabled for your Amazon Chime Voice Connector.
    routes List<Property Map>
    Set of call distribution properties defined for your SIP hosts. See route below for more details. Minimum of 1. Maximum of 20.
    voiceConnectorId String
    The Amazon Chime Voice Connector ID.

    Supporting Types

    VoiceConnectorOrganizationRoute, VoiceConnectorOrganizationRouteArgs

    Host string
    The FQDN or IP address to contact for origination traffic.
    Priority int
    The priority associated with the host, with 1 being the highest priority. Higher priority hosts are attempted first.
    Protocol string
    The protocol to use for the origination route. Encryption-enabled Amazon Chime Voice Connectors use TCP protocol by default.
    Weight int
    The weight associated with the host. If hosts are equal in priority, calls are redistributed among them based on their relative weight.
    Port int
    The designated origination route port. Defaults to 5060.
    Host string
    The FQDN or IP address to contact for origination traffic.
    Priority int
    The priority associated with the host, with 1 being the highest priority. Higher priority hosts are attempted first.
    Protocol string
    The protocol to use for the origination route. Encryption-enabled Amazon Chime Voice Connectors use TCP protocol by default.
    Weight int
    The weight associated with the host. If hosts are equal in priority, calls are redistributed among them based on their relative weight.
    Port int
    The designated origination route port. Defaults to 5060.
    host String
    The FQDN or IP address to contact for origination traffic.
    priority Integer
    The priority associated with the host, with 1 being the highest priority. Higher priority hosts are attempted first.
    protocol String
    The protocol to use for the origination route. Encryption-enabled Amazon Chime Voice Connectors use TCP protocol by default.
    weight Integer
    The weight associated with the host. If hosts are equal in priority, calls are redistributed among them based on their relative weight.
    port Integer
    The designated origination route port. Defaults to 5060.
    host string
    The FQDN or IP address to contact for origination traffic.
    priority number
    The priority associated with the host, with 1 being the highest priority. Higher priority hosts are attempted first.
    protocol string
    The protocol to use for the origination route. Encryption-enabled Amazon Chime Voice Connectors use TCP protocol by default.
    weight number
    The weight associated with the host. If hosts are equal in priority, calls are redistributed among them based on their relative weight.
    port number
    The designated origination route port. Defaults to 5060.
    host str
    The FQDN or IP address to contact for origination traffic.
    priority int
    The priority associated with the host, with 1 being the highest priority. Higher priority hosts are attempted first.
    protocol str
    The protocol to use for the origination route. Encryption-enabled Amazon Chime Voice Connectors use TCP protocol by default.
    weight int
    The weight associated with the host. If hosts are equal in priority, calls are redistributed among them based on their relative weight.
    port int
    The designated origination route port. Defaults to 5060.
    host String
    The FQDN or IP address to contact for origination traffic.
    priority Number
    The priority associated with the host, with 1 being the highest priority. Higher priority hosts are attempted first.
    protocol String
    The protocol to use for the origination route. Encryption-enabled Amazon Chime Voice Connectors use TCP protocol by default.
    weight Number
    The weight associated with the host. If hosts are equal in priority, calls are redistributed among them based on their relative weight.
    port Number
    The designated origination route port. Defaults to 5060.

    Import

    Using pulumi import, import Chime Voice Connector Origination using the voice_connector_id. For example:

    $ pulumi import aws:chime/voiceConnectorOrganization:VoiceConnectorOrganization default abcdef1ghij2klmno3pqr4
    

    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