Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. connect
  5. QuickConnect

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.connect.QuickConnect

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

Resource Type definition for AWS::Connect::QuickConnect

Create QuickConnect Resource

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

Constructor syntax

new QuickConnect(name: string, args: QuickConnectArgs, opts?: CustomResourceOptions);
@overload
def QuickConnect(resource_name: str,
                 args: QuickConnectArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def QuickConnect(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 instance_arn: Optional[str] = None,
                 quick_connect_config: Optional[QuickConnectConfigArgs] = None,
                 description: Optional[str] = None,
                 name: Optional[str] = None,
                 tags: Optional[Sequence[_root_inputs.TagArgs]] = 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-native:connect:QuickConnect
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. QuickConnectArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. QuickConnectArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. QuickConnectArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. 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

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

The QuickConnect resource accepts the following input properties:

InstanceArn This property is required. string
The identifier of the Amazon Connect instance.
QuickConnectConfig This property is required. Pulumi.AwsNative.Connect.Inputs.QuickConnectConfig
Configuration settings for the quick connect.
Description string
The description of the quick connect.
Name string
The name of the quick connect.
Tags List<Pulumi.AwsNative.Inputs.Tag>
One or more tags.
InstanceArn This property is required. string
The identifier of the Amazon Connect instance.
QuickConnectConfig This property is required. QuickConnectConfigArgs
Configuration settings for the quick connect.
Description string
The description of the quick connect.
Name string
The name of the quick connect.
Tags TagArgs
One or more tags.
instanceArn This property is required. String
The identifier of the Amazon Connect instance.
quickConnectConfig This property is required. QuickConnectConfig
Configuration settings for the quick connect.
description String
The description of the quick connect.
name String
The name of the quick connect.
tags List<Tag>
One or more tags.
instanceArn This property is required. string
The identifier of the Amazon Connect instance.
quickConnectConfig This property is required. QuickConnectConfig
Configuration settings for the quick connect.
description string
The description of the quick connect.
name string
The name of the quick connect.
tags Tag[]
One or more tags.
instance_arn This property is required. str
The identifier of the Amazon Connect instance.
quick_connect_config This property is required. QuickConnectConfigArgs
Configuration settings for the quick connect.
description str
The description of the quick connect.
name str
The name of the quick connect.
tags Sequence[TagArgs]
One or more tags.
instanceArn This property is required. String
The identifier of the Amazon Connect instance.
quickConnectConfig This property is required. Property Map
Configuration settings for the quick connect.
description String
The description of the quick connect.
name String
The name of the quick connect.
tags List<Property Map>
One or more tags.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
QuickConnectArn string
The Amazon Resource Name (ARN) for the quick connect.
QuickConnectType Pulumi.AwsNative.Connect.QuickConnectType
The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).
Id string
The provider-assigned unique ID for this managed resource.
QuickConnectArn string
The Amazon Resource Name (ARN) for the quick connect.
QuickConnectType QuickConnectType
The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).
id String
The provider-assigned unique ID for this managed resource.
quickConnectArn String
The Amazon Resource Name (ARN) for the quick connect.
quickConnectType QuickConnectType
The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).
id string
The provider-assigned unique ID for this managed resource.
quickConnectArn string
The Amazon Resource Name (ARN) for the quick connect.
quickConnectType QuickConnectType
The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).
id str
The provider-assigned unique ID for this managed resource.
quick_connect_arn str
The Amazon Resource Name (ARN) for the quick connect.
quick_connect_type QuickConnectType
The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).
id String
The provider-assigned unique ID for this managed resource.
quickConnectArn String
The Amazon Resource Name (ARN) for the quick connect.
quickConnectType "PHONE_NUMBER" | "QUEUE" | "USER"
The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).

Supporting Types

QuickConnectConfig
, QuickConnectConfigArgs

