Class CfnApplicationOutput
Adds an external destination to your Amazon Kinesis Analytics application.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.KinesisAnalytics
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnApplicationOutput : CfnResource, IInspectable
Syntax (vb)
Public Class CfnApplicationOutput
Inherits CfnResource
Implements IInspectable
Remarks
If you want Amazon Kinesis Analytics to deliver data from an in-application stream within your application to an external destination (such as an Amazon Kinesis stream, an Amazon Kinesis Firehose delivery stream, or an Amazon Lambda function), you add the relevant configuration to your application using this operation. You can configure one or more outputs for your application. Each output configuration maps an in-application stream and an external destination.
You can use one of the output configurations to deliver data from your in-application error stream to an external destination so that you can analyze the errors. For more information, see Understanding Application Output (Destination) .
Any configuration update, including adding a streaming source using this operation, results in a new version of the application. You can use the DescribeApplication
operation to find the current application version.
For the limits on the number of application inputs and outputs you can configure, see Limits .
This operation requires permissions to perform the kinesisanalytics:AddApplicationOutput
action.
CloudformationResource: AWS::KinesisAnalytics::ApplicationOutput
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 cfnApplicationOutput = new CfnApplicationOutput(this, "MyCfnApplicationOutput", new CfnApplicationOutputProps {
ApplicationName = "applicationName",
Output = new OutputProperty {
DestinationSchema = new DestinationSchemaProperty {
RecordFormatType = "recordFormatType"
},
// the properties below are optional
KinesisFirehoseOutput = new KinesisFirehoseOutputProperty {
ResourceArn = "resourceArn",
RoleArn = "roleArn"
},
KinesisStreamsOutput = new KinesisStreamsOutputProperty {
ResourceArn = "resourceArn",
RoleArn = "roleArn"
},
LambdaOutput = new LambdaOutputProperty {
ResourceArn = "resourceArn",
RoleArn = "roleArn"
},
Name = "name"
}
});
Synopsis
Constructors
CfnApplicationOutput(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnApplicationOutput(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnApplicationOutput(Construct, String, ICfnApplicationOutputProps) |
Properties
ApplicationName | Name of the application to which you want to add the output configuration. |
AttrId | |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Output | An array of objects, each describing one output configuration. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnApplicationOutput(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnApplicationOutput(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnApplicationOutput(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnApplicationOutput(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnApplicationOutput(Construct, String, ICfnApplicationOutputProps)
public CfnApplicationOutput(Construct scope, string id, ICfnApplicationOutputProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnApplicationOutputProps
Resource properties.
Properties
ApplicationName
Name of the application to which you want to add the output configuration.
public virtual string ApplicationName { get; set; }
Property Value
System.String
AttrId
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
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
Output
An array of objects, each describing one output configuration.
public virtual object Output { get; set; }
Property Value
System.Object
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>