AWS v6.57.0 published on Tuesday, Oct 29, 2024 by Pulumi
aws.connect.getQuickConnect
Explore with Pulumi AI
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:
- Instance
Id string - Reference to the hosting Amazon Connect Instance
- Name string
- Returns information on a specific Quick Connect by name
- Quick
Connect stringId - Returns information on a specific Quick Connect by Quick Connect id
- Dictionary<string, string>
- Map of tags to assign to the Quick Connect.
- Instance
Id string - Reference to the hosting Amazon Connect Instance
- Name string
- Returns information on a specific Quick Connect by name
- Quick
Connect stringId - Returns information on a specific Quick Connect by Quick Connect id
- map[string]string
- Map of tags to assign to the Quick Connect.
- instance
Id String - Reference to the hosting Amazon Connect Instance
- name String
- Returns information on a specific Quick Connect by name
- quick
Connect StringId - Returns information on a specific Quick Connect by Quick Connect id
- Map<String,String>
- Map of tags to assign to the Quick Connect.
- instance
Id string - Reference to the hosting Amazon Connect Instance
- name string
- Returns information on a specific Quick Connect by name
- quick
Connect stringId - Returns information on a specific Quick Connect by Quick Connect id
- {[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_ strid - Returns information on a specific Quick Connect by Quick Connect id
- Mapping[str, str]
- Map of tags to assign to the Quick Connect.
- instance
Id String - Reference to the hosting Amazon Connect Instance
- name String
- Returns information on a specific Quick Connect by name
- quick
Connect StringId - Returns information on a specific Quick Connect by Quick Connect id
- 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.
- Instance
Id string - Name string
- Quick
Connect List<GetConfigs Quick Connect Quick Connect Config> - A block that defines the configuration information for the Quick Connect:
quick_connect_type
and one ofphone_config
,queue_config
,user_config
. The Quick Connect Config block is documented below. - Quick
Connect stringId - Identifier for the Quick Connect.
- 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.
- Instance
Id string - Name string
- Quick
Connect []GetConfigs Quick Connect Quick Connect Config - A block that defines the configuration information for the Quick Connect:
quick_connect_type
and one ofphone_config
,queue_config
,user_config
. The Quick Connect Config block is documented below. - Quick
Connect stringId - Identifier for the Quick Connect.
- 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.
- instance
Id String - name String
- quick
Connect List<GetConfigs Quick Connect Quick Connect Config> - A block that defines the configuration information for the Quick Connect:
quick_connect_type
and one ofphone_config
,queue_config
,user_config
. The Quick Connect Config block is documented below. - quick
Connect StringId - Identifier for the Quick Connect.
- 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.
- instance
Id string - name string
- quick
Connect GetConfigs Quick Connect Quick Connect Config[] - A block that defines the configuration information for the Quick Connect:
quick_connect_type
and one ofphone_config
,queue_config
,user_config
. The Quick Connect Config block is documented below. - quick
Connect stringId - Identifier for the Quick Connect.
- {[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_ Sequence[Getconfigs Quick Connect Quick Connect Config] - A block that defines the configuration information for the Quick Connect:
quick_connect_type
and one ofphone_config
,queue_config
,user_config
. The Quick Connect Config block is documented below. - quick_
connect_ strid - Identifier for the Quick Connect.
- 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.
- instance
Id String - name String
- quick
Connect List<Property Map>Configs - A block that defines the configuration information for the Quick Connect:
quick_connect_type
and one ofphone_config
,queue_config
,user_config
. The Quick Connect Config block is documented below. - quick
Connect StringId - Identifier for the Quick Connect.
- Map<String>
- Map of tags to assign to the Quick Connect.
Supporting Types
GetQuickConnectQuickConnectConfig
- Phone
Configs List<GetQuick Connect Quick Connect Config Phone Config> - Phone configuration of the Quick Connect. This is returned only if
quick_connect_type
isPHONE_NUMBER
. Thephone_config
block is documented below. - Queue
Configs List<GetQuick Connect Quick Connect Config Queue Config> - Queue configuration of the Quick Connect. This is returned only if
quick_connect_type
isQUEUE
. Thequeue_config
block is documented below. - Quick
Connect stringType - Configuration type of the Quick Connect. Valid values are
PHONE_NUMBER
,QUEUE
,USER
. - User
Configs List<GetQuick Connect Quick Connect Config User Config> - User configuration of the Quick Connect. This is returned only if
quick_connect_type
isUSER
. Theuser_config
block is documented below.
- Phone
Configs []GetQuick Connect Quick Connect Config Phone Config - Phone configuration of the Quick Connect. This is returned only if
quick_connect_type
isPHONE_NUMBER
. Thephone_config
block is documented below. - Queue
Configs []GetQuick Connect Quick Connect Config Queue Config - Queue configuration of the Quick Connect. This is returned only if
quick_connect_type
isQUEUE
. Thequeue_config
block is documented below. - Quick
Connect stringType - Configuration type of the Quick Connect. Valid values are
PHONE_NUMBER
,QUEUE
,USER
. - User
Configs []GetQuick Connect Quick Connect Config User Config - User configuration of the Quick Connect. This is returned only if
quick_connect_type
isUSER
. Theuser_config
block is documented below.
- phone
Configs List<GetQuick Connect Quick Connect Config Phone Config> - Phone configuration of the Quick Connect. This is returned only if
quick_connect_type
isPHONE_NUMBER
. Thephone_config
block is documented below. - queue
Configs List<GetQuick Connect Quick Connect Config Queue Config> - Queue configuration of the Quick Connect. This is returned only if
quick_connect_type
isQUEUE
. Thequeue_config
block is documented below. - quick
Connect StringType - Configuration type of the Quick Connect. Valid values are
PHONE_NUMBER
,QUEUE
,USER
. - user
Configs List<GetQuick Connect Quick Connect Config User Config> - User configuration of the Quick Connect. This is returned only if
quick_connect_type
isUSER
. Theuser_config
block is documented below.
- phone
Configs GetQuick Connect Quick Connect Config Phone Config[] - Phone configuration of the Quick Connect. This is returned only if
quick_connect_type
isPHONE_NUMBER
. Thephone_config
block is documented below. - queue
Configs GetQuick Connect Quick Connect Config Queue Config[] - Queue configuration of the Quick Connect. This is returned only if
quick_connect_type
isQUEUE
. Thequeue_config
block is documented below. - quick
Connect stringType - Configuration type of the Quick Connect. Valid values are
PHONE_NUMBER
,QUEUE
,USER
. - user
Configs GetQuick Connect Quick Connect Config User Config[] - User configuration of the Quick Connect. This is returned only if
quick_connect_type
isUSER
. Theuser_config
block is documented below.
- phone_
configs Sequence[GetQuick Connect Quick Connect Config Phone Config] - Phone configuration of the Quick Connect. This is returned only if
quick_connect_type
isPHONE_NUMBER
. Thephone_config
block is documented below. - queue_
configs Sequence[GetQuick Connect Quick Connect Config Queue Config] - Queue configuration of the Quick Connect. This is returned only if
quick_connect_type
isQUEUE
. Thequeue_config
block is documented below. - quick_
connect_ strtype - Configuration type of the Quick Connect. Valid values are
PHONE_NUMBER
,QUEUE
,USER
. - user_
configs Sequence[GetQuick Connect Quick Connect Config User Config] - User configuration of the Quick Connect. This is returned only if
quick_connect_type
isUSER
. Theuser_config
block is documented below.
- phone
Configs List<Property Map> - Phone configuration of the Quick Connect. This is returned only if
quick_connect_type
isPHONE_NUMBER
. Thephone_config
block is documented below. - queue
Configs List<Property Map> - Queue configuration of the Quick Connect. This is returned only if
quick_connect_type
isQUEUE
. Thequeue_config
block is documented below. - quick
Connect StringType - Configuration type of the Quick Connect. Valid values are
PHONE_NUMBER
,QUEUE
,USER
. - user
Configs List<Property Map> - User configuration of the Quick Connect. This is returned only if
quick_connect_type
isUSER
. Theuser_config
block is documented below.
GetQuickConnectQuickConnectConfigPhoneConfig
- Phone
Number string - Phone number in in E.164 format.
- Phone
Number string - Phone number in in E.164 format.
- phone
Number String - Phone number in in E.164 format.
- phone
Number string - Phone number in in E.164 format.
- phone_
number str - Phone number in in E.164 format.
- phone
Number String - Phone number in in E.164 format.
GetQuickConnectQuickConnectConfigQueueConfig
- Contact
Flow stringId - Identifier of the contact flow.
- Queue
Id string - Identifier for the queue.
- Contact
Flow stringId - Identifier of the contact flow.
- Queue
Id string - Identifier for the queue.
- contact
Flow StringId - Identifier of the contact flow.
- queue
Id String - Identifier for the queue.
- contact
Flow stringId - Identifier of the contact flow.
- queue
Id string - Identifier for the queue.
- contact_
flow_ strid - Identifier of the contact flow.
- queue_
id str - Identifier for the queue.
- contact
Flow StringId - Identifier of the contact flow.
- queue
Id String - Identifier for the queue.
GetQuickConnectQuickConnectConfigUserConfig
- Contact
Flow stringId - Identifier of the contact flow.
- User
Id string - Identifier for the user.
- Contact
Flow stringId - Identifier of the contact flow.
- User
Id string - Identifier for the user.
- contact
Flow StringId - Identifier of the contact flow.
- user
Id String - Identifier for the user.
- contact
Flow stringId - Identifier of the contact flow.
- user
Id string - Identifier for the user.
- contact_
flow_ strid - Identifier of the contact flow.
- user_
id str - Identifier for the user.
- contact
Flow StringId - Identifier of the contact flow.
- user
Id 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.