1. Packages
  2. AWS Classic
  3. API Docs
  4. connect
  5. getInstance

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.13.0 published on Saturday, Dec 2, 2023 by Pulumi

aws.connect.getInstance

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.13.0 published on Saturday, Dec 2, 2023 by Pulumi

    Provides details about a specific Amazon Connect Instance.

    Example Usage

    By instance_

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var foo = Aws.Connect.GetInstance.Invoke(new()
        {
            InstanceAlias = "foo",
        });
    
    });
    
    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.LookupInstance(ctx, &connect.LookupInstanceArgs{
    			InstanceAlias: pulumi.StringRef("foo"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    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.GetInstanceArgs;
    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 foo = 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 = aws.connect.getInstance({
        instanceAlias: "foo",
    });
    
    variables:
      foo:
        fn::invoke:
          Function: aws:connect:getInstance
          Arguments:
            instanceAlias: foo
    

    id

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var foo = Aws.Connect.GetInstance.Invoke(new()
        {
            InstanceId = "97afc98d-101a-ba98-ab97-ae114fc115ec",
        });
    
    });
    
    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.LookupInstance(ctx, &connect.LookupInstanceArgs{
    			InstanceId: pulumi.StringRef("97afc98d-101a-ba98-ab97-ae114fc115ec"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    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.GetInstanceArgs;
    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 foo = ConnectFunctions.getInstance(GetInstanceArgs.builder()
                .instanceId("97afc98d-101a-ba98-ab97-ae114fc115ec")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_aws as aws
    
    foo = aws.connect.get_instance(instance_id="97afc98d-101a-ba98-ab97-ae114fc115ec")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const foo = aws.connect.getInstance({
        instanceId: "97afc98d-101a-ba98-ab97-ae114fc115ec",
    });
    
    variables:
      foo:
        fn::invoke:
          Function: aws:connect:getInstance
          Arguments:
            instanceId: 97afc98d-101a-ba98-ab97-ae114fc115ec
    

    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

    ARN of the instance.

    AutoResolveBestVoicesEnabled bool
    ContactFlowLogsEnabled bool

    Whether contact flow logs are enabled.

    ContactLensEnabled bool

    Whether contact lens is enabled.

    CreatedTime string

    When the instance was created.

    EarlyMediaEnabled bool

    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

    Whether inbound calls are enabled.

    InstanceAlias string
    InstanceId string
    MultiPartyConferenceEnabled bool

    Whether multi-party calls/conference is enabled.

    OutboundCallsEnabled bool

    Whether outbound calls are enabled.

    ServiceRole string

    Service role of the instance.

    Status string

    State of the instance.

    Arn string

    ARN of the instance.

    AutoResolveBestVoicesEnabled bool
    ContactFlowLogsEnabled bool

    Whether contact flow logs are enabled.

    ContactLensEnabled bool

    Whether contact lens is enabled.

    CreatedTime string

    When the instance was created.

    EarlyMediaEnabled bool

    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

    Whether inbound calls are enabled.

    InstanceAlias string
    InstanceId string
    MultiPartyConferenceEnabled bool

    Whether multi-party calls/conference is enabled.

    OutboundCallsEnabled bool

    Whether outbound calls are enabled.

    ServiceRole string

    Service role of the instance.

    Status string

    State of the instance.

    arn String

    ARN of the instance.

    autoResolveBestVoicesEnabled Boolean
    contactFlowLogsEnabled Boolean

    Whether contact flow logs are enabled.

    contactLensEnabled Boolean

    Whether contact lens is enabled.

    createdTime String

    When the instance was created.

    earlyMediaEnabled Boolean

    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

    Whether inbound calls are enabled.

    instanceAlias String
    instanceId String
    multiPartyConferenceEnabled Boolean

    Whether multi-party calls/conference is enabled.

    outboundCallsEnabled Boolean

    Whether outbound calls are enabled.

    serviceRole String

    Service role of the instance.

    status String

    State of the instance.

    arn string

    ARN of the instance.

    autoResolveBestVoicesEnabled boolean
    contactFlowLogsEnabled boolean

    Whether contact flow logs are enabled.

    contactLensEnabled boolean

    Whether contact lens is enabled.

    createdTime string

    When the instance was created.

    earlyMediaEnabled boolean

    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

    Whether inbound calls are enabled.

    instanceAlias string
    instanceId string
    multiPartyConferenceEnabled boolean

    Whether multi-party calls/conference is enabled.

    outboundCallsEnabled boolean

    Whether outbound calls are enabled.

    serviceRole string

    Service role of the instance.

    status string

    State of the instance.

    arn str

    ARN of the instance.

    auto_resolve_best_voices_enabled bool
    contact_flow_logs_enabled bool

    Whether contact flow logs are enabled.

    contact_lens_enabled bool

    Whether contact lens is enabled.

    created_time str

    When the instance was created.

    early_media_enabled bool

    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

    Whether inbound calls are enabled.

    instance_alias str
    instance_id str
    multi_party_conference_enabled bool

    Whether multi-party calls/conference is enabled.

    outbound_calls_enabled bool

    Whether outbound calls are enabled.

    service_role str

    Service role of the instance.

    status str

    State of the instance.

    arn String

    ARN of the instance.

    autoResolveBestVoicesEnabled Boolean
    contactFlowLogsEnabled Boolean

    Whether contact flow logs are enabled.

    contactLensEnabled Boolean

    Whether contact lens is enabled.

    createdTime String

    When the instance was created.

    earlyMediaEnabled Boolean

    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

    Whether inbound calls are enabled.

    instanceAlias String
    instanceId String
    multiPartyConferenceEnabled Boolean

    Whether multi-party calls/conference is enabled.

    outboundCallsEnabled Boolean

    Whether outbound calls are enabled.

    serviceRole String

    Service role of the instance.

    status String

    State of the instance.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the aws Terraform Provider.

    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.13.0 published on Saturday, Dec 2, 2023 by Pulumi