Package software.amazon.awscdk.services.kinesisanalytics

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.kinesisanalytics.CfnApplicationOutput
All Implemented Interfaces:
IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.97.0 (build 729de35)", date="2024-04-24T21:00:31.573Z") @Stability(Stable) public class CfnApplicationOutput extends CfnResource implements IInspectable
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();

See Also:

  • 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 software.constructs.Construct scope, @NotNull String id, @NotNull CfnApplicationOutputProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). 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.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getApplicationName

      @Stability(Stable) @NotNull public String getApplicationName()
      Name of the application to which you want to add the output configuration.

    • setApplicationName

      @Stability(Stable) public void setApplicationName(@NotNull String value)
      Name of the application to which you want to add the output configuration.

    • getOutput

      @Stability(Stable) @NotNull public Object getOutput()
      An array of objects, each describing one output configuration.

    • setOutput

      @Stability(Stable) public void setOutput(@NotNull IResolvable value)
      An array of objects, each describing one output configuration.

    • setOutput

      @Stability(Stable) public void setOutput(@NotNull CfnApplicationOutput.OutputProperty value)
      An array of objects, each describing one output configuration.