centralization_rule_for_organizations

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

Overview

Name	centralization_rule_for_organizations
Type	Resource
Id	aws.observabilityadmin.centralization_rule_for_organizations

Fields

The following fields are returned by SELECT queries:

get_centralization_rule_for_organization

Name	Datatype	Description
centralization_rule	object	Defines how telemetry data should be centralized across an Amazon Web Services Organization, including source and destination configurations.
created_region	string	The Amazon Web Services region where the organization centralization rule was created.
created_time_stamp	integer (int64)	The timestamp when the organization centralization rule was created.
creator_account_id	string	The Amazon Web Services Account that created the organization centralization rule.
failure_reason	string	The reason why an organization centralization rule is marked UNHEALTHY. (TRUSTED_ACCESS_NOT_ENABLED, DESTINATION_ACCOUNT_NOT_IN_ORGANIZATION, INTERNAL_SERVER_ERROR)
last_update_time_stamp	integer (int64)	The timestamp when the organization centralization rule was last updated.
rule_arn	string	The Amazon Resource Name (ARN) of the organization centralization rule. (pattern: <code>arn:aws([a-z0-9-]+)?:([a-zA-Z0-9-]+):([a-z0-9-]+)?:([0-9]{12})?:(.+)</code>)
rule_health	string	The health status of the organization centralization rule. (Healthy, Unhealthy, Provisioning)
rule_name	string	The name of the organization centralization rule. (pattern: <code>[0-9A-Za-z-_.#/]+</code>)
tag_propagation_failure_reason	string	The reason tag propagation is unhealthy for this rule. Only present when TagPropagationStatus is Unhealthy. (RoleNotAssumable, RoleLacksPermissions)
tag_propagation_status	string	The health status of tag propagation for this rule. This status is independent of the overall RuleHealth for log delivery. Returns Healthy when the most recent tag-propagation attempt succeeded, or Unhealthy when the most recent attempt failed. (Healthy, Unhealthy)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_centralization_rule_for_organization	select	region		Retrieves the details of a specific organization centralization rule. This operation can only be called by the organization's management account or a delegated administrator account.
create_centralization_rule_for_organization	insert	region, RuleName, Rule		Creates a centralization 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_centralization_rule_for_organization	update	region, RuleIdentifier, Rule		Updates an existing centralization 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_centralization_rule_for_organization	delete	region		Deletes an organization-wide centralization 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_centralization_rule_for_organization

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

SELECT
centralization_rule,
created_region,
created_time_stamp,
creator_account_id,
failure_reason,
last_update_time_stamp,
rule_arn,
rule_health,
rule_name,
tag_propagation_failure_reason,
tag_propagation_status
FROM aws.observabilityadmin.centralization_rule_for_organizations
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_centralization_rule_for_organization

Creates a centralization 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.centralization_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: centralization_rule_for_organizations
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the centralization_rule_for_organizations resource.
  - name: RuleName
    value: "{{ RuleName }}"
  - name: Rule
    description: |
      Defines how telemetry data should be centralized across an Amazon Web Services Organization, including source and destination configurations.
    value:
      Source:
        Regions:
          - "{{ Regions }}"
        Scope: "{{ Scope }}"
        SourceLogsConfiguration:
          LogGroupSelectionCriteria: "{{ LogGroupSelectionCriteria }}"
          DataSourceSelectionCriteria: "{{ DataSourceSelectionCriteria }}"
          EncryptedLogGroupStrategy: "{{ EncryptedLogGroupStrategy }}"
        SourceMetricsConfiguration:
          MetricsSelectionCriteria: "{{ MetricsSelectionCriteria }}"
      Destination:
        Region: "{{ Region }}"
        Account: "{{ Account }}"
        DestinationLogsConfiguration:
          LogsEncryptionConfiguration:
            EncryptionStrategy: "{{ EncryptionStrategy }}"
            KmsKeyArn: "{{ KmsKeyArn }}"
            EncryptionConflictResolutionStrategy: "{{ EncryptionConflictResolutionStrategy }}"
            EncryptionScope: "{{ EncryptionScope }}"
          BackupConfiguration:
            Region: "{{ Region }}"
            KmsKeyArn: "{{ KmsKeyArn }}"
          LogGroupNameConfiguration:
            LogGroupNamePattern: "{{ LogGroupNamePattern }}"
          TagPropagationConfiguration:
            DestinationRoleArn: "{{ DestinationRoleArn }}"
            TagConflictResolutionStrategy: "{{ TagConflictResolutionStrategy }}"
        DestinationMetricsConfiguration:
          BackupConfiguration:
            Region: "{{ Region }}"
  - name: Tags
    value: "{{ Tags }}"

UPDATE examples

update_centralization_rule_for_organization

Updates an existing centralization 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.centralization_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_centralization_rule_for_organization

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

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