github.com/pulumi/pulumi-aws/sdk/v6@v6.32.0/go/aws/connect/getInstance.go (about)

     1  // Code generated by the Pulumi Terraform Bridge (tfgen) Tool DO NOT EDIT.
     2  // *** WARNING: Do not edit by hand unless you're certain you know what you are doing! ***
     3  
     4  package connect
     5  
     6  import (
     7  	"context"
     8  	"reflect"
     9  
    10  	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/internal"
    11  	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    12  )
    13  
    14  // Provides details about a specific Amazon Connect Instance.
    15  //
    16  // ## Example Usage
    17  //
    18  // # By instanceAlias
    19  //
    20  // <!--Start PulumiCodeChooser -->
    21  // ```go
    22  // package main
    23  //
    24  // import (
    25  //
    26  //	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/connect"
    27  //	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    28  //
    29  // )
    30  //
    31  //	func main() {
    32  //		pulumi.Run(func(ctx *pulumi.Context) error {
    33  //			_, err := connect.LookupInstance(ctx, &connect.LookupInstanceArgs{
    34  //				InstanceAlias: pulumi.StringRef("foo"),
    35  //			}, nil)
    36  //			if err != nil {
    37  //				return err
    38  //			}
    39  //			return nil
    40  //		})
    41  //	}
    42  //
    43  // ```
    44  // <!--End PulumiCodeChooser -->
    45  //
    46  // # By instanceId
    47  //
    48  // <!--Start PulumiCodeChooser -->
    49  // ```go
    50  // package main
    51  //
    52  // import (
    53  //
    54  //	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/connect"
    55  //	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    56  //
    57  // )
    58  //
    59  //	func main() {
    60  //		pulumi.Run(func(ctx *pulumi.Context) error {
    61  //			_, err := connect.LookupInstance(ctx, &connect.LookupInstanceArgs{
    62  //				InstanceId: pulumi.StringRef("97afc98d-101a-ba98-ab97-ae114fc115ec"),
    63  //			}, nil)
    64  //			if err != nil {
    65  //				return err
    66  //			}
    67  //			return nil
    68  //		})
    69  //	}
    70  //
    71  // ```
    72  // <!--End PulumiCodeChooser -->
    73  func LookupInstance(ctx *pulumi.Context, args *LookupInstanceArgs, opts ...pulumi.InvokeOption) (*LookupInstanceResult, error) {
    74  	opts = internal.PkgInvokeDefaultOpts(opts)
    75  	var rv LookupInstanceResult
    76  	err := ctx.Invoke("aws:connect/getInstance:getInstance", args, &rv, opts...)
    77  	if err != nil {
    78  		return nil, err
    79  	}
    80  	return &rv, nil
    81  }
    82  
    83  // A collection of arguments for invoking getInstance.
    84  type LookupInstanceArgs struct {
    85  	// Returns information on a specific connect instance by alias
    86  	InstanceAlias *string `pulumi:"instanceAlias"`
    87  	// Returns information on a specific connect instance by id
    88  	InstanceId *string `pulumi:"instanceId"`
    89  }
    90  
    91  // A collection of values returned by getInstance.
    92  type LookupInstanceResult struct {
    93  	// ARN of the instance.
    94  	Arn                          string `pulumi:"arn"`
    95  	AutoResolveBestVoicesEnabled bool   `pulumi:"autoResolveBestVoicesEnabled"`
    96  	// Whether contact flow logs are enabled.
    97  	ContactFlowLogsEnabled bool `pulumi:"contactFlowLogsEnabled"`
    98  	// Whether contact lens is enabled.
    99  	ContactLensEnabled bool `pulumi:"contactLensEnabled"`
   100  	// When the instance was created.
   101  	CreatedTime string `pulumi:"createdTime"`
   102  	// Whether early media for outbound calls is enabled .
   103  	EarlyMediaEnabled bool `pulumi:"earlyMediaEnabled"`
   104  	// The provider-assigned unique ID for this managed resource.
   105  	Id string `pulumi:"id"`
   106  	// Specifies The identity management type attached to the instance.
   107  	IdentityManagementType string `pulumi:"identityManagementType"`
   108  	// Whether inbound calls are enabled.
   109  	InboundCallsEnabled bool   `pulumi:"inboundCallsEnabled"`
   110  	InstanceAlias       string `pulumi:"instanceAlias"`
   111  	InstanceId          string `pulumi:"instanceId"`
   112  	// Whether multi-party calls/conference is enabled.
   113  	MultiPartyConferenceEnabled bool `pulumi:"multiPartyConferenceEnabled"`
   114  	// Whether outbound calls are enabled.
   115  	OutboundCallsEnabled bool `pulumi:"outboundCallsEnabled"`
   116  	// Service role of the instance.
   117  	ServiceRole string `pulumi:"serviceRole"`
   118  	// State of the instance.
   119  	Status string `pulumi:"status"`
   120  }
   121  
   122  func LookupInstanceOutput(ctx *pulumi.Context, args LookupInstanceOutputArgs, opts ...pulumi.InvokeOption) LookupInstanceResultOutput {
   123  	return pulumi.ToOutputWithContext(context.Background(), args).
   124  		ApplyT(func(v interface{}) (LookupInstanceResult, error) {
   125  			args := v.(LookupInstanceArgs)
   126  			r, err := LookupInstance(ctx, &args, opts...)
   127  			var s LookupInstanceResult
   128  			if r != nil {
   129  				s = *r
   130  			}
   131  			return s, err
   132  		}).(LookupInstanceResultOutput)
   133  }
   134  
   135  // A collection of arguments for invoking getInstance.
   136  type LookupInstanceOutputArgs struct {
   137  	// Returns information on a specific connect instance by alias
   138  	InstanceAlias pulumi.StringPtrInput `pulumi:"instanceAlias"`
   139  	// Returns information on a specific connect instance by id
   140  	InstanceId pulumi.StringPtrInput `pulumi:"instanceId"`
   141  }
   142  
   143  func (LookupInstanceOutputArgs) ElementType() reflect.Type {
   144  	return reflect.TypeOf((*LookupInstanceArgs)(nil)).Elem()
   145  }
   146  
   147  // A collection of values returned by getInstance.
   148  type LookupInstanceResultOutput struct{ *pulumi.OutputState }
   149  
   150  func (LookupInstanceResultOutput) ElementType() reflect.Type {
   151  	return reflect.TypeOf((*LookupInstanceResult)(nil)).Elem()
   152  }
   153  
   154  func (o LookupInstanceResultOutput) ToLookupInstanceResultOutput() LookupInstanceResultOutput {
   155  	return o
   156  }
   157  
   158  func (o LookupInstanceResultOutput) ToLookupInstanceResultOutputWithContext(ctx context.Context) LookupInstanceResultOutput {
   159  	return o
   160  }
   161  
   162  // ARN of the instance.
   163  func (o LookupInstanceResultOutput) Arn() pulumi.StringOutput {
   164  	return o.ApplyT(func(v LookupInstanceResult) string { return v.Arn }).(pulumi.StringOutput)
   165  }
   166  
   167  func (o LookupInstanceResultOutput) AutoResolveBestVoicesEnabled() pulumi.BoolOutput {
   168  	return o.ApplyT(func(v LookupInstanceResult) bool { return v.AutoResolveBestVoicesEnabled }).(pulumi.BoolOutput)
   169  }
   170  
   171  // Whether contact flow logs are enabled.
   172  func (o LookupInstanceResultOutput) ContactFlowLogsEnabled() pulumi.BoolOutput {
   173  	return o.ApplyT(func(v LookupInstanceResult) bool { return v.ContactFlowLogsEnabled }).(pulumi.BoolOutput)
   174  }
   175  
   176  // Whether contact lens is enabled.
   177  func (o LookupInstanceResultOutput) ContactLensEnabled() pulumi.BoolOutput {
   178  	return o.ApplyT(func(v LookupInstanceResult) bool { return v.ContactLensEnabled }).(pulumi.BoolOutput)
   179  }
   180  
   181  // When the instance was created.
   182  func (o LookupInstanceResultOutput) CreatedTime() pulumi.StringOutput {
   183  	return o.ApplyT(func(v LookupInstanceResult) string { return v.CreatedTime }).(pulumi.StringOutput)
   184  }
   185  
   186  // Whether early media for outbound calls is enabled .
   187  func (o LookupInstanceResultOutput) EarlyMediaEnabled() pulumi.BoolOutput {
   188  	return o.ApplyT(func(v LookupInstanceResult) bool { return v.EarlyMediaEnabled }).(pulumi.BoolOutput)
   189  }
   190  
   191  // The provider-assigned unique ID for this managed resource.
   192  func (o LookupInstanceResultOutput) Id() pulumi.StringOutput {
   193  	return o.ApplyT(func(v LookupInstanceResult) string { return v.Id }).(pulumi.StringOutput)
   194  }
   195  
   196  // Specifies The identity management type attached to the instance.
   197  func (o LookupInstanceResultOutput) IdentityManagementType() pulumi.StringOutput {
   198  	return o.ApplyT(func(v LookupInstanceResult) string { return v.IdentityManagementType }).(pulumi.StringOutput)
   199  }
   200  
   201  // Whether inbound calls are enabled.
   202  func (o LookupInstanceResultOutput) InboundCallsEnabled() pulumi.BoolOutput {
   203  	return o.ApplyT(func(v LookupInstanceResult) bool { return v.InboundCallsEnabled }).(pulumi.BoolOutput)
   204  }
   205  
   206  func (o LookupInstanceResultOutput) InstanceAlias() pulumi.StringOutput {
   207  	return o.ApplyT(func(v LookupInstanceResult) string { return v.InstanceAlias }).(pulumi.StringOutput)
   208  }
   209  
   210  func (o LookupInstanceResultOutput) InstanceId() pulumi.StringOutput {
   211  	return o.ApplyT(func(v LookupInstanceResult) string { return v.InstanceId }).(pulumi.StringOutput)
   212  }
   213  
   214  // Whether multi-party calls/conference is enabled.
   215  func (o LookupInstanceResultOutput) MultiPartyConferenceEnabled() pulumi.BoolOutput {
   216  	return o.ApplyT(func(v LookupInstanceResult) bool { return v.MultiPartyConferenceEnabled }).(pulumi.BoolOutput)
   217  }
   218  
   219  // Whether outbound calls are enabled.
   220  func (o LookupInstanceResultOutput) OutboundCallsEnabled() pulumi.BoolOutput {
   221  	return o.ApplyT(func(v LookupInstanceResult) bool { return v.OutboundCallsEnabled }).(pulumi.BoolOutput)
   222  }
   223  
   224  // Service role of the instance.
   225  func (o LookupInstanceResultOutput) ServiceRole() pulumi.StringOutput {
   226  	return o.ApplyT(func(v LookupInstanceResult) string { return v.ServiceRole }).(pulumi.StringOutput)
   227  }
   228  
   229  // State of the instance.
   230  func (o LookupInstanceResultOutput) Status() pulumi.StringOutput {
   231  	return o.ApplyT(func(v LookupInstanceResult) string { return v.Status }).(pulumi.StringOutput)
   232  }
   233  
   234  func init() {
   235  	pulumi.RegisterOutputType(LookupInstanceResultOutput{})
   236  }