QuickConnect class
Provides an Amazon Connect Quick Connect resource. For more information see Amazon Connect: Getting Started
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const test = new aws.connect.QuickConnect("test", {
quickConnectConfig: {
phoneConfigs: [{
phoneNumber: "+12345678912",
}],
quickConnectType: "PHONE_NUMBER",
},
instanceId: "aaaaaaaa-bbbb-cccc-dddd-111111111111",
name: "Example Name",
description: "quick connect phone number",
tags: {
Name: "Example Quick Connect",
},
});
import pulumi
import pulumi_aws as aws
test = aws.connect.QuickConnect("test",
quick_connect_config={
"phone_configs": [{
"phone_number": "+12345678912",
}],
"quick_connect_type": "PHONE_NUMBER",
},
instance_id="aaaaaaaa-bbbb-cccc-dddd-111111111111",
name="Example Name",
description="quick connect phone number",
tags={
"Name": "Example Quick Connect",
})
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()
{
QuickConnectConfig = new Aws.Connect.Inputs.QuickConnectQuickConnectConfigArgs
{
PhoneConfigs = new[]
{
new Aws.Connect.Inputs.QuickConnectQuickConnectConfigPhoneConfigArgs
{
PhoneNumber = "+12345678912",
},
},
QuickConnectType = "PHONE_NUMBER",
},
InstanceId = "aaaaaaaa-bbbb-cccc-dddd-111111111111",
Name = "Example Name",
Description = "quick connect phone number",
Tags =
{
{ "Name", "Example Quick Connect" },
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/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{
QuickConnectConfig: &connect.QuickConnectQuickConnectConfigArgs{
PhoneConfigs: connect.QuickConnectQuickConnectConfigPhoneConfigArray{
&connect.QuickConnectQuickConnectConfigPhoneConfigArgs{
PhoneNumber: pulumi.String("+12345678912"),
},
},
QuickConnectType: pulumi.String("PHONE_NUMBER"),
},
InstanceId: pulumi.String("aaaaaaaa-bbbb-cccc-dddd-111111111111"),
Name: pulumi.String("Example Name"),
Description: pulumi.String("quick connect phone number"),
Tags: pulumi.StringMap{
"Name": pulumi.String("Example Quick Connect"),
},
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_connect_quickconnect" "test" {
quick_connect_config = {
phone_configs = [{
"phoneNumber" = "+12345678912"
}]
quick_connect_type = "PHONE_NUMBER"
}
instance_id = "aaaaaaaa-bbbb-cccc-dddd-111111111111"
name = "Example Name"
description = "quick connect phone number"
tags = {
"Name" = "Example Quick Connect"
}
}
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 com.pulumi.aws.connect.inputs.QuickConnectQuickConnectConfigPhoneConfigArgs;
import java.util.ArrayList;
import java.util.Arrays;
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()
.quickConnectConfig(QuickConnectQuickConnectConfigArgs.builder()
.phoneConfigs(QuickConnectQuickConnectConfigPhoneConfigArgs.builder()
.phoneNumber("+12345678912")
.build())
.quickConnectType("PHONE_NUMBER")
.build())
.instanceId("aaaaaaaa-bbbb-cccc-dddd-111111111111")
.name("Example Name")
.description("quick connect phone number")
.tags(Map.of("Name", "Example Quick Connect"))
.build());
}
}
resources:
test:
type: aws:connect:QuickConnect
properties:
quickConnectConfig:
phoneConfigs:
- phoneNumber: '+12345678912'
quickConnectType: PHONE_NUMBER
instanceId: aaaaaaaa-bbbb-cccc-dddd-111111111111
name: Example Name
description: quick connect phone number
tags:
Name: Example Quick Connect
Import
Using pulumi import, import Amazon Connect Quick Connects using the instanceId and quickConnectId separated by a colon (:). For example:
$ pulumi import aws:connect/quickConnect:QuickConnect example f1288a1f-6193-445a-b47e-af739b2:c1d4e5f6-1b3c-1b3c-1b3c-c1d4e5f6c1d4e5
Constructors
- QuickConnect(String name, {QuickConnectArgs? args, CustomResourceOptions? options})
-
Creates a new QuickConnect.
nameThe Pulumi resource name.argsArguments used to configure this QuickConnect. The set of arguments for QuickConnect.optionsResource options controlling this resource's behavior. - QuickConnect.reference(String urn)
- Creates a typed reference to an existing QuickConnect resource.
Properties
-
arn
↔ Output<
String> -
ARN of the Quick Connect.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
description
↔ Output<
String?> -
Specifies the description of the Quick Connect.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
-
instanceId
↔ Output<
String> -
Specifies the identifier of the hosting Amazon Connect Instance.
latefinal
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
name
↔ Output<
String> -
Specifies the name of the Quick Connect.
latefinal
-
quickConnectConfig
↔ Output<
QuickConnectQuickConnectConfig> -
A block that defines the configuration information for the Quick Connect:
quickConnectTypeand one ofphoneConfig,queueConfig,userConfig. The Quick Connect Config block is documented below.latefinal -
quickConnectId
↔ Output<
String> -
The identifier for the Quick Connect.
latefinal
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
Tags to apply to the Quick Connect. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
A map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.latefinal -
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {QuickConnectState? state, CustomResourceOptions? options}) → QuickConnect -
Gets an existing QuickConnect resource's state with the given
nameandid.