@pulumi/aws/kinesis/getStream.d.ts

A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
 * Use this data source to get information about a Kinesis Stream for use in other
 * resources.
 *
 * For more details, see the [Amazon Kinesis Documentation](https://aws.amazon.com/documentation/kinesis/).
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const stream = aws.kinesis.getStream({
 *     name: "stream-name",
 * });
 * ```
 */
export declare function getStream(args: GetStreamArgs, opts?: pulumi.InvokeOptions): Promise<GetStreamResult>;
/**
 * A collection of arguments for invoking getStream.
 */
export interface GetStreamArgs {
    /**
     * Name of the Kinesis Stream.
     */
    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;
    /**
     * Map of tags to assigned to the stream.
     */
    tags?: {
        [key: string]: string;
    };
}
/**
 * A collection of values returned by getStream.
 */
export interface GetStreamResult {
    /**
     * ARN of the Kinesis Stream (same as `id`).
     */
    readonly arn: string;
    /**
     * List of shard ids in the CLOSED state. See [Shard State](https://docs.aws.amazon.com/streams/latest/dev/kinesis-using-sdk-java-after-resharding.html#kinesis-using-sdk-java-resharding-data-routing) for more.
     */
    readonly closedShards: string[];
    /**
     * Approximate UNIX timestamp that the stream was created.
     */
    readonly creationTimestamp: number;
    /**
     * Encryption type used.
     */
    readonly encryptionType: string;
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    /**
     * GUID for the customer-managed AWS KMS key to use for encryption.
     */
    readonly kmsKeyId: string;
    /**
     * The maximum size for a single data record in KiB.
     */
    readonly maxRecordSizeInKib: number;
    /**
     * Name of the Kinesis Stream.
     */
    readonly name: string;
    /**
     * List of shard ids in the OPEN state. See [Shard State](https://docs.aws.amazon.com/streams/latest/dev/kinesis-using-sdk-java-after-resharding.html#kinesis-using-sdk-java-resharding-data-routing) for more.
     */
    readonly openShards: string[];
    readonly region: string;
    /**
     * Length of time (in hours) data records are accessible after they are added to the stream.
     */
    readonly retentionPeriod: number;
    /**
     * List of shard-level CloudWatch metrics which are enabled for the stream. See [Monitoring with CloudWatch](https://docs.aws.amazon.com/streams/latest/dev/monitoring-with-cloudwatch.html) for more.
     */
    readonly shardLevelMetrics: string[];
    /**
     * Current status of the stream. The stream status is one of CREATING, DELETING, ACTIVE, or UPDATING.
     */
    readonly status: string;
    /**
     * [Capacity mode](https://docs.aws.amazon.com/streams/latest/dev/how-do-i-size-a-stream.html) of the data stream. Detailed below.
     */
    readonly streamModeDetails: outputs.kinesis.GetStreamStreamModeDetail[];
    /**
     * Map of tags to assigned to the stream.
     */
    readonly tags: {
        [key: string]: string;
    };
}
/**
 * Use this data source to get information about a Kinesis Stream for use in other
 * resources.
 *
 * For more details, see the [Amazon Kinesis Documentation](https://aws.amazon.com/documentation/kinesis/).
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const stream = aws.kinesis.getStream({
 *     name: "stream-name",
 * });
 * ```
 */
export declare function getStreamOutput(args: GetStreamOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetStreamResult>;
/**
 * A collection of arguments for invoking getStream.
 */
export interface GetStreamOutputArgs {
    /**
     * Name of the Kinesis Stream.
     */
    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>;
    /**
     * Map of tags to assigned to the stream.
     */
    tags?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
}