github.com/pulumi/pulumi-aws/sdk/v6@v6.32.0/go/aws/sqs/getQueues.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 sqs
     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  // Data source for managing an AWS SQS (Simple Queue) Queues.
    15  //
    16  // ## Example Usage
    17  //
    18  // ### Basic Usage
    19  //
    20  // <!--Start PulumiCodeChooser -->
    21  // ```go
    22  // package main
    23  //
    24  // import (
    25  //
    26  //	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/sqs"
    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 := sqs.GetQueues(ctx, &sqs.GetQueuesArgs{
    34  //				QueueNamePrefix: pulumi.StringRef("example"),
    35  //			}, nil)
    36  //			if err != nil {
    37  //				return err
    38  //			}
    39  //			return nil
    40  //		})
    41  //	}
    42  //
    43  // ```
    44  // <!--End PulumiCodeChooser -->
    45  func GetQueues(ctx *pulumi.Context, args *GetQueuesArgs, opts ...pulumi.InvokeOption) (*GetQueuesResult, error) {
    46  	opts = internal.PkgInvokeDefaultOpts(opts)
    47  	var rv GetQueuesResult
    48  	err := ctx.Invoke("aws:sqs/getQueues:getQueues", args, &rv, opts...)
    49  	if err != nil {
    50  		return nil, err
    51  	}
    52  	return &rv, nil
    53  }
    54  
    55  // A collection of arguments for invoking getQueues.
    56  type GetQueuesArgs struct {
    57  	// A string to use for filtering the list results. Only those queues whose name begins with the specified string are returned. Queue URLs and names are case-sensitive.
    58  	QueueNamePrefix *string `pulumi:"queueNamePrefix"`
    59  }
    60  
    61  // A collection of values returned by getQueues.
    62  type GetQueuesResult struct {
    63  	// The provider-assigned unique ID for this managed resource.
    64  	Id              string  `pulumi:"id"`
    65  	QueueNamePrefix *string `pulumi:"queueNamePrefix"`
    66  	// A list of queue URLs.
    67  	QueueUrls []string `pulumi:"queueUrls"`
    68  }
    69  
    70  func GetQueuesOutput(ctx *pulumi.Context, args GetQueuesOutputArgs, opts ...pulumi.InvokeOption) GetQueuesResultOutput {
    71  	return pulumi.ToOutputWithContext(context.Background(), args).
    72  		ApplyT(func(v interface{}) (GetQueuesResult, error) {
    73  			args := v.(GetQueuesArgs)
    74  			r, err := GetQueues(ctx, &args, opts...)
    75  			var s GetQueuesResult
    76  			if r != nil {
    77  				s = *r
    78  			}
    79  			return s, err
    80  		}).(GetQueuesResultOutput)
    81  }
    82  
    83  // A collection of arguments for invoking getQueues.
    84  type GetQueuesOutputArgs struct {
    85  	// A string to use for filtering the list results. Only those queues whose name begins with the specified string are returned. Queue URLs and names are case-sensitive.
    86  	QueueNamePrefix pulumi.StringPtrInput `pulumi:"queueNamePrefix"`
    87  }
    88  
    89  func (GetQueuesOutputArgs) ElementType() reflect.Type {
    90  	return reflect.TypeOf((*GetQueuesArgs)(nil)).Elem()
    91  }
    92  
    93  // A collection of values returned by getQueues.
    94  type GetQueuesResultOutput struct{ *pulumi.OutputState }
    95  
    96  func (GetQueuesResultOutput) ElementType() reflect.Type {
    97  	return reflect.TypeOf((*GetQueuesResult)(nil)).Elem()
    98  }
    99  
   100  func (o GetQueuesResultOutput) ToGetQueuesResultOutput() GetQueuesResultOutput {
   101  	return o
   102  }
   103  
   104  func (o GetQueuesResultOutput) ToGetQueuesResultOutputWithContext(ctx context.Context) GetQueuesResultOutput {
   105  	return o
   106  }
   107  
   108  // The provider-assigned unique ID for this managed resource.
   109  func (o GetQueuesResultOutput) Id() pulumi.StringOutput {
   110  	return o.ApplyT(func(v GetQueuesResult) string { return v.Id }).(pulumi.StringOutput)
   111  }
   112  
   113  func (o GetQueuesResultOutput) QueueNamePrefix() pulumi.StringPtrOutput {
   114  	return o.ApplyT(func(v GetQueuesResult) *string { return v.QueueNamePrefix }).(pulumi.StringPtrOutput)
   115  }
   116  
   117  // A list of queue URLs.
   118  func (o GetQueuesResultOutput) QueueUrls() pulumi.StringArrayOutput {
   119  	return o.ApplyT(func(v GetQueuesResult) []string { return v.QueueUrls }).(pulumi.StringArrayOutput)
   120  }
   121  
   122  func init() {
   123  	pulumi.RegisterOutputType(GetQueuesResultOutput{})
   124  }