software.amazon.awscdk.services.kinesisanalyticsv2

Class CfnApplicationReferenceDataSource

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.kinesisanalyticsv2.CfnApplicationReferenceDataSource

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:36.641Z")
 @Stability(value=Stable)
public class CfnApplicationReferenceDataSource
extends CfnResource
implements IInspectable

A CloudFormation `AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource`.

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.kinesisanalyticsv2.*;
 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")
                         .build())
                 .tableName("tableName")
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnApplicationReferenceDataSource.Builder A fluent builder for CfnApplicationReferenceDataSource.
static interface	CfnApplicationReferenceDataSource.CSVMappingParametersProperty For a SQL-based Kinesis Data Analytics application, provides additional mapping information when the record format uses delimiters, such as CSV.
static interface	CfnApplicationReferenceDataSource.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	CfnApplicationReferenceDataSource.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	CfnApplicationReferenceDataSource.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	CfnApplicationReferenceDataSource.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	CfnApplicationReferenceDataSource.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	CfnApplicationReferenceDataSource.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	CfnApplicationReferenceDataSource.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.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnApplicationReferenceDataSource(Construct scope, String id, CfnApplicationReferenceDataSourceProps props) Create a new `AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource`.
protected	CfnApplicationReferenceDataSource(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnApplicationReferenceDataSource(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getApplicationName() The name of the application.
protected Map<String,Object>	getCfnProperties()
Object	getReferenceDataSource() 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.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setApplicationName(String value) The name of the application.
void	setReferenceDataSource(CfnApplicationReferenceDataSource.ReferenceDataSourceProperty value) 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.
void	setReferenceDataSource(IResolvable value) 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.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

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.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnApplicationReferenceDataSource

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

CfnApplicationReferenceDataSource

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

CfnApplicationReferenceDataSource

@Stability(value=Stable)
public CfnApplicationReferenceDataSource(@NotNull
                                                                  Construct scope,
                                                                  @NotNull
                                                                  String id,
                                                                  @NotNull
                                                                  CfnApplicationReferenceDataSourceProps props)

Create a new `AWS::KinesisAnalyticsV2::ApplicationReferenceDataSource`.

Parameters:

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

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=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(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getApplicationName

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

The name of the application.

setApplicationName

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

The name of the application.

getReferenceDataSource

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

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(value=Stable)
public void setReferenceDataSource(@NotNull
                                                            IResolvable value)

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(value=Stable)
public void setReferenceDataSource(@NotNull
                                                            CfnApplicationReferenceDataSource.ReferenceDataSourceProperty value)

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.