1. Packages
  2. AWS
  3. API Docs
  4. observabilityadmin
  5. TelemetryPipeline
Viewing docs for AWS v7.22.0
published on Wednesday, Mar 11, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

aws.observabilityadmin.TelemetryPipeline

aws logo
Viewing docs for AWS v7.22.0
published on Wednesday, Mar 11, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

    Manages an AWS CloudWatch Observability Admin Telemetry Pipeline.

    Telemetry pipelines allow you to collect, transform, and route telemetry data from AWS services. Each pipeline defines a source, optional processors, and one or more sinks for the telemetry data.

    For more information, see the AWS CloudWatch Observability Admin Telemetry Pipelines documentation.

    NOTE: Only one telemetry pipeline per data source type is allowed per account. For example, you can have one pipeline for amazon_api_gateway/access and another for amazon_vpc/flow, but not two pipelines for the same data source type.

    Example Usage

    Required

    • arn (String) ARN of the telemetry pipeline.

    Using pulumi import, import CloudWatch Observability Admin Telemetry Pipelines using the arn. For example:

    $ pulumi import aws:observabilityadmin/telemetryPipeline:TelemetryPipeline example arn:aws:observabilityadmin:us-west-2:1234567890:telemetry-pipeline/id

    Create TelemetryPipeline Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new TelemetryPipeline(name: string, args: TelemetryPipelineArgs, opts?: CustomResourceOptions);
    @overload
def TelemetryPipeline(resource_name: str,
                      args: TelemetryPipelineArgs,
                      opts: Optional[ResourceOptions] = None)

@overload
def TelemetryPipeline(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      configuration: Optional[TelemetryPipelineConfigurationArgs] = None,
                      name: Optional[str] = None,
                      region: Optional[str] = None,
                      tags: Optional[Mapping[str, str]] = None,
                      timeouts: Optional[TelemetryPipelineTimeoutsArgs] = None)
    func NewTelemetryPipeline(ctx *Context, name string, args TelemetryPipelineArgs, opts ...ResourceOption) (*TelemetryPipeline, error)
    public TelemetryPipeline(string name, TelemetryPipelineArgs args, CustomResourceOptions? opts = null)
    public TelemetryPipeline(String name, TelemetryPipelineArgs args)
