Instance class
Provides an Amazon Connect instance resource. For more information see Amazon Connect: Getting Started
> WARN: Amazon Connect enforces a limit of 100 combined instance creation and deletions every 30 days. For example, if you create 80 instances and delete 20 of them, you must wait 30 days to create or delete another instance. Use care when creating or deleting instances.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const test = new aws.connect.Instance("test", {
identityManagementType: "CONNECT_MANAGED",
inboundCallsEnabled: true,
instanceAlias: "friendly-name-connect",
outboundCallsEnabled: true,
tags: {
hello: "world",
},
});
import pulumi
import pulumi_aws as aws
test = aws.connect.Instance("test",
identity_management_type="CONNECT_MANAGED",
inbound_calls_enabled=True,
instance_alias="friendly-name-connect",
outbound_calls_enabled=True,
tags={
"hello": "world",
})
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var test = new Aws.Connect.Instance("test", new()
{
IdentityManagementType = "CONNECT_MANAGED",
InboundCallsEnabled = true,
InstanceAlias = "friendly-name-connect",
OutboundCallsEnabled = true,
Tags =
{
{ "hello", "world" },
},
});
});
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.NewInstance(ctx, "test", &connect.InstanceArgs{
IdentityManagementType: pulumi.String("CONNECT_MANAGED"),
InboundCallsEnabled: pulumi.Bool(true),
InstanceAlias: pulumi.String("friendly-name-connect"),
OutboundCallsEnabled: pulumi.Bool(true),
Tags: pulumi.StringMap{
"hello": pulumi.String("world"),
},
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_connect_instance" "test" {
identity_management_type = "CONNECT_MANAGED"
inbound_calls_enabled = true
instance_alias = "friendly-name-connect"
outbound_calls_enabled = true
tags = {
"hello" = "world"
}
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.connect.Instance;
import com.pulumi.aws.connect.InstanceArgs;
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 Instance("test", InstanceArgs.builder()
.identityManagementType("CONNECT_MANAGED")
.inboundCallsEnabled(true)
.instanceAlias("friendly-name-connect")
.outboundCallsEnabled(true)
.tags(Map.of("hello", "world"))
.build());
}
}
resources:
test:
type: aws:connect:Instance
properties:
identityManagementType: CONNECT_MANAGED
inboundCallsEnabled: true
instanceAlias: friendly-name-connect
outboundCallsEnabled: true
tags:
hello: world
Example Usage with Existing Active Directory
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const test = new aws.connect.Instance("test", {
directoryId: testAwsDirectoryServiceDirectory.id,
identityManagementType: "EXISTING_DIRECTORY",
inboundCallsEnabled: true,
instanceAlias: "friendly-name-connect",
outboundCallsEnabled: true,
});
import pulumi
import pulumi_aws as aws
test = aws.connect.Instance("test",
directory_id=test_aws_directory_service_directory["id"],
identity_management_type="EXISTING_DIRECTORY",
inbound_calls_enabled=True,
instance_alias="friendly-name-connect",
outbound_calls_enabled=True)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var test = new Aws.Connect.Instance("test", new()
{
DirectoryId = testAwsDirectoryServiceDirectory.Id,
IdentityManagementType = "EXISTING_DIRECTORY",
InboundCallsEnabled = true,
InstanceAlias = "friendly-name-connect",
OutboundCallsEnabled = true,
});
});
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.NewInstance(ctx, "test", &connect.InstanceArgs{
DirectoryId: pulumi.Any(testAwsDirectoryServiceDirectory.Id),
IdentityManagementType: pulumi.String("EXISTING_DIRECTORY"),
InboundCallsEnabled: pulumi.Bool(true),
InstanceAlias: pulumi.String("friendly-name-connect"),
OutboundCallsEnabled: pulumi.Bool(true),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_connect_instance" "test" {
directory_id = testAwsDirectoryServiceDirectory.id
identity_management_type = "EXISTING_DIRECTORY"
inbound_calls_enabled = true
instance_alias = "friendly-name-connect"
outbound_calls_enabled = true
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.connect.Instance;
import com.pulumi.aws.connect.InstanceArgs;
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 Instance("test", InstanceArgs.builder()
.directoryId(testAwsDirectoryServiceDirectory.id())
.identityManagementType("EXISTING_DIRECTORY")
.inboundCallsEnabled(true)
.instanceAlias("friendly-name-connect")
.outboundCallsEnabled(true)
.build());
}
}
resources:
test:
type: aws:connect:Instance
properties:
directoryId: ${testAwsDirectoryServiceDirectory.id}
identityManagementType: EXISTING_DIRECTORY
inboundCallsEnabled: true
instanceAlias: friendly-name-connect
outboundCallsEnabled: true
Example Usage with SAML
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const test = new aws.connect.Instance("test", {
identityManagementType: "SAML",
inboundCallsEnabled: true,
instanceAlias: "friendly-name-connect",
outboundCallsEnabled: true,
});
import pulumi
import pulumi_aws as aws
test = aws.connect.Instance("test",
identity_management_type="SAML",
inbound_calls_enabled=True,
instance_alias="friendly-name-connect",
outbound_calls_enabled=True)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var test = new Aws.Connect.Instance("test", new()
{
IdentityManagementType = "SAML",
InboundCallsEnabled = true,
InstanceAlias = "friendly-name-connect",
OutboundCallsEnabled = true,
});
});
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.NewInstance(ctx, "test", &connect.InstanceArgs{
IdentityManagementType: pulumi.String("SAML"),
InboundCallsEnabled: pulumi.Bool(true),
InstanceAlias: pulumi.String("friendly-name-connect"),
OutboundCallsEnabled: pulumi.Bool(true),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_connect_instance" "test" {
identity_management_type = "SAML"
inbound_calls_enabled = true
instance_alias = "friendly-name-connect"
outbound_calls_enabled = true
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.connect.Instance;
import com.pulumi.aws.connect.InstanceArgs;
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 Instance("test", InstanceArgs.builder()
.identityManagementType("SAML")
.inboundCallsEnabled(true)
.instanceAlias("friendly-name-connect")
.outboundCallsEnabled(true)
.build());
}
}
resources:
test:
type: aws:connect:Instance
properties:
identityManagementType: SAML
inboundCallsEnabled: true
instanceAlias: friendly-name-connect
outboundCallsEnabled: true
Import
Identity Schema
Required
id- (String) ID of the connect instance.
Optional
accountId(String) AWS Account where this resource is managed.region(String) Region where this resource is managed.
Using pulumi import, import Connect instances using the id. For example:
$ pulumi import aws:connect/instance:Instance example f1288a1f-6193-445a-b47e-af739b2
Constructors
- Instance(String name, {InstanceArgs? args, CustomResourceOptions? options})
-
Creates a new Instance.
nameThe Pulumi resource name.argsArguments used to configure this Instance. The set of arguments for Instance.optionsResource options controlling this resource's behavior. - Instance.reference(String urn)
- Creates a typed reference to an existing Instance resource.
Properties
-
arn
↔ Output<
String> -
ARN of the instance.
latefinal
-
autoResolveBestVoicesEnabled
↔ Output<
bool?> -
Specifies whether auto resolve best voices is enabled. Defaults to
true.latefinal -
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
contactFlowLogsEnabled
↔ Output<
bool?> -
Specifies whether contact flow logs are enabled. Defaults to
false.latefinal -
contactLensEnabled
↔ Output<
bool?> -
Specifies whether contact lens is enabled. Defaults to
true.latefinal -
createdTime
↔ Output<
String> -
When the instance was created.
latefinal
-
directoryId
↔ Output<
String?> -
The identifier for the directory if identityManagementType is
EXISTING_DIRECTORY.latefinal -
earlyMediaEnabled
↔ Output<
bool?> -
Specifies whether early media for outbound calls is enabled . Defaults to
trueif outbound calls is enabled.latefinal - hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
-
identityManagementType
↔ Output<
String> -
Specifies the identity management type attached to the instance. Allowed Values are:
SAML,CONNECT_MANAGED,EXISTING_DIRECTORY.latefinal -
inboundCallsEnabled
↔ Output<
bool> -
Specifies whether inbound calls are enabled.
latefinal
-
instanceAlias
↔ Output<
String?> -
Specifies the name of the instance. Required if
directoryIdnot specified.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
-
multiPartyConferenceEnabled
↔ Output<
bool?> -
Specifies whether multi-party calls/conference is enabled. Defaults to
false.latefinal -
outboundCallsEnabled
↔ Output<
bool> -
Specifies whether outbound calls are enabled.
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
-
serviceRole
↔ Output<
String> -
The service role of the instance.
latefinal
-
status
↔ Output<
String> -
The state of the instance.
latefinal
-
Tags to apply to the Instance. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. <!-- *useCustomTtsVoices- (Optional) Whether use custom tts voices is enabled. Defaults tofalse-->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