telemetry_rule_for_organizations

Creates, updates, deletes, gets or lists a telemetry_rule_for_organizations resource.

Overview

Name	telemetry_rule_for_organizations
Type	Resource
Id	aws.observabilityadmin.telemetry_rule_for_organizations

Fields

The following fields are returned by SELECT queries:

get_telemetry_rule_for_organization

Name	Datatype	Description
created_time_stamp	integer (int64)	The timestamp when the organization telemetry rule was created.
home_region	string	The Amazon Web Services Region where the organization telemetry rule was originally created. For replicated rules in spoke regions, this indicates the region that manages the rule. For rules created without multi-region scope, this field is not present.
is_replicated	boolean	Indicates whether this organization telemetry rule is a replica that was created in this region through multi-region fan-out from the home region. Replicated rules cannot be directly updated or deleted in the spoke region. To modify a replicated rule, make changes in the home region.
last_update_time_stamp	integer (int64)	The timestamp when the organization telemetry rule was last updated.
region_statuses	array	A list of per-region replication statuses for the organization telemetry rule. Each entry indicates the replication status of the rule in a specific spoke region. This field is only present for rules created with multi-region scope.
rule_arn	string	The Amazon Resource Name (ARN) of the organization telemetry rule. (pattern: <code>arn:aws([a-z0-9-]+)?:([a-zA-Z0-9-]+):([a-z0-9-]+)?:([0-9]{12})?:(.+)</code>)
rule_name	string	The name of the organization telemetry rule. (pattern: <code>[0-9A-Za-z-_.#/]+</code>)
telemetry_rule	object	Defines how telemetry should be configured for specific Amazon Web Services resources.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_telemetry_rule_for_organization	select	region		Retrieves the details of a specific organization telemetry rule. This operation can only be called by the organization's management account or a delegated administrator account.
create_telemetry_rule_for_organization	insert	region, RuleName, Rule		Creates a telemetry rule that applies across an Amazon Web Services Organization. This operation can only be called by the organization's management account or a delegated administrator account.
update_telemetry_rule_for_organization	update	region, RuleIdentifier, Rule		Updates an existing telemetry rule that applies across an Amazon Web Services Organization. This operation can only be called by the organization's management account or a delegated administrator account.
delete_telemetry_rule_for_organization	delete	region		Deletes an organization-wide telemetry rule. This operation can only be called by the organization's management account or a delegated administrator account.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_telemetry_rule_for_organization

Retrieves the details of a specific organization telemetry rule. This operation can only be called by the organization's management account or a delegated administrator account.

SELECT
created_time_stamp,
home_region,
is_replicated,
last_update_time_stamp,
region_statuses,
rule_arn,
rule_name,
telemetry_rule
FROM aws.observabilityadmin.telemetry_rule_for_organizations
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_telemetry_rule_for_organization

Creates a telemetry rule that applies across an Amazon Web Services Organization. This operation can only be called by the organization's management account or a delegated administrator account.

INSERT INTO aws.observabilityadmin.telemetry_rule_for_organizations (
RuleName,
Rule,
Tags,
region
)
SELECT 
'{{ RuleName }}' /* required */,
'{{ Rule }}' /* required */,
'{{ Tags }}',
'{{ region }}'
RETURNING
rule_arn
;

Manifest

# Description fields are for documentation purposes
- name: telemetry_rule_for_organizations
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the telemetry_rule_for_organizations resource.
  - name: RuleName
    value: "{{ RuleName }}"
  - name: Rule
    description: |
      Defines how telemetry should be configured for specific Amazon Web Services resources.
    value:
      ResourceType: "{{ ResourceType }}"
      TelemetryType: "{{ TelemetryType }}"
      TelemetrySourceTypes:
        - "{{ TelemetrySourceTypes }}"
      DestinationConfiguration:
        DestinationType: "{{ DestinationType }}"
        DestinationPattern: "{{ DestinationPattern }}"
        RetentionInDays: {{ RetentionInDays }}
        VPCFlowLogParameters:
          LogFormat: "{{ LogFormat }}"
          TrafficType: "{{ TrafficType }}"
          MaxAggregationInterval: {{ MaxAggregationInterval }}
        CloudtrailParameters:
          AdvancedEventSelectors:
            - Name: "{{ Name }}"
              FieldSelectors: "{{ FieldSelectors }}"
        ELBLoadBalancerLoggingParameters:
          OutputFormat: "{{ OutputFormat }}"
          FieldDelimiter: "{{ FieldDelimiter }}"
        WAFLoggingParameters:
          RedactedFields:
            - SingleHeader:
                Name: "{{ Name }}"
              UriPath: "{{ UriPath }}"
              QueryString: "{{ QueryString }}"
              Method: "{{ Method }}"
          LoggingFilter:
            Filters:
              - Behavior: "{{ Behavior }}"
                Requirement: "{{ Requirement }}"
                Conditions: "{{ Conditions }}"
            DefaultBehavior: "{{ DefaultBehavior }}"
          LogType: "{{ LogType }}"
        LogDeliveryParameters:
          LogTypes:
            - "{{ LogTypes }}"
        MskMonitoringParameters:
          EnhancedMonitoring: "{{ EnhancedMonitoring }}"
        KmsKeyArn: "{{ KmsKeyArn }}"
      Scope: "{{ Scope }}"
      SelectionCriteria: "{{ SelectionCriteria }}"
      AllowFieldUpdates: {{ AllowFieldUpdates }}
      Regions:
        - "{{ Regions }}"
      AllRegions: {{ AllRegions }}
  - name: Tags
    value: "{{ Tags }}"

UPDATE examples

update_telemetry_rule_for_organization

Updates an existing telemetry rule that applies across an Amazon Web Services Organization. This operation can only be called by the organization's management account or a delegated administrator account.

UPDATE aws.observabilityadmin.telemetry_rule_for_organizations
SET 
RuleIdentifier = '{{ RuleIdentifier }}',
Rule = '{{ Rule }}'
WHERE 
region = '{{ region }}' --required
AND RuleIdentifier = '{{ RuleIdentifier }}' --required
AND Rule = '{{ Rule }}' --required
RETURNING
rule_arn;

DELETE examples

delete_telemetry_rule_for_organization

Deletes an organization-wide telemetry rule. This operation can only be called by the organization's management account or a delegated administrator account.

DELETE FROM aws.observabilityadmin.telemetry_rule_for_organizations
WHERE region = '{{ region }}' --required
;