AWS Native

Pulumi Official
Package maintained by Pulumi
v0.19.0 published on Wednesday, Jun 8, 2022 by Pulumi

getStream

Resource Type definition for AWS::Kinesis::Stream

Using getStream

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 getStream(args: GetStreamArgs, opts?: InvokeOptions): Promise<GetStreamResult>
function getStreamOutput(args: GetStreamOutputArgs, opts?: InvokeOptions): Output<GetStreamResult>
def get_stream(name: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetStreamResult
def get_stream_output(name: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetStreamResult]
func LookupStream(ctx *Context, args *LookupStreamArgs, opts ...InvokeOption) (*LookupStreamResult, error)
func LookupStreamOutput(ctx *Context, args *LookupStreamOutputArgs, opts ...InvokeOption) LookupStreamResultOutput

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

public static class GetStream 
{
    public static Task<GetStreamResult> InvokeAsync(GetStreamArgs args, InvokeOptions? opts = null)
    public static Output<GetStreamResult> Invoke(GetStreamInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetStreamResult> getStream(GetStreamArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: aws-native:kinesis:getStream
  Arguments:
    # Arguments dictionary

The following arguments are supported:

Name string

The name of the Kinesis stream.

Name string

The name of the Kinesis stream.

name String

The name of the Kinesis stream.

name string

The name of the Kinesis stream.

name str

The name of the Kinesis stream.

name String

The name of the Kinesis stream.

getStream Result

The following output properties are available:

Arn string

The Amazon resource name (ARN) of the Kinesis stream

RetentionPeriodHours int

The number of hours for the data records that are stored in shards to remain accessible.

ShardCount int

The number of shards that the stream uses. Required when StreamMode = PROVISIONED is passed.

StreamEncryption Pulumi.AwsNative.Kinesis.Outputs.StreamEncryption

When specified, enables or updates server-side encryption using an AWS KMS key for a specified stream.

StreamModeDetails Pulumi.AwsNative.Kinesis.Outputs.StreamModeDetails

The mode in which the stream is running.

Tags List<Pulumi.AwsNative.Kinesis.Outputs.StreamTag>

An arbitrary set of tags (key–value pairs) to associate with the Kinesis stream.

Arn string

The Amazon resource name (ARN) of the Kinesis stream

RetentionPeriodHours int

The number of hours for the data records that are stored in shards to remain accessible.

ShardCount int

The number of shards that the stream uses. Required when StreamMode = PROVISIONED is passed.

StreamEncryption StreamEncryption

When specified, enables or updates server-side encryption using an AWS KMS key for a specified stream.

StreamModeDetails StreamModeDetails

The mode in which the stream is running.

Tags []StreamTag

An arbitrary set of tags (key–value pairs) to associate with the Kinesis stream.

arn String

The Amazon resource name (ARN) of the Kinesis stream

retentionPeriodHours Integer

The number of hours for the data records that are stored in shards to remain accessible.

shardCount Integer

The number of shards that the stream uses. Required when StreamMode = PROVISIONED is passed.

streamEncryption StreamEncryption

When specified, enables or updates server-side encryption using an AWS KMS key for a specified stream.

streamModeDetails StreamModeDetails

The mode in which the stream is running.

tags List<StreamTag>

An arbitrary set of tags (key–value pairs) to associate with the Kinesis stream.

arn string

The Amazon resource name (ARN) of the Kinesis stream

retentionPeriodHours number

The number of hours for the data records that are stored in shards to remain accessible.

shardCount number

The number of shards that the stream uses. Required when StreamMode = PROVISIONED is passed.

streamEncryption StreamEncryption

When specified, enables or updates server-side encryption using an AWS KMS key for a specified stream.

streamModeDetails StreamModeDetails

The mode in which the stream is running.

tags StreamTag[]

An arbitrary set of tags (key–value pairs) to associate with the Kinesis stream.

arn str

The Amazon resource name (ARN) of the Kinesis stream

retention_period_hours int

The number of hours for the data records that are stored in shards to remain accessible.

shard_count int

The number of shards that the stream uses. Required when StreamMode = PROVISIONED is passed.

stream_encryption StreamEncryption

When specified, enables or updates server-side encryption using an AWS KMS key for a specified stream.

stream_mode_details StreamModeDetails

The mode in which the stream is running.

tags Sequence[StreamTag]

An arbitrary set of tags (key–value pairs) to associate with the Kinesis stream.

arn String

The Amazon resource name (ARN) of the Kinesis stream

retentionPeriodHours Number

The number of hours for the data records that are stored in shards to remain accessible.

shardCount Number

The number of shards that the stream uses. Required when StreamMode = PROVISIONED is passed.

streamEncryption Property Map

When specified, enables or updates server-side encryption using an AWS KMS key for a specified stream.

streamModeDetails Property Map

The mode in which the stream is running.

tags List<Property Map>

An arbitrary set of tags (key–value pairs) to associate with the Kinesis stream.

Supporting Types

StreamEncryption

EncryptionType Pulumi.AwsNative.Kinesis.StreamEncryptionEncryptionType

The encryption type to use. The only valid value is KMS.

KeyId string

The GUID for the customer-managed AWS KMS key to use for encryption. This value can be a globally unique identifier, a fully specified Amazon Resource Name (ARN) to either an alias or a key, or an alias name prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis.

EncryptionType StreamEncryptionEncryptionType

The encryption type to use. The only valid value is KMS.

KeyId string

The GUID for the customer-managed AWS KMS key to use for encryption. This value can be a globally unique identifier, a fully specified Amazon Resource Name (ARN) to either an alias or a key, or an alias name prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis.

encryptionType StreamEncryptionEncryptionType

The encryption type to use. The only valid value is KMS.

keyId String

The GUID for the customer-managed AWS KMS key to use for encryption. This value can be a globally unique identifier, a fully specified Amazon Resource Name (ARN) to either an alias or a key, or an alias name prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis.

encryptionType StreamEncryptionEncryptionType

The encryption type to use. The only valid value is KMS.

keyId string

The GUID for the customer-managed AWS KMS key to use for encryption. This value can be a globally unique identifier, a fully specified Amazon Resource Name (ARN) to either an alias or a key, or an alias name prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis.

encryption_type StreamEncryptionEncryptionType

The encryption type to use. The only valid value is KMS.

key_id str

The GUID for the customer-managed AWS KMS key to use for encryption. This value can be a globally unique identifier, a fully specified Amazon Resource Name (ARN) to either an alias or a key, or an alias name prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis.

encryptionType "KMS"

The encryption type to use. The only valid value is KMS.

keyId String

The GUID for the customer-managed AWS KMS key to use for encryption. This value can be a globally unique identifier, a fully specified Amazon Resource Name (ARN) to either an alias or a key, or an alias name prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis.

StreamEncryptionEncryptionType

StreamModeDetails

StreamModeDetailsStreamMode

StreamTag

Key string

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Value string

The value for the tag. You can specify a value that is 0 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Key string

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Value string

The value for the tag. You can specify a value that is 0 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key String

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

value String

The value for the tag. You can specify a value that is 0 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key string

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

value string

The value for the tag. You can specify a value that is 0 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key str

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

value str

The value for the tag. You can specify a value that is 0 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key String

The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

value String

The value for the tag. You can specify a value that is 0 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Package Details

Repository
https://github.com/pulumi/pulumi-aws-native
License
Apache-2.0