CfnOrganizationCentralizationRule
- class aws_cdk.aws_observabilityadmin.CfnOrganizationCentralizationRule(scope, id, *, rule, rule_name, tags=None)
Bases:
CfnResourceDefines how telemetry data should be centralized across an AWS Organization, including source and destination configurations.
- See:
- CloudformationResource:
AWS::ObservabilityAdmin::OrganizationCentralizationRule
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_observabilityadmin as observabilityadmin cfn_organization_centralization_rule = observabilityadmin.CfnOrganizationCentralizationRule(self, "MyCfnOrganizationCentralizationRule", rule=observabilityadmin.CfnOrganizationCentralizationRule.CentralizationRuleProperty( destination=observabilityadmin.CfnOrganizationCentralizationRule.CentralizationRuleDestinationProperty( region="region", # the properties below are optional account="account", destination_logs_configuration=observabilityadmin.CfnOrganizationCentralizationRule.DestinationLogsConfigurationProperty( backup_configuration=observabilityadmin.CfnOrganizationCentralizationRule.LogsBackupConfigurationProperty( region="region", # the properties below are optional kms_key_arn="kmsKeyArn" ), logs_encryption_configuration=observabilityadmin.CfnOrganizationCentralizationRule.LogsEncryptionConfigurationProperty( encryption_strategy="encryptionStrategy", # the properties below are optional encryption_conflict_resolution_strategy="encryptionConflictResolutionStrategy", kms_key_arn="kmsKeyArn" ) ) ), source=observabilityadmin.CfnOrganizationCentralizationRule.CentralizationRuleSourceProperty( regions=["regions"], # the properties below are optional scope="scope", source_logs_configuration=observabilityadmin.CfnOrganizationCentralizationRule.SourceLogsConfigurationProperty( encrypted_log_group_strategy="encryptedLogGroupStrategy", log_group_selection_criteria="logGroupSelectionCriteria" ) ) ), rule_name="ruleName", # the properties below are optional tags=[CfnTag( key="key", value="value" )] )
Create a new
AWS::ObservabilityAdmin::OrganizationCentralizationRule.- Parameters:
scope (
Construct) – Scope in which this resource is defined.id (
str) – Construct identifier for this resource (unique in its scope).rule (
Union[IResolvable,CentralizationRuleProperty,Dict[str,Any]])rule_name (
str) – The name of the organization centralization rule.tags (
Optional[Sequence[Union[CfnTag,Dict[str,Any]]]]) – A key-value pair to filter resources based on tags associated with the resource. For more information about tags, see What are tags?
Methods
- add_deletion_override(path)
Syntactic sugar for
addOverride(path, undefined).- Parameters:
path (
str) – The path of the value to delete.- Return type:
None
- add_dependency(target)
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
- Parameters:
target (
CfnResource)- Return type:
None
- add_depends_on(target)
(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
- Parameters:
target (
CfnResource)- Deprecated:
use addDependency
- Stability:
deprecated
- Return type:
None
- add_metadata(key, value)
Add a value to the CloudFormation Resource Metadata.
- Parameters:
key (
str)value (
Any)
- See:
- Return type:
None
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- add_override(path, value)
Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverrideor prefixpathwith “Properties.” (i.e.Properties.TopicName).If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal
.in the property name, prefix with a\. In most programming languages you will need to write this as"\\."because the\itself will need to be escaped.For example:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
valueargument toaddOverridewill not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.- Parameters:
path (
str) –The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (
Any) –The value. Could be primitive or complex.
- Return type:
None
- add_property_deletion_override(property_path)
Adds an override that deletes the value of a property from the resource definition.
- Parameters:
property_path (
str) – The path to the property.- Return type:
None
- add_property_override(property_path, value)
Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value).- Parameters:
property_path (
str) – The path of the property.value (
Any) – The value.
- Return type:
None
- apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)
Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (
RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:- Parameters:
policy (
Optional[RemovalPolicy])apply_to_update_replace_policy (
Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.
- See:
- Return type:
None
- get_att(attribute_name, type_hint=None)
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g.
resource.arn), but this can be used for future compatibility in case there is no generated attribute.- Parameters:
attribute_name (
str) – The name of the attribute.type_hint (
Optional[ResolutionTypeHint])
- Return type:
- get_metadata(key)
Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters:
key (
str)- See:
- Return type:
Any
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- inspect(inspector)
Examines the CloudFormation resource and discloses attributes.
- Parameters:
inspector (
TreeInspector) – tree inspector to collect and process attributes.- Return type:
None
- obtain_dependencies()
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
- Return type:
List[Union[Stack,CfnResource]]
- obtain_resource_dependencies()
Get a shallow copy of dependencies between this resource and other resources in the same stack.
- Return type:
List[CfnResource]
- override_logical_id(new_logical_id)
Overrides the auto-generated logical ID with a specific ID.
- Parameters:
new_logical_id (
str) – The new logical ID to use for this stack element.- Return type:
None
- remove_dependency(target)
Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
- Parameters:
target (
CfnResource)- Return type:
None
- replace_dependency(target, new_target)
Replaces one dependency with another.
- Parameters:
target (
CfnResource) – The dependency to replace.new_target (
CfnResource) – The new dependency to add.
- Return type:
None
- to_string()
Returns a string representation of this construct.
- Return type:
str- Returns:
a string representation of this resource
Attributes
- CFN_RESOURCE_TYPE_NAME = 'AWS::ObservabilityAdmin::OrganizationCentralizationRule'
- attr_rule_arn
The Amazon Resource Name (ARN) of the organization centralization rule.
- CloudformationAttribute:
RuleArn
- cdk_tag_manager
Tag Manager which manages the tags for this resource.
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- creation_stack
return:
the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
- env
- logical_id
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use
overrideLogicalId(newLogicalId).- Returns:
the logical ID as a stringified token. This value will only get resolved during synthesis.
- node
The tree node.
- organization_centralization_rule_ref
A reference to a OrganizationCentralizationRule resource.
- ref
Return a string that will be resolved to a CloudFormation
{ Ref }for this element.If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through
Lazy.any({ produce: resource.ref }).
- rule
- rule_name
The name of the organization centralization rule.
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- tags
A key-value pair to filter resources based on tags associated with the resource.
Static Methods
- classmethod is_cfn_element(x)
Returns
trueif a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceofto allow stack elements from different versions of this library to be included in the same stack.- Parameters:
x (
Any)- Return type:
bool- Returns:
The construct as a stack element or undefined if it is not a stack element.
- classmethod is_cfn_organization_centralization_rule(x)
Checks whether the given object is a CfnOrganizationCentralizationRule.
- Parameters:
x (
Any)- Return type:
bool
- classmethod is_cfn_resource(x)
Check whether the given object is a CfnResource.
- Parameters:
x (
Any)- Return type:
bool
- classmethod is_construct(x)
Checks if
xis a construct.Use this method instead of
instanceofto properly detectConstructinstances, even when the construct library is symlinked.Explanation: in JavaScript, multiple copies of the
constructslibrary on disk are seen as independent, completely different libraries. As a consequence, the classConstructin each copy of theconstructslibrary is seen as a different class, and an instance of one class will not test asinstanceofthe other class.npm installwill not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of theconstructslibrary can be accidentally installed, andinstanceofwill behave unpredictably. It is safest to avoid usinginstanceof, and using this type-testing method instead.- Parameters:
x (
Any) – Any object.- Return type:
bool- Returns:
true if
xis an object created from a class which extendsConstruct.
CentralizationRuleDestinationProperty
- class CfnOrganizationCentralizationRule.CentralizationRuleDestinationProperty(*, region, account=None, destination_logs_configuration=None)
Bases:
objectConfiguration specifying the primary destination for centralized telemetry data.
- Parameters:
region (
str) – The primary destination region to which telemetry data should be centralized.account (
Optional[str]) – The destination account (within the organization) to which the telemetry data should be centralized.destination_logs_configuration (
Union[IResolvable,DestinationLogsConfigurationProperty,Dict[str,Any],None]) – Log specific configuration for centralization destination log groups.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_observabilityadmin as observabilityadmin centralization_rule_destination_property = observabilityadmin.CfnOrganizationCentralizationRule.CentralizationRuleDestinationProperty( region="region", # the properties below are optional account="account", destination_logs_configuration=observabilityadmin.CfnOrganizationCentralizationRule.DestinationLogsConfigurationProperty( backup_configuration=observabilityadmin.CfnOrganizationCentralizationRule.LogsBackupConfigurationProperty( region="region", # the properties below are optional kms_key_arn="kmsKeyArn" ), logs_encryption_configuration=observabilityadmin.CfnOrganizationCentralizationRule.LogsEncryptionConfigurationProperty( encryption_strategy="encryptionStrategy", # the properties below are optional encryption_conflict_resolution_strategy="encryptionConflictResolutionStrategy", kms_key_arn="kmsKeyArn" ) ) )
Attributes
- account
The destination account (within the organization) to which the telemetry data should be centralized.
- destination_logs_configuration
Log specific configuration for centralization destination log groups.
- region
The primary destination region to which telemetry data should be centralized.
CentralizationRuleProperty
- class CfnOrganizationCentralizationRule.CentralizationRuleProperty(*, destination, source)
Bases:
objectDefines how telemetry data should be centralized across an AWS Organization, including source and destination configurations.
- Parameters:
destination (
Union[IResolvable,CentralizationRuleDestinationProperty,Dict[str,Any]]) – Configuration determining where the telemetry data should be centralized, backed up, as well as encryption configuration for the primary and backup destinations.source (
Union[IResolvable,CentralizationRuleSourceProperty,Dict[str,Any]]) – Configuration determining the source of the telemetry data to be centralized.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_observabilityadmin as observabilityadmin centralization_rule_property = observabilityadmin.CfnOrganizationCentralizationRule.CentralizationRuleProperty( destination=observabilityadmin.CfnOrganizationCentralizationRule.CentralizationRuleDestinationProperty( region="region", # the properties below are optional account="account", destination_logs_configuration=observabilityadmin.CfnOrganizationCentralizationRule.DestinationLogsConfigurationProperty( backup_configuration=observabilityadmin.CfnOrganizationCentralizationRule.LogsBackupConfigurationProperty( region="region", # the properties below are optional kms_key_arn="kmsKeyArn" ), logs_encryption_configuration=observabilityadmin.CfnOrganizationCentralizationRule.LogsEncryptionConfigurationProperty( encryption_strategy="encryptionStrategy", # the properties below are optional encryption_conflict_resolution_strategy="encryptionConflictResolutionStrategy", kms_key_arn="kmsKeyArn" ) ) ), source=observabilityadmin.CfnOrganizationCentralizationRule.CentralizationRuleSourceProperty( regions=["regions"], # the properties below are optional scope="scope", source_logs_configuration=observabilityadmin.CfnOrganizationCentralizationRule.SourceLogsConfigurationProperty( encrypted_log_group_strategy="encryptedLogGroupStrategy", log_group_selection_criteria="logGroupSelectionCriteria" ) ) )
Attributes
- destination
Configuration determining where the telemetry data should be centralized, backed up, as well as encryption configuration for the primary and backup destinations.
- source
Configuration determining the source of the telemetry data to be centralized.
CentralizationRuleSourceProperty
- class CfnOrganizationCentralizationRule.CentralizationRuleSourceProperty(*, regions, scope=None, source_logs_configuration=None)
Bases:
objectConfiguration specifying the source of telemetry data to be centralized.
- Parameters:
regions (
Sequence[str]) – The list of source regions from which telemetry data should be centralized.scope (
Optional[str]) – The organizational scope from which telemetry data should be centralized, specified using organization id, accounts or organizational unit ids.source_logs_configuration (
Union[IResolvable,SourceLogsConfigurationProperty,Dict[str,Any],None]) – Log specific configuration for centralization source log groups.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_observabilityadmin as observabilityadmin centralization_rule_source_property = observabilityadmin.CfnOrganizationCentralizationRule.CentralizationRuleSourceProperty( regions=["regions"], # the properties below are optional scope="scope", source_logs_configuration=observabilityadmin.CfnOrganizationCentralizationRule.SourceLogsConfigurationProperty( encrypted_log_group_strategy="encryptedLogGroupStrategy", log_group_selection_criteria="logGroupSelectionCriteria" ) )
Attributes
- regions
The list of source regions from which telemetry data should be centralized.
- scope
The organizational scope from which telemetry data should be centralized, specified using organization id, accounts or organizational unit ids.
- source_logs_configuration
Log specific configuration for centralization source log groups.
DestinationLogsConfigurationProperty
- class CfnOrganizationCentralizationRule.DestinationLogsConfigurationProperty(*, backup_configuration=None, logs_encryption_configuration=None)
Bases:
objectConfiguration for centralization destination log groups, including encryption and backup settings.
- Parameters:
backup_configuration (
Union[IResolvable,LogsBackupConfigurationProperty,Dict[str,Any],None]) – Configuration defining the backup region and an optional KMS key for the backup destination.logs_encryption_configuration (
Union[IResolvable,LogsEncryptionConfigurationProperty,Dict[str,Any],None]) – The encryption configuration for centralization destination log groups.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_observabilityadmin as observabilityadmin destination_logs_configuration_property = observabilityadmin.CfnOrganizationCentralizationRule.DestinationLogsConfigurationProperty( backup_configuration=observabilityadmin.CfnOrganizationCentralizationRule.LogsBackupConfigurationProperty( region="region", # the properties below are optional kms_key_arn="kmsKeyArn" ), logs_encryption_configuration=observabilityadmin.CfnOrganizationCentralizationRule.LogsEncryptionConfigurationProperty( encryption_strategy="encryptionStrategy", # the properties below are optional encryption_conflict_resolution_strategy="encryptionConflictResolutionStrategy", kms_key_arn="kmsKeyArn" ) )
Attributes
- backup_configuration
Configuration defining the backup region and an optional KMS key for the backup destination.
- logs_encryption_configuration
The encryption configuration for centralization destination log groups.
LogsBackupConfigurationProperty
- class CfnOrganizationCentralizationRule.LogsBackupConfigurationProperty(*, region, kms_key_arn=None)
Bases:
objectConfiguration for backing up centralized log data to a secondary region.
- Parameters:
region (
str) – Logs specific backup destination region within the primary destination account to which log data should be centralized.kms_key_arn (
Optional[str]) – KMS Key ARN belonging to the primary destination account and backup region, to encrypt newly created central log groups in the backup destination.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_observabilityadmin as observabilityadmin logs_backup_configuration_property = observabilityadmin.CfnOrganizationCentralizationRule.LogsBackupConfigurationProperty( region="region", # the properties below are optional kms_key_arn="kmsKeyArn" )
Attributes
- kms_key_arn
KMS Key ARN belonging to the primary destination account and backup region, to encrypt newly created central log groups in the backup destination.
- region
Logs specific backup destination region within the primary destination account to which log data should be centralized.
LogsEncryptionConfigurationProperty
- class CfnOrganizationCentralizationRule.LogsEncryptionConfigurationProperty(*, encryption_strategy, encryption_conflict_resolution_strategy=None, kms_key_arn=None)
Bases:
objectConfiguration for encrypting centralized log groups.
This configuration is only applied to destination log groups for which the corresponding source log groups are encrypted using Customer Managed KMS Keys.
- Parameters:
encryption_strategy (
str) – Configuration that determines the encryption strategy of the destination log groups. CUSTOMER_MANAGED uses the configured KmsKeyArn to encrypt newly created destination log groups.encryption_conflict_resolution_strategy (
Optional[str]) – 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.kms_key_arn (
Optional[str]) – KMS Key ARN belonging to the primary destination account and region, to encrypt newly created central log groups in the primary destination.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_observabilityadmin as observabilityadmin logs_encryption_configuration_property = observabilityadmin.CfnOrganizationCentralizationRule.LogsEncryptionConfigurationProperty( encryption_strategy="encryptionStrategy", # the properties below are optional encryption_conflict_resolution_strategy="encryptionConflictResolutionStrategy", kms_key_arn="kmsKeyArn" )
Attributes
- encryption_conflict_resolution_strategy
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.
- encryption_strategy
Configuration that determines the encryption strategy of the destination log groups.
CUSTOMER_MANAGED uses the configured KmsKeyArn to encrypt newly created destination log groups.
- kms_key_arn
KMS Key ARN belonging to the primary destination account and region, to encrypt newly created central log groups in the primary destination.
SourceLogsConfigurationProperty
- class CfnOrganizationCentralizationRule.SourceLogsConfigurationProperty(*, encrypted_log_group_strategy, log_group_selection_criteria)
Bases:
objectConfiguration for selecting and handling source log groups for centralization.
- Parameters:
encrypted_log_group_strategy (
str) – 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.log_group_selection_criteria (
str) – The selection criteria that specifies which source log groups to centralize. The selection criteria uses the same format as OAM link filters.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_observabilityadmin as observabilityadmin source_logs_configuration_property = observabilityadmin.CfnOrganizationCentralizationRule.SourceLogsConfigurationProperty( encrypted_log_group_strategy="encryptedLogGroupStrategy", log_group_selection_criteria="logGroupSelectionCriteria" )
Attributes
- encrypted_log_group_strategy
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.
- log_group_selection_criteria
The selection criteria that specifies which source log groups to centralize.
The selection criteria uses the same format as OAM link filters.