Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. connect
  5. getQuickConnect
AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-aws

aws.connect.getQuickConnect

Explore with Pulumi AI

aws logo
AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-aws

    Provides details about a specific Amazon Connect Quick Connect.

    Example Usage

    By name

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

const example = aws.connect.getQuickConnect({
    instanceId: "aaaaaaaa-bbbb-cccc-dddd-111111111111",
    name: "Example",
});

    import pulumi
import pulumi_aws as aws

example = aws.connect.get_quick_connect(instance_id="aaaaaaaa-bbbb-cccc-dddd-111111111111",
    name="Example")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := connect.LookupQuickConnect(ctx, &connect.LookupQuickConnectArgs{
			InstanceId: "aaaaaaaa-bbbb-cccc-dddd-111111111111",
			Name:       pulumi.StringRef("Example"),
		}, nil)
		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 example = Aws.Connect.GetQuickConnect.Invoke(new()
    {
        InstanceId = "aaaaaaaa-bbbb-cccc-dddd-111111111111",
        Name = "Example",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.connect.ConnectFunctions;
import com.pulumi.aws.connect.inputs.GetQuickConnectArgs;
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) {
        final var example = ConnectFunctions.getQuickConnect(GetQuickConnectArgs.builder()
            .instanceId("aaaaaaaa-bbbb-cccc-dddd-111111111111")
            .name("Example")
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      Function: aws:connect:getQuickConnect
      Arguments:
        instanceId: aaaaaaaa-bbbb-cccc-dddd-111111111111
        name: Example

    By quick_connect_id

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

const example = aws.connect.getQuickConnect({
    instanceId: "aaaaaaaa-bbbb-cccc-dddd-111111111111",
    quickConnectId: "cccccccc-bbbb-cccc-dddd-111111111111",
});

    import pulumi
import pulumi_aws as aws

example = aws.connect.get_quick_connect(instance_id="aaaaaaaa-bbbb-cccc-dddd-111111111111",
    quick_connect_id="cccccccc-bbbb-cccc-dddd-111111111111")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := connect.LookupQuickConnect(ctx, &connect.LookupQuickConnectArgs{
			InstanceId:     "aaaaaaaa-bbbb-cccc-dddd-111111111111",
			QuickConnectId: pulumi.StringRef("cccccccc-bbbb-cccc-dddd-111111111111"),
		}, nil)
		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 example = Aws.Connect.GetQuickConnect.Invoke(new()
    {
        InstanceId = "aaaaaaaa-bbbb-cccc-dddd-111111111111",
        QuickConnectId = "cccccccc-bbbb-cccc-dddd-111111111111",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.connect.ConnectFunctions;
import com.pulumi.aws.connect.inputs.GetQuickConnectArgs;
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) {
        final var example = ConnectFunctions.getQuickConnect(GetQuickConnectArgs.builder()
            .instanceId("aaaaaaaa-bbbb-cccc-dddd-111111111111")
            .quickConnectId("cccccccc-bbbb-cccc-dddd-111111111111")
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      Function: aws:connect:getQuickConnect
      Arguments:
        instanceId: aaaaaaaa-bbbb-cccc-dddd-111111111111
        quickConnectId: cccccccc-bbbb-cccc-dddd-111111111111

    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(instance_id: Optional[str] = None,
                      name: Optional[str] = None,
                      quick_connect_id: Optional[str] = None,
                      tags: Optional[Mapping[str, str]] = None,
                      opts: Optional[InvokeOptions] = None) -> GetQuickConnectResult
def get_quick_connect_output(instance_id: Optional[pulumi.Input[str]] = None,
                      name: Optional[pulumi.Input[str]] = None,
                      quick_connect_id: Optional[pulumi.Input[str]] = None,
                      tags: Optional[pulumi.Input[Mapping[str, 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:connect/getQuickConnect:getQuickConnect
  arguments:
    # arguments dictionary

    The following arguments are supported:

    InstanceId string
    Reference to the hosting Amazon Connect Instance
    Name string
    Returns information on a specific Quick Connect by name
    QuickConnectId string
    Returns information on a specific Quick Connect by Quick Connect id
    Tags Dictionary<string, string>
    Map of tags to assign to the Quick Connect.
    InstanceId string
    Reference to the hosting Amazon Connect Instance
    Name string
    Returns information on a specific Quick Connect by name
    QuickConnectId string
    Returns information on a specific Quick Connect by Quick Connect id
    Tags map[string]string
    Map of tags to assign to the Quick Connect.
    instanceId String
    Reference to the hosting Amazon Connect Instance
    name String
    Returns information on a specific Quick Connect by name
    quickConnectId String
    Returns information on a specific Quick Connect by Quick Connect id
    tags Map<String,String>
    Map of tags to assign to the Quick Connect.
    instanceId string
    Reference to the hosting Amazon Connect Instance
    name string
    Returns information on a specific Quick Connect by name
    quickConnectId string
    Returns information on a specific Quick Connect by Quick Connect id
    tags {[key: string]: string}
    Map of tags to assign to the Quick Connect.
    instance_id str
    Reference to the hosting Amazon Connect Instance
    name str
    Returns information on a specific Quick Connect by name
    quick_connect_id str
    Returns information on a specific Quick Connect by Quick Connect id
    tags Mapping[str, str]
    Map of tags to assign to the Quick Connect.
    instanceId String
    Reference to the hosting Amazon Connect Instance
    name String
    Returns information on a specific Quick Connect by name
    quickConnectId String
    Returns information on a specific Quick Connect by Quick Connect id
    tags Map<String>
    Map of tags to assign to the Quick Connect.

    getQuickConnect Result

    The following output properties are available:

    Arn string
    ARN of the Quick Connect.
    Description string
    Description of the Quick Connect.
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceId string
    Name string
    QuickConnectConfigs List<GetQuickConnectQuickConnectConfig>
    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
    Identifier for the Quick Connect.
    Tags Dictionary<string, string>
    Map of tags to assign to the Quick Connect.
    Arn string
    ARN of the Quick Connect.
    Description string
    Description of the Quick Connect.
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceId string
    Name string
    QuickConnectConfigs []GetQuickConnectQuickConnectConfig
    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
    Identifier for the Quick Connect.
    Tags map[string]string
    Map of tags to assign to the Quick Connect.
    arn String
    ARN of the Quick Connect.
    description String
    Description of the Quick Connect.
    id String
    The provider-assigned unique ID for this managed resource.
    instanceId String
    name String
    quickConnectConfigs List<GetQuickConnectQuickConnectConfig>
    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
    Identifier for the Quick Connect.
    tags Map<String,String>
    Map of tags to assign to the Quick Connect.
    arn string
    ARN of the Quick Connect.
    description string
    Description of the Quick Connect.
    id string
    The provider-assigned unique ID for this managed resource.
    instanceId string
    name string
    quickConnectConfigs GetQuickConnectQuickConnectConfig[]
    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
    Identifier for the Quick Connect.
    tags {[key: string]: string}
    Map of tags to assign to the Quick Connect.
    arn str
    ARN of the Quick Connect.
    description str
    Description of the Quick Connect.
    id str
    The provider-assigned unique ID for this managed resource.
    instance_id str
    name str
    quick_connect_configs Sequence[GetQuickConnectQuickConnectConfig]
    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
    Identifier for the Quick Connect.
    tags Mapping[str, str]
    Map of tags to assign to the Quick Connect.
    arn String
    ARN of the Quick Connect.
    description String
    Description of the Quick Connect.
    id String
    The provider-assigned unique ID for this managed resource.
    instanceId String
    name String
    quickConnectConfigs List<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
    Identifier for the Quick Connect.
    tags Map<String>
    Map of tags to assign to the Quick Connect.

    Supporting Types

    GetQuickConnectQuickConnectConfig

    PhoneConfigs List<GetQuickConnectQuickConnectConfigPhoneConfig>
    Phone configuration of the Quick Connect. This is returned only if quick_connect_type is PHONE_NUMBER. The phone_config block is documented below.
    QueueConfigs List<GetQuickConnectQuickConnectConfigQueueConfig>
    Queue configuration of the Quick Connect. This is returned only if quick_connect_type is QUEUE. The queue_config block is documented below.
    QuickConnectType string
    Configuration type of the Quick Connect. Valid values are PHONE_NUMBER, QUEUE, USER.
    UserConfigs List<GetQuickConnectQuickConnectConfigUserConfig>
    User configuration of the Quick Connect. This is returned only if quick_connect_type is USER. The user_config block is documented below.
    PhoneConfigs []GetQuickConnectQuickConnectConfigPhoneConfig
    Phone configuration of the Quick Connect. This is returned only if quick_connect_type is PHONE_NUMBER. The phone_config block is documented below.
    QueueConfigs []GetQuickConnectQuickConnectConfigQueueConfig
    Queue configuration of the Quick Connect. This is returned only if quick_connect_type is QUEUE. The queue_config block is documented below.
    QuickConnectType string
    Configuration type of the Quick Connect. Valid values are PHONE_NUMBER, QUEUE, USER.
    UserConfigs []GetQuickConnectQuickConnectConfigUserConfig
    User configuration of the Quick Connect. This is returned only if quick_connect_type is USER. The user_config block is documented below.
    phoneConfigs List<GetQuickConnectQuickConnectConfigPhoneConfig>
    Phone configuration of the Quick Connect. This is returned only if quick_connect_type is PHONE_NUMBER. The phone_config block is documented below.
    queueConfigs List<GetQuickConnectQuickConnectConfigQueueConfig>
    Queue configuration of the Quick Connect. This is returned only if quick_connect_type is QUEUE. The queue_config block is documented below.
    quickConnectType String
    Configuration type of the Quick Connect. Valid values are PHONE_NUMBER, QUEUE, USER.
    userConfigs List<GetQuickConnectQuickConnectConfigUserConfig>
    User configuration of the Quick Connect. This is returned only if quick_connect_type is USER. The user_config block is documented below.
    phoneConfigs GetQuickConnectQuickConnectConfigPhoneConfig[]
    Phone configuration of the Quick Connect. This is returned only if quick_connect_type is PHONE_NUMBER. The phone_config block is documented below.
    queueConfigs GetQuickConnectQuickConnectConfigQueueConfig[]
    Queue configuration of the Quick Connect. This is returned only if quick_connect_type is QUEUE. The queue_config block is documented below.
    quickConnectType string
    Configuration type of the Quick Connect. Valid values are PHONE_NUMBER, QUEUE, USER.
    userConfigs GetQuickConnectQuickConnectConfigUserConfig[]
    User configuration of the Quick Connect. This is returned only if quick_connect_type is USER. The user_config block is documented below.
    phone_configs Sequence[GetQuickConnectQuickConnectConfigPhoneConfig]
    Phone configuration of the Quick Connect. This is returned only if quick_connect_type is PHONE_NUMBER. The phone_config block is documented below.
    queue_configs Sequence[GetQuickConnectQuickConnectConfigQueueConfig]
    Queue configuration of the Quick Connect. This is returned only if quick_connect_type is QUEUE. The queue_config block is documented below.
    quick_connect_type str
    Configuration type of the Quick Connect. Valid values are PHONE_NUMBER, QUEUE, USER.
    user_configs Sequence[GetQuickConnectQuickConnectConfigUserConfig]
    User configuration of the Quick Connect. This is returned only if quick_connect_type is USER. The user_config block is documented below.
    phoneConfigs List<Property Map>
    Phone configuration of the Quick Connect. This is returned only if quick_connect_type is PHONE_NUMBER. The phone_config block is documented below.
    queueConfigs List<Property Map>
    Queue configuration of the Quick Connect. This is returned only if quick_connect_type is QUEUE. The queue_config block is documented below.
    quickConnectType String
    Configuration type of the Quick Connect. Valid values are PHONE_NUMBER, QUEUE, USER.
    userConfigs List<Property Map>
    User configuration of the Quick Connect. This is returned only if quick_connect_type is USER. The user_config block is documented below.

    GetQuickConnectQuickConnectConfigPhoneConfig

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

    GetQuickConnectQuickConnectConfigQueueConfig

    ContactFlowId string
    Identifier of the contact flow.
    QueueId string
    Identifier for the queue.
    ContactFlowId string
    Identifier of the contact flow.
    QueueId string
    Identifier for the queue.
    contactFlowId String
    Identifier of the contact flow.
    queueId String
    Identifier for the queue.
    contactFlowId string
    Identifier of the contact flow.
    queueId string
    Identifier for the queue.
    contact_flow_id str
    Identifier of the contact flow.
    queue_id str
    Identifier for the queue.
    contactFlowId String
    Identifier of the contact flow.
    queueId String
    Identifier for the queue.

    GetQuickConnectQuickConnectConfigUserConfig

    ContactFlowId string
    Identifier of the contact flow.
    UserId string
    Identifier for the user.
    ContactFlowId string
    Identifier of the contact flow.
    UserId string
    Identifier for the user.
    contactFlowId String
    Identifier of the contact flow.
    userId String
    Identifier for the user.
    contactFlowId string
    Identifier of the contact flow.
    userId string
    Identifier for the user.
    contact_flow_id str
    Identifier of the contact flow.
    user_id str
    Identifier for the user.
    contactFlowId String
    Identifier of the contact flow.
    userId String
    Identifier for the user.

    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.54.0 published on Friday, Sep 27, 2024 by Pulumi
    pulumi/pulumi-aws