Fork me on GitHub

Module kinesis

@pulumi/aws > kinesis

Index

kinesis/firehoseDeliveryStream.ts kinesis/getStream.ts kinesis/stream.ts

class FirehoseDeliveryStream

Provides a Kinesis Firehose Delivery Stream resource. Amazon Kinesis Firehose is a fully managed, elastic service to easily deliver real-time data streams to destinations such as Amazon S3 and Amazon Redshift.

For more details, see the [Amazon Kinesis Firehose Documentation][1].

constructor

new FirehoseDeliveryStream(name: string, args: FirehoseDeliveryStreamArgs, opts?: pulumi.CustomResourceOptions)

Create a FirehoseDeliveryStream resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: FirehoseDeliveryStreamState): FirehoseDeliveryStream

Get an existing FirehoseDeliveryStream resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

The Amazon Resource Name (ARN) specifying the Stream

property destination

public destination: pulumi.Output<string>;

This is the destination to where the data is delivered. The only options are s3 (Deprecated, use extended_s3 instead), extended_s3, redshift, elasticsearch, and splunk.

property destinationId

public destinationId: pulumi.Output<string>;

property elasticsearchConfiguration

public elasticsearchConfiguration: pulumi.Output<{ ... } | undefined>;

property extendedS3Configuration

public extendedS3Configuration: pulumi.Output<{ ... } | undefined>;

Enhanced configuration options for the s3 destination. More details are given below.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property kinesisSourceConfiguration

public kinesisSourceConfiguration: pulumi.Output<{ ... } | undefined>;

Allows the ability to specify the kinesis stream that is used as the source of the firehose delivery stream.

property name

public name: pulumi.Output<string>;

A name to identify the stream. This is unique to the AWS account and region the Stream is created in.

property redshiftConfiguration

public redshiftConfiguration: pulumi.Output<{ ... } | undefined>;

Configuration options if redshift is the destination. Using redshift_configuration requires the user to also specify a s3_configuration block. More details are given below.

property s3Configuration

public s3Configuration: pulumi.Output<{ ... } | undefined>;

Configuration options for the s3 destination (or the intermediate bucket if the destination is redshift). More details are given below.

property splunkConfiguration

public splunkConfiguration: pulumi.Output<{ ... } | undefined>;

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property versionId

public versionId: pulumi.Output<string>;

Specifies the table version for the output data schema. Defaults to LATEST.

class Stream

Provides a Kinesis Stream resource. Amazon Kinesis is a managed service that scales elastically for real-time processing of streaming big data.

For more details, see the [Amazon Kinesis Documentation][1].

constructor

new Stream(name: string, args: StreamArgs, opts?: pulumi.CustomResourceOptions)

Create a Stream resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: StreamState): Stream

Get an existing Stream resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

The Amazon Resource Name (ARN) specifying the Stream (same as id)

property encryptionType

public encryptionType: pulumi.Output<string | undefined>;

The encryption type to use. The only acceptable values are NONE or KMS. The default value is NONE.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property kmsKeyId

public kmsKeyId: pulumi.Output<string | undefined>;

The GUID for the customer-managed KMS key to use for encryption. You can also use a Kinesis-owned master key by specifying the alias aws/kinesis.

property name

public name: pulumi.Output<string>;

A name to identify the stream. This is unique to the AWS account and region the Stream is created in.

property retentionPeriod

public retentionPeriod: pulumi.Output<number | undefined>;

Length of time data records are accessible after they are added to the stream. The maximum value of a stream’s retention period is 168 hours. Minimum value is 24. Default is 24.

property shardCount

public shardCount: pulumi.Output<number>;

The number of shards that the stream will use. Amazon has guidlines for specifying the Stream size that should be referenced when creating a Kinesis stream. See [Amazon Kinesis Streams][2] for more.

property shardLevelMetrics

public shardLevelMetrics: pulumi.Output<string[] | undefined>;

