Class: Aws::ObservabilityAdmin::Types::TelemetryRule

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/types.rb

Overview

Defines how telemetry should be configured for specific Amazon Web Services resources.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#all_regions ⇒ Boolean

If set to true, the telemetry rule is replicated to all Amazon Web Services Regions where Amazon CloudWatch Observability Admin is available in the current partition. When new regions become available, the rule automatically replicates to them. Mutually exclusive with Regions.

Returns:

  • (Boolean) 


2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
 
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/types.rb', line 2422

class TelemetryRule < Struct.new(
  :resource_type,
  :telemetry_type,
  :telemetry_source_types,
  :destination_configuration,
  :scope,
  :selection_criteria,
  :regions,
  :all_regions)
  SENSITIVE = []
  include Aws::Structure
end

#destination_configuration ⇒ Types::TelemetryDestinationConfiguration

Configuration specifying where and how the telemetry data should be delivered.

Returns:



2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
 
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/types.rb', line 2422

class TelemetryRule < Struct.new(
  :resource_type,
  :telemetry_type,
  :telemetry_source_types,
  :destination_configuration,
  :scope,
  :selection_criteria,
  :regions,
  :all_regions)
  SENSITIVE = []
  include Aws::Structure
end

#regions ⇒ Array<String>

An optional list of Amazon Web Services Regions where this telemetry rule should be replicated. When specified, the rule is created in the home region and automatically replicated to all listed regions. Mutually exclusive with AllRegions.

Returns:

  • (Array<String>) 


2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
 
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/types.rb', line 2422

class TelemetryRule < Struct.new(
  :resource_type,
  :telemetry_type,
  :telemetry_source_types,
  :destination_configuration,
  :scope,
  :selection_criteria,
  :regions,
  :all_regions)
  SENSITIVE = []
  include Aws::Structure
end

#resource_type ⇒ String

The type of Amazon Web Services resource to configure telemetry for (e.g., "AWS::EC2::VPC", "AWS::EKS::Cluster", "AWS::WAFv2::WebACL").

Returns:

  • (String) 


2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
 
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/types.rb', line 2422

class TelemetryRule < Struct.new(
  :resource_type,
  :telemetry_type,
  :telemetry_source_types,
  :destination_configuration,
  :scope,
  :selection_criteria,
  :regions,
  :all_regions)
  SENSITIVE = []
  include Aws::Structure
end

#scope ⇒ String

The organizational scope to which the rule applies, specified using accounts or organizational units.

Returns:

  • (String) 


2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
 
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/types.rb', line 2422

class TelemetryRule < Struct.new(
  :resource_type,
  :telemetry_type,
  :telemetry_source_types,
  :destination_configuration,
  :scope,
  :selection_criteria,
  :regions,
  :all_regions)
  SENSITIVE = []
  include Aws::Structure
end

#selection_criteria ⇒ String

Criteria for selecting which resources the rule applies to, such as resource tags.

Returns:

  • (String) 


2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
 
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/types.rb', line 2422

class TelemetryRule < Struct.new(
  :resource_type,
  :telemetry_type,
  :telemetry_source_types,
  :destination_configuration,
  :scope,
  :selection_criteria,
  :regions,
  :all_regions)
  SENSITIVE = []
  include Aws::Structure
end

#telemetry_source_types ⇒ Array<String>

The specific telemetry source types to configure for the resource, such as VPC_FLOW_LOGS or EKS_AUDIT_LOGS. TelemetrySourceTypes must be correlated with the specific resource type.

Returns:

  • (Array<String>) 


2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
 
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/types.rb', line 2422

class TelemetryRule < Struct.new(
  :resource_type,
  :telemetry_type,
  :telemetry_source_types,
  :destination_configuration,
  :scope,
  :selection_criteria,
  :regions,
  :all_regions)
  SENSITIVE = []
  include Aws::Structure
end

#telemetry_type ⇒ String

The type of telemetry to collect (Logs, Metrics, or Traces).

Returns:

  • (String) 


2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
 
# File 'gems/aws-sdk-observabilityadmin/lib/aws-sdk-observabilityadmin/types.rb', line 2422

class TelemetryRule < Struct.new(
  :resource_type,
  :telemetry_type,
  :telemetry_source_types,
  :destination_configuration,
  :scope,
  :selection_criteria,
  :regions,
  :all_regions)
  SENSITIVE = []
  include Aws::Structure
end