AWS Classic v5.41.0, May 15 23

aws.connect.QuickConnect

Explore with Pulumi AI

Provides an Amazon Connect Quick Connect resource. For more information see Amazon Connect: Getting Started

Example Usage

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var test = new Aws.Connect.QuickConnect("test", new()
    {
        Description = "quick connect phone number",
        InstanceId = "aaaaaaaa-bbbb-cccc-dddd-111111111111",
        QuickConnectConfig = new Aws.Connect.Inputs.QuickConnectQuickConnectConfigArgs
        {
            PhoneConfigs = new[]
            {
                new Aws.Connect.Inputs.QuickConnectQuickConnectConfigPhoneConfigArgs
                {
                    PhoneNumber = "+12345678912",
                },
            },
            QuickConnectType = "PHONE_NUMBER",
        },
        Tags = 
        {
            { "Name", "Example Quick Connect" },
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/connect"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := connect.NewQuickConnect(ctx, "test", &connect.QuickConnectArgs{
			Description: pulumi.String("quick connect phone number"),
			InstanceId:  pulumi.String("aaaaaaaa-bbbb-cccc-dddd-111111111111"),
			QuickConnectConfig: &connect.QuickConnectQuickConnectConfigArgs{
				PhoneConfigs: connect.QuickConnectQuickConnectConfigPhoneConfigArray{
					&connect.QuickConnectQuickConnectConfigPhoneConfigArgs{
						PhoneNumber: pulumi.String("+12345678912"),
					},
				},
				QuickConnectType: pulumi.String("PHONE_NUMBER"),
			},
			Tags: pulumi.StringMap{
				"Name": pulumi.String("Example Quick Connect"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.connect.QuickConnect;
import com.pulumi.aws.connect.QuickConnectArgs;
import com.pulumi.aws.connect.inputs.QuickConnectQuickConnectConfigArgs;
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 QuickConnect("test", QuickConnectArgs.builder()        
            .description("quick connect phone number")
            .instanceId("aaaaaaaa-bbbb-cccc-dddd-111111111111")
            .quickConnectConfig(QuickConnectQuickConnectConfigArgs.builder()
                .phoneConfigs(QuickConnectQuickConnectConfigPhoneConfigArgs.builder()
                    .phoneNumber("+12345678912")
                    .build())
                .quickConnectType("PHONE_NUMBER")
                .build())
            .tags(Map.of("Name", "Example Quick Connect"))
            .build());

    }
}

import pulumi
import pulumi_aws as aws

test = aws.connect.QuickConnect("test",
    description="quick connect phone number",
    instance_id="aaaaaaaa-bbbb-cccc-dddd-111111111111",
    quick_connect_config=aws.connect.QuickConnectQuickConnectConfigArgs(
        phone_configs=[aws.connect.QuickConnectQuickConnectConfigPhoneConfigArgs(
            phone_number="+12345678912",
        )],
        quick_connect_type="PHONE_NUMBER",
    ),
    tags={
        "Name": "Example Quick Connect",
    })

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const test = new aws.connect.QuickConnect("test", {
    description: "quick connect phone number",
    instanceId: "aaaaaaaa-bbbb-cccc-dddd-111111111111",
    quickConnectConfig: {
        phoneConfigs: [{
            phoneNumber: "+12345678912",
        }],
        quickConnectType: "PHONE_NUMBER",
    },
    tags: {
        Name: "Example Quick Connect",
    },
});

resources:
  test:
    type: aws:connect:QuickConnect
    properties:
      description: quick connect phone number
      instanceId: aaaaaaaa-bbbb-cccc-dddd-111111111111
      quickConnectConfig:
        phoneConfigs:
          - phoneNumber: '+12345678912'
        quickConnectType: PHONE_NUMBER
      tags:
        Name: Example Quick Connect

Create QuickConnect Resource

new QuickConnect(name: string, args: QuickConnectArgs, opts?: CustomResourceOptions);

@overload
def QuickConnect(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 description: Optional[str] = None,
                 instance_id: Optional[str] = None,
                 name: Optional[str] = None,
                 quick_connect_config: Optional[QuickConnectQuickConnectConfigArgs] = None,
                 tags: Optional[Mapping[str, str]] = None)
@overload
def QuickConnect(resource_name: str,
                 args: QuickConnectArgs,
                 opts: Optional[ResourceOptions] = None)

func NewQuickConnect(ctx *Context, name string, args QuickConnectArgs, opts ...ResourceOption) (*QuickConnect, error)

public QuickConnect(string name, QuickConnectArgs args, CustomResourceOptions? opts = null)

public QuickConnect(String name, QuickConnectArgs args)
public QuickConnect(String name, QuickConnectArgs args, CustomResourceOptions options)

type: aws:connect:QuickConnect
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args QuickConnectArgs: 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 QuickConnectArgs: 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 QuickConnectArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args QuickConnectArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args QuickConnectArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

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

InstanceId string: Specifies the identifier of the hosting Amazon Connect Instance.
QuickConnectConfig QuickConnectQuickConnectConfigArgs: A block that defines the configuration information for the Quick Connect: quick_connect_type and one of phone_config, queue_config, user_config . The Quick Connect Config block is documented below.
Description string: Specifies the description of the Quick Connect.
Name string: Specifies the name of the Quick Connect.
Tags Dictionary<string, string>: Tags to apply to the Quick Connect. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

InstanceId string: Specifies the identifier of the hosting Amazon Connect Instance.
QuickConnectConfig QuickConnectQuickConnectConfigArgs: A block that defines the configuration information for the Quick Connect: quick_connect_type and one of phone_config, queue_config, user_config . The Quick Connect Config block is documented below.
Description string: Specifies the description of the Quick Connect.
Name string: Specifies the name of the Quick Connect.
Tags map[string]string: Tags to apply to the Quick Connect. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

instanceId String: Specifies the identifier of the hosting Amazon Connect Instance.
quickConnectConfig QuickConnectQuickConnectConfigArgs: A block that defines the configuration information for the Quick Connect: quick_connect_type and one of phone_config, queue_config, user_config . The Quick Connect Config block is documented below.
description String: Specifies the description of the Quick Connect.
name String: Specifies the name of the Quick Connect.
tags Map<String,String>: Tags to apply to the Quick Connect. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

instanceId string: Specifies the identifier of the hosting Amazon Connect Instance.
quickConnectConfig QuickConnectQuickConnectConfigArgs: A block that defines the configuration information for the Quick Connect: quick_connect_type and one of phone_config, queue_config, user_config . The Quick Connect Config block is documented below.
description string: Specifies the description of the Quick Connect.
name string: Specifies the name of the Quick Connect.
tags {[key: string]: string}: Tags to apply to the Quick Connect. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

instance_id str: Specifies the identifier of the hosting Amazon Connect Instance.
quick_connect_config QuickConnectQuickConnectConfigArgs: A block that defines the configuration information for the Quick Connect: quick_connect_type and one of phone_config, queue_config, user_config . The Quick Connect Config block is documented below.
description str: Specifies the description of the Quick Connect.
name str: Specifies the name of the Quick Connect.
tags Mapping[str, str]: Tags to apply to the Quick Connect. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

instanceId String: Specifies the identifier of the hosting Amazon Connect Instance.
quickConnectConfig Property Map: A block that defines the configuration information for the Quick Connect: quick_connect_type and one of phone_config, queue_config, user_config . The Quick Connect Config block is documented below.
description String: Specifies the description of the Quick Connect.
name String: Specifies the name of the Quick Connect.
tags Map<String>: Tags to apply to the Quick Connect. 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 QuickConnect resource produces the following output properties:

Arn string: The Amazon Resource Name (ARN) of the Quick Connect.
Id string: The provider-assigned unique ID for this managed resource.
QuickConnectId string: The identifier for the Quick Connect.
TagsAll Dictionary<string, string>: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Arn string: The Amazon Resource Name (ARN) of the Quick Connect.
Id string: The provider-assigned unique ID for this managed resource.
QuickConnectId string: The identifier for the Quick Connect.
TagsAll map[string]string: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn String: The Amazon Resource Name (ARN) of the Quick Connect.
id String: The provider-assigned unique ID for this managed resource.
quickConnectId String: The identifier for the Quick Connect.
tagsAll Map<String,String>: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn string: The Amazon Resource Name (ARN) of the Quick Connect.
id string: The provider-assigned unique ID for this managed resource.
quickConnectId string: The identifier for the Quick Connect.
tagsAll {[key: string]: string}: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn str: The Amazon Resource Name (ARN) of the Quick Connect.
id str: The provider-assigned unique ID for this managed resource.
quick_connect_id str: The identifier for the Quick Connect.
tags_all Mapping[str, str]: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn String: The Amazon Resource Name (ARN) of the Quick Connect.
id String: The provider-assigned unique ID for this managed resource.
quickConnectId String: The identifier for the Quick Connect.
tagsAll Map<String>: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Look up Existing QuickConnect Resource

Get an existing QuickConnect 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?: QuickConnectState, opts?: CustomResourceOptions): QuickConnect

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        description: Optional[str] = None,
        instance_id: Optional[str] = None,
        name: Optional[str] = None,
        quick_connect_config: Optional[QuickConnectQuickConnectConfigArgs] = None,
        quick_connect_id: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> QuickConnect

func GetQuickConnect(ctx *Context, name string, id IDInput, state *QuickConnectState, opts ...ResourceOption) (*QuickConnect, error)

public static QuickConnect Get(string name, Input<string> id, QuickConnectState? state, CustomResourceOptions? opts = null)

public static QuickConnect get(String name, Output<String> id, QuickConnectState 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: The Amazon Resource Name (ARN) of the Quick Connect.
Description string: Specifies the description of the Quick Connect.
InstanceId string: Specifies the identifier of the hosting Amazon Connect Instance.
Name string: Specifies the name of the Quick Connect.
QuickConnectConfig QuickConnectQuickConnectConfigArgs: A block that defines the configuration information for the Quick Connect: quick_connect_type and one of phone_config, queue_config, user_config . The Quick Connect Config block is documented below.
QuickConnectId string: The identifier for the Quick Connect.
Tags Dictionary<string, string>: Tags to apply to the Quick Connect. 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>: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Arn string: The Amazon Resource Name (ARN) of the Quick Connect.
Description string: Specifies the description of the Quick Connect.
InstanceId string: Specifies the identifier of the hosting Amazon Connect Instance.
Name string: Specifies the name of the Quick Connect.
QuickConnectConfig QuickConnectQuickConnectConfigArgs: A block that defines the configuration information for the Quick Connect: quick_connect_type and one of phone_config, queue_config, user_config . The Quick Connect Config block is documented below.
QuickConnectId string: The identifier for the Quick Connect.
Tags map[string]string: Tags to apply to the Quick Connect. 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: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn String: The Amazon Resource Name (ARN) of the Quick Connect.
description String: Specifies the description of the Quick Connect.
instanceId String: Specifies the identifier of the hosting Amazon Connect Instance.
name String: Specifies the name of the Quick Connect.
quickConnectConfig QuickConnectQuickConnectConfigArgs: A block that defines the configuration information for the Quick Connect: quick_connect_type and one of phone_config, queue_config, user_config . The Quick Connect Config block is documented below.
quickConnectId String: The identifier for the Quick Connect.
tags Map<String,String>: Tags to apply to the Quick Connect. 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>: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn string: The Amazon Resource Name (ARN) of the Quick Connect.
description string: Specifies the description of the Quick Connect.
instanceId string: Specifies the identifier of the hosting Amazon Connect Instance.
name string: Specifies the name of the Quick Connect.
quickConnectConfig QuickConnectQuickConnectConfigArgs: A block that defines the configuration information for the Quick Connect: quick_connect_type and one of phone_config, queue_config, user_config . The Quick Connect Config block is documented below.
quickConnectId string: The identifier for the Quick Connect.
tags {[key: string]: string}: Tags to apply to the Quick Connect. 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}: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn str: The Amazon Resource Name (ARN) of the Quick Connect.
description str: Specifies the description of the Quick Connect.
instance_id str: Specifies the identifier of the hosting Amazon Connect Instance.
name str: Specifies the name of the Quick Connect.
quick_connect_config QuickConnectQuickConnectConfigArgs: A block that defines the configuration information for the Quick Connect: quick_connect_type and one of phone_config, queue_config, user_config . The Quick Connect Config block is documented below.
quick_connect_id str: The identifier for the Quick Connect.
tags Mapping[str, str]: Tags to apply to the Quick Connect. 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]: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn String: The Amazon Resource Name (ARN) of the Quick Connect.
description String: Specifies the description of the Quick Connect.
instanceId String: Specifies the identifier of the hosting Amazon Connect Instance.
name String: Specifies the name of the Quick Connect.
quickConnectConfig Property Map: A block that defines the configuration information for the Quick Connect: quick_connect_type and one of phone_config, queue_config, user_config . The Quick Connect Config block is documented below.
quickConnectId String: The identifier for the Quick Connect.
tags Map<String>: Tags to apply to the Quick Connect. 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>: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Supporting Types

QuickConnectQuickConnectConfig

QuickConnectType string: Specifies the configuration type of the quick connect. valid values are PHONE_NUMBER, QUEUE, USER.
PhoneConfigs List<QuickConnectQuickConnectConfigPhoneConfig>: Specifies the phone configuration of the Quick Connect. This is required only if quick_connect_type is PHONE_NUMBER. The phone_config block is documented below.
QueueConfigs List<QuickConnectQuickConnectConfigQueueConfig>: Specifies the queue configuration of the Quick Connect. This is required only if quick_connect_type is QUEUE. The queue_config block is documented below.
UserConfigs List<QuickConnectQuickConnectConfigUserConfig>: Specifies the user configuration of the Quick Connect. This is required only if quick_connect_type is USER. The user_config block is documented below.

QuickConnectType string: Specifies the configuration type of the quick connect. valid values are PHONE_NUMBER, QUEUE, USER.
PhoneConfigs []QuickConnectQuickConnectConfigPhoneConfig: Specifies the phone configuration of the Quick Connect. This is required only if quick_connect_type is PHONE_NUMBER. The phone_config block is documented below.
QueueConfigs []QuickConnectQuickConnectConfigQueueConfig: Specifies the queue configuration of the Quick Connect. This is required only if quick_connect_type is QUEUE. The queue_config block is documented below.
UserConfigs []QuickConnectQuickConnectConfigUserConfig: Specifies the user configuration of the Quick Connect. This is required only if quick_connect_type is USER. The user_config block is documented below.

quickConnectType String: Specifies the configuration type of the quick connect. valid values are PHONE_NUMBER, QUEUE, USER.
phoneConfigs List<QuickConnectQuickConnectConfigPhoneConfig>: Specifies the phone configuration of the Quick Connect. This is required only if quick_connect_type is PHONE_NUMBER. The phone_config block is documented below.
queueConfigs List<QuickConnectQuickConnectConfigQueueConfig>: Specifies the queue configuration of the Quick Connect. This is required only if quick_connect_type is QUEUE. The queue_config block is documented below.
userConfigs List<QuickConnectQuickConnectConfigUserConfig>: Specifies the user configuration of the Quick Connect. This is required only if quick_connect_type is USER. The user_config block is documented below.

quickConnectType string: Specifies the configuration type of the quick connect. valid values are PHONE_NUMBER, QUEUE, USER.
phoneConfigs QuickConnectQuickConnectConfigPhoneConfig[]: Specifies the phone configuration of the Quick Connect. This is required only if quick_connect_type is PHONE_NUMBER. The phone_config block is documented below.
queueConfigs QuickConnectQuickConnectConfigQueueConfig[]: Specifies the queue configuration of the Quick Connect. This is required only if quick_connect_type is QUEUE. The queue_config block is documented below.
userConfigs QuickConnectQuickConnectConfigUserConfig[]: Specifies the user configuration of the Quick Connect. This is required only if quick_connect_type is USER. The user_config block is documented below.

quick_connect_type str: Specifies the configuration type of the quick connect. valid values are PHONE_NUMBER, QUEUE, USER.
phone_configs Sequence[QuickConnectQuickConnectConfigPhoneConfig]: Specifies the phone configuration of the Quick Connect. This is required only if quick_connect_type is PHONE_NUMBER. The phone_config block is documented below.
queue_configs Sequence[QuickConnectQuickConnectConfigQueueConfig]: Specifies the queue configuration of the Quick Connect. This is required only if quick_connect_type is QUEUE. The queue_config block is documented below.
user_configs Sequence[QuickConnectQuickConnectConfigUserConfig]: Specifies the user configuration of the Quick Connect. This is required only if quick_connect_type is USER. The user_config block is documented below.

quickConnectType String: Specifies the configuration type of the quick connect. valid values are PHONE_NUMBER, QUEUE, USER.
phoneConfigs List<Property Map>: Specifies the phone configuration of the Quick Connect. This is required only if quick_connect_type is PHONE_NUMBER. The phone_config block is documented below.
queueConfigs List<Property Map>: Specifies the queue configuration of the Quick Connect. This is required only if quick_connect_type is QUEUE. The queue_config block is documented below.
userConfigs List<Property Map>: Specifies the user configuration of the Quick Connect. This is required only if quick_connect_type is USER. The user_config block is documented below.

QuickConnectQuickConnectConfigPhoneConfig

PhoneNumber string: Specifies the phone number in in E.164 format.

PhoneNumber string: Specifies the phone number in in E.164 format.

phoneNumber String: Specifies the phone number in in E.164 format.

phoneNumber string: Specifies the phone number in in E.164 format.

phone_number str: Specifies the phone number in in E.164 format.

phoneNumber String: Specifies the phone number in in E.164 format.

QuickConnectQuickConnectConfigQueueConfig

ContactFlowId string: Specifies the identifier of the contact flow.
QueueId string: Specifies the identifier for the queue.

ContactFlowId string: Specifies the identifier of the contact flow.
QueueId string: Specifies the identifier for the queue.

contactFlowId String: Specifies the identifier of the contact flow.
queueId String: Specifies the identifier for the queue.

contactFlowId string: Specifies the identifier of the contact flow.
queueId string: Specifies the identifier for the queue.

contact_flow_id str: Specifies the identifier of the contact flow.
queue_id str: Specifies the identifier for the queue.

contactFlowId String: Specifies the identifier of the contact flow.
queueId String: Specifies the identifier for the queue.

QuickConnectQuickConnectConfigUserConfig

ContactFlowId string: Specifies the identifier of the contact flow.
UserId string: Specifies the identifier for the user.

ContactFlowId string: Specifies the identifier of the contact flow.
UserId string: Specifies the identifier for the user.

contactFlowId String: Specifies the identifier of the contact flow.
userId String: Specifies the identifier for the user.

contactFlowId string: Specifies the identifier of the contact flow.
userId string: Specifies the identifier for the user.

contact_flow_id str: Specifies the identifier of the contact flow.
user_id str: Specifies the identifier for the user.

contactFlowId String: Specifies the identifier of the contact flow.
userId String: Specifies the identifier for the user.

Import

Amazon Connect Quick Connects can be imported using the instance_id and quick_connect_id separated by a colon (:), e.g.,

 $ pulumi import aws:connect/quickConnect:QuickConnect example f1288a1f-6193-445a-b47e-af739b2:c1d4e5f6-1b3c-1b3c-1b3c-c1d4e5f6c1d4e5

Package Details

Repository: AWS Classic pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.