Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. connect
  5. Instance
AWS v6.78.0 published on Thursday, Apr 24, 2025 by Pulumi
pulumi/pulumi-aws

aws.connect.Instance

Explore with Pulumi AI

AWS v6.78.0 published on Thursday, Apr 24, 2025 by Pulumi
pulumi/pulumi-aws

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",
    },
});
Copy
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",
    })
Copy
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.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
	})
}
Copy
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" },
        },
    });

});
Copy
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.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) {
        var test = new Instance("test", InstanceArgs.builder()
            .identityManagementType("CONNECT_MANAGED")
            .inboundCallsEnabled(true)
            .instanceAlias("friendly-name-connect")
            .outboundCallsEnabled(true)
            .tags(Map.of("hello", "world"))
            .build());

    }
}
Copy
resources:
  test:
    type: aws:connect:Instance
    properties:
      identityManagementType: CONNECT_MANAGED
      inboundCallsEnabled: true
      instanceAlias: friendly-name-connect
      outboundCallsEnabled: true
      tags:
        hello: world
Copy

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,
});
Copy
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)
Copy
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.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
	})
}
Copy
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,
    });

});
Copy
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.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) {
        var test = new Instance("test", InstanceArgs.builder()
            .directoryId(testAwsDirectoryServiceDirectory.id())
            .identityManagementType("EXISTING_DIRECTORY")
            .inboundCallsEnabled(true)
            .instanceAlias("friendly-name-connect")
            .outboundCallsEnabled(true)
            .build());

    }
}
Copy
resources:
  test:
    type: aws:connect:Instance
    properties:
      directoryId: ${testAwsDirectoryServiceDirectory.id}
      identityManagementType: EXISTING_DIRECTORY
      inboundCallsEnabled: true
      instanceAlias: friendly-name-connect
      outboundCallsEnabled: true
Copy

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,
});
Copy
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)
Copy
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.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
	})
}
Copy
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,
    });

});
Copy
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.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) {
        var test = new Instance("test", InstanceArgs.builder()
            .identityManagementType("SAML")
            .inboundCallsEnabled(true)
            .instanceAlias("friendly-name-connect")
            .outboundCallsEnabled(true)
            .build());

    }
}
Copy
resources:
  test:
    type: aws:connect:Instance
    properties:
      identityManagementType: SAML
      inboundCallsEnabled: true
      instanceAlias: friendly-name-connect
      outboundCallsEnabled: true
Copy

