CfnApplicationReferenceDataSourceProps

class aws_cdk.aws_kinesisanalyticsv2.CfnApplicationReferenceDataSourceProps(*, application_name, reference_data_source)

Bases: object

Properties for defining a CfnApplicationReferenceDataSource.

Parameters
  • application_name (str) – The name of the application.

  • reference_data_source (Union[ReferenceDataSourceProperty, Dict[str, Any], IResolvable]) – For a SQL-based Kinesis Data Analytics application, describes the reference data source by providing the source information (Amazon 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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalyticsv2-applicationreferencedatasource.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 import aws_kinesisanalyticsv2 as kinesisanalyticsv2

cfn_application_reference_data_source_props = kinesisanalyticsv2.CfnApplicationReferenceDataSourceProps(
    application_name="applicationName",
    reference_data_source=kinesisanalyticsv2.CfnApplicationReferenceDataSource.ReferenceDataSourceProperty(
        reference_schema=kinesisanalyticsv2.CfnApplicationReferenceDataSource.ReferenceSchemaProperty(
            record_columns=[kinesisanalyticsv2.CfnApplicationReferenceDataSource.RecordColumnProperty(
                name="name",
                sql_type="sqlType",

                # the properties below are optional
                mapping="mapping"
            )],
            record_format=kinesisanalyticsv2.CfnApplicationReferenceDataSource.RecordFormatProperty(
                record_format_type="recordFormatType",

                # the properties below are optional
                mapping_parameters=kinesisanalyticsv2.CfnApplicationReferenceDataSource.MappingParametersProperty(
                    csv_mapping_parameters=kinesisanalyticsv2.CfnApplicationReferenceDataSource.CSVMappingParametersProperty(
                        record_column_delimiter="recordColumnDelimiter",
                        record_row_delimiter="recordRowDelimiter"
                    ),
                    json_mapping_parameters=kinesisanalyticsv2.CfnApplicationReferenceDataSource.JSONMappingParametersProperty(
                        record_row_path="recordRowPath"
                    )
                )
            ),

            # the properties below are optional
            record_encoding="recordEncoding"
        ),

        # the properties below are optional
        s3_reference_data_source=kinesisanalyticsv2.CfnApplicationReferenceDataSource.S3ReferenceDataSourceProperty(
            bucket_arn="bucketArn",
            file_key="fileKey"
        ),
        table_name="tableName"
    )
)

Attributes

application_name

The name of the application.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalyticsv2-applicationreferencedatasource.html#cfn-kinesisanalyticsv2-applicationreferencedatasource-applicationname

reference_data_source

For a SQL-based Kinesis Data Analytics application, describes the reference data source by providing the source information (Amazon 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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalyticsv2-applicationreferencedatasource.html#cfn-kinesisanalyticsv2-applicationreferencedatasource-referencedatasource