Package software.amazon.awscdk.cfnpropertymixins.services.kinesisanalyticsv2

Class CfnApplicationReferenceDataSourcePropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.kinesisanalyticsv2.CfnApplicationReferenceDataSourcePropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:20:00.739Z")
@Stability(Stable)
public class CfnApplicationReferenceDataSourcePropsMixin
extends Mixin
implements software.constructs.IMixin

Adds a reference data source to an existing SQL-based Kinesis Data Analytics application.

Kinesis Data 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 an Amazon S3 object maps to columns in the resulting in-application table.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.kinesisanalyticsv2.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnApplicationReferenceDataSourcePropsMixin cfnApplicationReferenceDataSourcePropsMixin = CfnApplicationReferenceDataSourcePropsMixin.Builder.create(CfnApplicationReferenceDataSourceMixinProps.builder()
         .applicationName("applicationName")
         .referenceDataSource(ReferenceDataSourceProperty.builder()
                 .referenceSchema(ReferenceSchemaProperty.builder()
                         .recordColumns(List.of(RecordColumnProperty.builder()
                                 .mapping("mapping")
                                 .name("name")
                                 .sqlType("sqlType")
                                 .build()))
                         .recordEncoding("recordEncoding")
                         .recordFormat(RecordFormatProperty.builder()
                                 .mappingParameters(MappingParametersProperty.builder()
                                         .csvMappingParameters(CSVMappingParametersProperty.builder()
                                                 .recordColumnDelimiter("recordColumnDelimiter")
                                                 .recordRowDelimiter("recordRowDelimiter")
                                                 .build())
                                         .jsonMappingParameters(JSONMappingParametersProperty.builder()
                                                 .recordRowPath("recordRowPath")
                                                 .build())
                                         .build())
                                 .recordFormatType("recordFormatType")
                                 .build())
                         .build())
                 .s3ReferenceDataSource(S3ReferenceDataSourceProperty.builder()
                         .bucketArn("bucketArn")
                         .fileKey("fileKey")
                         .build())
                 .tableName("tableName")
                 .build())
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnApplicationReferenceDataSourcePropsMixin.Builder	A fluent builder for CfnApplicationReferenceDataSourcePropsMixin.
static interface	CfnApplicationReferenceDataSourcePropsMixin.CSVMappingParametersProperty	For a SQL-based Kinesis Data Analytics application, provides additional mapping information when the record format uses delimiters, such as CSV.
static interface	CfnApplicationReferenceDataSourcePropsMixin.JSONMappingParametersProperty	For a SQL-based Kinesis Data Analytics application, provides additional mapping information when JSON is the record format on the streaming source.
static interface	CfnApplicationReferenceDataSourcePropsMixin.MappingParametersProperty	When you configure a SQL-based Kinesis Data Analytics application's 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.
static interface	CfnApplicationReferenceDataSourcePropsMixin.RecordColumnProperty	For a SQL-based Kinesis Data Analytics application, describes the mapping of each data element in the streaming source to the corresponding column in the in-application stream.
static interface	CfnApplicationReferenceDataSourcePropsMixin.RecordFormatProperty	For a SQL-based Kinesis Data Analytics application, describes the record format and relevant mapping information that should be applied to schematize the records on the stream.
static interface	CfnApplicationReferenceDataSourcePropsMixin.ReferenceDataSourceProperty	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.
static interface	CfnApplicationReferenceDataSourcePropsMixin.ReferenceSchemaProperty	For a SQL-based Kinesis Data Analytics application, 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.
static interface	CfnApplicationReferenceDataSourcePropsMixin.S3ReferenceDataSourceProperty	For an SQL-based Amazon Kinesis Data Analytics application, identifies the Amazon S3 bucket and object that contains the reference data.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnApplicationReferenceDataSourcePropsMixin(CfnApplicationReferenceDataSourceMixinProps props)	Create a mixin to apply properties to AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource.
	CfnApplicationReferenceDataSourcePropsMixin(CfnApplicationReferenceDataSourceMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource.
protected	CfnApplicationReferenceDataSourcePropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnApplicationReferenceDataSourcePropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnApplicationReferenceDataSourceMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnApplicationReferenceDataSourcePropsMixin

protected CfnApplicationReferenceDataSourcePropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

CfnApplicationReferenceDataSourcePropsMixin

protected CfnApplicationReferenceDataSourcePropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnApplicationReferenceDataSourcePropsMixin

@Stability(Stable)
public CfnApplicationReferenceDataSourcePropsMixin(@NotNull
 CfnApplicationReferenceDataSourceMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

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

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnApplicationReferenceDataSourcePropsMixin

@Stability(Stable)
public CfnApplicationReferenceDataSourcePropsMixin(@NotNull
 CfnApplicationReferenceDataSourceMixinProps props)

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

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnApplicationReferenceDataSourceMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()