Try AWS Native preview for resources not in the classic version.
AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi
aws.kinesis.getStreamConsumer
Explore with Pulumi AI
Try AWS Native preview for resources not in the classic version.
AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi
Provides details about a Kinesis Stream Consumer.
For more details, see the Amazon Kinesis Stream Consumer Documentation.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = aws.kinesis.getStreamConsumer({
name: "example-consumer",
streamArn: exampleAwsKinesisStream.arn,
});
import pulumi
import pulumi_aws as aws
example = aws.kinesis.get_stream_consumer(name="example-consumer",
stream_arn=example_aws_kinesis_stream["arn"])
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/kinesis"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := kinesis.LookupStreamConsumer(ctx, &kinesis.LookupStreamConsumerArgs{
Name: pulumi.StringRef("example-consumer"),
StreamArn: exampleAwsKinesisStream.Arn,
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = Aws.Kinesis.GetStreamConsumer.Invoke(new()
{
Name = "example-consumer",
StreamArn = exampleAwsKinesisStream.Arn,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.kinesis.KinesisFunctions;
import com.pulumi.aws.kinesis.inputs.GetStreamConsumerArgs;
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 example = KinesisFunctions.getStreamConsumer(GetStreamConsumerArgs.builder()
.name("example-consumer")
.streamArn(exampleAwsKinesisStream.arn())
.build());
}
}
variables:
example:
fn::invoke:
Function: aws:kinesis:getStreamConsumer
Arguments:
name: example-consumer
streamArn: ${exampleAwsKinesisStream.arn}
Using getStreamConsumer
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 getStreamConsumer(args: GetStreamConsumerArgs, opts?: InvokeOptions): Promise<GetStreamConsumerResult>
function getStreamConsumerOutput(args: GetStreamConsumerOutputArgs, opts?: InvokeOptions): Output<GetStreamConsumerResult>
def get_stream_consumer(arn: Optional[str] = None,
name: Optional[str] = None,
stream_arn: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetStreamConsumerResult
def get_stream_consumer_output(arn: Optional[pulumi.Input[str]] = None,
name: Optional[pulumi.Input[str]] = None,
stream_arn: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetStreamConsumerResult]
func LookupStreamConsumer(ctx *Context, args *LookupStreamConsumerArgs, opts ...InvokeOption) (*LookupStreamConsumerResult, error)
func LookupStreamConsumerOutput(ctx *Context, args *LookupStreamConsumerOutputArgs, opts ...InvokeOption) LookupStreamConsumerResultOutput
> Note: This function is named LookupStreamConsumer
in the Go SDK.
public static class GetStreamConsumer
{
public static Task<GetStreamConsumerResult> InvokeAsync(GetStreamConsumerArgs args, InvokeOptions? opts = null)
public static Output<GetStreamConsumerResult> Invoke(GetStreamConsumerInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetStreamConsumerResult> getStreamConsumer(GetStreamConsumerArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: aws:kinesis/getStreamConsumer:getStreamConsumer
arguments:
# arguments dictionary
The following arguments are supported:
- stream_
arn str - ARN of the data stream the consumer is registered with.
- arn str
- ARN of the stream consumer.
- name str
- Name of the stream consumer.
getStreamConsumer Result
The following output properties are available:
- Arn string
- Creation
Timestamp string - Approximate timestamp in RFC3339 format of when the stream consumer was created.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- Status string
- Current status of the stream consumer.
- Stream
Arn string
- Arn string
- Creation
Timestamp string - Approximate timestamp in RFC3339 format of when the stream consumer was created.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- Status string
- Current status of the stream consumer.
- Stream
Arn string
- arn String
- creation
Timestamp String - Approximate timestamp in RFC3339 format of when the stream consumer was created.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- status String
- Current status of the stream consumer.
- stream
Arn String
- arn string
- creation
Timestamp string - Approximate timestamp in RFC3339 format of when the stream consumer was created.
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- status string
- Current status of the stream consumer.
- stream
Arn string
- arn str
- creation_
timestamp str - Approximate timestamp in RFC3339 format of when the stream consumer was created.
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- status str
- Current status of the stream consumer.
- stream_
arn str
- arn String
- creation
Timestamp String - Approximate timestamp in RFC3339 format of when the stream consumer was created.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- status String
- Current status of the stream consumer.
- stream
Arn String
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
aws
Terraform Provider.
Try AWS Native preview for resources not in the classic version.
AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi