Package software.amazon.awscdk.services.observabilityadmin

Class CfnTelemetryPipelines

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.observabilityadmin.CfnTelemetryPipelines
All Implemented Interfaces:
IInspectable, IEnvironmentAware, ITelemetryPipelinesRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.125.0 (build fdbe357)", date="2026-01-23T11:19:50.706Z") @Stability(Stable) public class CfnTelemetryPipelines extends CfnResource implements IInspectable, ITelemetryPipelinesRef, ITaggableV2
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: true\n maximum_messages: 10\n 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"

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.observabilityadmin.*;
 CfnTelemetryPipelines cfnTelemetryPipelines = CfnTelemetryPipelines.Builder.create(this, "MyCfnTelemetryPipelines")
         .configuration(TelemetryPipelineConfigurationProperty.builder()
                 .body("body")
                 .build())
         // the properties below are optional
         .name("name")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnTelemetryPipelines

      protected CfnTelemetryPipelines(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnTelemetryPipelines

      protected CfnTelemetryPipelines(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnTelemetryPipelines

      @Stability(Stable) public CfnTelemetryPipelines(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnTelemetryPipelinesProps props)
      Create a new AWS::ObservabilityAdmin::TelemetryPipelines.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForTelemetryPipelines

      @Stability(Stable) @NotNull public static String arnForTelemetryPipelines(@NotNull ITelemetryPipelinesRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnTelemetryPipelines

      @Stability(Stable) @NotNull public static Boolean isCfnTelemetryPipelines(@NotNull Object x)
      Checks whether the given object is a CfnTelemetryPipelines.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the created telemetry pipeline.

    • getAttrPipeline

      @Stability(Stable) @NotNull public IResolvable getAttrPipeline()

    • getAttrPipelineIdentifier

      @Stability(Stable) @NotNull public String getAttrPipelineIdentifier()
      The Amazon Resource Name (ARN) of the telemetry pipeline.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      The current status of the telemetry pipeline.

    • getAttrStatusReason

      @Stability(Stable) @NotNull public IResolvable getAttrStatusReason()

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTelemetryPipelinesRef

      @Stability(Stable) @NotNull public TelemetryPipelinesReference getTelemetryPipelinesRef()
      A reference to a TelemetryPipelines resource.
      Specified by:
      getTelemetryPipelinesRef in interface ITelemetryPipelinesRef

    • getConfiguration

      @Stability(Stable) @NotNull public Object getConfiguration()
      The configuration that defines how the telemetry pipeline processes data, including sources, processors, and destinations.

      Returns union: either IResolvable or CfnTelemetryPipelines.TelemetryPipelineConfigurationProperty

    • setConfiguration

      @Stability(Stable) public void setConfiguration(@NotNull IResolvable value)
      The configuration that defines how the telemetry pipeline processes data, including sources, processors, and destinations.

    • setConfiguration

      @Stability(Stable) public void setConfiguration(@NotNull CfnTelemetryPipelines.TelemetryPipelineConfigurationProperty value)
      The configuration that defines how the telemetry pipeline processes data, including sources, processors, and destinations.

    • getName

      @Stability(Stable) @Nullable public String getName()
      The name of the telemetry pipeline to create.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      The name of the telemetry pipeline to create.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      The key-value pairs to associate with the telemetry pipeline resource for categorization and management purposes.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      The key-value pairs to associate with the telemetry pipeline resource for categorization and management purposes.