CfnTelemetryPipelines

class aws_cdk.aws_observabilityadmin.CfnTelemetryPipelines(scope, id, *, configuration, name=None, tags=None)

Bases: CfnResource

Creates a telemetry pipeline for processing and transforming telemetry data.

The pipeline defines how data flows from sources through processors to destinations, enabling data transformation and delivering capabilities.

Using CloudWatch as a pipeline source The following is an example of a Body property value for the Configuration object. { “Type”: “AWS::ObservabilityAdmin::TelemetryPipelines”, “Properties”: { “Configuration”: { “Body”: “pipeline:n source:n cloudwatch_logs:n log_event_metadata:n data_source_name: “my_data_source”n data_source_type: “default”n aws:n sts_role_arn: “arn:aws:iam::123456789012:role/MyPipelineAccessRole”n processor:n - parse_json: {}n sink:n - cloudwatch_logs:n log_group: “@original”” } } } Type: AWS::ObservabilityAdmin::TelemetryPipelines Properties: Configuration: Body: | pipeline: source: cloudwatch_logs: log_event_metadata: data_source_name: “my_data_source” data_source_type: “default” aws: sts_role_arn: “arn:aws:iam::123456789012:role/MyPipelineAccessRole” processor: - parse_json: {} sink: - cloudwatch_logs: log_group: “@original” Using Amazon S3 as a pipeline source The following is an example of a Body property value for the Configuration object. { “Type”: “AWS::ObservabilityAdmin::TelemetryPipelines”, “Properties”: { “Configuration”: { “Body”: “pipeline:n source:n s3:n sqs:n visibility_timeout: “PT60S”n visibility_duplication_protection: truen maximum_messages: 10n queue_url: “https://sqs.us-east-1.amazonaws.com/123456789012/my-sqs-queue”n notification_type: “sqs”n codec:n ndjson: {}n aws:n region: “us-east-1”n sts_role_arn: “arn:aws:iam::123456789012:role/MyAccessRole”n data_source_name: “crowdstrike_falcon”n processor:n - ocsf:n version: “1.5”n mapping_version: “1.5.0”n schema:n crowdstrike_falcon:n sink:n - cloudwatch_logs:n log_group: “my-log-group”” } } } Type: AWS::ObservabilityAdmin::TelemetryPipelines Properties: Configuration: Body: | pipeline: source: s3: sqs: visibility_timeout: “PT60S” visibility_duplication_protection: true maximum_messages: 10 queue_url: “https://sqs.us-east-1.amazonaws.com/123456789012/my-sqs-queue” notification_type: “sqs” codec: ndjson: {} aws: region: “us-east-1” sts_role_arn: “arn:aws:iam::123456789012:role/MyAccessRole” data_source_name: “crowdstrike_falcon” processor: - ocsf: version: “1.5” mapping_version: “1.5.0” schema: crowdstrike_falcon: sink: - cloudwatch_logs: log_group: “my-log-group”

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-observabilityadmin-telemetrypipelines.html
CloudformationResource:: AWS::ObservabilityAdmin::TelemetryPipelines
ExampleMetadata:: fixture=_generated

Example:

from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_observabilityadmin as observabilityadmin

cfn_telemetry_pipelines = observabilityadmin.CfnTelemetryPipelines(self, "MyCfnTelemetryPipelines",
    configuration=observabilityadmin.CfnTelemetryPipelines.TelemetryPipelineConfigurationProperty(
        body="body"
    ),

    # the properties below are optional
    name="name",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Create a new AWS::ObservabilityAdmin::TelemetryPipelines.

Parameters:

scope (Construct) – Scope in which this resource is defined.
id (str) – Construct identifier for this resource (unique in its scope).
configuration (Union[IResolvable, TelemetryPipelineConfigurationProperty, Dict[str, Any]]) – The configuration that defines how the telemetry pipeline processes data, including sources, processors, and destinations. For more information, see the Amazon CloudWatch User Guide .
name (Optional[str]) – The name of the telemetry pipeline to create. The name must be unique within your account.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The key-value pairs to associate with the telemetry pipeline resource for categorization and management purposes.

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 prefix path 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 to addOverride 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: true
default (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:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

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:

Reference

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::ObservabilityAdmin::TelemetryPipelines'

attr_arn

The Amazon Resource Name (ARN) of the created telemetry pipeline.

CloudformationAttribute:: Arn

attr_pipeline

Pipeline

Type:: cloudformationAttribute

attr_pipeline_identifier

The Amazon Resource Name (ARN) of the telemetry pipeline.

CloudformationAttribute:: PipelineIdentifier

attr_status

The current status of the telemetry pipeline.

CloudformationAttribute:: Status

attr_status_reason

StatusReason

Type:: cloudformationAttribute

cdk_tag_manager: Tag Manager which manages the tags for this resource.

cfn_options: Options for this resource, such as condition, update policy etc.

cfn_resource_type: AWS resource type.

configuration: The configuration that defines how the telemetry pipeline processes data, including sources, processors, and destinations.

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.

env

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.

name: The name of the telemetry pipeline to create.

node: The tree node.

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).

tags: The key-value pairs to associate with the telemetry pipeline resource for categorization and management purposes.

telemetry_pipelines_ref: A reference to a TelemetryPipelines resource.

Static Methods

classmethod arn_for_telemetry_pipelines(resource)

Parameters:: resource (ITelemetryPipelinesRef)
Return type:: str

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_cfn_telemetry_pipelines(x)

Checks whether the given object is a CfnTelemetryPipelines.

Parameters:: x (Any)
Return type:: bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct 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 class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof 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 the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, 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 extends Construct.

TelemetryPipelineConfigurationProperty

class CfnTelemetryPipelines.TelemetryPipelineConfigurationProperty(*, body)

Bases: object

Defines the configuration for a pipeline, including how data flows from sources through processors to destinations.

The configuration is specified in YAML format and must include a valid pipeline definition with required source and sink components. This pipeline enables end-to-end telemetry data collection, transformation, and delivery while supporting optional processing steps and extensions for enhanced functionality.

The primary pipeline configuration section are:

Source: Defines where log data originates from (S3 buckets, CloudWatch Logs, third-party APIs). Each pipeline must have exactly one source.
Processors (optional): Transform, parse, and enrich log data as it flows through the pipeline. Processors are applied sequentially in the order they are defined.
Sink: Defines the destination where processed log data is sent. Each pipeline must have exactly one sink.
Extensions (optional): Provide additional functionality such as AWS Secrets Manager integration for credential management.

For more details on each configuration section see CloudWatch pipelines User Guide . Additional comprehensive configuration examples can be found in the CreateTelemetryPipeline API docs .

Parameters:: body (str) – The pipeline configuration body that defines the data processing rules and transformations.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetrypipelines-telemetrypipelineconfiguration.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 import aws_observabilityadmin as observabilityadmin

telemetry_pipeline_configuration_property = observabilityadmin.CfnTelemetryPipelines.TelemetryPipelineConfigurationProperty(
    body="body"
)

Attributes

body

The pipeline configuration body that defines the data processing rules and transformations.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetrypipelines-telemetrypipelineconfiguration.html#cfn-observabilityadmin-telemetrypipelines-telemetrypipelineconfiguration-body

TelemetryPipelineProperty

class CfnTelemetryPipelines.TelemetryPipelineProperty(*, arn=None, configuration=None, created_time_stamp=None, last_update_time_stamp=None, name=None, status=None, status_reason=None, tags=None)

Bases: object

Represents a complete telemetry pipeline resource with configuration, status, and metadata for data processing and transformation.

Parameters:

arn (Optional[str]) – The Amazon Resource Name (ARN) of the telemetry pipeline.
configuration (Union[IResolvable, TelemetryPipelineConfigurationProperty, Dict[str, Any], None]) –
The configuration that defines how the telemetry pipeline processes data. For more information, see the Amazon CloudWatch User Guide .
created_time_stamp (Union[int, float, None]) – The timestamp when the telemetry pipeline was created.
last_update_time_stamp (Union[int, float, None]) – The timestamp when the telemetry pipeline was last updated.
name (Optional[str]) – The name of the telemetry pipeline.
status (Optional[str]) – The current status of the telemetry pipeline.
status_reason (Union[IResolvable, TelemetryPipelineStatusReasonProperty, Dict[str, Any], None]) – Additional information about the pipeline status, including reasons for failure states.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The key-value pairs associated with the telemetry pipeline resource.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetrypipelines-telemetrypipeline.html

ExampleMetadata:

fixture=_generated

Example:

from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_observabilityadmin as observabilityadmin

telemetry_pipeline_property = observabilityadmin.CfnTelemetryPipelines.TelemetryPipelineProperty(
    arn="arn",
    configuration=observabilityadmin.CfnTelemetryPipelines.TelemetryPipelineConfigurationProperty(
        body="body"
    ),
    created_time_stamp=123,
    last_update_time_stamp=123,
    name="name",
    status="status",
    status_reason=observabilityadmin.CfnTelemetryPipelines.TelemetryPipelineStatusReasonProperty(
        description="description"
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

arn

The Amazon Resource Name (ARN) of the telemetry pipeline.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetrypipelines-telemetrypipeline.html#cfn-observabilityadmin-telemetrypipelines-telemetrypipeline-arn

configuration

The configuration that defines how the telemetry pipeline processes data.

For more information, see the Amazon CloudWatch User Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetrypipelines-telemetrypipeline.html#cfn-observabilityadmin-telemetrypipelines-telemetrypipeline-configuration

created_time_stamp

The timestamp when the telemetry pipeline was created.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetrypipelines-telemetrypipeline.html#cfn-observabilityadmin-telemetrypipelines-telemetrypipeline-createdtimestamp

last_update_time_stamp

The timestamp when the telemetry pipeline was last updated.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetrypipelines-telemetrypipeline.html#cfn-observabilityadmin-telemetrypipelines-telemetrypipeline-lastupdatetimestamp

name

The name of the telemetry pipeline.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetrypipelines-telemetrypipeline.html#cfn-observabilityadmin-telemetrypipelines-telemetrypipeline-name

status

The current status of the telemetry pipeline.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetrypipelines-telemetrypipeline.html#cfn-observabilityadmin-telemetrypipelines-telemetrypipeline-status

status_reason

Additional information about the pipeline status, including reasons for failure states.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetrypipelines-telemetrypipeline.html#cfn-observabilityadmin-telemetrypipelines-telemetrypipeline-statusreason

tags

The key-value pairs associated with the telemetry pipeline resource.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetrypipelines-telemetrypipeline.html#cfn-observabilityadmin-telemetrypipelines-telemetrypipeline-tags

TelemetryPipelineStatusReasonProperty

class CfnTelemetryPipelines.TelemetryPipelineStatusReasonProperty(*, description=None)

Bases: object

Provides detailed information about the status of a telemetry pipeline, including reasons for specific states.

Parameters:: description (Optional[str]) – A description of the pipeline status reason, providing additional context about the current state.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetrypipelines-telemetrypipelinestatusreason.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 import aws_observabilityadmin as observabilityadmin

telemetry_pipeline_status_reason_property = observabilityadmin.CfnTelemetryPipelines.TelemetryPipelineStatusReasonProperty(
    description="description"
)

Attributes

description

A description of the pipeline status reason, providing additional context about the current state.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-observabilityadmin-telemetrypipelines-telemetrypipelinestatusreason.html#cfn-observabilityadmin-telemetrypipelines-telemetrypipelinestatusreason-description