github.com/pulumi/pulumi-aws/sdk/v6@v6.32.0/go/aws/kinesis/getStreamConsumer.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 kinesis
     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 Kinesis Stream Consumer.
    15  //
    16  // For more details, see the [Amazon Kinesis Stream Consumer Documentation](https://docs.aws.amazon.com/streams/latest/dev/amazon-kinesis-consumers.html).
    17  //
    18  // ## Example Usage
    19  //
    20  // <!--Start PulumiCodeChooser -->
    21  // ```go
    22  // package main
    23  //
    24  // import (
    25  //
    26  //	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/kinesis"
    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 := kinesis.LookupStreamConsumer(ctx, &kinesis.LookupStreamConsumerArgs{
    34  //				Name:      pulumi.StringRef("example-consumer"),
    35  //				StreamArn: exampleAwsKinesisStream.Arn,
    36  //			}, nil)
    37  //			if err != nil {
    38  //				return err
    39  //			}
    40  //			return nil
    41  //		})
    42  //	}
    43  //
    44  // ```
    45  // <!--End PulumiCodeChooser -->
    46  func LookupStreamConsumer(ctx *pulumi.Context, args *LookupStreamConsumerArgs, opts ...pulumi.InvokeOption) (*LookupStreamConsumerResult, error) {
    47  	opts = internal.PkgInvokeDefaultOpts(opts)
    48  	var rv LookupStreamConsumerResult
    49  	err := ctx.Invoke("aws:kinesis/getStreamConsumer:getStreamConsumer", args, &rv, opts...)
    50  	if err != nil {
    51  		return nil, err
    52  	}
    53  	return &rv, nil
    54  }
    55  
    56  // A collection of arguments for invoking getStreamConsumer.
    57  type LookupStreamConsumerArgs struct {
    58  	// ARN of the stream consumer.
    59  	Arn *string `pulumi:"arn"`
    60  	// Name of the stream consumer.
    61  	Name *string `pulumi:"name"`
    62  	// ARN of the data stream the consumer is registered with.
    63  	StreamArn string `pulumi:"streamArn"`
    64  }
    65  
    66  // A collection of values returned by getStreamConsumer.
    67  type LookupStreamConsumerResult struct {
    68  	Arn string `pulumi:"arn"`
    69  	// Approximate timestamp in [RFC3339 format](https://tools.ietf.org/html/rfc3339#section-5.8) of when the stream consumer was created.
    70  	CreationTimestamp string `pulumi:"creationTimestamp"`
    71  	// The provider-assigned unique ID for this managed resource.
    72  	Id   string `pulumi:"id"`
    73  	Name string `pulumi:"name"`
    74  	// Current status of the stream consumer.
    75  	Status    string `pulumi:"status"`
    76  	StreamArn string `pulumi:"streamArn"`
    77  }
    78  
    79  func LookupStreamConsumerOutput(ctx *pulumi.Context, args LookupStreamConsumerOutputArgs, opts ...pulumi.InvokeOption) LookupStreamConsumerResultOutput {
    80  	return pulumi.ToOutputWithContext(context.Background(), args).
    81  		ApplyT(func(v interface{}) (LookupStreamConsumerResult, error) {
    82  			args := v.(LookupStreamConsumerArgs)
    83  			r, err := LookupStreamConsumer(ctx, &args, opts...)
    84  			var s LookupStreamConsumerResult
    85  			if r != nil {
    86  				s = *r
    87  			}
    88  			return s, err
    89  		}).(LookupStreamConsumerResultOutput)
    90  }
    91  
    92  // A collection of arguments for invoking getStreamConsumer.
    93  type LookupStreamConsumerOutputArgs struct {
    94  	// ARN of the stream consumer.
    95  	Arn pulumi.StringPtrInput `pulumi:"arn"`
    96  	// Name of the stream consumer.
    97  	Name pulumi.StringPtrInput `pulumi:"name"`
    98  	// ARN of the data stream the consumer is registered with.
    99  	StreamArn pulumi.StringInput `pulumi:"streamArn"`
   100  }
   101  
   102  func (LookupStreamConsumerOutputArgs) ElementType() reflect.Type {
   103  	return reflect.TypeOf((*LookupStreamConsumerArgs)(nil)).Elem()
   104  }
   105  
   106  // A collection of values returned by getStreamConsumer.
   107  type LookupStreamConsumerResultOutput struct{ *pulumi.OutputState }
   108  
   109  func (LookupStreamConsumerResultOutput) ElementType() reflect.Type {
   110  	return reflect.TypeOf((*LookupStreamConsumerResult)(nil)).Elem()
   111  }
   112  
   113  func (o LookupStreamConsumerResultOutput) ToLookupStreamConsumerResultOutput() LookupStreamConsumerResultOutput {
   114  	return o
   115  }
   116  
   117  func (o LookupStreamConsumerResultOutput) ToLookupStreamConsumerResultOutputWithContext(ctx context.Context) LookupStreamConsumerResultOutput {
   118  	return o
   119  }
   120  
   121  func (o LookupStreamConsumerResultOutput) Arn() pulumi.StringOutput {
   122  	return o.ApplyT(func(v LookupStreamConsumerResult) string { return v.Arn }).(pulumi.StringOutput)
   123  }
   124  
   125  // Approximate timestamp in [RFC3339 format](https://tools.ietf.org/html/rfc3339#section-5.8) of when the stream consumer was created.
   126  func (o LookupStreamConsumerResultOutput) CreationTimestamp() pulumi.StringOutput {
   127  	return o.ApplyT(func(v LookupStreamConsumerResult) string { return v.CreationTimestamp }).(pulumi.StringOutput)
   128  }
   129  
   130  // The provider-assigned unique ID for this managed resource.
   131  func (o LookupStreamConsumerResultOutput) Id() pulumi.StringOutput {
   132  	return o.ApplyT(func(v LookupStreamConsumerResult) string { return v.Id }).(pulumi.StringOutput)
   133  }
   134  
   135  func (o LookupStreamConsumerResultOutput) Name() pulumi.StringOutput {
   136  	return o.ApplyT(func(v LookupStreamConsumerResult) string { return v.Name }).(pulumi.StringOutput)
   137  }
   138  
   139  // Current status of the stream consumer.
   140  func (o LookupStreamConsumerResultOutput) Status() pulumi.StringOutput {
   141  	return o.ApplyT(func(v LookupStreamConsumerResult) string { return v.Status }).(pulumi.StringOutput)
   142  }
   143  
   144  func (o LookupStreamConsumerResultOutput) StreamArn() pulumi.StringOutput {
   145  	return o.ApplyT(func(v LookupStreamConsumerResult) string { return v.StreamArn }).(pulumi.StringOutput)
   146  }
   147  
   148  func init() {
   149  	pulumi.RegisterOutputType(LookupStreamConsumerResultOutput{})
   150  }