@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)",
date="2022-08-09T19:16:33.375Z")
public class CfnApplication
extends CfnResource
implements IInspectable
The AWS::KinesisAnalytics::Application resource creates an Amazon Kinesis Data Analytics application. For more information, see the Amazon Kinesis Data Analytics Developer Guide .
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.*;
CfnApplication cfnApplication = CfnApplication.Builder.create(this, "MyCfnApplication")
.inputs(List.of(InputProperty.builder()
.inputSchema(InputSchemaProperty.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())
.namePrefix("namePrefix")
// the properties below are optional
.inputParallelism(InputParallelismProperty.builder()
.count(123)
.build())
.inputProcessingConfiguration(InputProcessingConfigurationProperty.builder()
.inputLambdaProcessor(InputLambdaProcessorProperty.builder()
.resourceArn("resourceArn")
.roleArn("roleArn")
.build())
.build())
.kinesisFirehoseInput(KinesisFirehoseInputProperty.builder()
.resourceArn("resourceArn")
.roleArn("roleArn")
.build())
.kinesisStreamsInput(KinesisStreamsInputProperty.builder()
.resourceArn("resourceArn")
.roleArn("roleArn")
.build())
.build()))
// the properties below are optional
.applicationCode("applicationCode")
.applicationDescription("applicationDescription")
.applicationName("applicationName")
.build();
| Modifier and Type | Class and Description |
|---|---|
static class |
CfnApplication.Builder
A fluent builder for
CfnApplication. |
static interface |
CfnApplication.CSVMappingParametersProperty
Provides additional mapping information when the record format uses delimiters, such as CSV.
|
static interface |
CfnApplication.InputLambdaProcessorProperty
An object that contains the Amazon Resource Name (ARN) of the [AWS Lambda](https://docs.aws.amazon.com/lambda/) function that is used to preprocess records in the stream, and the ARN of the IAM role that is used to access the AWS Lambda function.
|
static interface |
CfnApplication.InputParallelismProperty
Describes the number of in-application streams to create for a given streaming source.
|
static interface |
CfnApplication.InputProcessingConfigurationProperty
Provides a description of a processor that is used to preprocess the records in the stream before being processed by your application code.
|
static interface |
CfnApplication.InputProperty
When you configure the application input, you specify the streaming source, the in-application stream name that is created, and the mapping between the two.
|
static interface |
CfnApplication.InputSchemaProperty
Describes the format of the data in the streaming source, and how each data element maps to corresponding columns in the in-application stream that is being created.
|
static interface |
CfnApplication.JSONMappingParametersProperty
Provides additional mapping information when JSON is the record format on the streaming source.
|
static interface |
CfnApplication.KinesisFirehoseInputProperty
Identifies an Amazon Kinesis Firehose delivery stream as the streaming source.
|
static interface |
CfnApplication.KinesisStreamsInputProperty
Identifies an Amazon Kinesis stream as the streaming source.
|
static interface |
CfnApplication.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 |
CfnApplication.RecordColumnProperty
Describes the mapping of each data element in the streaming source to the corresponding column in the in-application stream.
|
static interface |
CfnApplication.RecordFormatProperty
Describes the record format and relevant mapping information that should be applied to schematize the records on the stream.
|
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 |
|---|---|
|
CfnApplication(Construct scope,
java.lang.String id,
CfnApplicationProps props)
Create a new `AWS::KinesisAnalytics::Application`.
|
protected |
CfnApplication(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnApplication(software.amazon.jsii.JsiiObjectRef objRef) |
| Modifier and Type | Method and Description |
|---|---|
java.lang.String |
getApplicationCode()
One or more SQL statements that read input data, transform it, and generate output.
|
java.lang.String |
getApplicationDescription()
Summary description of the application.
|
java.lang.String |
getApplicationName()
Name of your Amazon Kinesis Analytics application (for example, `sample-app` ).
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.Object |
getInputs()
Use this parameter to configure the application input.
|
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 |
setApplicationCode(java.lang.String value)
One or more SQL statements that read input data, transform it, and generate output.
|
void |
setApplicationDescription(java.lang.String value)
Summary description of the application.
|
void |
setApplicationName(java.lang.String value)
Name of your Amazon Kinesis Analytics application (for example, `sample-app` ).
|
void |
setInputs(IResolvable value)
Use this parameter to configure the application input.
|
void |
setInputs(java.util.List<java.lang.Object> value)
Use this parameter to configure the application input.
|
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 CfnApplication(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnApplication(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnApplication(Construct scope, java.lang.String id, CfnApplicationProps 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.Object getInputs()
You can configure your application to receive input from a single streaming source. In this configuration, you map this streaming source to an in-application stream that is created. Your application code can then query the in-application stream like a table (you can think of it as a constantly updating table).
For the streaming source, you provide its Amazon Resource Name (ARN) and format of data on the stream (for example, JSON, CSV, etc.). You also must provide an IAM role that Amazon Kinesis Analytics can assume to read this stream on your behalf.
To create the in-application stream, you need to specify a schema to transform your data into a schematized version used in SQL. In the schema, you provide the necessary mapping of the data elements in the streaming source to record columns in the in-app stream.
public void setInputs(IResolvable value)
You can configure your application to receive input from a single streaming source. In this configuration, you map this streaming source to an in-application stream that is created. Your application code can then query the in-application stream like a table (you can think of it as a constantly updating table).
For the streaming source, you provide its Amazon Resource Name (ARN) and format of data on the stream (for example, JSON, CSV, etc.). You also must provide an IAM role that Amazon Kinesis Analytics can assume to read this stream on your behalf.
To create the in-application stream, you need to specify a schema to transform your data into a schematized version used in SQL. In the schema, you provide the necessary mapping of the data elements in the streaming source to record columns in the in-app stream.
public void setInputs(java.util.List<java.lang.Object> value)
You can configure your application to receive input from a single streaming source. In this configuration, you map this streaming source to an in-application stream that is created. Your application code can then query the in-application stream like a table (you can think of it as a constantly updating table).
For the streaming source, you provide its Amazon Resource Name (ARN) and format of data on the stream (for example, JSON, CSV, etc.). You also must provide an IAM role that Amazon Kinesis Analytics can assume to read this stream on your behalf.
To create the in-application stream, you need to specify a schema to transform your data into a schematized version used in SQL. In the schema, you provide the necessary mapping of the data elements in the streaming source to record columns in the in-app stream.
public java.lang.String getApplicationCode()
For example, you can write a SQL statement that reads data from one in-application stream, generates a running average of the number of advertisement clicks by vendor, and insert resulting rows in another in-application stream using pumps. For more information about the typical pattern, see Application Code .
You can provide such series of SQL statements, where output of one statement can be used as the input for the next statement. You store intermediate results by creating in-application streams and pumps.
Note that the application code must create the streams with names specified in the Outputs . For example, if your Outputs defines output streams named ExampleOutputStream1 and ExampleOutputStream2 , then your application code must create these streams.
public void setApplicationCode(java.lang.String value)
For example, you can write a SQL statement that reads data from one in-application stream, generates a running average of the number of advertisement clicks by vendor, and insert resulting rows in another in-application stream using pumps. For more information about the typical pattern, see Application Code .
You can provide such series of SQL statements, where output of one statement can be used as the input for the next statement. You store intermediate results by creating in-application streams and pumps.
Note that the application code must create the streams with names specified in the Outputs . For example, if your Outputs defines output streams named ExampleOutputStream1 and ExampleOutputStream2 , then your application code must create these streams.
public java.lang.String getApplicationDescription()
public void setApplicationDescription(java.lang.String value)
public java.lang.String getApplicationName()
public void setApplicationName(java.lang.String value)