Create Instance Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Instance(name: string, args: InstanceArgs, opts?: CustomResourceOptions);
@overload
def Instance(resource_name: str,
             args: InstanceArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def Instance(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             identity_management_type: Optional[str] = None,
             inbound_calls_enabled: Optional[bool] = None,
             outbound_calls_enabled: Optional[bool] = None,
             auto_resolve_best_voices_enabled: Optional[bool] = None,
             contact_flow_logs_enabled: Optional[bool] = None,
             contact_lens_enabled: Optional[bool] = None,
             directory_id: Optional[str] = None,
             early_media_enabled: Optional[bool] = None,
             instance_alias: Optional[str] = None,
             multi_party_conference_enabled: Optional[bool] = None,
             tags: Optional[Mapping[str, str]] = None)
func NewInstance(ctx *Context, name string, args InstanceArgs, opts ...ResourceOption) (*Instance, error)
public Instance(string name, InstanceArgs args, CustomResourceOptions? opts = null)
public Instance(String name, InstanceArgs args)
public Instance(String name, InstanceArgs args, CustomResourceOptions options)

type: aws:connect:Instance
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. InstanceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. InstanceArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. InstanceArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. InstanceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. InstanceArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var instanceResource = new Aws.Connect.Instance("instanceResource", new()
{
    IdentityManagementType = "string",
    InboundCallsEnabled = false,
    OutboundCallsEnabled = false,
    AutoResolveBestVoicesEnabled = false,
    ContactFlowLogsEnabled = false,
    ContactLensEnabled = false,
    DirectoryId = "string",
    EarlyMediaEnabled = false,
    InstanceAlias = "string",
    MultiPartyConferenceEnabled = false,
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := connect.NewInstance(ctx, "instanceResource", &connect.InstanceArgs{
	IdentityManagementType:       pulumi.String("string"),
	InboundCallsEnabled:          pulumi.Bool(false),
	OutboundCallsEnabled:         pulumi.Bool(false),
	AutoResolveBestVoicesEnabled: pulumi.Bool(false),
	ContactFlowLogsEnabled:       pulumi.Bool(false),
	ContactLensEnabled:           pulumi.Bool(false),
	DirectoryId:                  pulumi.String("string"),
	EarlyMediaEnabled:            pulumi.Bool(false),
	InstanceAlias:                pulumi.String("string"),
	MultiPartyConferenceEnabled:  pulumi.Bool(false),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var instanceResource = new com.pulumi.aws.connect.Instance("instanceResource", com.pulumi.aws.connect.InstanceArgs.builder()
    .identityManagementType("string")
    .inboundCallsEnabled(false)
    .outboundCallsEnabled(false)
    .autoResolveBestVoicesEnabled(false)
    .contactFlowLogsEnabled(false)
    .contactLensEnabled(false)
    .directoryId("string")
    .earlyMediaEnabled(false)
    .instanceAlias("string")
    .multiPartyConferenceEnabled(false)
    .tags(Map.of("string", "string"))
    .build());
Copy
instance_resource = aws.connect.Instance("instanceResource",
    identity_management_type="string",
    inbound_calls_enabled=False,
    outbound_calls_enabled=False,
    auto_resolve_best_voices_enabled=False,
    contact_flow_logs_enabled=False,
    contact_lens_enabled=False,
    directory_id="string",
    early_media_enabled=False,
    instance_alias="string",
    multi_party_conference_enabled=False,
    tags={
        "string": "string",
    })
Copy
const instanceResource = new aws.connect.Instance("instanceResource", {
    identityManagementType: "string",
    inboundCallsEnabled: false,
    outboundCallsEnabled: false,
    autoResolveBestVoicesEnabled: false,
    contactFlowLogsEnabled: false,
    contactLensEnabled: false,
    directoryId: "string",
    earlyMediaEnabled: false,
    instanceAlias: "string",
    multiPartyConferenceEnabled: false,
    tags: {
        string: "string",
    },
});
Copy
type: aws:connect:Instance
properties:
    autoResolveBestVoicesEnabled: false
    contactFlowLogsEnabled: false
    contactLensEnabled: false
    directoryId: string
    earlyMediaEnabled: false
    identityManagementType: string
    inboundCallsEnabled: false
    instanceAlias: string
    multiPartyConferenceEnabled: false
    outboundCallsEnabled: false
    tags:
        string: string
Copy

Instance Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Instance resource accepts the following input properties:

IdentityManagementType
This property is required.
Changes to this property will trigger replacement.
string
Specifies the identity management type attached to the instance. Allowed Values are: SAML, CONNECT_MANAGED, EXISTING_DIRECTORY.
InboundCallsEnabled This property is required. bool
Specifies whether inbound calls are enabled.
OutboundCallsEnabled This property is required. bool
Specifies whether outbound calls are enabled.
AutoResolveBestVoicesEnabled bool
Specifies whether auto resolve best voices is enabled. Defaults to true.
ContactFlowLogsEnabled bool
Specifies whether contact flow logs are enabled. Defaults to false.
ContactLensEnabled bool
Specifies whether contact lens is enabled. Defaults to true.
DirectoryId Changes to this property will trigger replacement. string
The identifier for the directory if identity_management_type is EXISTING_DIRECTORY.
EarlyMediaEnabled bool
Specifies whether early media for outbound calls is enabled . Defaults to true if outbound calls is enabled.
InstanceAlias Changes to this property will trigger replacement. string
Specifies the name of the instance. Required if directory_id not specified.
MultiPartyConferenceEnabled bool
Specifies whether multi-party calls/conference is enabled. Defaults to false.
Tags Dictionary<string, string>
Tags to apply to the Instance. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

IdentityManagementType
This property is required.
Changes to this property will trigger replacement.
string
Specifies the identity management type attached to the instance. Allowed Values are: SAML, CONNECT_MANAGED, EXISTING_DIRECTORY.
InboundCallsEnabled This property is required. bool
Specifies whether inbound calls are enabled.
OutboundCallsEnabled This property is required. bool
Specifies whether outbound calls are enabled.
AutoResolveBestVoicesEnabled bool
Specifies whether auto resolve best voices is enabled. Defaults to true.
ContactFlowLogsEnabled bool
Specifies whether contact flow logs are enabled. Defaults to false.
ContactLensEnabled bool
Specifies whether contact lens is enabled. Defaults to true.
DirectoryId Changes to this property will trigger replacement. string
The identifier for the directory if identity_management_type is EXISTING_DIRECTORY.
EarlyMediaEnabled bool
Specifies whether early media for outbound calls is enabled . Defaults to true if outbound calls is enabled.
InstanceAlias Changes to this property will trigger replacement. string
Specifies the name of the instance. Required if directory_id not specified.
MultiPartyConferenceEnabled bool
Specifies whether multi-party calls/conference is enabled. Defaults to false.
Tags map[string]string
Tags to apply to the Instance. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

identityManagementType
This property is required.
Changes to this property will trigger replacement.
String
Specifies the identity management type attached to the instance. Allowed Values are: SAML, CONNECT_MANAGED, EXISTING_DIRECTORY.
inboundCallsEnabled This property is required. Boolean
Specifies whether inbound calls are enabled.
outboundCallsEnabled This property is required. Boolean
Specifies whether outbound calls are enabled.
autoResolveBestVoicesEnabled Boolean
Specifies whether auto resolve best voices is enabled. Defaults to true.
contactFlowLogsEnabled Boolean
Specifies whether contact flow logs are enabled. Defaults to false.
contactLensEnabled Boolean
Specifies whether contact lens is enabled. Defaults to true.
directoryId Changes to this property will trigger replacement. String
The identifier for the directory if identity_management_type is EXISTING_DIRECTORY.
earlyMediaEnabled Boolean
Specifies whether early media for outbound calls is enabled . Defaults to true if outbound calls is enabled.
instanceAlias Changes to this property will trigger replacement. String
Specifies the name of the instance. Required if directory_id not specified.
multiPartyConferenceEnabled Boolean
Specifies whether multi-party calls/conference is enabled. Defaults to false.
tags Map<String,String>
Tags to apply to the Instance. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

identityManagementType
This property is required.
Changes to this property will trigger replacement.
string
Specifies the identity management type attached to the instance. Allowed Values are: SAML, CONNECT_MANAGED, EXISTING_DIRECTORY.
inboundCallsEnabled This property is required. boolean
Specifies whether inbound calls are enabled.
outboundCallsEnabled This property is required. boolean
Specifies whether outbound calls are enabled.
autoResolveBestVoicesEnabled boolean
Specifies whether auto resolve best voices is enabled. Defaults to true.
contactFlowLogsEnabled boolean
Specifies whether contact flow logs are enabled. Defaults to false.
contactLensEnabled boolean
Specifies whether contact lens is enabled. Defaults to true.
directoryId Changes to this property will trigger replacement. string
The identifier for the directory if identity_management_type is EXISTING_DIRECTORY.
earlyMediaEnabled boolean
Specifies whether early media for outbound calls is enabled . Defaults to true if outbound calls is enabled.
instanceAlias Changes to this property will trigger replacement. string
Specifies the name of the instance. Required if directory_id not specified.
multiPartyConferenceEnabled boolean
Specifies whether multi-party calls/conference is enabled. Defaults to false.
tags {[key: string]: string}
Tags to apply to the Instance. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

identity_management_type
This property is required.
Changes to this property will trigger replacement.
str
Specifies the identity management type attached to the instance. Allowed Values are: SAML, CONNECT_MANAGED, EXISTING_DIRECTORY.
inbound_calls_enabled This property is required. bool
Specifies whether inbound calls are enabled.
outbound_calls_enabled This property is required. bool
Specifies whether outbound calls are enabled.
auto_resolve_best_voices_enabled bool
Specifies whether auto resolve best voices is enabled. Defaults to true.
contact_flow_logs_enabled bool
Specifies whether contact flow logs are enabled. Defaults to false.
contact_lens_enabled bool
Specifies whether contact lens is enabled. Defaults to true.
directory_id Changes to this property will trigger replacement. str
The identifier for the directory if identity_management_type is EXISTING_DIRECTORY.
early_media_enabled bool
Specifies whether early media for outbound calls is enabled . Defaults to true if outbound calls is enabled.
instance_alias Changes to this property will trigger replacement. str
Specifies the name of the instance. Required if directory_id not specified.
multi_party_conference_enabled bool
Specifies whether multi-party calls/conference is enabled. Defaults to false.
tags Mapping[str, str]
Tags to apply to the Instance. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

identityManagementType
This property is required.
Changes to this property will trigger replacement.
String
Specifies the identity management type attached to the instance. Allowed Values are: SAML, CONNECT_MANAGED, EXISTING_DIRECTORY.
inboundCallsEnabled This property is required. Boolean
Specifies whether inbound calls are enabled.
outboundCallsEnabled This property is required. Boolean
Specifies whether outbound calls are enabled.
autoResolveBestVoicesEnabled Boolean
Specifies whether auto resolve best voices is enabled. Defaults to true.
contactFlowLogsEnabled Boolean
Specifies whether contact flow logs are enabled. Defaults to false.
contactLensEnabled Boolean
Specifies whether contact lens is enabled. Defaults to true.
directoryId Changes to this property will trigger replacement. String
The identifier for the directory if identity_management_type is EXISTING_DIRECTORY.
earlyMediaEnabled Boolean
Specifies whether early media for outbound calls is enabled . Defaults to true if outbound calls is enabled.
instanceAlias Changes to this property will trigger replacement. String
Specifies the name of the instance. Required if directory_id not specified.
multiPartyConferenceEnabled Boolean
Specifies whether multi-party calls/conference is enabled. Defaults to false.
tags Map<String>
Tags to apply to the Instance. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Outputs

All input properties are implicitly available as output properties. Additionally, the Instance resource produces the following output properties:

Arn string
Amazon Resource Name (ARN) of the instance.
CreatedTime string
When the instance was created.
Id string
The provider-assigned unique ID for this managed resource.
ServiceRole string
The service role of the instance.
Status string
The state of the instance.
TagsAll Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Arn string
Amazon Resource Name (ARN) of the instance.
CreatedTime string
When the instance was created.
Id string
The provider-assigned unique ID for this managed resource.
ServiceRole string
The service role of the instance.
Status string
The state of the instance.
TagsAll map[string]string
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
Amazon Resource Name (ARN) of the instance.
createdTime String
When the instance was created.
id String
The provider-assigned unique ID for this managed resource.
serviceRole String
The service role of the instance.
status String
The state of the instance.
tagsAll Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn string
Amazon Resource Name (ARN) of the instance.
createdTime string
When the instance was created.
id string
The provider-assigned unique ID for this managed resource.
serviceRole string
The service role of the instance.
status string
The state of the instance.
tagsAll {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn str
Amazon Resource Name (ARN) of the instance.
created_time str
When the instance was created.
id str
The provider-assigned unique ID for this managed resource.
service_role str
The service role of the instance.
status str
The state of the instance.
tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
Amazon Resource Name (ARN) of the instance.
createdTime String
When the instance was created.
id String
The provider-assigned unique ID for this managed resource.
serviceRole String
The service role of the instance.
status String
The state of the instance.
tagsAll Map<String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Look up Existing Instance Resource

Get an existing Instance resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: InstanceState, opts?: CustomResourceOptions): Instance
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        auto_resolve_best_voices_enabled: Optional[bool] = None,
        contact_flow_logs_enabled: Optional[bool] = None,
        contact_lens_enabled: Optional[bool] = None,
        created_time: Optional[str] = None,
        directory_id: Optional[str] = None,
        early_media_enabled: Optional[bool] = None,
        identity_management_type: Optional[str] = None,
        inbound_calls_enabled: Optional[bool] = None,
        instance_alias: Optional[str] = None,
        multi_party_conference_enabled: Optional[bool] = None,
        outbound_calls_enabled: Optional[bool] = None,
        service_role: Optional[str] = None,
        status: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> Instance
func GetInstance(ctx *Context, name string, id IDInput, state *InstanceState, opts ...ResourceOption) (*Instance, error)
public static Instance Get(string name, Input<string> id, InstanceState? state, CustomResourceOptions? opts = null)
public static Instance get(String name, Output<String> id, InstanceState state, CustomResourceOptions options)
resources:  _:    type: aws:connect:Instance    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Arn string
Amazon Resource Name (ARN) of the instance.
AutoResolveBestVoicesEnabled bool
Specifies whether auto resolve best voices is enabled. Defaults to true.
ContactFlowLogsEnabled bool
Specifies whether contact flow logs are enabled. Defaults to false.
ContactLensEnabled bool
Specifies whether contact lens is enabled. Defaults to true.
CreatedTime string
When the instance was created.
DirectoryId Changes to this property will trigger replacement. string
The identifier for the directory if identity_management_type is EXISTING_DIRECTORY.
EarlyMediaEnabled bool
Specifies whether early media for outbound calls is enabled . Defaults to true if outbound calls is enabled.
IdentityManagementType Changes to this property will trigger replacement. string
Specifies the identity management type attached to the instance. Allowed Values are: SAML, CONNECT_MANAGED, EXISTING_DIRECTORY.
InboundCallsEnabled bool
Specifies whether inbound calls are enabled.
InstanceAlias Changes to this property will trigger replacement. string
Specifies the name of the instance. Required if directory_id not specified.
MultiPartyConferenceEnabled bool
Specifies whether multi-party calls/conference is enabled. Defaults to false.
OutboundCallsEnabled bool
Specifies whether outbound calls are enabled.
ServiceRole string
The service role of the instance.
Status string
The state of the instance.
Tags Dictionary<string, string>
Tags to apply to the Instance. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

TagsAll Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Arn string
Amazon Resource Name (ARN) of the instance.
AutoResolveBestVoicesEnabled bool
Specifies whether auto resolve best voices is enabled. Defaults to true.
ContactFlowLogsEnabled bool
Specifies whether contact flow logs are enabled. Defaults to false.
ContactLensEnabled bool
Specifies whether contact lens is enabled. Defaults to true.
CreatedTime string
When the instance was created.
DirectoryId Changes to this property will trigger replacement. string
The identifier for the directory if identity_management_type is EXISTING_DIRECTORY.
EarlyMediaEnabled bool
Specifies whether early media for outbound calls is enabled . Defaults to true if outbound calls is enabled.
IdentityManagementType Changes to this property will trigger replacement. string
Specifies the identity management type attached to the instance. Allowed Values are: SAML, CONNECT_MANAGED, EXISTING_DIRECTORY.
InboundCallsEnabled bool
Specifies whether inbound calls are enabled.
InstanceAlias Changes to this property will trigger replacement. string
Specifies the name of the instance. Required if directory_id not specified.
MultiPartyConferenceEnabled bool
Specifies whether multi-party calls/conference is enabled. Defaults to false.
OutboundCallsEnabled bool
Specifies whether outbound calls are enabled.
ServiceRole string
The service role of the instance.
Status string
The state of the instance.
Tags map[string]string
Tags to apply to the Instance. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

TagsAll map[string]string
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
Amazon Resource Name (ARN) of the instance.
autoResolveBestVoicesEnabled Boolean
Specifies whether auto resolve best voices is enabled. Defaults to true.
contactFlowLogsEnabled Boolean
Specifies whether contact flow logs are enabled. Defaults to false.
contactLensEnabled Boolean
Specifies whether contact lens is enabled. Defaults to true.
createdTime String
When the instance was created.
directoryId Changes to this property will trigger replacement. String
The identifier for the directory if identity_management_type is EXISTING_DIRECTORY.
earlyMediaEnabled Boolean
Specifies whether early media for outbound calls is enabled . Defaults to true if outbound calls is enabled.
identityManagementType Changes to this property will trigger replacement. String
Specifies the identity management type attached to the instance. Allowed Values are: SAML, CONNECT_MANAGED, EXISTING_DIRECTORY.
inboundCallsEnabled Boolean
Specifies whether inbound calls are enabled.
instanceAlias Changes to this property will trigger replacement. String
Specifies the name of the instance. Required if directory_id not specified.
multiPartyConferenceEnabled Boolean
Specifies whether multi-party calls/conference is enabled. Defaults to false.
outboundCallsEnabled Boolean
Specifies whether outbound calls are enabled.
serviceRole String
The service role of the instance.
status String
The state of the instance.
tags Map<String,String>
Tags to apply to the Instance. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tagsAll Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn string
Amazon Resource Name (ARN) of the instance.
autoResolveBestVoicesEnabled boolean
Specifies whether auto resolve best voices is enabled. Defaults to true.
contactFlowLogsEnabled boolean
Specifies whether contact flow logs are enabled. Defaults to false.
contactLensEnabled boolean
Specifies whether contact lens is enabled. Defaults to true.
createdTime string
When the instance was created.
directoryId Changes to this property will trigger replacement. string
The identifier for the directory if identity_management_type is EXISTING_DIRECTORY.
earlyMediaEnabled boolean
Specifies whether early media for outbound calls is enabled . Defaults to true if outbound calls is enabled.
identityManagementType Changes to this property will trigger replacement. string
Specifies the identity management type attached to the instance. Allowed Values are: SAML, CONNECT_MANAGED, EXISTING_DIRECTORY.
inboundCallsEnabled boolean
Specifies whether inbound calls are enabled.
instanceAlias Changes to this property will trigger replacement. string
Specifies the name of the instance. Required if directory_id not specified.
multiPartyConferenceEnabled boolean
Specifies whether multi-party calls/conference is enabled. Defaults to false.
outboundCallsEnabled boolean
Specifies whether outbound calls are enabled.
serviceRole string
The service role of the instance.
status string
The state of the instance.
tags {[key: string]: string}
Tags to apply to the Instance. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tagsAll {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn str
Amazon Resource Name (ARN) of the instance.
auto_resolve_best_voices_enabled bool
Specifies whether auto resolve best voices is enabled. Defaults to true.
contact_flow_logs_enabled bool
Specifies whether contact flow logs are enabled. Defaults to false.
contact_lens_enabled bool
Specifies whether contact lens is enabled. Defaults to true.
created_time str
When the instance was created.
directory_id Changes to this property will trigger replacement. str
The identifier for the directory if identity_management_type is EXISTING_DIRECTORY.
early_media_enabled bool
Specifies whether early media for outbound calls is enabled . Defaults to true if outbound calls is enabled.
identity_management_type Changes to this property will trigger replacement. str
Specifies the identity management type attached to the instance. Allowed Values are: SAML, CONNECT_MANAGED, EXISTING_DIRECTORY.
inbound_calls_enabled bool
Specifies whether inbound calls are enabled.
instance_alias Changes to this property will trigger replacement. str
Specifies the name of the instance. Required if directory_id not specified.
multi_party_conference_enabled bool
Specifies whether multi-party calls/conference is enabled. Defaults to false.
outbound_calls_enabled bool
Specifies whether outbound calls are enabled.
service_role str
The service role of the instance.
status str
The state of the instance.
tags Mapping[str, str]
Tags to apply to the Instance. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
Amazon Resource Name (ARN) of the instance.
autoResolveBestVoicesEnabled Boolean
Specifies whether auto resolve best voices is enabled. Defaults to true.
contactFlowLogsEnabled Boolean
Specifies whether contact flow logs are enabled. Defaults to false.
contactLensEnabled Boolean
Specifies whether contact lens is enabled. Defaults to true.
createdTime String
When the instance was created.
directoryId Changes to this property will trigger replacement. String
The identifier for the directory if identity_management_type is EXISTING_DIRECTORY.
earlyMediaEnabled Boolean
Specifies whether early media for outbound calls is enabled . Defaults to true if outbound calls is enabled.
identityManagementType Changes to this property will trigger replacement. String
Specifies the identity management type attached to the instance. Allowed Values are: SAML, CONNECT_MANAGED, EXISTING_DIRECTORY.
inboundCallsEnabled Boolean
Specifies whether inbound calls are enabled.
instanceAlias Changes to this property will trigger replacement. String
Specifies the name of the instance. Required if directory_id not specified.
multiPartyConferenceEnabled Boolean
Specifies whether multi-party calls/conference is enabled. Defaults to false.
outboundCallsEnabled Boolean
Specifies whether outbound calls are enabled.
serviceRole String
The service role of the instance.
status String
The state of the instance.
tags Map<String>
Tags to apply to the Instance. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tagsAll Map<String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Import

Using pulumi import, import Connect instances using the id. For example:

$ pulumi import aws:connect/instance:Instance example f1288a1f-6193-445a-b47e-af739b2
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.
AWS v6.78.0 published on Thursday, Apr 24, 2025 by Pulumi
pulumi/pulumi-aws