GetStream

Use this data source to get information about a Kinesis Stream for use in other resources.

For more details, see the Amazon Kinesis Documentation.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var stream = Output.Create(Aws.Kinesis.GetStream.InvokeAsync(new Aws.Kinesis.GetStreamArgs
        {
            Name = "stream-name",
        }));
    }

}

package main

import (
    "github.com/pulumi/pulumi-aws/sdk/v2/go/aws/kinesis"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := kinesis.LookupStream(ctx, &kinesis.LookupStreamArgs{
            Name: "stream-name",
        }, nil)
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_aws as aws

stream = aws.kinesis.get_stream(name="stream-name")

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const stream = pulumi.output(aws.kinesis.getStream({
    name: "stream-name",
}, { async: true }));

Using GetStream

function getStream(args: GetStreamArgs, opts?: InvokeOptions): Promise<GetStreamResult>

function  get_stream(name=None, tags=None, opts=None)

func LookupStream(ctx *Context, args *LookupStreamArgs, opts ...InvokeOption) (*LookupStreamResult, error)

Note: This function is named LookupStream in the Go SDK.

public static class GetStream {
    public static Task<GetStreamResult> InvokeAsync(GetStreamArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

Name string: The name of the Kinesis Stream.
Tags Dictionary<string, string>: A map of tags to assigned to the stream.

Name string: The name of the Kinesis Stream.
Tags map[string]string: A map of tags to assigned to the stream.

name string: The name of the Kinesis Stream.
tags {[key: string]: string}: A map of tags to assigned to the stream.

name str: The name of the Kinesis Stream.
tags Dict[str, str]: A map of tags to assigned to the stream.

GetStream Result

The following output properties are available:

Arn string: The Amazon Resource Name (ARN) of the Kinesis Stream (same as id).
ClosedShards List<string>: The list of shard ids in the CLOSED state. See Shard State for more.
CreationTimestamp int: The approximate UNIX timestamp that the stream was created.
Id string: The provider-assigned unique ID for this managed resource.
Name string: The name of the Kinesis Stream.
OpenShards List<string>: The list of shard ids in the OPEN state. See Shard State for more.
RetentionPeriod int: Length of time (in hours) data records are accessible after they are added to the stream.
ShardLevelMetrics List<string>: A list of shard-level CloudWatch metrics which are enabled for the stream. See Monitoring with CloudWatch for more.
Status string: The current status of the stream. The stream status is one of CREATING, DELETING, ACTIVE, or UPDATING.
Tags Dictionary<string, string>: A map of tags to assigned to the stream.

Arn string: The Amazon Resource Name (ARN) of the Kinesis Stream (same as id).
ClosedShards []string: The list of shard ids in the CLOSED state. See Shard State for more.
CreationTimestamp int: The approximate UNIX timestamp that the stream was created.
Id string: The provider-assigned unique ID for this managed resource.
Name string: The name of the Kinesis Stream.
OpenShards []string: The list of shard ids in the OPEN state. See Shard State for more.
RetentionPeriod int: Length of time (in hours) data records are accessible after they are added to the stream.
ShardLevelMetrics []string: A list of shard-level CloudWatch metrics which are enabled for the stream. See Monitoring with CloudWatch for more.
Status string: The current status of the stream. The stream status is one of CREATING, DELETING, ACTIVE, or UPDATING.
Tags map[string]string: A map of tags to assigned to the stream.

arn string: The Amazon Resource Name (ARN) of the Kinesis Stream (same as id).
closedShards string[]: The list of shard ids in the CLOSED state. See Shard State for more.
creationTimestamp number: The approximate UNIX timestamp that the stream was created.
id string: The provider-assigned unique ID for this managed resource.
name string: The name of the Kinesis Stream.
openShards string[]: The list of shard ids in the OPEN state. See Shard State for more.
retentionPeriod number: Length of time (in hours) data records are accessible after they are added to the stream.
shardLevelMetrics string[]: A list of shard-level CloudWatch metrics which are enabled for the stream. See Monitoring with CloudWatch for more.
status string: The current status of the stream. The stream status is one of CREATING, DELETING, ACTIVE, or UPDATING.
tags {[key: string]: string}: A map of tags to assigned to the stream.

arn str: The Amazon Resource Name (ARN) of the Kinesis Stream (same as id).
closed_shards List[str]: The list of shard ids in the CLOSED state. See Shard State for more.
creation_timestamp float: The approximate UNIX timestamp that the stream was created.
id str: The provider-assigned unique ID for this managed resource.
name str: The name of the Kinesis Stream.
open_shards List[str]: The list of shard ids in the OPEN state. See Shard State for more.
retention_period float: Length of time (in hours) data records are accessible after they are added to the stream.
shard_level_metrics List[str]: A list of shard-level CloudWatch metrics which are enabled for the stream. See Monitoring with CloudWatch for more.
status str: The current status of the stream. The stream status is one of CREATING, DELETING, ACTIVE, or UPDATING.
tags Dict[str, str]: A map of tags to assigned to the stream.

Package Details

Repository: https://github.com/pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

GetStream

Example Usage

Using GetStream

GetStream Result

Package Details

On This Page