Package software.amazon.awscdk.services.kinesisanalyticsv2

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.kinesisanalyticsv2.CfnApplicationOutput
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:58.365Z") @Stability(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.

Creation of multiple outputs should be sequential (use of DependsOn) to avoid a problem with a stale application version ( ConcurrentModificationException ).

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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnApplicationOutput

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

    • CfnApplicationOutput

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

    • CfnApplicationOutput

      @Stability(Stable) public CfnApplicationOutput(@NotNull 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 Details

    • inspect

      @Stability(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(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(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getApplicationName

      @Stability(Stable) @NotNull public String getApplicationName()
      The name of the application.

    • setApplicationName

      @Stability(Stable) public void setApplicationName(@NotNull String value)
      The name of the application.

    • getOutput

      @Stability(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(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.

    • setOutput

      @Stability(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.