A list of shard-level CloudWatch metrics which can be enabled for the stream. See [Monitoring with CloudWatch][3] for more. Note that the value ALL should not be used; instead you should provide an explicit list of metrics you wish to enable.

property tags

public tags: pulumi.Output<Tags | undefined>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

function getStream

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

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

For more details, see the [Amazon Kinesis Documentation][1].

interface FirehoseDeliveryStreamArgs

The set of arguments for constructing a FirehoseDeliveryStream resource.

property arn

arn?: pulumi.Input<string>;

The Amazon Resource Name (ARN) specifying the Stream

property destination

destination: pulumi.Input<string>;

This is the destination to where the data is delivered. The only options are s3 (Deprecated, use extended_s3 instead), extended_s3, redshift, elasticsearch, and splunk.

property destinationId

destinationId?: pulumi.Input<string>;

property elasticsearchConfiguration

elasticsearchConfiguration?: pulumi.Input<{ ... }>;

property extendedS3Configuration

extendedS3Configuration?: pulumi.Input<{ ... }>;

Enhanced configuration options for the s3 destination. More details are given below.

property kinesisSourceConfiguration

kinesisSourceConfiguration?: pulumi.Input<{ ... }>;

Allows the ability to specify the kinesis stream that is used as the source of the firehose delivery stream.

property name

name?: pulumi.Input<string>;

A name to identify the stream. This is unique to the AWS account and region the Stream is created in.

property redshiftConfiguration

redshiftConfiguration?: pulumi.Input<{ ... }>;

Configuration options if redshift is the destination. Using redshift_configuration requires the user to also specify a s3_configuration block. More details are given below.

property s3Configuration

s3Configuration?: pulumi.Input<{ ... }>;

Configuration options for the s3 destination (or the intermediate bucket if the destination is redshift). More details are given below.

property splunkConfiguration

splunkConfiguration?: pulumi.Input<{ ... }>;

property versionId

versionId?: pulumi.Input<string>;

Specifies the table version for the output data schema. Defaults to LATEST.

interface FirehoseDeliveryStreamState

Input properties used for looking up and filtering FirehoseDeliveryStream resources.

property arn

arn?: pulumi.Input<string>;

The Amazon Resource Name (ARN) specifying the Stream

property destination

destination?: pulumi.Input<string>;

This is the destination to where the data is delivered. The only options are s3 (Deprecated, use extended_s3 instead), extended_s3, redshift, elasticsearch, and splunk.

property destinationId

destinationId?: pulumi.Input<string>;

property elasticsearchConfiguration

elasticsearchConfiguration?: pulumi.Input<{ ... }>;

property extendedS3Configuration

extendedS3Configuration?: pulumi.Input<{ ... }>;

Enhanced configuration options for the s3 destination. More details are given below.

property kinesisSourceConfiguration

kinesisSourceConfiguration?: pulumi.Input<{ ... }>;

Allows the ability to specify the kinesis stream that is used as the source of the firehose delivery stream.

property name

name?: pulumi.Input<string>;

A name to identify the stream. This is unique to the AWS account and region the Stream is created in.

property redshiftConfiguration

redshiftConfiguration?: pulumi.Input<{ ... }>;

Configuration options if redshift is the destination. Using redshift_configuration requires the user to also specify a s3_configuration block. More details are given below.

property s3Configuration

s3Configuration?: pulumi.Input<{ ... }>;

Configuration options for the s3 destination (or the intermediate bucket if the destination is redshift). More details are given below.

property splunkConfiguration

splunkConfiguration?: pulumi.Input<{ ... }>;

property versionId

versionId?: pulumi.Input<string>;

Specifies the table version for the output data schema. Defaults to LATEST.

interface GetStreamArgs

A collection of arguments for invoking getStream.

property name

name: string;

The name of the Kinesis Stream.

interface GetStreamResult

A collection of values returned by getStream.

property arn

arn: string;

The Amazon Resource Name (ARN) of the Kinesis Stream (same as id).

