Package software.amazon.awscdk.services.kinesisanalytics

Class CfnApplicationReferenceDataSource

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.kinesisanalytics.CfnApplicationReferenceDataSource

All Implemented Interfaces:

IInspectable, IApplicationReferenceDataSourceRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-24T13:34:40.779Z")
@Stability(Stable)
public class CfnApplicationReferenceDataSource
extends CfnResource
implements IInspectable, IApplicationReferenceDataSourceRef

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.services.kinesisanalytics.*;
 CfnApplicationReferenceDataSource cfnApplicationReferenceDataSource = CfnApplicationReferenceDataSource.Builder.create(this, "MyCfnApplicationReferenceDataSource")
         .applicationName("applicationName")
         .referenceDataSource(ReferenceDataSourceProperty.builder()
                 .referenceSchema(ReferenceSchemaProperty.builder()
                         .recordColumns(List.of(RecordColumnProperty.builder()
                                 .name("name")
                                 .sqlType("sqlType")
                                 // the properties below are optional
                                 .mapping("mapping")
                                 .build()))
                         .recordFormat(RecordFormatProperty.builder()
                                 .recordFormatType("recordFormatType")
                                 // the properties below are optional
                                 .mappingParameters(MappingParametersProperty.builder()
                                         .csvMappingParameters(CSVMappingParametersProperty.builder()
                                                 .recordColumnDelimiter("recordColumnDelimiter")
                                                 .recordRowDelimiter("recordRowDelimiter")
                                                 .build())
                                         .jsonMappingParameters(JSONMappingParametersProperty.builder()
                                                 .recordRowPath("recordRowPath")
                                                 .build())
                                         .build())
                                 .build())
                         // the properties below are optional
                         .recordEncoding("recordEncoding")
                         .build())
                 // the properties below are optional
                 .s3ReferenceDataSource(S3ReferenceDataSourceProperty.builder()
                         .bucketArn("bucketArn")
                         .fileKey("fileKey")
                         .referenceRoleArn("referenceRoleArn")
                         .build())
                 .tableName("tableName")
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnApplicationReferenceDataSource.Builder	A fluent builder for CfnApplicationReferenceDataSource.
static interface	CfnApplicationReferenceDataSource.CSVMappingParametersProperty	Provides additional mapping information when the record format uses delimiters, such as CSV.
static interface	CfnApplicationReferenceDataSource.JSONMappingParametersProperty	Provides additional mapping information when JSON is the record format on the streaming source.
static interface	CfnApplicationReferenceDataSource.MappingParametersProperty	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.
static interface	CfnApplicationReferenceDataSource.RecordColumnProperty	Describes the mapping of each data element in the streaming source to the corresponding column in the in-application stream.
static interface	CfnApplicationReferenceDataSource.RecordFormatProperty	Describes the record format and relevant mapping information that should be applied to schematize the records on the stream.
static interface	CfnApplicationReferenceDataSource.ReferenceDataSourceProperty	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.
static interface	CfnApplicationReferenceDataSource.ReferenceSchemaProperty	The ReferenceSchema property type specifies the format of the data in the reference source for a SQL-based Amazon Kinesis Data Analytics application.
static interface	CfnApplicationReferenceDataSource.S3ReferenceDataSourceProperty	Identifies the 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.amazon.awscdk.services.kinesisanalytics.IApplicationReferenceDataSourceRef

IApplicationReferenceDataSourceRef.Jsii$Default, IApplicationReferenceDataSourceRef.Jsii$Proxy

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

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnApplicationReferenceDataSource(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnApplicationReferenceDataSource(software.amazon.jsii.JsiiObjectRef objRef)
	CfnApplicationReferenceDataSource(software.constructs.Construct scope, String id, CfnApplicationReferenceDataSourceProps props)

Method Summary

Modifier and Type	Method	Description
String	getApplicationName()	Name of an existing application.
ApplicationReferenceDataSourceReference	getApplicationReferenceDataSourceRef()	A reference to a ApplicationReferenceDataSource resource.
String	getAttrId()
protected Map<String,Object>	getCfnProperties()
Object	getReferenceDataSource()	The reference data source can be an object in your Amazon S3 bucket.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setApplicationName(String value)	Name of an existing application.
void	setReferenceDataSource(IResolvable value)	The reference data source can be an object in your Amazon S3 bucket.
void	setReferenceDataSource(CfnApplicationReferenceDataSource.ReferenceDataSourceProperty value)	The reference data source can be an object in your Amazon S3 bucket.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnApplicationReferenceDataSource

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

CfnApplicationReferenceDataSource

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

CfnApplicationReferenceDataSource

@Stability(Stable)
public CfnApplicationReferenceDataSource(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnApplicationReferenceDataSourceProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getApplicationReferenceDataSourceRef

@Stability(Stable)
@NotNull
public ApplicationReferenceDataSourceReference getApplicationReferenceDataSourceRef()

A reference to a ApplicationReferenceDataSource resource.

Specified by:

getApplicationReferenceDataSourceRef in interface IApplicationReferenceDataSourceRef

getAttrId

@Stability(Stable)
@NotNull
public String getAttrId()

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getApplicationName

@Stability(Stable)
@NotNull
public String getApplicationName()

Name of an existing application.

setApplicationName

@Stability(Stable)
public void setApplicationName(@NotNull
 String value)

Name of an existing application.

getReferenceDataSource

@Stability(Stable)
@NotNull
public Object getReferenceDataSource()

The reference data source can be an object in your Amazon S3 bucket.

Returns union: either IResolvable or CfnApplicationReferenceDataSource.ReferenceDataSourceProperty

setReferenceDataSource

@Stability(Stable)
public void setReferenceDataSource(@NotNull
 IResolvable value)

The reference data source can be an object in your Amazon S3 bucket.

setReferenceDataSource

@Stability(Stable)
public void setReferenceDataSource(@NotNull
 CfnApplicationReferenceDataSource.ReferenceDataSourceProperty value)

The reference data source can be an object in your Amazon S3 bucket.