QuickConnectType This property is required. Pulumi.AwsNative.Connect.QuickConnectType
The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).
PhoneConfig Pulumi.AwsNative.Connect.Inputs.QuickConnectPhoneNumberQuickConnectConfig
The phone configuration. This is required only if QuickConnectType is PHONE_NUMBER.
QueueConfig Pulumi.AwsNative.Connect.Inputs.QuickConnectQueueQuickConnectConfig
The queue configuration. This is required only if QuickConnectType is QUEUE.
UserConfig Pulumi.AwsNative.Connect.Inputs.QuickConnectUserQuickConnectConfig
The user configuration. This is required only if QuickConnectType is USER.
QuickConnectType This property is required. QuickConnectType
The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).
PhoneConfig QuickConnectPhoneNumberQuickConnectConfig
The phone configuration. This is required only if QuickConnectType is PHONE_NUMBER.
QueueConfig QuickConnectQueueQuickConnectConfig
The queue configuration. This is required only if QuickConnectType is QUEUE.
UserConfig QuickConnectUserQuickConnectConfig
The user configuration. This is required only if QuickConnectType is USER.
quickConnectType This property is required. QuickConnectType
The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).
phoneConfig QuickConnectPhoneNumberQuickConnectConfig
The phone configuration. This is required only if QuickConnectType is PHONE_NUMBER.
queueConfig QuickConnectQueueQuickConnectConfig
The queue configuration. This is required only if QuickConnectType is QUEUE.
userConfig QuickConnectUserQuickConnectConfig
The user configuration. This is required only if QuickConnectType is USER.
quickConnectType This property is required. QuickConnectType
The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).
phoneConfig QuickConnectPhoneNumberQuickConnectConfig
The phone configuration. This is required only if QuickConnectType is PHONE_NUMBER.
queueConfig QuickConnectQueueQuickConnectConfig
The queue configuration. This is required only if QuickConnectType is QUEUE.
userConfig QuickConnectUserQuickConnectConfig
The user configuration. This is required only if QuickConnectType is USER.
quick_connect_type This property is required. QuickConnectType
The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).
phone_config QuickConnectPhoneNumberQuickConnectConfig
The phone configuration. This is required only if QuickConnectType is PHONE_NUMBER.
queue_config QuickConnectQueueQuickConnectConfig
The queue configuration. This is required only if QuickConnectType is QUEUE.
user_config QuickConnectUserQuickConnectConfig
The user configuration. This is required only if QuickConnectType is USER.
quickConnectType This property is required. "PHONE_NUMBER" | "QUEUE" | "USER"
The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).
phoneConfig Property Map
The phone configuration. This is required only if QuickConnectType is PHONE_NUMBER.
queueConfig Property Map
The queue configuration. This is required only if QuickConnectType is QUEUE.
userConfig Property Map
The user configuration. This is required only if QuickConnectType is USER.

QuickConnectPhoneNumberQuickConnectConfig
, QuickConnectPhoneNumberQuickConnectConfigArgs

PhoneNumber This property is required. string
The phone number in E.164 format.
PhoneNumber This property is required. string
The phone number in E.164 format.
phoneNumber This property is required. String
The phone number in E.164 format.
phoneNumber This property is required. string
The phone number in E.164 format.
phone_number This property is required. str
The phone number in E.164 format.
phoneNumber This property is required. String
The phone number in E.164 format.

QuickConnectQueueQuickConnectConfig
, QuickConnectQueueQuickConnectConfigArgs

ContactFlowArn This property is required. string
The Amazon Resource Name (ARN) of the flow.
QueueArn This property is required. string
The Amazon Resource Name (ARN) of the queue.
ContactFlowArn This property is required. string
The Amazon Resource Name (ARN) of the flow.
QueueArn This property is required. string
The Amazon Resource Name (ARN) of the queue.
contactFlowArn This property is required. String
The Amazon Resource Name (ARN) of the flow.
queueArn This property is required. String
The Amazon Resource Name (ARN) of the queue.
contactFlowArn This property is required. string
The Amazon Resource Name (ARN) of the flow.
queueArn This property is required. string
The Amazon Resource Name (ARN) of the queue.
contact_flow_arn This property is required. str
The Amazon Resource Name (ARN) of the flow.
queue_arn This property is required. str
The Amazon Resource Name (ARN) of the queue.
contactFlowArn This property is required. String
The Amazon Resource Name (ARN) of the flow.
queueArn This property is required. String
The Amazon Resource Name (ARN) of the queue.

QuickConnectType
, QuickConnectTypeArgs

PhoneNumber
PHONE_NUMBER
Queue
QUEUE
User
USER
QuickConnectTypePhoneNumber
PHONE_NUMBER
QuickConnectTypeQueue
QUEUE
QuickConnectTypeUser
USER
PhoneNumber
PHONE_NUMBER
Queue
QUEUE
User
USER
PhoneNumber
PHONE_NUMBER
Queue
QUEUE
User
USER
PHONE_NUMBER
PHONE_NUMBER
QUEUE
QUEUE
USER
USER
"PHONE_NUMBER"
PHONE_NUMBER
"QUEUE"
QUEUE
"USER"
USER

QuickConnectUserQuickConnectConfig
, QuickConnectUserQuickConnectConfigArgs

ContactFlowArn This property is required. string
The Amazon Resource Name (ARN) of the flow.
UserArn This property is required. string
The Amazon Resource Name (ARN) of the user.
ContactFlowArn This property is required. string
The Amazon Resource Name (ARN) of the flow.
UserArn This property is required. string
The Amazon Resource Name (ARN) of the user.
contactFlowArn This property is required. String
The Amazon Resource Name (ARN) of the flow.
userArn This property is required. String
The Amazon Resource Name (ARN) of the user.
contactFlowArn This property is required. string
The Amazon Resource Name (ARN) of the flow.
userArn This property is required. string
The Amazon Resource Name (ARN) of the user.
contact_flow_arn This property is required. str
The Amazon Resource Name (ARN) of the flow.
user_arn This property is required. str
The Amazon Resource Name (ARN) of the user.
contactFlowArn This property is required. String
The Amazon Resource Name (ARN) of the flow.
userArn This property is required. String
The Amazon Resource Name (ARN) of the user.

Tag
, TagArgs

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native