TelemetryPipeline class
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
Constructors
- TelemetryPipeline(String name, {TelemetryPipelineArgs? args, CustomResourceOptions? options})
-
Creates a new TelemetryPipeline.
nameThe Pulumi resource name.argsArguments used to configure this TelemetryPipeline. The set of arguments for TelemetryPipeline.optionsResource options controlling this resource's behavior. - TelemetryPipeline.reference(String urn)
- Creates a typed reference to an existing TelemetryPipeline resource.
Properties
-
arn
↔ Output<
String> -
ARN of the telemetry pipeline.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
configuration
↔ Output<
TelemetryPipelineConfiguration> -
Configuration block for the telemetry pipeline. See
configurationbelow.latefinal - hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
name
↔ Output<
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.
latefinal
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
Key-value map of resource tags. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.latefinal -
timeouts
↔ Output<
TelemetryPipelineTimeouts?> -
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {TelemetryPipelineState? state, CustomResourceOptions? options}) → TelemetryPipeline -
Gets an existing TelemetryPipeline resource's state with the given
nameandid.