@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
date="2023-01-31T18:36:47.564Z")
public class CfnApplicationReferenceDataSource
extends CfnResource
implements IInspectable
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();
| Modifier and Type | Class and Description |
|---|---|
static 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.
|
IInspectable.Jsii$Default, IInspectable.Jsii$ProxyIConstruct.Jsii$Default| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
| Modifier | Constructor and Description |
|---|---|
|
CfnApplicationReferenceDataSource(Construct scope,
java.lang.String id,
CfnApplicationReferenceDataSourceProps props)
Create a new `AWS::KinesisAnalytics::ApplicationReferenceDataSource`.
|
protected |
CfnApplicationReferenceDataSource(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnApplicationReferenceDataSource(software.amazon.jsii.JsiiObjectRef objRef) |
| Modifier and Type | Method and Description |
|---|---|
java.lang.String |
getApplicationName()
Name of an existing application.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.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 java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setApplicationName(java.lang.String value)
Name of an existing application.
|
void |
setReferenceDataSource(CfnApplicationReferenceDataSource.ReferenceDataSourceProperty value)
The reference data source can be an object in your Amazon S3 bucket.
|
void |
setReferenceDataSource(IResolvable value)
The reference data source can be an object in your Amazon S3 bucket.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validatePropertiesgetRefgetCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalIdgetNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validatepublic static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnApplicationReferenceDataSource(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnApplicationReferenceDataSource(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnApplicationReferenceDataSource(Construct scope, java.lang.String id, CfnApplicationReferenceDataSourceProps props)
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.public void inspect(TreeInspector inspector)
inspect in interface IInspectableinspector - - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties in class CfnResourceprops - This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties in class CfnResourcepublic java.lang.String getApplicationName()
public void setApplicationName(java.lang.String value)
public java.lang.Object getReferenceDataSource()
Amazon Kinesis Analytics reads the object and copies the data into the in-application table that is created. You provide an S3 bucket, object key name, and the resulting in-application table that is created. You must also provide an IAM role with the necessary permissions that Amazon Kinesis Analytics can assume to read the object from your S3 bucket on your behalf.
public void setReferenceDataSource(IResolvable value)
Amazon Kinesis Analytics reads the object and copies the data into the in-application table that is created. You provide an S3 bucket, object key name, and the resulting in-application table that is created. You must also provide an IAM role with the necessary permissions that Amazon Kinesis Analytics can assume to read the object from your S3 bucket on your behalf.
public void setReferenceDataSource(CfnApplicationReferenceDataSource.ReferenceDataSourceProperty value)
Amazon Kinesis Analytics reads the object and copies the data into the in-application table that is created. You provide an S3 bucket, object key name, and the resulting in-application table that is created. You must also provide an IAM role with the necessary permissions that Amazon Kinesis Analytics can assume to read the object from your S3 bucket on your behalf.