update-centralization-rule-for-organization¶

Description¶

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.

Synopsis¶

  update-centralization-rule-for-organization
--rule-identifier <value>
--rule <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options¶

--rule-identifier (string)

The identifier (name or ARN) of the organization centralization rule to update.

--rule (structure)

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 -> (structure)

Configuration determining the source of the telemetry data to be centralized.

Regions -> (list)

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 -> (structure)

Log specific configuration for centralization source log groups.

LogGroupSelectionCriteria -> (string)

The selection criteria that specifies which source log groups to centralize. The selection criteria uses the same format as OAM link filters.

EncryptedLogGroupStrategy -> (string)

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 -> (structure)

Configuration determining where the telemetry data should be centralized, backed up, as well as encryption configuration for the primary and backup destinations.

Region -> (string)

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 -> (structure)

Log specific configuration for centralization destination log groups.

LogsEncryptionConfiguration -> (structure)

The encryption configuration for centralization destination log groups.

EncryptionStrategy -> (string)

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 -> (structure)

Configuration defining the backup region and an optional KMS key for the backup destination.

Region -> (string)

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.

JSON Syntax:

{
  "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"
      }
    }
  }
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table
yaml
yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output¶

RuleArn -> (string)

The Amazon Resource Name (ARN) of the updated organization centralization rule.

Table of Contents

Feedback

User Guide