CfnApplicationPropsMixin

class aws_cdk.mixins_preview.aws_kinesisanalytics.mixins.CfnApplicationPropsMixin(props, *, strategy=None)

Bases: Mixin

The AWS::KinesisAnalytics::Application resource creates an Amazon Kinesis Data Analytics application.

For more information, see the Amazon Kinesis Data Analytics Developer Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalytics-application.html
CloudformationResource:: AWS::KinesisAnalytics::Application
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_kinesisanalytics import mixins as kinesisanalytics_mixins

cfn_application_props_mixin = kinesisanalytics_mixins.CfnApplicationPropsMixin(kinesisanalytics_mixins.CfnApplicationMixinProps(
    application_code="applicationCode",
    application_description="applicationDescription",
    application_name="applicationName",
    inputs=[kinesisanalytics_mixins.CfnApplicationPropsMixin.InputProperty(
        input_parallelism=kinesisanalytics_mixins.CfnApplicationPropsMixin.InputParallelismProperty(
            count=123
        ),
        input_processing_configuration=kinesisanalytics_mixins.CfnApplicationPropsMixin.InputProcessingConfigurationProperty(
            input_lambda_processor=kinesisanalytics_mixins.CfnApplicationPropsMixin.InputLambdaProcessorProperty(
                resource_arn="resourceArn",
                role_arn="roleArn"
            )
        ),
        input_schema=kinesisanalytics_mixins.CfnApplicationPropsMixin.InputSchemaProperty(
            record_columns=[kinesisanalytics_mixins.CfnApplicationPropsMixin.RecordColumnProperty(
                mapping="mapping",
                name="name",
                sql_type="sqlType"
            )],
            record_encoding="recordEncoding",
            record_format=kinesisanalytics_mixins.CfnApplicationPropsMixin.RecordFormatProperty(
                mapping_parameters=kinesisanalytics_mixins.CfnApplicationPropsMixin.MappingParametersProperty(
                    csv_mapping_parameters=kinesisanalytics_mixins.CfnApplicationPropsMixin.CSVMappingParametersProperty(
                        record_column_delimiter="recordColumnDelimiter",
                        record_row_delimiter="recordRowDelimiter"
                    ),
                    json_mapping_parameters=kinesisanalytics_mixins.CfnApplicationPropsMixin.JSONMappingParametersProperty(
                        record_row_path="recordRowPath"
                    )
                ),
                record_format_type="recordFormatType"
            )
        ),
        kinesis_firehose_input=kinesisanalytics_mixins.CfnApplicationPropsMixin.KinesisFirehoseInputProperty(
            resource_arn="resourceArn",
            role_arn="roleArn"
        ),
        kinesis_streams_input=kinesisanalytics_mixins.CfnApplicationPropsMixin.KinesisStreamsInputProperty(
            resource_arn="resourceArn",
            role_arn="roleArn"
        ),
        name_prefix="namePrefix"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::KinesisAnalytics::Application.

Parameters:

props (Union[CfnApplicationMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['applicationCode', 'applicationDescription', 'applicationName', 'inputs']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

CSVMappingParametersProperty

class CfnApplicationPropsMixin.CSVMappingParametersProperty(*, record_column_delimiter=None, record_row_delimiter=None)

Bases: object

Provides additional mapping information when the record format uses delimiters, such as CSV.

For example, the following sample records use CSV format, where the records use the ‘n’ as the row delimiter and a comma (“,”) as the column delimiter:

"name1", "address1"

"name2", "address2"

Parameters:

record_column_delimiter (Optional[str]) – Column delimiter. For example, in a CSV format, a comma (“,”) is the typical column delimiter.
record_row_delimiter (Optional[str]) – Row delimiter. For example, in a CSV format, ‘n’ is the typical row delimiter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-csvmappingparameters.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_kinesisanalytics import mixins as kinesisanalytics_mixins

c_sVMapping_parameters_property = kinesisanalytics_mixins.CfnApplicationPropsMixin.CSVMappingParametersProperty(
    record_column_delimiter="recordColumnDelimiter",
    record_row_delimiter="recordRowDelimiter"
)

Attributes

record_column_delimiter

Column delimiter.

For example, in a CSV format, a comma (“,”) is the typical column delimiter.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-csvmappingparameters.html#cfn-kinesisanalytics-application-csvmappingparameters-recordcolumndelimiter

record_row_delimiter

Row delimiter.

For example, in a CSV format, ‘n’ is the typical row delimiter.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-csvmappingparameters.html#cfn-kinesisanalytics-application-csvmappingparameters-recordrowdelimiter

InputLambdaProcessorProperty

class CfnApplicationPropsMixin.InputLambdaProcessorProperty(*, resource_arn=None, role_arn=None)

Bases: object

An object that contains the Amazon Resource Name (ARN) of the AWS Lambda function that is used to preprocess records in the stream, and the ARN of the IAM role that is used to access the AWS Lambda function.

Parameters:

resource_arn (Optional[str]) –
The ARN of the AWS Lambda function that operates on records in the stream. .. epigraph:: To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: AWS Lambda
role_arn (Optional[str]) – The ARN of the IAM role that is used to access the AWS Lambda function.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-inputlambdaprocessor.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_kinesisanalytics import mixins as kinesisanalytics_mixins

input_lambda_processor_property = kinesisanalytics_mixins.CfnApplicationPropsMixin.InputLambdaProcessorProperty(
    resource_arn="resourceArn",
    role_arn="roleArn"
)

Attributes

resource_arn

The ARN of the AWS Lambda function that operates on records in the stream.

To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: AWS Lambda

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-inputlambdaprocessor.html#cfn-kinesisanalytics-application-inputlambdaprocessor-resourcearn

role_arn

The ARN of the IAM role that is used to access the AWS Lambda function.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-inputlambdaprocessor.html#cfn-kinesisanalytics-application-inputlambdaprocessor-rolearn

InputParallelismProperty

class CfnApplicationPropsMixin.InputParallelismProperty(*, count=None)

Bases: object

Describes the number of in-application streams to create for a given streaming source.

For information about parallelism, see Configuring Application Input .

Parameters:: count (Union[int, float, None]) – Number of in-application streams to create. For more information, see Limits .
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-inputparallelism.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_kinesisanalytics import mixins as kinesisanalytics_mixins

input_parallelism_property = kinesisanalytics_mixins.CfnApplicationPropsMixin.InputParallelismProperty(
    count=123
)

Attributes

count

Number of in-application streams to create.

For more information, see Limits .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-inputparallelism.html#cfn-kinesisanalytics-application-inputparallelism-count

InputProcessingConfigurationProperty

class CfnApplicationPropsMixin.InputProcessingConfigurationProperty(*, input_lambda_processor=None)

Bases: object

Provides a description of a processor that is used to preprocess the records in the stream before being processed by your application code.

Currently, the only input processor available is AWS Lambda .

Parameters:: input_lambda_processor (Union[IResolvable, InputLambdaProcessorProperty, Dict[str, Any], None]) – The InputLambdaProcessor that is used to preprocess the records in the stream before being processed by your application code.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-inputprocessingconfiguration.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_kinesisanalytics import mixins as kinesisanalytics_mixins

input_processing_configuration_property = kinesisanalytics_mixins.CfnApplicationPropsMixin.InputProcessingConfigurationProperty(
    input_lambda_processor=kinesisanalytics_mixins.CfnApplicationPropsMixin.InputLambdaProcessorProperty(
        resource_arn="resourceArn",
        role_arn="roleArn"
    )
)

Attributes

input_lambda_processor

The InputLambdaProcessor that is used to preprocess the records in the stream before being processed by your application code.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-inputprocessingconfiguration.html#cfn-kinesisanalytics-application-inputprocessingconfiguration-inputlambdaprocessor

InputProperty

class CfnApplicationPropsMixin.InputProperty(*, input_parallelism=None, input_processing_configuration=None, input_schema=None, kinesis_firehose_input=None, kinesis_streams_input=None, name_prefix=None)

Bases: object

When you configure the application input, you specify the streaming source, the in-application stream name that is created, and the mapping between the two.

For more information, see Configuring Application Input .

Parameters:

input_parallelism (Union[IResolvable, InputParallelismProperty, Dict[str, Any], None]) –
Describes the number of in-application streams to create. Data from your source is routed to these in-application input streams. See Configuring Application Input .
input_processing_configuration (Union[IResolvable, InputProcessingConfigurationProperty, Dict[str, Any], None]) –
The InputProcessingConfiguration for the input. An input processor transforms records as they are received from the stream, before the application’s SQL code executes. Currently, the only input processing configuration available is InputLambdaProcessor .
input_schema (Union[IResolvable, InputSchemaProperty, Dict[str, Any], None]) – Describes the format of the data in the streaming source, and how each data element maps to corresponding columns in the in-application stream that is being created. Also used to describe the format of the reference data source.
kinesis_firehose_input (Union[IResolvable, KinesisFirehoseInputProperty, Dict[str, Any], None]) – If the streaming source is an Amazon Kinesis Firehose delivery stream, identifies the delivery stream’s ARN and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf. Note: Either KinesisStreamsInput or KinesisFirehoseInput is required.
kinesis_streams_input (Union[IResolvable, KinesisStreamsInputProperty, Dict[str, Any], None]) – If the streaming source is an Amazon Kinesis stream, identifies the stream’s Amazon Resource Name (ARN) and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf. Note: Either KinesisStreamsInput or KinesisFirehoseInput is required.
name_prefix (Optional[str]) – Name prefix to use when creating an in-application stream. Suppose that you specify a prefix “MyInApplicationStream.” Amazon Kinesis Analytics then creates one or more (as per the InputParallelism count you specified) in-application streams with names “MyInApplicationStream_001,” “MyInApplicationStream_002,” and so on.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-input.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_kinesisanalytics import mixins as kinesisanalytics_mixins

input_property = kinesisanalytics_mixins.CfnApplicationPropsMixin.InputProperty(
    input_parallelism=kinesisanalytics_mixins.CfnApplicationPropsMixin.InputParallelismProperty(
        count=123
    ),
    input_processing_configuration=kinesisanalytics_mixins.CfnApplicationPropsMixin.InputProcessingConfigurationProperty(
        input_lambda_processor=kinesisanalytics_mixins.CfnApplicationPropsMixin.InputLambdaProcessorProperty(
            resource_arn="resourceArn",
            role_arn="roleArn"
        )
    ),
    input_schema=kinesisanalytics_mixins.CfnApplicationPropsMixin.InputSchemaProperty(
        record_columns=[kinesisanalytics_mixins.CfnApplicationPropsMixin.RecordColumnProperty(
            mapping="mapping",
            name="name",
            sql_type="sqlType"
        )],
        record_encoding="recordEncoding",
        record_format=kinesisanalytics_mixins.CfnApplicationPropsMixin.RecordFormatProperty(
            mapping_parameters=kinesisanalytics_mixins.CfnApplicationPropsMixin.MappingParametersProperty(
                csv_mapping_parameters=kinesisanalytics_mixins.CfnApplicationPropsMixin.CSVMappingParametersProperty(
                    record_column_delimiter="recordColumnDelimiter",
                    record_row_delimiter="recordRowDelimiter"
                ),
                json_mapping_parameters=kinesisanalytics_mixins.CfnApplicationPropsMixin.JSONMappingParametersProperty(
                    record_row_path="recordRowPath"
                )
            ),
            record_format_type="recordFormatType"
        )
    ),
    kinesis_firehose_input=kinesisanalytics_mixins.CfnApplicationPropsMixin.KinesisFirehoseInputProperty(
        resource_arn="resourceArn",
        role_arn="roleArn"
    ),
    kinesis_streams_input=kinesisanalytics_mixins.CfnApplicationPropsMixin.KinesisStreamsInputProperty(
        resource_arn="resourceArn",
        role_arn="roleArn"
    ),
    name_prefix="namePrefix"
)

Attributes

input_parallelism

Describes the number of in-application streams to create.

Data from your source is routed to these in-application input streams.

See Configuring Application Input .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-input.html#cfn-kinesisanalytics-application-input-inputparallelism

input_processing_configuration

The InputProcessingConfiguration for the input. An input processor transforms records as they are received from the stream, before the application’s SQL code executes. Currently, the only input processing configuration available is InputLambdaProcessor .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-input.html#cfn-kinesisanalytics-application-input-inputprocessingconfiguration

input_schema

Describes the format of the data in the streaming source, and how each data element maps to corresponding columns in the in-application stream that is being created.

Also used to describe the format of the reference data source.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-input.html#cfn-kinesisanalytics-application-input-inputschema

kinesis_firehose_input

If the streaming source is an Amazon Kinesis Firehose delivery stream, identifies the delivery stream’s ARN and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.

Note: Either KinesisStreamsInput or KinesisFirehoseInput is required.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-input.html#cfn-kinesisanalytics-application-input-kinesisfirehoseinput

kinesis_streams_input

If the streaming source is an Amazon Kinesis stream, identifies the stream’s Amazon Resource Name (ARN) and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.

Note: Either KinesisStreamsInput or KinesisFirehoseInput is required.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-input.html#cfn-kinesisanalytics-application-input-kinesisstreamsinput

name_prefix

Name prefix to use when creating an in-application stream.

Suppose that you specify a prefix “MyInApplicationStream.” Amazon Kinesis Analytics then creates one or more (as per the InputParallelism count you specified) in-application streams with names “MyInApplicationStream_001,” “MyInApplicationStream_002,” and so on.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-input.html#cfn-kinesisanalytics-application-input-nameprefix

InputSchemaProperty

class CfnApplicationPropsMixin.InputSchemaProperty(*, record_columns=None, record_encoding=None, record_format=None)

Bases: object

Describes the format of the data in the streaming source, and how each data element maps to corresponding columns in the in-application stream that is being created.

Also used to describe the format of the reference data source.

Parameters:

record_columns (Union[IResolvable, Sequence[Union[IResolvable, RecordColumnProperty, Dict[str, Any]]], None]) – A list of RecordColumn objects.
record_encoding (Optional[str]) – Specifies the encoding of the records in the streaming source. For example, UTF-8.
record_format (Union[IResolvable, RecordFormatProperty, Dict[str, Any], None]) – Specifies the format of the records on the streaming source.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-inputschema.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_kinesisanalytics import mixins as kinesisanalytics_mixins

input_schema_property = kinesisanalytics_mixins.CfnApplicationPropsMixin.InputSchemaProperty(
    record_columns=[kinesisanalytics_mixins.CfnApplicationPropsMixin.RecordColumnProperty(
        mapping="mapping",
        name="name",
        sql_type="sqlType"
    )],
    record_encoding="recordEncoding",
    record_format=kinesisanalytics_mixins.CfnApplicationPropsMixin.RecordFormatProperty(
        mapping_parameters=kinesisanalytics_mixins.CfnApplicationPropsMixin.MappingParametersProperty(
            csv_mapping_parameters=kinesisanalytics_mixins.CfnApplicationPropsMixin.CSVMappingParametersProperty(
                record_column_delimiter="recordColumnDelimiter",
                record_row_delimiter="recordRowDelimiter"
            ),
            json_mapping_parameters=kinesisanalytics_mixins.CfnApplicationPropsMixin.JSONMappingParametersProperty(
                record_row_path="recordRowPath"
            )
        ),
        record_format_type="recordFormatType"
    )
)

Attributes

record_columns

A list of RecordColumn objects.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-inputschema.html#cfn-kinesisanalytics-application-inputschema-recordcolumns

record_encoding

Specifies the encoding of the records in the streaming source.

For example, UTF-8.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-inputschema.html#cfn-kinesisanalytics-application-inputschema-recordencoding

record_format

Specifies the format of the records on the streaming source.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-inputschema.html#cfn-kinesisanalytics-application-inputschema-recordformat

JSONMappingParametersProperty

class CfnApplicationPropsMixin.JSONMappingParametersProperty(*, record_row_path=None)

Bases: object

Provides additional mapping information when JSON is the record format on the streaming source.

Parameters:: record_row_path (Optional[str]) – Path to the top-level parent that contains the records.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-jsonmappingparameters.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_kinesisanalytics import mixins as kinesisanalytics_mixins

j_sONMapping_parameters_property = kinesisanalytics_mixins.CfnApplicationPropsMixin.JSONMappingParametersProperty(
    record_row_path="recordRowPath"
)

Attributes

record_row_path

Path to the top-level parent that contains the records.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-jsonmappingparameters.html#cfn-kinesisanalytics-application-jsonmappingparameters-recordrowpath

KinesisFirehoseInputProperty

class CfnApplicationPropsMixin.KinesisFirehoseInputProperty(*, resource_arn=None, role_arn=None)

Bases: object

Identifies an Amazon Kinesis Firehose delivery stream as the streaming source.

You provide the delivery stream’s Amazon Resource Name (ARN) and an IAM role ARN that enables Amazon Kinesis Analytics to access the stream on your behalf.

Parameters:

resource_arn (Optional[str]) – ARN of the input delivery stream.
role_arn (Optional[str]) – ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to make sure that the role has the necessary permissions to access the stream.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-kinesisfirehoseinput.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_kinesisanalytics import mixins as kinesisanalytics_mixins

kinesis_firehose_input_property = kinesisanalytics_mixins.CfnApplicationPropsMixin.KinesisFirehoseInputProperty(
    resource_arn="resourceArn",
    role_arn="roleArn"
)

Attributes

resource_arn

ARN of the input delivery stream.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-kinesisfirehoseinput.html#cfn-kinesisanalytics-application-kinesisfirehoseinput-resourcearn

role_arn

ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf.

You need to make sure that the role has the necessary permissions to access the stream.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-kinesisfirehoseinput.html#cfn-kinesisanalytics-application-kinesisfirehoseinput-rolearn

KinesisStreamsInputProperty

class CfnApplicationPropsMixin.KinesisStreamsInputProperty(*, resource_arn=None, role_arn=None)

Bases: object

Identifies an Amazon Kinesis stream as the streaming source.

You provide the stream’s Amazon Resource Name (ARN) and an IAM role ARN that enables Amazon Kinesis Analytics to access the stream on your behalf.

Parameters:

resource_arn (Optional[str]) – ARN of the input Amazon Kinesis stream to read.
role_arn (Optional[str]) – ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf. You need to grant the necessary permissions to this role.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-kinesisstreamsinput.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_kinesisanalytics import mixins as kinesisanalytics_mixins

kinesis_streams_input_property = kinesisanalytics_mixins.CfnApplicationPropsMixin.KinesisStreamsInputProperty(
    resource_arn="resourceArn",
    role_arn="roleArn"
)

Attributes

resource_arn

ARN of the input Amazon Kinesis stream to read.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-kinesisstreamsinput.html#cfn-kinesisanalytics-application-kinesisstreamsinput-resourcearn

role_arn

ARN of the IAM role that Amazon Kinesis Analytics can assume to access the stream on your behalf.

You need to grant the necessary permissions to this role.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-kinesisstreamsinput.html#cfn-kinesisanalytics-application-kinesisstreamsinput-rolearn

MappingParametersProperty

class CfnApplicationPropsMixin.MappingParametersProperty(*, csv_mapping_parameters=None, json_mapping_parameters=None)

Bases: object

When configuring application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.

Parameters:

csv_mapping_parameters (Union[IResolvable, CSVMappingParametersProperty, Dict[str, Any], None]) – Provides additional mapping information when the record format uses delimiters (for example, CSV).
json_mapping_parameters (Union[IResolvable, JSONMappingParametersProperty, Dict[str, Any], None]) – Provides additional mapping information when JSON is the record format on the streaming source.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-mappingparameters.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_kinesisanalytics import mixins as kinesisanalytics_mixins

mapping_parameters_property = kinesisanalytics_mixins.CfnApplicationPropsMixin.MappingParametersProperty(
    csv_mapping_parameters=kinesisanalytics_mixins.CfnApplicationPropsMixin.CSVMappingParametersProperty(
        record_column_delimiter="recordColumnDelimiter",
        record_row_delimiter="recordRowDelimiter"
    ),
    json_mapping_parameters=kinesisanalytics_mixins.CfnApplicationPropsMixin.JSONMappingParametersProperty(
        record_row_path="recordRowPath"
    )
)

Attributes

csv_mapping_parameters

Provides additional mapping information when the record format uses delimiters (for example, CSV).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-mappingparameters.html#cfn-kinesisanalytics-application-mappingparameters-csvmappingparameters

json_mapping_parameters

Provides additional mapping information when JSON is the record format on the streaming source.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-mappingparameters.html#cfn-kinesisanalytics-application-mappingparameters-jsonmappingparameters

RecordColumnProperty

class CfnApplicationPropsMixin.RecordColumnProperty(*, mapping=None, name=None, sql_type=None)

Bases: object

Describes the mapping of each data element in the streaming source to the corresponding column in the in-application stream.

Also used to describe the format of the reference data source.

Parameters:

mapping (Optional[str]) – Reference to the data element in the streaming input or the reference data source. This element is required if the RecordFormatType is JSON .
name (Optional[str]) – Name of the column created in the in-application input stream or reference table.
sql_type (Optional[str]) – Type of column created in the in-application input stream or reference table.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-recordcolumn.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_kinesisanalytics import mixins as kinesisanalytics_mixins

record_column_property = kinesisanalytics_mixins.CfnApplicationPropsMixin.RecordColumnProperty(
    mapping="mapping",
    name="name",
    sql_type="sqlType"
)

Attributes

mapping

Reference to the data element in the streaming input or the reference data source.

This element is required if the RecordFormatType is JSON .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-recordcolumn.html#cfn-kinesisanalytics-application-recordcolumn-mapping

name

Name of the column created in the in-application input stream or reference table.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-recordcolumn.html#cfn-kinesisanalytics-application-recordcolumn-name

sql_type

Type of column created in the in-application input stream or reference table.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-recordcolumn.html#cfn-kinesisanalytics-application-recordcolumn-sqltype

RecordFormatProperty

class CfnApplicationPropsMixin.RecordFormatProperty(*, mapping_parameters=None, record_format_type=None)

Bases: object

Describes the record format and relevant mapping information that should be applied to schematize the records on the stream.

Parameters:

mapping_parameters (Union[IResolvable, MappingParametersProperty, Dict[str, Any], None]) – When configuring application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.
record_format_type (Optional[str]) – The type of record format.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-recordformat.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_kinesisanalytics import mixins as kinesisanalytics_mixins

record_format_property = kinesisanalytics_mixins.CfnApplicationPropsMixin.RecordFormatProperty(
    mapping_parameters=kinesisanalytics_mixins.CfnApplicationPropsMixin.MappingParametersProperty(
        csv_mapping_parameters=kinesisanalytics_mixins.CfnApplicationPropsMixin.CSVMappingParametersProperty(
            record_column_delimiter="recordColumnDelimiter",
            record_row_delimiter="recordRowDelimiter"
        ),
        json_mapping_parameters=kinesisanalytics_mixins.CfnApplicationPropsMixin.JSONMappingParametersProperty(
            record_row_path="recordRowPath"
        )
    ),
    record_format_type="recordFormatType"
)

Attributes

mapping_parameters

When configuring application input at the time of creating or updating an application, provides additional mapping information specific to the record format (such as JSON, CSV, or record fields delimited by some delimiter) on the streaming source.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-recordformat.html#cfn-kinesisanalytics-application-recordformat-mappingparameters

record_format_type

The type of record format.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-application-recordformat.html#cfn-kinesisanalytics-application-recordformat-recordformattype