Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. connect
  5. getQuickConnect

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.connect.getQuickConnect

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::Connect::QuickConnect

    Using getQuickConnect

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getQuickConnect(args: GetQuickConnectArgs, opts?: InvokeOptions): Promise<GetQuickConnectResult>
function getQuickConnectOutput(args: GetQuickConnectOutputArgs, opts?: InvokeOptions): Output<GetQuickConnectResult>
    def get_quick_connect(quick_connect_arn: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetQuickConnectResult
def get_quick_connect_output(quick_connect_arn: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetQuickConnectResult]
    func LookupQuickConnect(ctx *Context, args *LookupQuickConnectArgs, opts ...InvokeOption) (*LookupQuickConnectResult, error)
func LookupQuickConnectOutput(ctx *Context, args *LookupQuickConnectOutputArgs, opts ...InvokeOption) LookupQuickConnectResultOutput

    > Note: This function is named LookupQuickConnect in the Go SDK.

    public static class GetQuickConnect 
{
    public static Task<GetQuickConnectResult> InvokeAsync(GetQuickConnectArgs args, InvokeOptions? opts = null)
    public static Output<GetQuickConnectResult> Invoke(GetQuickConnectInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetQuickConnectResult> getQuickConnect(GetQuickConnectArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: aws-native:connect:getQuickConnect
  arguments:
    # arguments dictionary

    The following arguments are supported:

    QuickConnectArn string
    The Amazon Resource Name (ARN) for the quick connect.
    QuickConnectArn string
    The Amazon Resource Name (ARN) for the quick connect.
    quickConnectArn String
    The Amazon Resource Name (ARN) for the quick connect.
    quickConnectArn string
    The Amazon Resource Name (ARN) for the quick connect.
    quick_connect_arn str
    The Amazon Resource Name (ARN) for the quick connect.
    quickConnectArn String
    The Amazon Resource Name (ARN) for the quick connect.

    getQuickConnect Result

    The following output properties are available:

    Description string
    The description of the quick connect.
    InstanceArn string
    The identifier of the Amazon Connect instance.
    Name string
    The name of the quick connect.
    QuickConnectArn string
    The Amazon Resource Name (ARN) for the quick connect.
    QuickConnectConfig Pulumi.AwsNative.Connect.Outputs.QuickConnectConfig
    Configuration settings 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).
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    One or more tags.
    Description string
    The description of the quick connect.
    InstanceArn string
    The identifier of the Amazon Connect instance.
    Name string
    The name of the quick connect.
    QuickConnectArn string
    The Amazon Resource Name (ARN) for the quick connect.
    QuickConnectConfig QuickConnectConfig
    Configuration settings 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).
    Tags Tag
    One or more tags.
    description String
    The description of the quick connect.
    instanceArn String
    The identifier of the Amazon Connect instance.
    name String
    The name of the quick connect.
    quickConnectArn String
    The Amazon Resource Name (ARN) for the quick connect.
    quickConnectConfig QuickConnectConfig
    Configuration settings 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).
    tags List<Tag>
    One or more tags.
    description string
    The description of the quick connect.
    instanceArn string
    The identifier of the Amazon Connect instance.
    name string
    The name of the quick connect.
    quickConnectArn string
    The Amazon Resource Name (ARN) for the quick connect.
    quickConnectConfig QuickConnectConfig
    Configuration settings 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).
    tags Tag[]
    One or more tags.
    description str
    The description of the quick connect.
    instance_arn str
    The identifier of the Amazon Connect instance.
    name str
    The name of the quick connect.
    quick_connect_arn str
    The Amazon Resource Name (ARN) for the quick connect.
    quick_connect_config QuickConnectConfig
    Configuration settings 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).
    tags Sequence[root_Tag]
    One or more tags.
    description String
    The description of the quick connect.
    instanceArn String
    The identifier of the Amazon Connect instance.
    name String
    The name of the quick connect.
    quickConnectArn String
    The Amazon Resource Name (ARN) for the quick connect.
    quickConnectConfig Property Map
    Configuration settings 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).
    tags List<Property Map>
    One or more tags.

    Supporting Types

    QuickConnectConfig

    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).
    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 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 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 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 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 "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

    PhoneNumber string
    The phone number in E.164 format.
    PhoneNumber string
    The phone number in E.164 format.
    phoneNumber String
    The phone number in E.164 format.
    phoneNumber string
    The phone number in E.164 format.
    phone_number str
    The phone number in E.164 format.
    phoneNumber String
    The phone number in E.164 format.

    QuickConnectQueueQuickConnectConfig

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

    QuickConnectType

    QuickConnectUserQuickConnectConfig

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

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

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

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
    pulumi/pulumi-aws-native