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.kinesisanalyticsv2.CfnApplicationReferenceDataSource
- All Implemented Interfaces:
IInspectable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2024-11-21T06:34:10.130Z")
@Stability(Stable)
public class CfnApplicationReferenceDataSource
extends CfnResource
implements IInspectable
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();
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
A fluent builder forCfnApplicationReferenceDataSource
.static interface
For a SQL-based Kinesis Data Analytics application, provides additional mapping information when the record format uses delimiters, such as CSV.static interface
For a SQL-based Kinesis Data Analytics application, provides additional mapping information when JSON is the record format on the streaming source.static interface
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
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
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
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
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
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.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
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
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 TypeMethodDescriptionThe name of the application.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.renderProperties
(Map<String, Object> props) void
setApplicationName
(String value) The name of the application.void
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
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.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.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
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
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- 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 classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrId
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getApplicationName
The name of the application. -
setApplicationName
The name of the application. -
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
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(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.
-