software.amazon.awscdk.services.kinesisanalytics

Class CfnApplicationOutput

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.kinesisanalytics.CfnApplicationOutput

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:36.523Z")
 @Stability(value=Stable)
public class CfnApplicationOutput
extends CfnResource
implements IInspectable

A CloudFormation `AWS::KinesisAnalytics::ApplicationOutput`.

Adds an external destination to your Amazon Kinesis Analytics application.

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.

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.*;
 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")
                         .roleArn("roleArn")
                         .build())
                 .kinesisStreamsOutput(KinesisStreamsOutputProperty.builder()
                         .resourceArn("resourceArn")
                         .roleArn("roleArn")
                         .build())
                 .lambdaOutput(LambdaOutputProperty.builder()
                         .resourceArn("resourceArn")
                         .roleArn("roleArn")
                         .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.
static interface	CfnApplicationOutput.KinesisFirehoseOutputProperty When configuring application output, identifies an Amazon Kinesis Firehose delivery stream as the destination.
static interface	CfnApplicationOutput.KinesisStreamsOutputProperty When configuring application output, identifies an Amazon Kinesis stream as the destination.
static interface	CfnApplicationOutput.LambdaOutputProperty When configuring application output, identifies an AWS Lambda function as the destination.
static interface	CfnApplicationOutput.OutputProperty Describes application 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.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

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(Construct scope, String id, CfnApplicationOutputProps props) Create a new `AWS::KinesisAnalytics::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() Name of the application to which you want to add the output configuration.
protected Map<String,Object>	getCfnProperties()
Object	getOutput() An array of objects, each describing one output configuration.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setApplicationName(String value) Name of the application to which you want to add the output configuration.
void	setOutput(CfnApplicationOutput.OutputProperty value) An array of objects, each describing one output configuration.
void	setOutput(IResolvable value) An array of objects, each describing one output configuration.

Methods inherited from class software.amazon.awscdk.core.CfnResource

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

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

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
                                                     Construct scope,
                                                     @NotNull
                                                     String id,
                                                     @NotNull
                                                     CfnApplicationOutputProps props)

Create a new `AWS::KinesisAnalytics::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()

Name of the application to which you want to add the output configuration.

setApplicationName

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

Name of the application to which you want to add the output configuration.

getOutput

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

An array of objects, each describing one output configuration.

In the output configuration, you specify the name of an in-application stream, a destination (that is, an Amazon Kinesis stream, an Amazon Kinesis Firehose delivery stream, or an AWS Lambda function), and record the formation to use when writing to the destination.

setOutput

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

An array of objects, each describing one output configuration.

In the output configuration, you specify the name of an in-application stream, a destination (that is, an Amazon Kinesis stream, an Amazon Kinesis Firehose delivery stream, or an AWS Lambda function), and record the formation to use when writing to the destination.

setOutput

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

An array of objects, each describing one output configuration.

In the output configuration, you specify the name of an in-application stream, a destination (that is, an Amazon Kinesis stream, an Amazon Kinesis Firehose delivery stream, or an AWS Lambda function), and record the formation to use when writing to the destination.