CfnApplicationReferenceDataSourcePropsMixin

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

Bases: Mixin

Adds a reference data source to an existing application.

Amazon Kinesis Analytics reads reference data (that is, an Amazon S3 object) and creates an in-application table within your application. In the request, you provide the source (S3 bucket name and object key name), name of the in-application table to create, and the necessary mapping information that describes how data in Amazon S3 object maps to columns in the resulting in-application table.

For conceptual information, see Configuring Application Input . For the limits on data sources you can add to your application, see Limits .

This operation requires permissions to perform the kinesisanalytics:AddApplicationOutput action.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalytics-applicationreferencedatasource.html

CloudformationResource:

AWS::KinesisAnalytics::ApplicationReferenceDataSource

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_reference_data_source_props_mixin = kinesisanalytics_mixins.CfnApplicationReferenceDataSourcePropsMixin(kinesisanalytics_mixins.CfnApplicationReferenceDataSourceMixinProps(
    application_name="applicationName",
    reference_data_source=kinesisanalytics_mixins.CfnApplicationReferenceDataSourcePropsMixin.ReferenceDataSourceProperty(
        reference_schema=kinesisanalytics_mixins.CfnApplicationReferenceDataSourcePropsMixin.ReferenceSchemaProperty(
            record_columns=[kinesisanalytics_mixins.CfnApplicationReferenceDataSourcePropsMixin.RecordColumnProperty(
                mapping="mapping",
                name="name",
                sql_type="sqlType"
            )],
            record_encoding="recordEncoding",
            record_format=kinesisanalytics_mixins.CfnApplicationReferenceDataSourcePropsMixin.RecordFormatProperty(
                mapping_parameters=kinesisanalytics_mixins.CfnApplicationReferenceDataSourcePropsMixin.MappingParametersProperty(
                    csv_mapping_parameters=kinesisanalytics_mixins.CfnApplicationReferenceDataSourcePropsMixin.CSVMappingParametersProperty(
                        record_column_delimiter="recordColumnDelimiter",
                        record_row_delimiter="recordRowDelimiter"
                    ),
                    json_mapping_parameters=kinesisanalytics_mixins.CfnApplicationReferenceDataSourcePropsMixin.JSONMappingParametersProperty(
                        record_row_path="recordRowPath"
                    )
                ),
                record_format_type="recordFormatType"
            )
        ),
        s3_reference_data_source=kinesisanalytics_mixins.CfnApplicationReferenceDataSourcePropsMixin.S3ReferenceDataSourceProperty(
            bucket_arn="bucketArn",
            file_key="fileKey",
            reference_role_arn="referenceRoleArn"
        ),
        table_name="tableName"
    )
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

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 = ['applicationName', 'referenceDataSource']

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 CfnApplicationReferenceDataSourcePropsMixin.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-applicationreferencedatasource-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.CfnApplicationReferenceDataSourcePropsMixin.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-applicationreferencedatasource-csvmappingparameters.html#cfn-kinesisanalytics-applicationreferencedatasource-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-applicationreferencedatasource-csvmappingparameters.html#cfn-kinesisanalytics-applicationreferencedatasource-csvmappingparameters-recordrowdelimiter

JSONMappingParametersProperty

class CfnApplicationReferenceDataSourcePropsMixin.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-applicationreferencedatasource-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.CfnApplicationReferenceDataSourcePropsMixin.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-applicationreferencedatasource-jsonmappingparameters.html#cfn-kinesisanalytics-applicationreferencedatasource-jsonmappingparameters-recordrowpath

MappingParametersProperty

class CfnApplicationReferenceDataSourcePropsMixin.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-applicationreferencedatasource-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.CfnApplicationReferenceDataSourcePropsMixin.MappingParametersProperty(
    csv_mapping_parameters=kinesisanalytics_mixins.CfnApplicationReferenceDataSourcePropsMixin.CSVMappingParametersProperty(
        record_column_delimiter="recordColumnDelimiter",
        record_row_delimiter="recordRowDelimiter"
    ),
    json_mapping_parameters=kinesisanalytics_mixins.CfnApplicationReferenceDataSourcePropsMixin.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-applicationreferencedatasource-mappingparameters.html#cfn-kinesisanalytics-applicationreferencedatasource-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-applicationreferencedatasource-mappingparameters.html#cfn-kinesisanalytics-applicationreferencedatasource-mappingparameters-jsonmappingparameters

RecordColumnProperty

class CfnApplicationReferenceDataSourcePropsMixin.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-applicationreferencedatasource-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.CfnApplicationReferenceDataSourcePropsMixin.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-applicationreferencedatasource-recordcolumn.html#cfn-kinesisanalytics-applicationreferencedatasource-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-applicationreferencedatasource-recordcolumn.html#cfn-kinesisanalytics-applicationreferencedatasource-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-applicationreferencedatasource-recordcolumn.html#cfn-kinesisanalytics-applicationreferencedatasource-recordcolumn-sqltype

RecordFormatProperty

class CfnApplicationReferenceDataSourcePropsMixin.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-applicationreferencedatasource-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.CfnApplicationReferenceDataSourcePropsMixin.RecordFormatProperty(
    mapping_parameters=kinesisanalytics_mixins.CfnApplicationReferenceDataSourcePropsMixin.MappingParametersProperty(
        csv_mapping_parameters=kinesisanalytics_mixins.CfnApplicationReferenceDataSourcePropsMixin.CSVMappingParametersProperty(
            record_column_delimiter="recordColumnDelimiter",
            record_row_delimiter="recordRowDelimiter"
        ),
        json_mapping_parameters=kinesisanalytics_mixins.CfnApplicationReferenceDataSourcePropsMixin.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-applicationreferencedatasource-recordformat.html#cfn-kinesisanalytics-applicationreferencedatasource-recordformat-mappingparameters

record_format_type

The type of record format.

See:

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

ReferenceDataSourceProperty

class CfnApplicationReferenceDataSourcePropsMixin.ReferenceDataSourceProperty(*, reference_schema=None, s3_reference_data_source=None, table_name=None)

Bases: object

Describes the reference data source by providing the source information (S3 bucket name and object key name), the resulting in-application table name that is created, and the necessary schema to map the data elements in the Amazon S3 object to the in-application table.

Parameters:

  • reference_schema (Union[IResolvable, ReferenceSchemaProperty, Dict[str, Any], None]) – Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.

  • s3_reference_data_source (Union[IResolvable, S3ReferenceDataSourceProperty, Dict[str, Any], None]) – Identifies the S3 bucket and object that contains the reference data. Also identifies the IAM role Amazon Kinesis Analytics can assume to read this object on your behalf. An Amazon Kinesis Analytics application loads reference data only once. If the data changes, you call the UpdateApplication operation to trigger reloading of data into your application.

  • table_name (Optional[str]) – Name of the in-application table to create.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-referencedatasource.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

reference_data_source_property = kinesisanalytics_mixins.CfnApplicationReferenceDataSourcePropsMixin.ReferenceDataSourceProperty(
    reference_schema=kinesisanalytics_mixins.CfnApplicationReferenceDataSourcePropsMixin.ReferenceSchemaProperty(
        record_columns=[kinesisanalytics_mixins.CfnApplicationReferenceDataSourcePropsMixin.RecordColumnProperty(
            mapping="mapping",
            name="name",
            sql_type="sqlType"
        )],
        record_encoding="recordEncoding",
        record_format=kinesisanalytics_mixins.CfnApplicationReferenceDataSourcePropsMixin.RecordFormatProperty(
            mapping_parameters=kinesisanalytics_mixins.CfnApplicationReferenceDataSourcePropsMixin.MappingParametersProperty(
                csv_mapping_parameters=kinesisanalytics_mixins.CfnApplicationReferenceDataSourcePropsMixin.CSVMappingParametersProperty(
                    record_column_delimiter="recordColumnDelimiter",
                    record_row_delimiter="recordRowDelimiter"
                ),
                json_mapping_parameters=kinesisanalytics_mixins.CfnApplicationReferenceDataSourcePropsMixin.JSONMappingParametersProperty(
                    record_row_path="recordRowPath"
                )
            ),
            record_format_type="recordFormatType"
        )
    ),
    s3_reference_data_source=kinesisanalytics_mixins.CfnApplicationReferenceDataSourcePropsMixin.S3ReferenceDataSourceProperty(
        bucket_arn="bucketArn",
        file_key="fileKey",
        reference_role_arn="referenceRoleArn"
    ),
    table_name="tableName"
)

Attributes

reference_schema

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-referencedatasource.html#cfn-kinesisanalytics-applicationreferencedatasource-referencedatasource-referenceschema

s3_reference_data_source

Identifies the S3 bucket and object that contains the reference data.

Also identifies the IAM role Amazon Kinesis Analytics can assume to read this object on your behalf. An Amazon Kinesis Analytics application loads reference data only once. If the data changes, you call the UpdateApplication operation to trigger reloading of data into your application.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-referencedatasource.html#cfn-kinesisanalytics-applicationreferencedatasource-referencedatasource-s3referencedatasource

table_name

Name of the in-application table to create.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-referencedatasource.html#cfn-kinesisanalytics-applicationreferencedatasource-referencedatasource-tablename

ReferenceSchemaProperty

class CfnApplicationReferenceDataSourcePropsMixin.ReferenceSchemaProperty(*, record_columns=None, record_encoding=None, record_format=None)

Bases: object

The ReferenceSchema property type specifies the format of the data in the reference source for a SQL-based Amazon Kinesis Data Analytics application.

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 reference source. For example, UTF-8.

  • record_format (Union[IResolvable, RecordFormatProperty, Dict[str, Any], None]) – Specifies the format of the records on the reference source.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-referenceschema.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

reference_schema_property = kinesisanalytics_mixins.CfnApplicationReferenceDataSourcePropsMixin.ReferenceSchemaProperty(
    record_columns=[kinesisanalytics_mixins.CfnApplicationReferenceDataSourcePropsMixin.RecordColumnProperty(
        mapping="mapping",
        name="name",
        sql_type="sqlType"
    )],
    record_encoding="recordEncoding",
    record_format=kinesisanalytics_mixins.CfnApplicationReferenceDataSourcePropsMixin.RecordFormatProperty(
        mapping_parameters=kinesisanalytics_mixins.CfnApplicationReferenceDataSourcePropsMixin.MappingParametersProperty(
            csv_mapping_parameters=kinesisanalytics_mixins.CfnApplicationReferenceDataSourcePropsMixin.CSVMappingParametersProperty(
                record_column_delimiter="recordColumnDelimiter",
                record_row_delimiter="recordRowDelimiter"
            ),
            json_mapping_parameters=kinesisanalytics_mixins.CfnApplicationReferenceDataSourcePropsMixin.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-applicationreferencedatasource-referenceschema.html#cfn-kinesisanalytics-applicationreferencedatasource-referenceschema-recordcolumns

record_encoding

Specifies the encoding of the records in the reference source.

For example, UTF-8.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-referenceschema.html#cfn-kinesisanalytics-applicationreferencedatasource-referenceschema-recordencoding

record_format

Specifies the format of the records on the reference source.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-referenceschema.html#cfn-kinesisanalytics-applicationreferencedatasource-referenceschema-recordformat

S3ReferenceDataSourceProperty

class CfnApplicationReferenceDataSourcePropsMixin.S3ReferenceDataSourceProperty(*, bucket_arn=None, file_key=None, reference_role_arn=None)

Bases: object

Identifies the S3 bucket and object that contains the reference data.

Also identifies the IAM role Amazon Kinesis Analytics can assume to read this object on your behalf.

An Amazon Kinesis Analytics application loads reference data only once. If the data changes, you call the UpdateApplication operation to trigger reloading of data into your application.

Parameters:

  • bucket_arn (Optional[str]) – Amazon Resource Name (ARN) of the S3 bucket.

  • file_key (Optional[str]) – Object key name containing reference data.

  • reference_role_arn (Optional[str]) – ARN of the IAM role that the service can assume to read data on your behalf. This role must have permission for the s3:GetObject action on the object and trust policy that allows Amazon Kinesis Analytics service principal to assume this role.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-s3referencedatasource.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

s3_reference_data_source_property = kinesisanalytics_mixins.CfnApplicationReferenceDataSourcePropsMixin.S3ReferenceDataSourceProperty(
    bucket_arn="bucketArn",
    file_key="fileKey",
    reference_role_arn="referenceRoleArn"
)

Attributes

bucket_arn

Amazon Resource Name (ARN) of the S3 bucket.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-s3referencedatasource.html#cfn-kinesisanalytics-applicationreferencedatasource-s3referencedatasource-bucketarn

file_key

Object key name containing reference data.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-s3referencedatasource.html#cfn-kinesisanalytics-applicationreferencedatasource-s3referencedatasource-filekey

reference_role_arn

ARN of the IAM role that the service can assume to read data on your behalf.

This role must have permission for the s3:GetObject action on the object and trust policy that allows Amazon Kinesis Analytics service principal to assume this role.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-applicationreferencedatasource-s3referencedatasource.html#cfn-kinesisanalytics-applicationreferencedatasource-s3referencedatasource-referencerolearn