CfnTelemetryPipelinesPropsMixin

class aws_cdk.mixins_preview.aws_observabilityadmin.mixins.CfnTelemetryPipelinesPropsMixin(props, *, strategy=None)

Bases: Mixin

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
Mixin:: true
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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_observabilityadmin import mixins as observabilityadmin_mixins

cfn_telemetry_pipelines_props_mixin = observabilityadmin_mixins.CfnTelemetryPipelinesPropsMixin(observabilityadmin_mixins.CfnTelemetryPipelinesMixinProps(
    configuration=observabilityadmin_mixins.CfnTelemetryPipelinesPropsMixin.TelemetryPipelineConfigurationProperty(
        body="body"
    ),
    name="name",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::ObservabilityAdmin::TelemetryPipelines.

Parameters:

props (Union[CfnTelemetryPipelinesMixinProps, 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 = ['configuration', 'name', 'tags']

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

TelemetryPipelineConfigurationProperty

class CfnTelemetryPipelinesPropsMixin.TelemetryPipelineConfigurationProperty(*, body=None)

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 (Optional[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.mixins_preview.aws_observabilityadmin import mixins as observabilityadmin_mixins

telemetry_pipeline_configuration_property = observabilityadmin_mixins.CfnTelemetryPipelinesPropsMixin.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 CfnTelemetryPipelinesPropsMixin.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.mixins_preview.aws_observabilityadmin import mixins as observabilityadmin_mixins

telemetry_pipeline_property = observabilityadmin_mixins.CfnTelemetryPipelinesPropsMixin.TelemetryPipelineProperty(
    arn="arn",
    configuration=observabilityadmin_mixins.CfnTelemetryPipelinesPropsMixin.TelemetryPipelineConfigurationProperty(
        body="body"
    ),
    created_time_stamp=123,
    last_update_time_stamp=123,
    name="name",
    status="status",
    status_reason=observabilityadmin_mixins.CfnTelemetryPipelinesPropsMixin.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 CfnTelemetryPipelinesPropsMixin.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.mixins_preview.aws_observabilityadmin import mixins as observabilityadmin_mixins

telemetry_pipeline_status_reason_property = observabilityadmin_mixins.CfnTelemetryPipelinesPropsMixin.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