public TelemetryPipeline(String name, TelemetryPipelineArgs args, CustomResourceOptions options)

    type: aws:observabilityadmin:TelemetryPipeline
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args TelemetryPipelineArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args TelemetryPipelineArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args TelemetryPipelineArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TelemetryPipelineArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TelemetryPipelineArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var telemetryPipelineResource = new Aws.Observabilityadmin.TelemetryPipeline("telemetryPipelineResource", new()
{
    Configuration = new Aws.Observabilityadmin.Inputs.TelemetryPipelineConfigurationArgs
    {
        Body = "string",
    },
    Name = "string",
    Region = "string",
    Tags = 
    {
        { "string", "string" },
    },
    Timeouts = new Aws.Observabilityadmin.Inputs.TelemetryPipelineTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
});

    example, err := observabilityadmin.NewTelemetryPipeline(ctx, "telemetryPipelineResource", &observabilityadmin.TelemetryPipelineArgs{
	Configuration: &observabilityadmin.TelemetryPipelineConfigurationArgs{
		Body: pulumi.String("string"),
	},
	Name:   pulumi.String("string"),
	Region: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Timeouts: &observabilityadmin.TelemetryPipelineTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
		Update: pulumi.String("string"),
	},
})

    var telemetryPipelineResource = new TelemetryPipeline("telemetryPipelineResource", TelemetryPipelineArgs.builder()
    .configuration(TelemetryPipelineConfigurationArgs.builder()
        .body("string")
        .build())
    .name("string")
    .region("string")
    .tags(Map.of("string", "string"))
    .timeouts(TelemetryPipelineTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .build());

    telemetry_pipeline_resource = aws.observabilityadmin.TelemetryPipeline("telemetryPipelineResource",
    configuration={
        "body": "string",
    },
    name="string",
    region="string",
    tags={
        "string": "string",
    },
    timeouts={
        "create": "string",
        "delete": "string",
        "update": "string",
    })

    const telemetryPipelineResource = new aws.observabilityadmin.TelemetryPipeline("telemetryPipelineResource", {
    configuration: {
        body: "string",
    },
    name: "string",
    region: "string",
    tags: {
        string: "string",
    },
    timeouts: {
        create: "string",
        "delete": "string",
        update: "string",
    },
});

    type: aws:observabilityadmin:TelemetryPipeline
properties:
    configuration:
        body: string
    name: string
    region: string
    tags:
        string: string
    timeouts:
        create: string
        delete: string
        update: string

    TelemetryPipeline Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The TelemetryPipeline resource accepts the following input properties:

    Configuration TelemetryPipelineConfiguration

    Configuration block for the telemetry pipeline. See configuration below.

    The following arguments are optional:

    Name string
    Name of the telemetry pipeline. Must be between 3 and 28 characters, start with a lowercase letter, and contain only lowercase letters, digits, and hyphens.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Tags Dictionary<string, string>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    Timeouts TelemetryPipelineTimeouts
    Configuration TelemetryPipelineConfigurationArgs

    Configuration block for the telemetry pipeline. See configuration below.

    The following arguments are optional:

    Name string
    Name of the telemetry pipeline. Must be between 3 and 28 characters, start with a lowercase letter, and contain only lowercase letters, digits, and hyphens.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Tags map[string]string
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    Timeouts TelemetryPipelineTimeoutsArgs
    configuration TelemetryPipelineConfiguration

    Configuration block for the telemetry pipeline. See configuration below.

    The following arguments are optional:

    name String
    Name of the telemetry pipeline. Must be between 3 and 28 characters, start with a lowercase letter, and contain only lowercase letters, digits, and hyphens.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Map<String,String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    timeouts TelemetryPipelineTimeouts
    configuration TelemetryPipelineConfiguration

    Configuration block for the telemetry pipeline. See configuration below.

    The following arguments are optional:

    name string
    Name of the telemetry pipeline. Must be between 3 and 28 characters, start with a lowercase letter, and contain only lowercase letters, digits, and hyphens.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags {[key: string]: string}
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    timeouts TelemetryPipelineTimeouts
    configuration TelemetryPipelineConfigurationArgs

    Configuration block for the telemetry pipeline. See configuration below.

    The following arguments are optional:

    name str
    Name of the telemetry pipeline. Must be between 3 and 28 characters, start with a lowercase letter, and contain only lowercase letters, digits, and hyphens.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Mapping[str, str]
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    timeouts TelemetryPipelineTimeoutsArgs
    configuration Property Map

    Configuration block for the telemetry pipeline. See configuration below.

    The following arguments are optional:

    name String
    Name of the telemetry pipeline. Must be between 3 and 28 characters, start with a lowercase letter, and contain only lowercase letters, digits, and hyphens.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Map<String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    timeouts Property Map

    Outputs

    All input properties are implicitly available as output properties. Additionally, the TelemetryPipeline resource produces the following output properties:

    Arn string
    ARN of the telemetry pipeline.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    Arn string
    ARN of the telemetry pipeline.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    arn String
    ARN of the telemetry pipeline.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    arn string
    ARN of the telemetry pipeline.
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    arn str
    ARN of the telemetry pipeline.
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    arn String
    ARN of the telemetry pipeline.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Look up Existing TelemetryPipeline Resource

    Get an existing TelemetryPipeline resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: TelemetryPipelineState, opts?: CustomResourceOptions): TelemetryPipeline
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        configuration: Optional[TelemetryPipelineConfigurationArgs] = None,
        name: Optional[str] = None,
        region: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        timeouts: Optional[TelemetryPipelineTimeoutsArgs] = None) -> TelemetryPipeline
    func GetTelemetryPipeline(ctx *Context, name string, id IDInput, state *TelemetryPipelineState, opts ...ResourceOption) (*TelemetryPipeline, error)
    public static TelemetryPipeline Get(string name, Input<string> id, TelemetryPipelineState? state, CustomResourceOptions? opts = null)
    public static TelemetryPipeline get(String name, Output<String> id, TelemetryPipelineState state, CustomResourceOptions options)
    resources:  _:    type: aws:observabilityadmin:TelemetryPipeline    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    ARN of the telemetry pipeline.
    Configuration TelemetryPipelineConfiguration

    Configuration block for the telemetry pipeline. See configuration below.

    The following arguments are optional:

    Name string
    Name of the telemetry pipeline. Must be between 3 and 28 characters, start with a lowercase letter, and contain only lowercase letters, digits, and hyphens.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Tags Dictionary<string, string>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    Timeouts TelemetryPipelineTimeouts
    Arn string
    ARN of the telemetry pipeline.
    Configuration TelemetryPipelineConfigurationArgs

    Configuration block for the telemetry pipeline. See configuration below.

    The following arguments are optional:

    Name string
    Name of the telemetry pipeline. Must be between 3 and 28 characters, start with a lowercase letter, and contain only lowercase letters, digits, and hyphens.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Tags map[string]string
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    Timeouts TelemetryPipelineTimeoutsArgs
    arn String
    ARN of the telemetry pipeline.
    configuration TelemetryPipelineConfiguration

    Configuration block for the telemetry pipeline. See configuration below.

    The following arguments are optional:

    name String
    Name of the telemetry pipeline. Must be between 3 and 28 characters, start with a lowercase letter, and contain only lowercase letters, digits, and hyphens.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Map<String,String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    timeouts TelemetryPipelineTimeouts
    arn string
    ARN of the telemetry pipeline.
    configuration TelemetryPipelineConfiguration

    Configuration block for the telemetry pipeline. See configuration below.

    The following arguments are optional:

    name string
    Name of the telemetry pipeline. Must be between 3 and 28 characters, start with a lowercase letter, and contain only lowercase letters, digits, and hyphens.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags {[key: string]: string}
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    timeouts TelemetryPipelineTimeouts
    arn str
    ARN of the telemetry pipeline.
    configuration TelemetryPipelineConfigurationArgs

    Configuration block for the telemetry pipeline. See configuration below.

    The following arguments are optional:

    name str
    Name of the telemetry pipeline. Must be between 3 and 28 characters, start with a lowercase letter, and contain only lowercase letters, digits, and hyphens.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Mapping[str, str]
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    timeouts TelemetryPipelineTimeoutsArgs
    arn String
    ARN of the telemetry pipeline.
    configuration Property Map

    Configuration block for the telemetry pipeline. See configuration below.

    The following arguments are optional:

    name String
    Name of the telemetry pipeline. Must be between 3 and 28 characters, start with a lowercase letter, and contain only lowercase letters, digits, and hyphens.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Map<String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    timeouts Property Map

    Supporting Types

    TelemetryPipelineConfiguration, TelemetryPipelineConfigurationArgs

    Body string
    The pipeline configuration body. This is a YAML-encoded string defining the pipeline source, optional processors, and sinks.
    Body string
    The pipeline configuration body. This is a YAML-encoded string defining the pipeline source, optional processors, and sinks.
    body String
    The pipeline configuration body. This is a YAML-encoded string defining the pipeline source, optional processors, and sinks.
    body string
    The pipeline configuration body. This is a YAML-encoded string defining the pipeline source, optional processors, and sinks.
    body str
    The pipeline configuration body. This is a YAML-encoded string defining the pipeline source, optional processors, and sinks.
    body String
    The pipeline configuration body. This is a YAML-encoded string defining the pipeline source, optional processors, and sinks.

    TelemetryPipelineTimeouts, TelemetryPipelineTimeoutsArgs

    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    Update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    Update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    update String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    update string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    update str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    update String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    Viewing docs for AWS v7.22.0
    published on Wednesday, Mar 11, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws
      Try Pulumi Cloud free. Your team will thank you.