CfnApplicationOutputPropsMixin

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

Bases: Mixin

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisanalytics-applicationoutput.html
CloudformationResource:: AWS::KinesisAnalytics::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_kinesisanalytics import mixins as kinesisanalytics_mixins

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

Create a mixin to apply properties to AWS::KinesisAnalytics::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.

For more information, see Configuring Application Output .

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-kinesisanalytics-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_kinesisanalytics import mixins as kinesisanalytics_mixins

destination_schema_property = kinesisanalytics_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-kinesisanalytics-applicationoutput-destinationschema.html#cfn-kinesisanalytics-applicationoutput-destinationschema-recordformattype

KinesisFirehoseOutputProperty

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

Bases: object

When configuring application output, identifies an Amazon Kinesis Firehose delivery stream as the destination.

You provide the stream Amazon Resource Name (ARN) and an IAM role that enables Amazon Kinesis Analytics to write to the stream on your behalf.

Parameters:

resource_arn (Optional[str]) – ARN of the destination Amazon Kinesis Firehose delivery stream to write to.
role_arn (Optional[str]) – ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the destination stream on your behalf. You need to grant the necessary permissions to this role.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-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_kinesisanalytics import mixins as kinesisanalytics_mixins

kinesis_firehose_output_property = kinesisanalytics_mixins.CfnApplicationOutputPropsMixin.KinesisFirehoseOutputProperty(
    resource_arn="resourceArn",
    role_arn="roleArn"
)

Attributes

resource_arn

ARN of the destination Amazon Kinesis Firehose delivery stream to write to.

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

role_arn

ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the destination stream on your behalf.

You need to grant the necessary permissions to this role.

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

KinesisStreamsOutputProperty

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

Bases: object

When configuring application output, identifies an Amazon Kinesis stream as the destination.

You provide the stream Amazon Resource Name (ARN) and also an IAM role ARN that Amazon Kinesis Analytics can use to write to the stream on your behalf.

Parameters:

resource_arn (Optional[str]) – ARN of the destination Amazon Kinesis stream to write to.
role_arn (Optional[str]) – ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the destination stream on your behalf. You need to grant the necessary permissions to this role.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-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_kinesisanalytics import mixins as kinesisanalytics_mixins

kinesis_streams_output_property = kinesisanalytics_mixins.CfnApplicationOutputPropsMixin.KinesisStreamsOutputProperty(
    resource_arn="resourceArn",
    role_arn="roleArn"
)

Attributes

resource_arn

ARN of the destination Amazon Kinesis stream to write to.

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

role_arn

ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the destination stream on your behalf.

You need to grant the necessary permissions to this role.

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

LambdaOutputProperty

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

Bases: object

When configuring application output, identifies an AWS Lambda function as the destination.

You provide the function Amazon Resource Name (ARN) and also an IAM role ARN that Amazon Kinesis Analytics can use to write to the function on your behalf.

Parameters:

resource_arn (Optional[str]) – 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: AWS Lambda
role_arn (Optional[str]) – ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the destination function on your behalf. You need to grant the necessary permissions to this role.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-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_kinesisanalytics import mixins as kinesisanalytics_mixins

lambda_output_property = kinesisanalytics_mixins.CfnApplicationOutputPropsMixin.LambdaOutputProperty(
    resource_arn="resourceArn",
    role_arn="roleArn"
)

Attributes

resource_arn

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: AWS Lambda

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

role_arn

ARN of the IAM role that Amazon Kinesis Analytics can assume to write to the destination function on your behalf.

You need to grant the necessary permissions to this role.

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

OutputProperty

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

Bases: object

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.

The destination can be an Amazon Kinesis stream or an Amazon Kinesis Firehose delivery stream.

For limits on how many destinations an application can write and other limitations, see Limits .

Parameters:

destination_schema (Union[IResolvable, DestinationSchemaProperty, Dict[str, Any], None]) –
Describes the data format when records are written to the destination. For more information, see Configuring Application Output .
kinesis_firehose_output (Union[IResolvable, KinesisFirehoseOutputProperty, Dict[str, Any], None]) – Identifies an Amazon Kinesis Firehose delivery stream as the destination.
kinesis_streams_output (Union[IResolvable, KinesisStreamsOutputProperty, Dict[str, Any], None]) – Identifies an Amazon Kinesis stream as the destination.
lambda_output (Union[IResolvable, LambdaOutputProperty, Dict[str, Any], None]) – Identifies an AWS Lambda function as the destination.
name (Optional[str]) – Name of the in-application stream.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisanalytics-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_kinesisanalytics import mixins as kinesisanalytics_mixins

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