property closedShards

closedShards: string[];

The list of shard ids in the CLOSED state. See [Shard State][2] for more.

property creationTimestamp

creationTimestamp: number;

The approximate UNIX timestamp that the stream was created.

property id

id: string;

id is the provider-assigned unique ID for this managed resource.

property openShards

openShards: string[];

The list of shard ids in the OPEN state. See [Shard State][2] for more.

property retentionPeriod

retentionPeriod: number;

Length of time (in hours) data records are accessible after they are added to the stream.

property shardLevelMetrics

shardLevelMetrics: string[];

A list of shard-level CloudWatch metrics which are enabled for the stream. See [Monitoring with CloudWatch][3] for more.

property status

status: string;

The current status of the stream. The stream status is one of CREATING, DELETING, ACTIVE, or UPDATING.

property tags

tags: { ... };

A mapping of tags to assigned to the stream.

interface StreamArgs

The set of arguments for constructing a Stream resource.

property arn

arn?: pulumi.Input<string>;

The Amazon Resource Name (ARN) specifying the Stream (same as id)

property encryptionType

encryptionType?: pulumi.Input<string>;

The encryption type to use. The only acceptable values are NONE or KMS. The default value is NONE.

property kmsKeyId

kmsKeyId?: pulumi.Input<string>;

The GUID for the customer-managed KMS key to use for encryption. You can also use a Kinesis-owned master key by specifying the alias aws/kinesis.

property name

name?: pulumi.Input<string>;

A name to identify the stream. This is unique to the AWS account and region the Stream is created in.

property retentionPeriod

retentionPeriod?: pulumi.Input<number>;

Length of time data records are accessible after they are added to the stream. The maximum value of a stream’s retention period is 168 hours. Minimum value is 24. Default is 24.

property shardCount

shardCount: pulumi.Input<number>;

The number of shards that the stream will use. Amazon has guidlines for specifying the Stream size that should be referenced when creating a Kinesis stream. See [Amazon Kinesis Streams][2] for more.

property shardLevelMetrics

shardLevelMetrics?: pulumi.Input<pulumi.Input<string>[]>;

A list of shard-level CloudWatch metrics which can be enabled for the stream. See [Monitoring with CloudWatch][3] for more. Note that the value ALL should not be used; instead you should provide an explicit list of metrics you wish to enable.

property tags

tags?: pulumi.Input<Tags>;

A mapping of tags to assign to the resource.

interface StreamState

Input properties used for looking up and filtering Stream resources.

property arn

arn?: pulumi.Input<string>;

The Amazon Resource Name (ARN) specifying the Stream (same as id)

property encryptionType

encryptionType?: pulumi.Input<string>;

The encryption type to use. The only acceptable values are NONE or KMS. The default value is NONE.

property kmsKeyId

kmsKeyId?: pulumi.Input<string>;

The GUID for the customer-managed KMS key to use for encryption. You can also use a Kinesis-owned master key by specifying the alias aws/kinesis.

property name

name?: pulumi.Input<string>;

A name to identify the stream. This is unique to the AWS account and region the Stream is created in.

property retentionPeriod

retentionPeriod?: pulumi.Input<number>;

Length of time data records are accessible after they are added to the stream. The maximum value of a stream’s retention period is 168 hours. Minimum value is 24. Default is 24.

property shardCount

shardCount?: pulumi.Input<number>;

The number of shards that the stream will use. Amazon has guidlines for specifying the Stream size that should be referenced when creating a Kinesis stream. See [Amazon Kinesis Streams][2] for more.

property shardLevelMetrics

shardLevelMetrics?: pulumi.Input<pulumi.Input<string>[]>;

A list of shard-level CloudWatch metrics which can be enabled for the stream. See [Monitoring with CloudWatch][3] for more. Note that the value ALL should not be used; instead you should provide an explicit list of metrics you wish to enable.

property tags

tags?: pulumi.Input<Tags>;

A mapping of tags to assign to the resource.