Package software.amazon.awscdk.services.kinesisanalytics

Class CfnApplicationReferenceDataSourceV2

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.CfnApplicationReferenceDataSourceV2

All Implemented Interfaces:

IEnvironmentAware, IInspectable, IApplicationReferenceDataSourceV2Ref, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)",
           date="2025-11-10T13:40:08.330Z")
@Stability(Deprecated)
@Deprecated
public class CfnApplicationReferenceDataSourceV2
extends CfnResource
implements IInspectable, IApplicationReferenceDataSourceV2Ref

Deprecated.

use aws-kinesisanalyticsv2 instead

(deprecated) 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.services.kinesisanalytics.*;
 CfnApplicationReferenceDataSourceV2 cfnApplicationReferenceDataSourceV2 = CfnApplicationReferenceDataSourceV2.Builder.create(this, "MyCfnApplicationReferenceDataSourceV2")
         .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")
                         .build())
                 .tableName("tableName")
                 .build())
         .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	CfnApplicationReferenceDataSourceV2.Builder	Deprecated.
static interface	CfnApplicationReferenceDataSourceV2.CSVMappingParametersProperty	Deprecated. For a SQL-based Kinesis Data Analytics application, provides additional mapping information when the record format uses delimiters, such as CSV.
static interface	CfnApplicationReferenceDataSourceV2.JSONMappingParametersProperty	Deprecated. For a SQL-based Kinesis Data Analytics application, provides additional mapping information when JSON is the record format on the streaming source.
static interface	CfnApplicationReferenceDataSourceV2.MappingParametersProperty	Deprecated. 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	CfnApplicationReferenceDataSourceV2.RecordColumnProperty	Deprecated. 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	CfnApplicationReferenceDataSourceV2.RecordFormatProperty	Deprecated. 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	CfnApplicationReferenceDataSourceV2.ReferenceDataSourceProperty	Deprecated. 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	CfnApplicationReferenceDataSourceV2.ReferenceSchemaProperty	Deprecated. 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	CfnApplicationReferenceDataSourceV2.S3ReferenceDataSourceProperty	Deprecated. 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.amazon.awscdk.services.kinesisanalytics.IApplicationReferenceDataSourceV2Ref

IApplicationReferenceDataSourceV2Ref.Jsii$Default, IApplicationReferenceDataSourceV2Ref.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	Deprecated.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
String	getApplicationName()	Deprecated.
ApplicationReferenceDataSourceV2Reference	getApplicationReferenceDataSourceRef()	Deprecated.
String	getAttrId()	Deprecated.
protected Map<String,Object>	getCfnProperties()	Deprecated.
Object	getReferenceDataSource()	Deprecated.
void	inspect(TreeInspector inspector)	Deprecated.
protected Map<String,Object>	renderProperties(Map<String,Object> props)	Deprecated.
void	setApplicationName(String value)	Deprecated.
void	setReferenceDataSource(IResolvable value)	Deprecated.
void	setReferenceDataSource(CfnApplicationReferenceDataSourceV2.ReferenceDataSourceProperty value)	Deprecated.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, 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.awscdk.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Deprecated)
@Deprecated
public static final String CFN_RESOURCE_TYPE_NAME

Deprecated.

(deprecated) The CloudFormation resource type name for this resource class.

Constructor Details

CfnApplicationReferenceDataSourceV2

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

Deprecated.

CfnApplicationReferenceDataSourceV2

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

Deprecated.

CfnApplicationReferenceDataSourceV2

@Stability(Deprecated)
@Deprecated
public CfnApplicationReferenceDataSourceV2(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnApplicationReferenceDataSourceV2Props props)

Deprecated.

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(Deprecated)
@Deprecated
public void inspect(@NotNull
 TreeInspector inspector)

Deprecated.

(deprecated) 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(Deprecated)
@Deprecated
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Deprecated.

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getApplicationReferenceDataSourceRef

@Stability(Deprecated)
@Deprecated
@NotNull
public ApplicationReferenceDataSourceV2Reference getApplicationReferenceDataSourceRef()

Deprecated.

(deprecated) A reference to a ApplicationReferenceDataSource resource.

Specified by:

getApplicationReferenceDataSourceRef in interface IApplicationReferenceDataSourceV2Ref

getAttrId

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

Deprecated.

getCfnProperties

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

Deprecated.

Overrides:

getCfnProperties in class CfnResource

getApplicationName

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

Deprecated.

(deprecated) The name of the application.

setApplicationName

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

Deprecated.

(deprecated) The name of the application.

getReferenceDataSource

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

Deprecated.

(deprecated) 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.

Returns union: either IResolvable or CfnApplicationReferenceDataSourceV2.ReferenceDataSourceProperty

setReferenceDataSource

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

Deprecated.

(deprecated) 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.

setReferenceDataSource

@Stability(Deprecated)
@Deprecated
public void setReferenceDataSource(@NotNull
 CfnApplicationReferenceDataSourceV2.ReferenceDataSourceProperty value)

Deprecated.

(deprecated) 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.