Package software.amazon.awscdk.services.kinesisanalytics

Interface CfnApplicationReferenceDataSourceProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnApplicationReferenceDataSourceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.109.0 (build c221850)",
           date="2025-03-19T18:01:37.218Z")
@Stability(Stable)
public interface CfnApplicationReferenceDataSourceProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnApplicationReferenceDataSource.

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.*;
 CfnApplicationReferenceDataSourceProps cfnApplicationReferenceDataSourceProps = CfnApplicationReferenceDataSourceProps.builder()
         .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	Interface	Description
static final class	CfnApplicationReferenceDataSourceProps.Builder	A builder for CfnApplicationReferenceDataSourceProps
static final class	CfnApplicationReferenceDataSourceProps.Jsii$Proxy	An implementation for CfnApplicationReferenceDataSourceProps

Method Summary

Modifier and Type	Method	Description
static CfnApplicationReferenceDataSourceProps.Builder	builder()
String	getApplicationName()	Name of an existing application.
Object	getReferenceDataSource()	The reference data source can be an object in your Amazon S3 bucket.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApplicationName

@Stability(Stable)
@NotNull
String getApplicationName()

Name of an existing application.

See Also:

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

getReferenceDataSource

@Stability(Stable)
@NotNull
Object getReferenceDataSource()

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

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.

See Also:

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

builder

@Stability(Stable)
static CfnApplicationReferenceDataSourceProps.Builder builder()

Returns:

a CfnApplicationReferenceDataSourceProps.Builder of CfnApplicationReferenceDataSourceProps