Class CfnApplicationReferenceDataSource
A CloudFormation AWS::KinesisAnalytics::ApplicationReferenceDataSource
.
Inheritance
Inherited Members
Namespace: Amazon.CDK.AWS.KinesisAnalytics
Assembly: Amazon.CDK.AWS.KinesisAnalytics.dll
Syntax (csharp)
public class CfnApplicationReferenceDataSource : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnApplicationReferenceDataSource
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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.
CloudformationResource: AWS::KinesisAnalytics::ApplicationReferenceDataSource
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 cfnApplicationReferenceDataSource = new CfnApplicationReferenceDataSource(this, "MyCfnApplicationReferenceDataSource", new CfnApplicationReferenceDataSourceProps {
ApplicationName = "applicationName",
ReferenceDataSource = new ReferenceDataSourceProperty {
ReferenceSchema = new ReferenceSchemaProperty {
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"
},
// the properties below are optional
S3ReferenceDataSource = new S3ReferenceDataSourceProperty {
BucketArn = "bucketArn",
FileKey = "fileKey",
ReferenceRoleArn = "referenceRoleArn"
},
TableName = "tableName"
}
});
Synopsis
Constructors
CfnApplicationReferenceDataSource(Construct, String, ICfnApplicationReferenceDataSourceProps) | Create a new |
CfnApplicationReferenceDataSource(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnApplicationReferenceDataSource(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
ApplicationName | Name of an existing application. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
ReferenceDataSource | The reference data source can be an object in your Amazon S3 bucket. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnApplicationReferenceDataSource(Construct, String, ICfnApplicationReferenceDataSourceProps)
Create a new AWS::KinesisAnalytics::ApplicationReferenceDataSource
.
public CfnApplicationReferenceDataSource(Construct scope, string id, ICfnApplicationReferenceDataSourceProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnApplicationReferenceDataSourceProps
- resource properties.
CfnApplicationReferenceDataSource(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnApplicationReferenceDataSource(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnApplicationReferenceDataSource(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnApplicationReferenceDataSource(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
ApplicationName
Name of an existing application.
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
ReferenceDataSource
The reference data source can be an object in your Amazon S3 bucket.
public virtual object ReferenceDataSource { get; set; }
Property Value
System.Object
Remarks
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.
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>