@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
110 lines (109 loc) • 3.35 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides details about a Kinesis Stream Consumer.
*
* For more details, see the [Amazon Kinesis Stream Consumer Documentation](https://docs.aws.amazon.com/streams/latest/dev/amazon-kinesis-consumers.html).
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = aws.kinesis.getStreamConsumer({
* name: "example-consumer",
* streamArn: exampleAwsKinesisStream.arn,
* });
* ```
*/
export declare function getStreamConsumer(args: GetStreamConsumerArgs, opts?: pulumi.InvokeOptions): Promise<GetStreamConsumerResult>;
/**
* A collection of arguments for invoking getStreamConsumer.
*/
export interface GetStreamConsumerArgs {
/**
* ARN of the stream consumer.
*/
arn?: string;
/**
* Name of the stream consumer.
*/
name?: string;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: string;
/**
* ARN of the data stream the consumer is registered with.
*/
streamArn: string;
tags?: {
[key: string]: string;
};
}
/**
* A collection of values returned by getStreamConsumer.
*/
export interface GetStreamConsumerResult {
readonly arn: string;
/**
* Approximate timestamp in [RFC3339 format](https://tools.ietf.org/html/rfc3339#section-5.8) of when the stream consumer was created.
*/
readonly creationTimestamp: string;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
readonly name: string;
readonly region: string;
/**
* Current status of the stream consumer.
*/
readonly status: string;
readonly streamArn: string;
readonly tags: {
[key: string]: string;
};
}
/**
* Provides details about a Kinesis Stream Consumer.
*
* For more details, see the [Amazon Kinesis Stream Consumer Documentation](https://docs.aws.amazon.com/streams/latest/dev/amazon-kinesis-consumers.html).
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = aws.kinesis.getStreamConsumer({
* name: "example-consumer",
* streamArn: exampleAwsKinesisStream.arn,
* });
* ```
*/
export declare function getStreamConsumerOutput(args: GetStreamConsumerOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetStreamConsumerResult>;
/**
* A collection of arguments for invoking getStreamConsumer.
*/
export interface GetStreamConsumerOutputArgs {
/**
* ARN of the stream consumer.
*/
arn?: pulumi.Input<string>;
/**
* Name of the stream consumer.
*/
name?: pulumi.Input<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
/**
* ARN of the data stream the consumer is registered with.
*/
streamArn: pulumi.Input<string>;
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}