Class CfnApplicationReferenceDataSourcePropsMixin
java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.Mixin
software.amazon.awscdk.cfnpropertymixins.services.kinesisanalytics.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.698Z")
@Stability(Stable)
public class CfnApplicationReferenceDataSourcePropsMixin
extends Mixin
implements software.constructs.IMixin
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.
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.kinesisanalytics.*;
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")
.referenceRoleArn("referenceRoleArn")
.build())
.tableName("tableName")
.build())
.build())
.strategy(mergeStrategy)
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classA fluent builder forCfnApplicationReferenceDataSourcePropsMixin.static interfaceProvides additional mapping information when the record format uses delimiters, such as CSV.static interfaceProvides additional mapping information when JSON is the record format on the streaming source.static interfaceWhen 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.static interfaceDescribes the mapping of each data element in the streaming source to the corresponding column in the in-application stream.static interfaceDescribes the record format and relevant mapping information that should be applied to schematize the records on the stream.static interfaceDescribes 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.static interfaceThe ReferenceSchema property type specifies the format of the data in the reference source for a SQL-based Amazon Kinesis Data Analytics application.static interfaceIdentifies the S3 bucket and object that contains the reference data.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationModeNested classes/interfaces inherited from interface software.constructs.IMixin
software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy -
Field Summary
Fields -
Constructor Summary
ConstructorsModifierConstructorDescriptionCreate a mixin to apply properties toAWS::KinesisAnalytics::ApplicationReferenceDataSource.CfnApplicationReferenceDataSourcePropsMixin(CfnApplicationReferenceDataSourceMixinProps props, CfnPropertyMixinOptions options) Create a mixin to apply properties toAWS::KinesisAnalytics::ApplicationReferenceDataSource.protectedCfnApplicationReferenceDataSourcePropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protectedCfnApplicationReferenceDataSourcePropsMixin(software.amazon.jsii.JsiiObjectRef objRef) -
Method Summary
Modifier and TypeMethodDescriptionvoidapplyTo(software.constructs.IConstruct construct) Apply the mixin properties to the construct.getProps()protected IMergeStrategysupports(software.constructs.IConstruct construct) Check if this mixin supports the given construct.Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSetMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
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 toAWS::KinesisAnalytics::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 toAWS::KinesisAnalytics::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. -
supports
@Stability(Stable) @NotNull public Boolean supports(@NotNull software.constructs.IConstruct construct) Check if this mixin supports the given construct. -
getProps
-
getStrategy
-