Class CfnApplication
A CloudFormation AWS::KinesisAnalytics::Application
.
Inherited Members
Namespace: Amazon.CDK.AWS.KinesisAnalytics
Assembly: Amazon.CDK.AWS.KinesisAnalytics.dll
Syntax (csharp)
public class CfnApplication : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnApplication
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
The AWS::KinesisAnalytics::Application
resource creates an Amazon Kinesis Data Analytics application. For more information, see the Amazon Kinesis Data Analytics Developer Guide .
CloudformationResource: AWS::KinesisAnalytics::Application
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.KinesisAnalytics;
var cfnApplication = new CfnApplication(this, "MyCfnApplication", new CfnApplicationProps {
Inputs = new [] { new InputProperty {
InputSchema = new InputSchemaProperty {
RecordColumns = new [] { new RecordColumnProperty {
Name = "name",
SqlType = "sqlType",
// the properties below are optional
Mapping = "mapping"
} },
RecordFormat = new RecordFormatProperty {
RecordFormatType = "recordFormatType",
// the properties below are optional
MappingParameters = new MappingParametersProperty {
CsvMappingParameters = new CSVMappingParametersProperty {
RecordColumnDelimiter = "recordColumnDelimiter",
RecordRowDelimiter = "recordRowDelimiter"
},
JsonMappingParameters = new JSONMappingParametersProperty {
RecordRowPath = "recordRowPath"
}
}
},
// the properties below are optional
RecordEncoding = "recordEncoding"
},
NamePrefix = "namePrefix",
// the properties below are optional
InputParallelism = new InputParallelismProperty {
Count = 123
},
InputProcessingConfiguration = new InputProcessingConfigurationProperty {
InputLambdaProcessor = new InputLambdaProcessorProperty {
ResourceArn = "resourceArn",
RoleArn = "roleArn"
}
},
KinesisFirehoseInput = new KinesisFirehoseInputProperty {
ResourceArn = "resourceArn",
RoleArn = "roleArn"
},
KinesisStreamsInput = new KinesisStreamsInputProperty {
ResourceArn = "resourceArn",
RoleArn = "roleArn"
}
} },
// the properties below are optional
ApplicationCode = "applicationCode",
ApplicationDescription = "applicationDescription",
ApplicationName = "applicationName"
});
Synopsis
Constructors
CfnApplication(Construct, String, ICfnApplicationProps) | Create a new |
CfnApplication(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnApplication(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
ApplicationCode | One or more SQL statements that read input data, transform it, and generate output. |
ApplicationDescription | Summary description of the application. |
ApplicationName | Name of your Amazon Kinesis Analytics application (for example, |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Inputs | Use this parameter to configure the application input. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnApplication(Construct, String, ICfnApplicationProps)
Create a new AWS::KinesisAnalytics::Application
.
public CfnApplication(Construct scope, string id, ICfnApplicationProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnApplicationProps
- resource properties.
CfnApplication(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnApplication(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnApplication(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnApplication(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
ApplicationCode
One or more SQL statements that read input data, transform it, and generate output.
public virtual string ApplicationCode { get; set; }
Property Value
System.String
Remarks
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.
ApplicationDescription
Summary description of the application.
public virtual string ApplicationDescription { get; set; }
Property Value
System.String
Remarks
ApplicationName
Name of your Amazon Kinesis Analytics application (for example, sample-app
).
public virtual string ApplicationName { get; set; }
Property Value
System.String
Remarks
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Inputs
Use this parameter to configure the application input.
public virtual object Inputs { get; set; }
Property Value
System.Object
Remarks
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.
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>