AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the CloudWatch Observability Admin Service UpdateCentralizationRuleForOrganization API operation.

Syntax

Update-CWOADMNCentralizationRuleForOrganization
-RuleIdentifier <String>
-Destination_Account <String>
-Rule_Source_SourceLogsConfiguration_DataSourceSelectionCriterion <String>
-SourceLogsConfiguration_EncryptedLogGroupStrategy <EncryptedLogGroupStrategy>
-LogsEncryptionConfiguration_EncryptionConflictResolutionStrategy <EncryptionConflictResolutionStrategy>
-LogsEncryptionConfiguration_EncryptionStrategy <EncryptionStrategy>
-BackupConfiguration_KmsKeyArn <String>
-LogsEncryptionConfiguration_KmsKeyArn <String>
-Rule_Destination_DestinationLogsConfiguration_LogGroupNameConfiguration_LogGroupNamePattern <String>
-SourceLogsConfiguration_LogGroupSelectionCriterion <String>
-BackupConfiguration_Region <String>
-Destination_Region <String>
-Source_Region <String[]>
-Source_Scope <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonObservabilityAdminConfig>

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.

Parameters

-BackupConfiguration_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRule_Destination_DestinationLogsConfiguration_BackupConfiguration_KmsKeyArn
-BackupConfiguration_Region <String>
Logs specific backup destination region within the primary destination account to which log data should be centralized.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRule_Destination_DestinationLogsConfiguration_BackupConfiguration_Region
-ClientConfig <AmazonObservabilityAdminConfig>
Amazon.PowerShell.Cmdlets.CWOADMN.AmazonObservabilityAdminClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Destination_Account <String>
The destination account (within the organization) to which the telemetry data should be centralized.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRule_Destination_Account
-Destination_Region <String>
The primary destination region to which telemetry data should be centralized.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRule_Destination_Region
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LogsEncryptionConfiguration_EncryptionConflictResolutionStrategy <EncryptionConflictResolutionStrategy>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRule_Destination_DestinationLogsConfiguration_LogsEncryptionConfiguration_EncryptionConflictResolutionStrategy
-LogsEncryptionConfiguration_EncryptionStrategy <EncryptionStrategy>
Configuration that determines the encryption strategy of the destination log groups. CUSTOMER_MANAGED uses the configured KmsKeyArn to encrypt newly created destination log groups.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRule_Destination_DestinationLogsConfiguration_LogsEncryptionConfiguration_EncryptionStrategy
-LogsEncryptionConfiguration_KmsKeyArn <String>
KMS Key ARN belonging to the primary destination account and region, to encrypt newly created central log groups in the primary destination.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRule_Destination_DestinationLogsConfiguration_LogsEncryptionConfiguration_KmsKeyArn
-Rule_Destination_DestinationLogsConfiguration_LogGroupNameConfiguration_LogGroupNamePattern <String>
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 Amazon Web Services account ID where the log originated.
  • ${source.region} — The Amazon Web Services Region where the log originated.
  • ${source.org.id} — The Amazon Web Services 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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Rule_Source_SourceLogsConfiguration_DataSourceSelectionCriterion <String>
The selection criteria that specifies which data sources to centralize. The selection criteria uses the same filter expression format as LogGroupSelectionCriteria, but operates on DataSourceName and DataSourceType operands. When both LogGroupSelectionCriteria and DataSourceSelectionCriteria are specified, a log event must match both criteria to be centralized.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRule_Source_SourceLogsConfiguration_DataSourceSelectionCriteria
-RuleIdentifier <String>
The identifier (name or ARN) of the organization centralization rule to update.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'RuleArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ObservabilityAdmin.Model.UpdateCentralizationRuleForOrganizationResponse). Specifying the name of a property of type Amazon.ObservabilityAdmin.Model.UpdateCentralizationRuleForOrganizationResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Source_Region <String[]>
The list of source regions from which telemetry data should be centralized. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRule_Source_Regions
-Source_Scope <String>
The organizational scope from which telemetry data should be centralized, specified using organization id, accounts or organizational unit ids.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRule_Source_Scope
-SourceLogsConfiguration_EncryptedLogGroupStrategy <EncryptedLogGroupStrategy>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRule_Source_SourceLogsConfiguration_EncryptedLogGroupStrategy
-SourceLogsConfiguration_LogGroupSelectionCriterion <String>
The selection criteria that specifies which source log groups to centralize. The selection criteria uses the same format as OAM link filters.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRule_Source_SourceLogsConfiguration_LogGroupSelectionCriteria

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

System.String or Amazon.ObservabilityAdmin.Model.UpdateCentralizationRuleForOrganizationResponse
This cmdlet returns a System.String object. The service call response (type Amazon.ObservabilityAdmin.Model.UpdateCentralizationRuleForOrganizationResponse) can be returned by specifying '-Select *'.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z