kinesis

class pulumi_aws.kinesis.AnalyticsApplication(resource_name, opts=None, cloudwatch_logging_options=None, code=None, description=None, inputs=None, name=None, outputs=None, reference_data_sources=None, __name__=None, __opts__=None)

Provides a Kinesis Analytics Application resource. Kinesis Analytics is a managed service that allows processing and analyzing streaming data using standard SQL.

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

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • cloudwatch_logging_options (pulumi.Input[dict]) – The CloudWatch log stream options to monitor application errors. See CloudWatch Logging Options below for more details.
  • code (pulumi.Input[str]) – SQL Code to transform input data, and generate output.
  • description (pulumi.Input[str]) – Description of the application.
  • inputs (pulumi.Input[dict]) – Input configuration of the application. See Inputs below for more details.
  • name (pulumi.Input[str]) – Name of the Kinesis Analytics Application.
  • outputs (pulumi.Input[list]) – Output destination configuration of the application. See Outputs below for more details.
  • reference_data_sources (pulumi.Input[dict]) – An S3 Reference Data Source for the application. See Reference Data Sources below for more details.
arn = None

The ARN of the Kinesis Analytics Appliation.

cloudwatch_logging_options = None

The CloudWatch log stream options to monitor application errors. See CloudWatch Logging Options below for more details.

code = None

SQL Code to transform input data, and generate output.

create_timestamp = None

The Timestamp when the application version was created.

description = None

Description of the application.

inputs = None

Input configuration of the application. See Inputs below for more details.

last_update_timestamp = None

The Timestamp when the application was last updated.

name = None

Name of the Kinesis Analytics Application.

outputs = None

Output destination configuration of the application. See Outputs below for more details.

reference_data_sources = None

An S3 Reference Data Source for the application. See Reference Data Sources below for more details.

status = None

The Status of the application.

version = None

The Version of the application.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.kinesis.FirehoseDeliveryStream(resource_name, opts=None, arn=None, destination=None, destination_id=None, elasticsearch_configuration=None, extended_s3_configuration=None, kinesis_source_configuration=None, name=None, redshift_configuration=None, s3_configuration=None, splunk_configuration=None, tags=None, version_id=None, __name__=None, __opts__=None)

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].

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • arn (pulumi.Input[str]) – The Amazon Resource Name (ARN) specifying the Stream
  • destination (pulumi.Input[str]) – 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.

:param pulumi.Input[str] destination_id :param pulumi.Input[dict] elasticsearch_configuration :param pulumi.Input[dict] extended_s3_configuration: Enhanced configuration options for the s3 destination. More details are given below. :param pulumi.Input[dict] kinesis_source_configuration: Allows the ability to specify the kinesis stream that is used as the source of the firehose delivery stream. :param pulumi.Input[str] name: A name to identify the stream. This is unique to the

AWS account and region the Stream is created in.
Parameters:
  • redshift_configuration (pulumi.Input[dict]) – 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.
  • s3_configuration (pulumi.Input[dict]) – Configuration options for the s3 destination (or the intermediate bucket if the destination is redshift). More details are given below.

:param pulumi.Input[dict] splunk_configuration :param pulumi.Input[dict] tags: A mapping of tags to assign to the resource. :param pulumi.Input[str] version_id: Specifies the table version for the output data schema. Defaults to LATEST.

arn = None

The Amazon Resource Name (ARN) specifying the Stream

destination = None

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.

extended_s3_configuration = None

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

kinesis_source_configuration = None

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

name = None

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

redshift_configuration = None

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.

s3_configuration = None

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

tags = None

A mapping of tags to assign to the resource.

version_id = None

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

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.kinesis.GetStreamResult(arn=None, closed_shards=None, creation_timestamp=None, open_shards=None, retention_period=None, shard_level_metrics=None, status=None, tags=None, id=None)

A collection of values returned by getStream.

arn = None

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

closed_shards = None

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

creation_timestamp = None

The approximate UNIX timestamp that the stream was created.

open_shards = None

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

retention_period = None

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

shard_level_metrics = None

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

status = None

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

tags = None

A mapping of tags to assigned to the stream.

id = None

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

class pulumi_aws.kinesis.Stream(resource_name, opts=None, arn=None, encryption_type=None, kms_key_id=None, name=None, retention_period=None, shard_count=None, shard_level_metrics=None, tags=None, __name__=None, __opts__=None)

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].

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • arn (pulumi.Input[str]) – The Amazon Resource Name (ARN) specifying the Stream (same as id)
  • encryption_type (pulumi.Input[str]) – The encryption type to use. The only acceptable values are NONE or KMS. The default value is NONE.
  • kms_key_id (pulumi.Input[str]) – 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.
  • name (pulumi.Input[str]) – A name to identify the stream. This is unique to the AWS account and region the Stream is created in.
  • retention_period (pulumi.Input[int]) – 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.
  • shard_count (pulumi.Input[int]) – 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.
  • shard_level_metrics (pulumi.Input[list]) – 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.
  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
arn = None

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

encryption_type = None

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

kms_key_id = None

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.

name = None

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

retention_period = None

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.

shard_count = None

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.

shard_level_metrics = None

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.

tags = None

A mapping of tags to assign to the resource.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
pulumi_aws.kinesis.get_stream(name=None)

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].