CloudWatchObservabilityAdminService / Client / create_centralization_rule_for_organization

create_centralization_rule_for_organization¶

CloudWatchObservabilityAdminService.Client.create_centralization_rule_for_organization(**kwargs)¶

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.

Request Syntax

response = client.create_centralization_rule_for_organization(
    RuleName='string',
    Rule={
        'Source': {
            'Regions': [
                'string',
            ],
            'Scope': 'string',
            'SourceLogsConfiguration': {
                'LogGroupSelectionCriteria': 'string',
                'EncryptedLogGroupStrategy': 'ALLOW'|'SKIP'
            }
        },
        'Destination': {
            'Region': 'string',
            'Account': 'string',
            'DestinationLogsConfiguration': {
                'LogsEncryptionConfiguration': {
                    'EncryptionStrategy': 'CUSTOMER_MANAGED'|'AWS_OWNED',
                    'KmsKeyArn': 'string',
                    'EncryptionConflictResolutionStrategy': 'ALLOW'|'SKIP'
                },
                'BackupConfiguration': {
                    'Region': 'string',
                    'KmsKeyArn': 'string'
                },
                'LogGroupNameConfiguration': {
                    'LogGroupNamePattern': 'string'
                }
            }
        }
    },
    Tags={
        'string': 'string'
    }
)

Parameters:

RuleName (string) –
[REQUIRED]

A unique name for the organization-wide centralization rule being created.
Rule (dict) –
[REQUIRED]

The configuration details for the organization-wide centralization rule, including the source configuration and the destination configuration to centralize telemetry data across the organization.
- Source (dict) – [REQUIRED]
  
  Configuration determining the source of the telemetry data to be centralized.
  - Regions (list) – [REQUIRED]
    
    The list of source regions from which telemetry data should be centralized.
    - (string) –
  - Scope (string) –
    
    The organizational scope from which telemetry data should be centralized, specified using organization id, accounts or organizational unit ids.
  - SourceLogsConfiguration (dict) –
    
    Log specific configuration for centralization source log groups.
    - LogGroupSelectionCriteria (string) – [REQUIRED]
      
      The selection criteria that specifies which source log groups to centralize. The selection criteria uses the same format as OAM link filters.
    - EncryptedLogGroupStrategy (string) – [REQUIRED]
      
      A strategy determining whether to centralize source log groups that are encrypted with customer managed KMS keys (CMK). ALLOW will consider CMK encrypted source log groups for centralization while SKIP will skip CMK encrypted source log groups from centralization.
- Destination (dict) – [REQUIRED]
  
  Configuration determining where the telemetry data should be centralized, backed up, as well as encryption configuration for the primary and backup destinations.
  - Region (string) – [REQUIRED]
    
    The primary destination region to which telemetry data should be centralized.
  - Account (string) –
    
    The destination account (within the organization) to which the telemetry data should be centralized.
  - DestinationLogsConfiguration (dict) –
    
    Log specific configuration for centralization destination log groups.
    - LogsEncryptionConfiguration (dict) –
      
      The encryption configuration for centralization destination log groups.
      - EncryptionStrategy (string) – [REQUIRED]
        
        Configuration that determines the encryption strategy of the destination log groups. CUSTOMER_MANAGED uses the configured KmsKeyArn to encrypt newly created destination log groups.
      - KmsKeyArn (string) –
        
        KMS Key ARN belonging to the primary destination account and region, to encrypt newly created central log groups in the primary destination.
      - EncryptionConflictResolutionStrategy (string) –
        
        Conflict resolution strategy for centralization if the encryption strategy is set to CUSTOMER_MANAGED and the destination log group is encrypted with an AWS_OWNED KMS Key. ALLOW lets centralization go through while SKIP prevents centralization into the destination log group.
    - BackupConfiguration (dict) –
      
      Configuration defining the backup region and an optional KMS key for the backup destination.
      - Region (string) – [REQUIRED]
        
        Logs specific backup destination region within the primary destination account to which log data should be centralized.
      - KmsKeyArn (string) –
        
        KMS Key ARN belonging to the primary destination account and backup region, to encrypt newly created central log groups in the backup destination.
    - LogGroupNameConfiguration (dict) –
      
      Configuration that specifies a naming pattern for destination log groups created during centralization. The pattern supports static text and dynamic variables that are replaced with source attributes when log groups are created.
      - LogGroupNamePattern (string) – [REQUIRED]
        
        The pattern used to generate destination log group names during centralization. The pattern can contain static text and dynamic variables that are replaced with source attributes. If a variable cannot be resolved, it inherits the value from its parent variable in the hierarchy. The pattern must be between 1 and 512 characters.
        
        Supported variables:
        
        ${source.logGroup} — The original log group name from the source account.
        
        ${source.accountId} — The AWS account ID where the log originated.
        
        ${source.region} — The AWS Region where the log originated.
        
        ${source.org.id} — The AWS Organization ID of the source account.
        
        ${source.org.ouId} — The organizational unit ID of the source account.
        
        ${source.org.rootId} — The organization Root ID.
        
        ${source.org.path} — The organizational path from account to root.
Tags (dict) –
The key-value pairs to associate with the organization telemetry rule resource for categorization and management purposes.
- (string) –
  - (string) –

Return type:

dict

Returns:

Response Syntax

{
    'RuleArn': 'string'
}

Response Structure

(dict) –
- RuleArn (string) –
  
  The Amazon Resource Name (ARN) of the created organization centralization rule.

Exceptions

CloudWatchObservabilityAdminService.Client.exceptions.ServiceQuotaExceededException
CloudWatchObservabilityAdminService.Client.exceptions.ConflictException
CloudWatchObservabilityAdminService.Client.exceptions.AccessDeniedException
CloudWatchObservabilityAdminService.Client.exceptions.InternalServerException
CloudWatchObservabilityAdminService.Client.exceptions.ValidationException
CloudWatchObservabilityAdminService.Client.exceptions.TooManyRequestsException