CfnApplicationOutputPropsMixin

class aws_cdk.mixins_preview.aws_kinesisanalyticsv2.mixins.CfnApplicationOutputPropsMixin(props, *, strategy=None)

Bases: Mixin

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. .. epigraph:

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

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalyticsv2-applicationoutput.html
CloudformationResource:: AWS::KinesisAnalyticsV2::ApplicationOutput
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_kinesisanalyticsv2 import mixins as kinesisanalyticsv2_mixins

cfn_application_output_props_mixin = kinesisanalyticsv2_mixins.CfnApplicationOutputPropsMixin(kinesisanalyticsv2_mixins.CfnApplicationOutputMixinProps(
    application_name="applicationName",
    output=kinesisanalyticsv2_mixins.CfnApplicationOutputPropsMixin.OutputProperty(
        destination_schema=kinesisanalyticsv2_mixins.CfnApplicationOutputPropsMixin.DestinationSchemaProperty(
            record_format_type="recordFormatType"
        ),
        kinesis_firehose_output=kinesisanalyticsv2_mixins.CfnApplicationOutputPropsMixin.KinesisFirehoseOutputProperty(
            resource_arn="resourceArn"
        ),
        kinesis_streams_output=kinesisanalyticsv2_mixins.CfnApplicationOutputPropsMixin.KinesisStreamsOutputProperty(
            resource_arn="resourceArn"
        ),
        lambda_output=kinesisanalyticsv2_mixins.CfnApplicationOutputPropsMixin.LambdaOutputProperty(
            resource_arn="resourceArn"
        ),
        name="name"
    )
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::KinesisAnalyticsV2::ApplicationOutput.

Parameters:

props (Union[CfnApplicationOutputMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['applicationName', 'output']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

DestinationSchemaProperty

class CfnApplicationOutputPropsMixin.DestinationSchemaProperty(*, record_format_type=None)

Bases: object

Describes the data format when records are written to the destination in a SQL-based Kinesis Data Analytics application.

Parameters:: record_format_type (Optional[str]) – Specifies the format of the records on the output stream.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationoutput-destinationschema.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_kinesisanalyticsv2 import mixins as kinesisanalyticsv2_mixins

destination_schema_property = kinesisanalyticsv2_mixins.CfnApplicationOutputPropsMixin.DestinationSchemaProperty(
    record_format_type="recordFormatType"
)

Attributes

record_format_type

Specifies the format of the records on the output stream.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationoutput-destinationschema.html#cfn-kinesisanalyticsv2-applicationoutput-destinationschema-recordformattype

KinesisFirehoseOutputProperty

class CfnApplicationOutputPropsMixin.KinesisFirehoseOutputProperty(*, resource_arn=None)

Bases: object

For a SQL-based Kinesis Data Analytics application, when configuring application output, identifies a Kinesis Data Firehose delivery stream as the destination.

You provide the stream Amazon Resource Name (ARN) of the delivery stream.

Parameters:: resource_arn (Optional[str]) – The ARN of the destination delivery stream to write to.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationoutput-kinesisfirehoseoutput.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_kinesisanalyticsv2 import mixins as kinesisanalyticsv2_mixins

kinesis_firehose_output_property = kinesisanalyticsv2_mixins.CfnApplicationOutputPropsMixin.KinesisFirehoseOutputProperty(
    resource_arn="resourceArn"
)

Attributes

resource_arn

The ARN of the destination delivery stream to write to.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationoutput-kinesisfirehoseoutput.html#cfn-kinesisanalyticsv2-applicationoutput-kinesisfirehoseoutput-resourcearn

KinesisStreamsOutputProperty

class CfnApplicationOutputPropsMixin.KinesisStreamsOutputProperty(*, resource_arn=None)

Bases: object

When you configure a SQL-based Kinesis Data Analytics application’s output, identifies a Kinesis data stream as the destination.

You provide the stream Amazon Resource Name (ARN).

Parameters:: resource_arn (Optional[str]) – The ARN of the destination Kinesis data stream to write to.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationoutput-kinesisstreamsoutput.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_kinesisanalyticsv2 import mixins as kinesisanalyticsv2_mixins

kinesis_streams_output_property = kinesisanalyticsv2_mixins.CfnApplicationOutputPropsMixin.KinesisStreamsOutputProperty(
    resource_arn="resourceArn"
)

Attributes

resource_arn

The ARN of the destination Kinesis data stream to write to.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationoutput-kinesisstreamsoutput.html#cfn-kinesisanalyticsv2-applicationoutput-kinesisstreamsoutput-resourcearn

LambdaOutputProperty

class CfnApplicationOutputPropsMixin.LambdaOutputProperty(*, resource_arn=None)

Bases: object

When you configure a SQL-based Kinesis Data Analytics application’s output, identifies an Amazon Lambda function as the destination.

You provide the function Amazon Resource Name (ARN) of the Lambda function.

Parameters:: resource_arn (Optional[str]) – The Amazon Resource Name (ARN) of the destination Lambda function to write to. .. epigraph:: To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: Amazon Lambda
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationoutput-lambdaoutput.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_kinesisanalyticsv2 import mixins as kinesisanalyticsv2_mixins

lambda_output_property = kinesisanalyticsv2_mixins.CfnApplicationOutputPropsMixin.LambdaOutputProperty(
    resource_arn="resourceArn"
)

Attributes

resource_arn

The Amazon Resource Name (ARN) of the destination Lambda function to write to.

To specify an earlier version of the Lambda function than the latest, include the Lambda function version in the Lambda function ARN. For more information about Lambda ARNs, see Example ARNs: Amazon Lambda

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationoutput-lambdaoutput.html#cfn-kinesisanalyticsv2-applicationoutput-lambdaoutput-resourcearn

OutputProperty

class CfnApplicationOutputPropsMixin.OutputProperty(*, destination_schema=None, kinesis_firehose_output=None, kinesis_streams_output=None, lambda_output=None, name=None)

Bases: object

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.

Parameters:

destination_schema (Union[IResolvable, DestinationSchemaProperty, Dict[str, Any], None]) – Describes the data format when records are written to the destination.
kinesis_firehose_output (Union[IResolvable, KinesisFirehoseOutputProperty, Dict[str, Any], None]) – Identifies a Kinesis Data Firehose delivery stream as the destination.
kinesis_streams_output (Union[IResolvable, KinesisStreamsOutputProperty, Dict[str, Any], None]) – Identifies a Kinesis data stream as the destination.
lambda_output (Union[IResolvable, LambdaOutputProperty, Dict[str, Any], None]) – Identifies an Amazon Lambda function as the destination.
name (Optional[str]) – The name of the in-application stream.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalyticsv2-applicationoutput-output.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_kinesisanalyticsv2 import mixins as kinesisanalyticsv2_mixins

output_property = kinesisanalyticsv2_mixins.CfnApplicationOutputPropsMixin.OutputProperty(
    destination_schema=kinesisanalyticsv2_mixins.CfnApplicationOutputPropsMixin.DestinationSchemaProperty(
        record_format_type="recordFormatType"
    ),
    kinesis_firehose_output=kinesisanalyticsv2_mixins.CfnApplicationOutputPropsMixin.KinesisFirehoseOutputProperty(
        resource_arn="resourceArn"
    ),
    kinesis_streams_output=kinesisanalyticsv2_mixins.CfnApplicationOutputPropsMixin.KinesisStreamsOutputProperty(
        resource_arn="resourceArn"
    ),
    lambda_output=kinesisanalyticsv2_mixins.CfnApplicationOutputPropsMixin.LambdaOutputProperty(
        resource_arn="resourceArn"
    ),
    name="name"
)