CfnApplicationOutput
- class aws_cdk.aws_kinesisanalyticsv2.CfnApplicationOutput(scope, id, *, application_name, output)
Bases:
CfnResource
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:
- CloudformationResource:
AWS::KinesisAnalyticsV2::ApplicationOutput
- 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 import aws_kinesisanalyticsv2 as kinesisanalyticsv2 cfn_application_output = kinesisanalyticsv2.CfnApplicationOutput(self, "MyCfnApplicationOutput", application_name="applicationName", output=kinesisanalyticsv2.CfnApplicationOutput.OutputProperty( destination_schema=kinesisanalyticsv2.CfnApplicationOutput.DestinationSchemaProperty( record_format_type="recordFormatType" ), # the properties below are optional kinesis_firehose_output=kinesisanalyticsv2.CfnApplicationOutput.KinesisFirehoseOutputProperty( resource_arn="resourceArn" ), kinesis_streams_output=kinesisanalyticsv2.CfnApplicationOutput.KinesisStreamsOutputProperty( resource_arn="resourceArn" ), lambda_output=kinesisanalyticsv2.CfnApplicationOutput.LambdaOutputProperty( resource_arn="resourceArn" ), name="name" ) )
- Parameters:
scope (
Construct
) – Scope in which this resource is defined.id (
str
) – Construct identifier for this resource (unique in its scope).application_name (
str
) – The name of the application.output (
Union
[IResolvable
,OutputProperty
,Dict
[str
,Any
]]) – 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.
Methods
- add_deletion_override(path)
Syntactic sugar for
addOverride(path, undefined)
.- Parameters:
path (
str
) – The path of the value to delete.- Return type:
None
- add_dependency(target)
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
- Parameters:
target (
CfnResource
) –- Return type:
None
- add_depends_on(target)
(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
- Parameters:
target (
CfnResource
) –- Deprecated:
use addDependency
- Stability:
deprecated
- Return type:
None
- add_metadata(key, value)
Add a value to the CloudFormation Resource Metadata.
- Parameters:
key (
str
) –value (
Any
) –
- See:
- Return type:
None
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- add_override(path, value)
Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverride
or prefixpath
with “Properties.” (i.e.Properties.TopicName
).If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal
.
in the property name, prefix with a\
. In most programming languages you will need to write this as"\\."
because the\
itself will need to be escaped.For example:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
value
argument toaddOverride
will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.- Parameters:
path (
str
) –The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (
Any
) –The value. Could be primitive or complex.
- Return type:
None
- add_property_deletion_override(property_path)
Adds an override that deletes the value of a property from the resource definition.
- Parameters:
property_path (
str
) – The path to the property.- Return type:
None
- add_property_override(property_path, value)
Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value)
.- Parameters:
property_path (
str
) – The path of the property.value (
Any
) – The value.
- Return type:
None
- apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)
Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (
RemovalPolicy.DESTROY
), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN
). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT
). A list of resources that support this policy can be found in the following link:- Parameters:
policy (
Optional
[RemovalPolicy
]) –apply_to_update_replace_policy (
Optional
[bool
]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional
[RemovalPolicy
]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.
- See:
- Return type:
None
- get_att(attribute_name, type_hint=None)
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g.
resource.arn
), but this can be used for future compatibility in case there is no generated attribute.- Parameters:
attribute_name (
str
) – The name of the attribute.type_hint (
Optional
[ResolutionTypeHint
]) –
- Return type:
- get_metadata(key)
Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters:
key (
str
) –- See:
- Return type:
Any
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- inspect(inspector)
Examines the CloudFormation resource and discloses attributes.
- Parameters:
inspector (
TreeInspector
) – tree inspector to collect and process attributes.- Return type:
None
- obtain_dependencies()
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
- Return type:
List
[Union
[Stack
,CfnResource
]]
- obtain_resource_dependencies()
Get a shallow copy of dependencies between this resource and other resources in the same stack.
- Return type:
List
[CfnResource
]
- override_logical_id(new_logical_id)
Overrides the auto-generated logical ID with a specific ID.
- Parameters:
new_logical_id (
str
) – The new logical ID to use for this stack element.- Return type:
None
- remove_dependency(target)
Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
- Parameters:
target (
CfnResource
) –- Return type:
None
- replace_dependency(target, new_target)
Replaces one dependency with another.
- Parameters:
target (
CfnResource
) – The dependency to replace.new_target (
CfnResource
) – The new dependency to add.
- Return type:
None
- to_string()
Returns a string representation of this construct.
- Return type:
str
- Returns:
a string representation of this resource
Attributes
- CFN_RESOURCE_TYPE_NAME = 'AWS::KinesisAnalyticsV2::ApplicationOutput'
- application_name
The name of the application.
- attr_id
Id
- Type:
cloudformationAttribute
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- creation_stack
return:
the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
- logical_id
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use
overrideLogicalId(newLogicalId)
.- Returns:
the logical ID as a stringified token. This value will only get resolved during synthesis.
- node
The tree node.
- output
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.
- ref
Return a string that will be resolved to a CloudFormation
{ Ref }
for this element.If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through
Lazy.any({ produce: resource.ref })
.
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
Static Methods
- classmethod is_cfn_element(x)
Returns
true
if a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceof
to allow stack elements from different versions of this library to be included in the same stack.- Parameters:
x (
Any
) –- Return type:
bool
- Returns:
The construct as a stack element or undefined if it is not a stack element.
- classmethod is_cfn_resource(x)
Check whether the given object is a CfnResource.
- Parameters:
x (
Any
) –- Return type:
bool
- classmethod is_construct(x)
Checks if
x
is a construct.Use this method instead of
instanceof
to properly detectConstruct
instances, even when the construct library is symlinked.Explanation: in JavaScript, multiple copies of the
constructs
library on disk are seen as independent, completely different libraries. As a consequence, the classConstruct
in each copy of theconstructs
library is seen as a different class, and an instance of one class will not test asinstanceof
the other class.npm install
will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of theconstructs
library can be accidentally installed, andinstanceof
will behave unpredictably. It is safest to avoid usinginstanceof
, and using this type-testing method instead.- Parameters:
x (
Any
) – Any object.- Return type:
bool
- Returns:
true if
x
is an object created from a class which extendsConstruct
.
DestinationSchemaProperty
- class CfnApplicationOutput.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:
- 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 import aws_kinesisanalyticsv2 as kinesisanalyticsv2 destination_schema_property = kinesisanalyticsv2.CfnApplicationOutput.DestinationSchemaProperty( record_format_type="recordFormatType" )
Attributes
- record_format_type
Specifies the format of the records on the output stream.
KinesisFirehoseOutputProperty
- class CfnApplicationOutput.KinesisFirehoseOutputProperty(*, resource_arn)
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 (
str
) – The ARN of the destination delivery stream to write to.- See:
- 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 import aws_kinesisanalyticsv2 as kinesisanalyticsv2 kinesis_firehose_output_property = kinesisanalyticsv2.CfnApplicationOutput.KinesisFirehoseOutputProperty( resource_arn="resourceArn" )
Attributes
- resource_arn
The ARN of the destination delivery stream to write to.
KinesisStreamsOutputProperty
- class CfnApplicationOutput.KinesisStreamsOutputProperty(*, resource_arn)
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 (
str
) – The ARN of the destination Kinesis data stream to write to.- See:
- 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 import aws_kinesisanalyticsv2 as kinesisanalyticsv2 kinesis_streams_output_property = kinesisanalyticsv2.CfnApplicationOutput.KinesisStreamsOutputProperty( resource_arn="resourceArn" )
Attributes
- resource_arn
The ARN of the destination Kinesis data stream to write to.
LambdaOutputProperty
- class CfnApplicationOutput.LambdaOutputProperty(*, resource_arn)
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 (
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:
- 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 import aws_kinesisanalyticsv2 as kinesisanalyticsv2 lambda_output_property = kinesisanalyticsv2.CfnApplicationOutput.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
OutputProperty
- class CfnApplicationOutput.OutputProperty(*, destination_schema, 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
]]) – 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:
- 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 import aws_kinesisanalyticsv2 as kinesisanalyticsv2 output_property = kinesisanalyticsv2.CfnApplicationOutput.OutputProperty( destination_schema=kinesisanalyticsv2.CfnApplicationOutput.DestinationSchemaProperty( record_format_type="recordFormatType" ), # the properties below are optional kinesis_firehose_output=kinesisanalyticsv2.CfnApplicationOutput.KinesisFirehoseOutputProperty( resource_arn="resourceArn" ), kinesis_streams_output=kinesisanalyticsv2.CfnApplicationOutput.KinesisStreamsOutputProperty( resource_arn="resourceArn" ), lambda_output=kinesisanalyticsv2.CfnApplicationOutput.LambdaOutputProperty( resource_arn="resourceArn" ), name="name" )
Attributes
- destination_schema
Describes the data format when records are written to the destination.
- kinesis_firehose_output
Identifies a Kinesis Data Firehose delivery stream as the destination.
- kinesis_streams_output
Identifies a Kinesis data stream as the destination.
- lambda_output
Identifies an Amazon Lambda function as the destination.
- name
The name of the in-application stream.