AWS Classic

Pulumi Official
Package maintained by Pulumi
v5.4.0 published on Wednesday, May 4, 2022 by Pulumi

getInstance

Provides details about a specific Amazon Connect Instance.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var foo = Output.Create(Aws.Connect.GetInstance.InvokeAsync(new Aws.Connect.GetInstanceArgs
        {
            InstanceAlias = "foo",
        }));
    }

}
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := connect.LookupInstance(ctx, &connect.LookupInstanceArgs{
			InstanceAlias: pulumi.StringRef("foo"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var foo = Output.of(ConnectFunctions.getInstance(GetInstanceArgs.builder()
            .instanceAlias("foo")
            .build()));

        }
}
import pulumi
import pulumi_aws as aws

foo = aws.connect.get_instance(instance_alias="foo")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const foo = pulumi.output(aws.connect.getInstance({
    instanceAlias: "foo",
}));
variables:
  foo:
    Fn::Invoke:
      Function: aws:connect:getInstance
      Arguments:
        instanceAlias: foo

Using getInstance

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 getInstance(args: GetInstanceArgs, opts?: InvokeOptions): Promise<GetInstanceResult>
function getInstanceOutput(args: GetInstanceOutputArgs, opts?: InvokeOptions): Output<GetInstanceResult>
def get_instance(instance_alias: Optional[str] = None,
                 instance_id: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetInstanceResult
def get_instance_output(instance_alias: Optional[pulumi.Input[str]] = None,
                 instance_id: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetInstanceResult]
func LookupInstance(ctx *Context, args *LookupInstanceArgs, opts ...InvokeOption) (*LookupInstanceResult, error)
func LookupInstanceOutput(ctx *Context, args *LookupInstanceOutputArgs, opts ...InvokeOption) LookupInstanceResultOutput

> Note: This function is named LookupInstance in the Go SDK.

public static class GetInstance 
{
    public static Task<GetInstanceResult> InvokeAsync(GetInstanceArgs args, InvokeOptions? opts = null)
    public static Output<GetInstanceResult> Invoke(GetInstanceInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetInstanceResult> getInstance(GetInstanceArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: aws:connect/getInstance:getInstance
  Arguments:
    # Arguments dictionary

The following arguments are supported:

InstanceAlias string

Returns information on a specific connect instance by alias

InstanceId string

Returns information on a specific connect instance by id

InstanceAlias string

Returns information on a specific connect instance by alias

InstanceId string

Returns information on a specific connect instance by id

instanceAlias String

Returns information on a specific connect instance by alias

instanceId String

Returns information on a specific connect instance by id

instanceAlias string

Returns information on a specific connect instance by alias

instanceId string

Returns information on a specific connect instance by id

instance_alias str

Returns information on a specific connect instance by alias

instance_id str

Returns information on a specific connect instance by id

instanceAlias String

Returns information on a specific connect instance by alias

instanceId String

Returns information on a specific connect instance by id

getInstance Result

The following output properties are available:

Arn string

The Amazon Resource Name (ARN) of the instance.

AutoResolveBestVoicesEnabled bool
ContactFlowLogsEnabled bool

Specifies Whether contact flow logs are enabled.

ContactLensEnabled bool

Specifies Whether contact lens is enabled.

CreatedTime string

Specifies When the instance was created.

EarlyMediaEnabled bool

Specifies Whether early media for outbound calls is enabled .

Id string

The provider-assigned unique ID for this managed resource.

IdentityManagementType string

Specifies The identity management type attached to the instance.

InboundCallsEnabled bool

Specifies Whether inbound calls are enabled.

InstanceAlias string
InstanceId string
OutboundCallsEnabled bool

Specifies Whether outbound calls are enabled.

ServiceRole string

The service role of the instance.

Status string

Specifies The state of the instance.

Arn string

The Amazon Resource Name (ARN) of the instance.

AutoResolveBestVoicesEnabled bool
ContactFlowLogsEnabled bool

Specifies Whether contact flow logs are enabled.

ContactLensEnabled bool

Specifies Whether contact lens is enabled.

CreatedTime string

Specifies When the instance was created.

EarlyMediaEnabled bool

Specifies Whether early media for outbound calls is enabled .

Id string

The provider-assigned unique ID for this managed resource.

IdentityManagementType string

Specifies The identity management type attached to the instance.

InboundCallsEnabled bool

Specifies Whether inbound calls are enabled.

InstanceAlias string
InstanceId string
OutboundCallsEnabled bool

Specifies Whether outbound calls are enabled.

ServiceRole string

The service role of the instance.

Status string

Specifies The state of the instance.

arn String

The Amazon Resource Name (ARN) of the instance.

autoResolveBestVoicesEnabled Boolean
contactFlowLogsEnabled Boolean

Specifies Whether contact flow logs are enabled.

contactLensEnabled Boolean

Specifies Whether contact lens is enabled.

createdTime String

Specifies When the instance was created.

earlyMediaEnabled Boolean

Specifies Whether early media for outbound calls is enabled .

id String

The provider-assigned unique ID for this managed resource.

identityManagementType String

Specifies The identity management type attached to the instance.

inboundCallsEnabled Boolean

Specifies Whether inbound calls are enabled.

instanceAlias String
instanceId String
outboundCallsEnabled Boolean

Specifies Whether outbound calls are enabled.

serviceRole String

The service role of the instance.

status String

Specifies The state of the instance.

arn string

The Amazon Resource Name (ARN) of the instance.

autoResolveBestVoicesEnabled boolean
contactFlowLogsEnabled boolean

Specifies Whether contact flow logs are enabled.

contactLensEnabled boolean

Specifies Whether contact lens is enabled.

createdTime string

Specifies When the instance was created.

earlyMediaEnabled boolean

Specifies Whether early media for outbound calls is enabled .

id string

The provider-assigned unique ID for this managed resource.

identityManagementType string

Specifies The identity management type attached to the instance.

inboundCallsEnabled boolean

Specifies Whether inbound calls are enabled.

instanceAlias string
instanceId string
outboundCallsEnabled boolean

Specifies Whether outbound calls are enabled.

serviceRole string

The service role of the instance.

status string

Specifies The state of the instance.

arn str

The Amazon Resource Name (ARN) of the instance.

auto_resolve_best_voices_enabled bool
contact_flow_logs_enabled bool

Specifies Whether contact flow logs are enabled.

contact_lens_enabled bool

Specifies Whether contact lens is enabled.

created_time str

Specifies When the instance was created.

early_media_enabled bool

Specifies Whether early media for outbound calls is enabled .

id str

The provider-assigned unique ID for this managed resource.

identity_management_type str

Specifies The identity management type attached to the instance.

inbound_calls_enabled bool

Specifies Whether inbound calls are enabled.

instance_alias str
instance_id str
outbound_calls_enabled bool

Specifies Whether outbound calls are enabled.

service_role str

The service role of the instance.

status str

Specifies The state of the instance.

arn String

The Amazon Resource Name (ARN) of the instance.

autoResolveBestVoicesEnabled Boolean
contactFlowLogsEnabled Boolean

Specifies Whether contact flow logs are enabled.

contactLensEnabled Boolean

Specifies Whether contact lens is enabled.

createdTime String

Specifies When the instance was created.

earlyMediaEnabled Boolean

Specifies Whether early media for outbound calls is enabled .

id String

The provider-assigned unique ID for this managed resource.

identityManagementType String

Specifies The identity management type attached to the instance.

inboundCallsEnabled Boolean

Specifies Whether inbound calls are enabled.

instanceAlias String
instanceId String
outboundCallsEnabled Boolean

Specifies Whether outbound calls are enabled.

serviceRole String

The service role of the instance.

status String

Specifies The state of the instance.

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.