software.amazon.awscdk.services.kinesisanalyticsv2

Class CfnApplicationOutput

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.kinesisanalyticsv2.CfnApplicationOutput

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.264Z")
 @Stability(value=Stable)
public class CfnApplicationOutput
extends CfnResource
implements IInspectable

A CloudFormation `AWS::KinesisAnalyticsV2::ApplicationOutput`.

Adds an external destination to your SQL-based Amazon Kinesis Data Analytics application.

If you want Kinesis Data Analytics to deliver data from an in-application stream within your application to an external destination (such as an Kinesis data stream, a Kinesis Data 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.

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.

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.kinesisanalyticsv2.*;
 CfnApplicationOutput cfnApplicationOutput = CfnApplicationOutput.Builder.create(this, "MyCfnApplicationOutput")
         .applicationName("applicationName")
         .output(OutputProperty.builder()
                 .destinationSchema(DestinationSchemaProperty.builder()
                         .recordFormatType("recordFormatType")
                         .build())
                 // the properties below are optional
                 .kinesisFirehoseOutput(KinesisFirehoseOutputProperty.builder()
                         .resourceArn("resourceArn")
                         .build())
                 .kinesisStreamsOutput(KinesisStreamsOutputProperty.builder()
                         .resourceArn("resourceArn")
                         .build())
                 .lambdaOutput(LambdaOutputProperty.builder()
                         .resourceArn("resourceArn")
                         .build())
                 .name("name")
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnApplicationOutput.Builder A fluent builder for CfnApplicationOutput.
static interface	CfnApplicationOutput.DestinationSchemaProperty Describes the data format when records are written to the destination in a SQL-based Kinesis Data Analytics application.
static interface	CfnApplicationOutput.KinesisFirehoseOutputProperty For a SQL-based Kinesis Data Analytics application, when configuring application output, identifies a Kinesis Data Firehose delivery stream as the destination.
static interface	CfnApplicationOutput.KinesisStreamsOutputProperty When you configure a SQL-based Kinesis Data Analytics application's output, identifies a Kinesis data stream as the destination.
static interface	CfnApplicationOutput.LambdaOutputProperty When you configure a SQL-based Kinesis Data Analytics application's output, identifies an Amazon Lambda function as the destination.
static interface	CfnApplicationOutput.OutputProperty Describes a SQL-based Kinesis Data Analytics application's output configuration, in which you identify an in-application stream and a destination where you want the in-application stream data to be written.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnApplicationOutput(software.constructs.Construct scope, String id, CfnApplicationOutputProps props) Create a new `AWS::KinesisAnalyticsV2::ApplicationOutput`.
protected	CfnApplicationOutput(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnApplicationOutput(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getApplicationName() The name of the application.
protected Map<String,Object>	getCfnProperties()
Object	getOutput() Describes a SQL-based Kinesis Data Analytics application's output configuration, in which you identify an in-application stream and a destination where you want the in-application stream data to be written.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setApplicationName(String value) The name of the application.
void	setOutput(CfnApplicationOutput.OutputProperty value) Describes a SQL-based Kinesis Data Analytics application's output configuration, in which you identify an in-application stream and a destination where you want the in-application stream data to be written.
void	setOutput(IResolvable value) Describes a SQL-based Kinesis Data Analytics application's output configuration, in which you identify an in-application stream and a destination where you want the in-application stream data to be written.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnApplicationOutput

protected CfnApplicationOutput(software.amazon.jsii.JsiiObjectRef objRef)

CfnApplicationOutput

protected CfnApplicationOutput(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnApplicationOutput

@Stability(value=Stable)
public CfnApplicationOutput(@NotNull
                                                     software.constructs.Construct scope,
                                                     @NotNull
                                                     String id,
                                                     @NotNull
                                                     CfnApplicationOutputProps props)

Create a new `AWS::KinesisAnalyticsV2::ApplicationOutput`.

Parameters:

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.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getApplicationName

@Stability(value=Stable)
 @NotNull
public String getApplicationName()

The name of the application.

setApplicationName

@Stability(value=Stable)
public void setApplicationName(@NotNull
                                                        String value)

The name of the application.

getOutput

@Stability(value=Stable)
 @NotNull
public Object getOutput()

Describes a SQL-based Kinesis Data Analytics application's output configuration, in which you identify an in-application stream and a destination where you want the in-application stream data to be written.

The destination can be a Kinesis data stream or a Kinesis Data Firehose delivery stream.

setOutput

@Stability(value=Stable)
public void setOutput(@NotNull
                                               CfnApplicationOutput.OutputProperty value)

Describes a SQL-based Kinesis Data Analytics application's output configuration, in which you identify an in-application stream and a destination where you want the in-application stream data to be written.

The destination can be a Kinesis data stream or a Kinesis Data Firehose delivery stream.

setOutput

@Stability(value=Stable)
public void setOutput(@NotNull
                                               IResolvable value)

Describes a SQL-based Kinesis Data Analytics application's output configuration, in which you identify an in-application stream and a destination where you want the in-application stream data to be written.

The destination can be a Kinesis data stream or a Kinesis Data Firehose delivery stream.