github.com/pulumi/pulumi-aws/sdk/v6@v6.32.0/go/aws/connect/getQuickConnect.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 Quick Connect.
    15  //
    16  // ## Example Usage
    17  //
    18  // By `name`
    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.LookupQuickConnect(ctx, &connect.LookupQuickConnectArgs{
    34  //				InstanceId: "aaaaaaaa-bbbb-cccc-dddd-111111111111",
    35  //				Name:       pulumi.StringRef("Example"),
    36  //			}, nil)
    37  //			if err != nil {
    38  //				return err
    39  //			}
    40  //			return nil
    41  //		})
    42  //	}
    43  //
    44  // ```
    45  // <!--End PulumiCodeChooser -->
    46  //
    47  // By `quickConnectId`
    48  //
    49  // <!--Start PulumiCodeChooser -->
    50  // ```go
    51  // package main
    52  //
    53  // import (
    54  //
    55  //	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/connect"
    56  //	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    57  //
    58  // )
    59  //
    60  //	func main() {
    61  //		pulumi.Run(func(ctx *pulumi.Context) error {
    62  //			_, err := connect.LookupQuickConnect(ctx, &connect.LookupQuickConnectArgs{
    63  //				InstanceId:     "aaaaaaaa-bbbb-cccc-dddd-111111111111",
    64  //				QuickConnectId: pulumi.StringRef("cccccccc-bbbb-cccc-dddd-111111111111"),
    65  //			}, nil)
    66  //			if err != nil {
    67  //				return err
    68  //			}
    69  //			return nil
    70  //		})
    71  //	}
    72  //
    73  // ```
    74  // <!--End PulumiCodeChooser -->
    75  func LookupQuickConnect(ctx *pulumi.Context, args *LookupQuickConnectArgs, opts ...pulumi.InvokeOption) (*LookupQuickConnectResult, error) {
    76  	opts = internal.PkgInvokeDefaultOpts(opts)
    77  	var rv LookupQuickConnectResult
    78  	err := ctx.Invoke("aws:connect/getQuickConnect:getQuickConnect", args, &rv, opts...)
    79  	if err != nil {
    80  		return nil, err
    81  	}
    82  	return &rv, nil
    83  }
    84  
    85  // A collection of arguments for invoking getQuickConnect.
    86  type LookupQuickConnectArgs struct {
    87  	// Reference to the hosting Amazon Connect Instance
    88  	InstanceId string `pulumi:"instanceId"`
    89  	// Returns information on a specific Quick Connect by name
    90  	Name *string `pulumi:"name"`
    91  	// Returns information on a specific Quick Connect by Quick Connect id
    92  	QuickConnectId *string `pulumi:"quickConnectId"`
    93  	// Map of tags to assign to the Quick Connect.
    94  	Tags map[string]string `pulumi:"tags"`
    95  }
    96  
    97  // A collection of values returned by getQuickConnect.
    98  type LookupQuickConnectResult struct {
    99  	// ARN of the Quick Connect.
   100  	Arn string `pulumi:"arn"`
   101  	// Description of the Quick Connect.
   102  	Description string `pulumi:"description"`
   103  	// The provider-assigned unique ID for this managed resource.
   104  	Id         string `pulumi:"id"`
   105  	InstanceId string `pulumi:"instanceId"`
   106  	Name       string `pulumi:"name"`
   107  	// A block that defines the configuration information for the Quick Connect: `quickConnectType` and one of `phoneConfig`, `queueConfig`, `userConfig` . The Quick Connect Config block is documented below.
   108  	QuickConnectConfigs []GetQuickConnectQuickConnectConfig `pulumi:"quickConnectConfigs"`
   109  	// Identifier for the Quick Connect.
   110  	QuickConnectId string `pulumi:"quickConnectId"`
   111  	// Map of tags to assign to the Quick Connect.
   112  	Tags map[string]string `pulumi:"tags"`
   113  }
   114  
   115  func LookupQuickConnectOutput(ctx *pulumi.Context, args LookupQuickConnectOutputArgs, opts ...pulumi.InvokeOption) LookupQuickConnectResultOutput {
   116  	return pulumi.ToOutputWithContext(context.Background(), args).
   117  		ApplyT(func(v interface{}) (LookupQuickConnectResult, error) {
   118  			args := v.(LookupQuickConnectArgs)
   119  			r, err := LookupQuickConnect(ctx, &args, opts...)
   120  			var s LookupQuickConnectResult
   121  			if r != nil {
   122  				s = *r
   123  			}
   124  			return s, err
   125  		}).(LookupQuickConnectResultOutput)
   126  }
   127  
   128  // A collection of arguments for invoking getQuickConnect.
   129  type LookupQuickConnectOutputArgs struct {
   130  	// Reference to the hosting Amazon Connect Instance
   131  	InstanceId pulumi.StringInput `pulumi:"instanceId"`
   132  	// Returns information on a specific Quick Connect by name
   133  	Name pulumi.StringPtrInput `pulumi:"name"`
   134  	// Returns information on a specific Quick Connect by Quick Connect id
   135  	QuickConnectId pulumi.StringPtrInput `pulumi:"quickConnectId"`
   136  	// Map of tags to assign to the Quick Connect.
   137  	Tags pulumi.StringMapInput `pulumi:"tags"`
   138  }
   139  
   140  func (LookupQuickConnectOutputArgs) ElementType() reflect.Type {
   141  	return reflect.TypeOf((*LookupQuickConnectArgs)(nil)).Elem()
   142  }
   143  
   144  // A collection of values returned by getQuickConnect.
   145  type LookupQuickConnectResultOutput struct{ *pulumi.OutputState }
   146  
   147  func (LookupQuickConnectResultOutput) ElementType() reflect.Type {
   148  	return reflect.TypeOf((*LookupQuickConnectResult)(nil)).Elem()
   149  }
   150  
   151  func (o LookupQuickConnectResultOutput) ToLookupQuickConnectResultOutput() LookupQuickConnectResultOutput {
   152  	return o
   153  }
   154  
   155  func (o LookupQuickConnectResultOutput) ToLookupQuickConnectResultOutputWithContext(ctx context.Context) LookupQuickConnectResultOutput {
   156  	return o
   157  }
   158  
   159  // ARN of the Quick Connect.
   160  func (o LookupQuickConnectResultOutput) Arn() pulumi.StringOutput {
   161  	return o.ApplyT(func(v LookupQuickConnectResult) string { return v.Arn }).(pulumi.StringOutput)
   162  }
   163  
   164  // Description of the Quick Connect.
   165  func (o LookupQuickConnectResultOutput) Description() pulumi.StringOutput {
   166  	return o.ApplyT(func(v LookupQuickConnectResult) string { return v.Description }).(pulumi.StringOutput)
   167  }
   168  
   169  // The provider-assigned unique ID for this managed resource.
   170  func (o LookupQuickConnectResultOutput) Id() pulumi.StringOutput {
   171  	return o.ApplyT(func(v LookupQuickConnectResult) string { return v.Id }).(pulumi.StringOutput)
   172  }
   173  
   174  func (o LookupQuickConnectResultOutput) InstanceId() pulumi.StringOutput {
   175  	return o.ApplyT(func(v LookupQuickConnectResult) string { return v.InstanceId }).(pulumi.StringOutput)
   176  }
   177  
   178  func (o LookupQuickConnectResultOutput) Name() pulumi.StringOutput {
   179  	return o.ApplyT(func(v LookupQuickConnectResult) string { return v.Name }).(pulumi.StringOutput)
   180  }
   181  
   182  // A block that defines the configuration information for the Quick Connect: `quickConnectType` and one of `phoneConfig`, `queueConfig`, `userConfig` . The Quick Connect Config block is documented below.
   183  func (o LookupQuickConnectResultOutput) QuickConnectConfigs() GetQuickConnectQuickConnectConfigArrayOutput {
   184  	return o.ApplyT(func(v LookupQuickConnectResult) []GetQuickConnectQuickConnectConfig { return v.QuickConnectConfigs }).(GetQuickConnectQuickConnectConfigArrayOutput)
   185  }
   186  
   187  // Identifier for the Quick Connect.
   188  func (o LookupQuickConnectResultOutput) QuickConnectId() pulumi.StringOutput {
   189  	return o.ApplyT(func(v LookupQuickConnectResult) string { return v.QuickConnectId }).(pulumi.StringOutput)
   190  }
   191  
   192  // Map of tags to assign to the Quick Connect.
   193  func (o LookupQuickConnectResultOutput) Tags() pulumi.StringMapOutput {
   194  	return o.ApplyT(func(v LookupQuickConnectResult) map[string]string { return v.Tags }).(pulumi.StringMapOutput)
   195  }
   196  
   197  func init() {
   198  	pulumi.RegisterOutputType(LookupQuickConnectResultOutput{})
   199  }