1. Packages
  2. AWS
  3. API Docs
  4. chime
  5. VoiceConnectorTerminationCredentials
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi

aws.chime.VoiceConnectorTerminationCredentials

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi

    Adds termination SIP credentials for the specified Amazon Chime Voice Connector.

    Note: Voice Connector Termination Credentials requires a Voice Connector Termination to be present. Use of depends_on (as shown below) is recommended to avoid race conditions.

    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 defaultVoiceConnectorTermination = new aws.chime.VoiceConnectorTermination("default", {
        disabled: true,
        cpsLimit: 1,
        cidrAllowLists: ["50.35.78.96/31"],
        callingRegions: [
            "US",
            "CA",
        ],
        voiceConnectorId: _default.id,
    });
    const defaultVoiceConnectorTerminationCredentials = new aws.chime.VoiceConnectorTerminationCredentials("default", {
        voiceConnectorId: _default.id,
        credentials: [{
            username: "test",
            password: "test!",
        }],
    }, {
        dependsOn: [defaultVoiceConnectorTermination],
    });
    
    import pulumi
    import pulumi_aws as aws
    
    default = aws.chime.VoiceConnector("default",
        name="test",
        require_encryption=True)
    default_voice_connector_termination = aws.chime.VoiceConnectorTermination("default",
        disabled=True,
        cps_limit=1,
        cidr_allow_lists=["50.35.78.96/31"],
        calling_regions=[
            "US",
            "CA",
        ],
        voice_connector_id=default.id)
    default_voice_connector_termination_credentials = aws.chime.VoiceConnectorTerminationCredentials("default",
        voice_connector_id=default.id,
        credentials=[{
            "username": "test",
            "password": "test!",
        }],
        opts = pulumi.ResourceOptions(depends_on=[default_voice_connector_termination]))
    
    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
    		}
    		defaultVoiceConnectorTermination, err := chime.NewVoiceConnectorTermination(ctx, "default", &chime.VoiceConnectorTerminationArgs{
    			Disabled: pulumi.Bool(true),
    			CpsLimit: pulumi.Int(1),
    			CidrAllowLists: pulumi.StringArray{
    				pulumi.String("50.35.78.96/31"),
    			},
    			CallingRegions: pulumi.StringArray{
    				pulumi.String("US"),
    				pulumi.String("CA"),
    			},
    			VoiceConnectorId: _default.ID(),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = chime.NewVoiceConnectorTerminationCredentials(ctx, "default", &chime.VoiceConnectorTerminationCredentialsArgs{
    			VoiceConnectorId: _default.ID(),
    			Credentials: chime.VoiceConnectorTerminationCredentialsCredentialArray{
    				&chime.VoiceConnectorTerminationCredentialsCredentialArgs{
    					Username: pulumi.String("test"),
    					Password: pulumi.String("test!"),
    				},
    			},
    		}, pulumi.DependsOn([]pulumi.Resource{
    			defaultVoiceConnectorTermination,
    		}))
    		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 defaultVoiceConnectorTermination = new Aws.Chime.VoiceConnectorTermination("default", new()
        {
            Disabled = true,
            CpsLimit = 1,
            CidrAllowLists = new[]
            {
                "50.35.78.96/31",
            },
            CallingRegions = new[]
            {
                "US",
                "CA",
            },
            VoiceConnectorId = @default.Id,
        });
    
        var defaultVoiceConnectorTerminationCredentials = new Aws.Chime.VoiceConnectorTerminationCredentials("default", new()
        {
            VoiceConnectorId = @default.Id,
            Credentials = new[]
            {
                new Aws.Chime.Inputs.VoiceConnectorTerminationCredentialsCredentialArgs
                {
                    Username = "test",
                    Password = "test!",
                },
            },
        }, new CustomResourceOptions
        {
            DependsOn =
            {
                defaultVoiceConnectorTermination,
            },
        });
    
    });
    
    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.VoiceConnectorTermination;
    import com.pulumi.aws.chime.VoiceConnectorTerminationArgs;
    import com.pulumi.aws.chime.VoiceConnectorTerminationCredentials;
    import com.pulumi.aws.chime.VoiceConnectorTerminationCredentialsArgs;
    import com.pulumi.aws.chime.inputs.VoiceConnectorTerminationCredentialsCredentialArgs;
    import com.pulumi.resources.CustomResourceOptions;
    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 defaultVoiceConnectorTermination = new VoiceConnectorTermination("defaultVoiceConnectorTermination", VoiceConnectorTerminationArgs.builder()
                .disabled(true)
                .cpsLimit(1)
                .cidrAllowLists("50.35.78.96/31")
                .callingRegions(            
                    "US",
                    "CA")
                .voiceConnectorId(default_.id())
                .build());
    
            var defaultVoiceConnectorTerminationCredentials = new VoiceConnectorTerminationCredentials("defaultVoiceConnectorTerminationCredentials", VoiceConnectorTerminationCredentialsArgs.builder()
                .voiceConnectorId(default_.id())
                .credentials(VoiceConnectorTerminationCredentialsCredentialArgs.builder()
                    .username("test")
                    .password("test!")
                    .build())
                .build(), CustomResourceOptions.builder()
                    .dependsOn(defaultVoiceConnectorTermination)
                    .build());
    
        }
    }
    
    resources:
      default:
        type: aws:chime:VoiceConnector
        properties:
          name: test
          requireEncryption: true
      defaultVoiceConnectorTermination:
        type: aws:chime:VoiceConnectorTermination
        name: default
        properties:
          disabled: true
          cpsLimit: 1
          cidrAllowLists:
            - 50.35.78.96/31
          callingRegions:
            - US
            - CA
          voiceConnectorId: ${default.id}
      defaultVoiceConnectorTerminationCredentials:
        type: aws:chime:VoiceConnectorTerminationCredentials
        name: default
        properties:
          voiceConnectorId: ${default.id}
          credentials:
            - username: test
              password: test!
        options:
          dependson:
            - ${defaultVoiceConnectorTermination}
    

    Create VoiceConnectorTerminationCredentials Resource

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

    Constructor syntax

    new VoiceConnectorTerminationCredentials(name: string, args: VoiceConnectorTerminationCredentialsArgs, opts?: CustomResourceOptions);
    @overload
    def VoiceConnectorTerminationCredentials(resource_name: str,
                                             args: VoiceConnectorTerminationCredentialsArgs,
                                             opts: Optional[ResourceOptions] = None)
    
    @overload
    def VoiceConnectorTerminationCredentials(resource_name: str,
                                             opts: Optional[ResourceOptions] = None,
                                             credentials: Optional[Sequence[VoiceConnectorTerminationCredentialsCredentialArgs]] = None,
                                             voice_connector_id: Optional[str] = None)
    func NewVoiceConnectorTerminationCredentials(ctx *Context, name string, args VoiceConnectorTerminationCredentialsArgs, opts ...ResourceOption) (*VoiceConnectorTerminationCredentials, error)
    public VoiceConnectorTerminationCredentials(string name, VoiceConnectorTerminationCredentialsArgs args, CustomResourceOptions? opts = null)
    public VoiceConnectorTerminationCredentials(String name, VoiceConnectorTerminationCredentialsArgs args)
    public VoiceConnectorTerminationCredentials(String name, VoiceConnectorTerminationCredentialsArgs args, CustomResourceOptions options)
    
    type: aws:chime:VoiceConnectorTerminationCredentials
    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 VoiceConnectorTerminationCredentialsArgs
    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 VoiceConnectorTerminationCredentialsArgs
    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 VoiceConnectorTerminationCredentialsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VoiceConnectorTerminationCredentialsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VoiceConnectorTerminationCredentialsArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

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

    var voiceConnectorTerminationCredentialsResource = new Aws.Chime.VoiceConnectorTerminationCredentials("voiceConnectorTerminationCredentialsResource", new()
    {
        Credentials = new[]
        {
            new Aws.Chime.Inputs.VoiceConnectorTerminationCredentialsCredentialArgs
            {
                Password = "string",
                Username = "string",
            },
        },
        VoiceConnectorId = "string",
    });
    
    example, err := chime.NewVoiceConnectorTerminationCredentials(ctx, "voiceConnectorTerminationCredentialsResource", &chime.VoiceConnectorTerminationCredentialsArgs{
    	Credentials: chime.VoiceConnectorTerminationCredentialsCredentialArray{
    		&chime.VoiceConnectorTerminationCredentialsCredentialArgs{
    			Password: pulumi.String("string"),
    			Username: pulumi.String("string"),
    		},
    	},
    	VoiceConnectorId: pulumi.String("string"),
    })
    
    var voiceConnectorTerminationCredentialsResource = new VoiceConnectorTerminationCredentials("voiceConnectorTerminationCredentialsResource", VoiceConnectorTerminationCredentialsArgs.builder()
        .credentials(VoiceConnectorTerminationCredentialsCredentialArgs.builder()
            .password("string")
            .username("string")
            .build())
        .voiceConnectorId("string")
        .build());
    
    voice_connector_termination_credentials_resource = aws.chime.VoiceConnectorTerminationCredentials("voiceConnectorTerminationCredentialsResource",
        credentials=[{
            "password": "string",
            "username": "string",
        }],
        voice_connector_id="string")
    
    const voiceConnectorTerminationCredentialsResource = new aws.chime.VoiceConnectorTerminationCredentials("voiceConnectorTerminationCredentialsResource", {
        credentials: [{
            password: "string",
            username: "string",
        }],
        voiceConnectorId: "string",
    });
    
    type: aws:chime:VoiceConnectorTerminationCredentials
    properties:
        credentials:
            - password: string
              username: string
        voiceConnectorId: string
    

    VoiceConnectorTerminationCredentials Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The VoiceConnectorTerminationCredentials resource accepts the following input properties:

    Credentials List<VoiceConnectorTerminationCredentialsCredential>
    List of termination SIP credentials.
    VoiceConnectorId string
    Amazon Chime Voice Connector ID.
    Credentials []VoiceConnectorTerminationCredentialsCredentialArgs
    List of termination SIP credentials.
    VoiceConnectorId string
    Amazon Chime Voice Connector ID.
    credentials List<VoiceConnectorTerminationCredentialsCredential>
    List of termination SIP credentials.
    voiceConnectorId String
    Amazon Chime Voice Connector ID.
    credentials VoiceConnectorTerminationCredentialsCredential[]
    List of termination SIP credentials.
    voiceConnectorId string
    Amazon Chime Voice Connector ID.
    credentials Sequence[VoiceConnectorTerminationCredentialsCredentialArgs]
    List of termination SIP credentials.
    voice_connector_id str
    Amazon Chime Voice Connector ID.
    credentials List<Property Map>
    List of termination SIP credentials.
    voiceConnectorId String
    Amazon Chime Voice Connector ID.

    Outputs

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

    Get an existing VoiceConnectorTerminationCredentials 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?: VoiceConnectorTerminationCredentialsState, opts?: CustomResourceOptions): VoiceConnectorTerminationCredentials
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            credentials: Optional[Sequence[VoiceConnectorTerminationCredentialsCredentialArgs]] = None,
            voice_connector_id: Optional[str] = None) -> VoiceConnectorTerminationCredentials
    func GetVoiceConnectorTerminationCredentials(ctx *Context, name string, id IDInput, state *VoiceConnectorTerminationCredentialsState, opts ...ResourceOption) (*VoiceConnectorTerminationCredentials, error)
    public static VoiceConnectorTerminationCredentials Get(string name, Input<string> id, VoiceConnectorTerminationCredentialsState? state, CustomResourceOptions? opts = null)
    public static VoiceConnectorTerminationCredentials get(String name, Output<String> id, VoiceConnectorTerminationCredentialsState 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:
    Credentials List<VoiceConnectorTerminationCredentialsCredential>
    List of termination SIP credentials.
    VoiceConnectorId string
    Amazon Chime Voice Connector ID.
    Credentials []VoiceConnectorTerminationCredentialsCredentialArgs
    List of termination SIP credentials.
    VoiceConnectorId string
    Amazon Chime Voice Connector ID.
    credentials List<VoiceConnectorTerminationCredentialsCredential>
    List of termination SIP credentials.
    voiceConnectorId String
    Amazon Chime Voice Connector ID.
    credentials VoiceConnectorTerminationCredentialsCredential[]
    List of termination SIP credentials.
    voiceConnectorId string
    Amazon Chime Voice Connector ID.
    credentials Sequence[VoiceConnectorTerminationCredentialsCredentialArgs]
    List of termination SIP credentials.
    voice_connector_id str
    Amazon Chime Voice Connector ID.
    credentials List<Property Map>
    List of termination SIP credentials.
    voiceConnectorId String
    Amazon Chime Voice Connector ID.

    Supporting Types

    VoiceConnectorTerminationCredentialsCredential, VoiceConnectorTerminationCredentialsCredentialArgs

    Password string
    RFC2617 compliant password associated with the SIP credentials.
    Username string
    RFC2617 compliant username associated with the SIP credentials.
    Password string
    RFC2617 compliant password associated with the SIP credentials.
    Username string
    RFC2617 compliant username associated with the SIP credentials.
    password String
    RFC2617 compliant password associated with the SIP credentials.
    username String
    RFC2617 compliant username associated with the SIP credentials.
    password string
    RFC2617 compliant password associated with the SIP credentials.
    username string
    RFC2617 compliant username associated with the SIP credentials.
    password str
    RFC2617 compliant password associated with the SIP credentials.
    username str
    RFC2617 compliant username associated with the SIP credentials.
    password String
    RFC2617 compliant password associated with the SIP credentials.
    username String
    RFC2617 compliant username associated with the SIP credentials.

    Import

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

    $ pulumi import aws:chime/voiceConnectorTerminationCredentials:VoiceConnectorTerminationCredentials 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
    AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi