CfnOrganizationConfigRule

class aws_cdk.aws_config.CfnOrganizationConfigRule(scope, id, *, organization_config_rule_name, excluded_accounts=None, organization_custom_rule_metadata=None, organization_managed_rule_metadata=None)

Bases: aws_cdk.core.CfnResource

A CloudFormation AWS::Config::OrganizationConfigRule.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-organizationconfigrule.html cloudformationResource: :cloudformationResource:: AWS::Config::OrganizationConfigRule

Create a new AWS::Config::OrganizationConfigRule.

Parameters
  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

  • organization_config_rule_name (str) – AWS::Config::OrganizationConfigRule.OrganizationConfigRuleName.

  • excluded_accounts (Optional[List[str]]) – AWS::Config::OrganizationConfigRule.ExcludedAccounts.

  • organization_custom_rule_metadata (Union[IResolvable, ForwardRef, None]) – AWS::Config::OrganizationConfigRule.OrganizationCustomRuleMetadata.

  • organization_managed_rule_metadata (Union[IResolvable, ForwardRef, None]) – AWS::Config::OrganizationConfigRule.OrganizationManagedRuleMetadata.

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_depends_on(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_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters
  • key (str) –

  • value (Any) –

see :see:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

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.

Return type

None

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “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.

For example:

# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}
Parameters
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermdediate 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.

Parameters
  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (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 resoure, please consult that specific resource’s documentation.

Return type

None

get_att(attribute_name)

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.

Return type

Reference

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

stability :stability: experimental

Return type

None

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

to_string()

Returns a string representation of this construct.

return :rtype: str :return: a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::Config::OrganizationConfigRule'
cfn_options

Options for this resource, such as condition, update policy etc.

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

creation_stack

return :rtype: List[str] :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.

excluded_accounts

AWS::Config::OrganizationConfigRule.ExcludedAccounts.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-organizationconfigrule.html#cfn-config-organizationconfigrule-excludedaccounts

Return type

Optional[List[str]]

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).

return :rtype: str :return:

the logical ID as a stringified token. This value will only get resolved during synthesis.

node

The construct tree node associated with this construct.

Return type

ConstructNode

organization_config_rule_name

AWS::Config::OrganizationConfigRule.OrganizationConfigRuleName.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-organizationconfigrule.html#cfn-config-organizationconfigrule-organizationconfigrulename

Return type

str

organization_custom_rule_metadata

AWS::Config::OrganizationConfigRule.OrganizationCustomRuleMetadata.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-organizationconfigrule.html#cfn-config-organizationconfigrule-organizationcustomrulemetadata

Return type

Union[IResolvable, ForwardRef, None]

organization_managed_rule_metadata

AWS::Config::OrganizationConfigRule.OrganizationManagedRuleMetadata.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-config-organizationconfigrule.html#cfn-config-organizationconfigrule-organizationmanagedrulemetadata

Return type

Union[IResolvable, ForwardRef, None]

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 }).

Return type

str

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Return type

Stack

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters

x (Any) –

return :rtype: bool :return: The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

OrganizationCustomRuleMetadataProperty

class CfnOrganizationConfigRule.OrganizationCustomRuleMetadataProperty(*, lambda_function_arn, organization_config_rule_trigger_types, description=None, input_parameters=None, maximum_execution_frequency=None, resource_id_scope=None, resource_types_scope=None, tag_key_scope=None, tag_value_scope=None)

Bases: object

Parameters
  • lambda_function_arn (str) – CfnOrganizationConfigRule.OrganizationCustomRuleMetadataProperty.LambdaFunctionArn.

  • organization_config_rule_trigger_types (List[str]) – CfnOrganizationConfigRule.OrganizationCustomRuleMetadataProperty.OrganizationConfigRuleTriggerTypes.

  • description (Optional[str]) – CfnOrganizationConfigRule.OrganizationCustomRuleMetadataProperty.Description.

  • input_parameters (Optional[str]) – CfnOrganizationConfigRule.OrganizationCustomRuleMetadataProperty.InputParameters.

  • maximum_execution_frequency (Optional[str]) – CfnOrganizationConfigRule.OrganizationCustomRuleMetadataProperty.MaximumExecutionFrequency.

  • resource_id_scope (Optional[str]) – CfnOrganizationConfigRule.OrganizationCustomRuleMetadataProperty.ResourceIdScope.

  • resource_types_scope (Optional[List[str]]) – CfnOrganizationConfigRule.OrganizationCustomRuleMetadataProperty.ResourceTypesScope.

  • tag_key_scope (Optional[str]) – CfnOrganizationConfigRule.OrganizationCustomRuleMetadataProperty.TagKeyScope.

  • tag_value_scope (Optional[str]) – CfnOrganizationConfigRule.OrganizationCustomRuleMetadataProperty.TagValueScope.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationcustomrulemetadata.html

Attributes

description

CfnOrganizationConfigRule.OrganizationCustomRuleMetadataProperty.Description.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationcustomrulemetadata.html#cfn-config-organizationconfigrule-organizationcustomrulemetadata-description

Return type

Optional[str]

input_parameters

CfnOrganizationConfigRule.OrganizationCustomRuleMetadataProperty.InputParameters.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationcustomrulemetadata.html#cfn-config-organizationconfigrule-organizationcustomrulemetadata-inputparameters

Return type

Optional[str]

lambda_function_arn

CfnOrganizationConfigRule.OrganizationCustomRuleMetadataProperty.LambdaFunctionArn.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationcustomrulemetadata.html#cfn-config-organizationconfigrule-organizationcustomrulemetadata-lambdafunctionarn

Return type

str

maximum_execution_frequency

CfnOrganizationConfigRule.OrganizationCustomRuleMetadataProperty.MaximumExecutionFrequency.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationcustomrulemetadata.html#cfn-config-organizationconfigrule-organizationcustomrulemetadata-maximumexecutionfrequency

Return type

Optional[str]

organization_config_rule_trigger_types

CfnOrganizationConfigRule.OrganizationCustomRuleMetadataProperty.OrganizationConfigRuleTriggerTypes.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationcustomrulemetadata.html#cfn-config-organizationconfigrule-organizationcustomrulemetadata-organizationconfigruletriggertypes

Return type

List[str]

resource_id_scope

CfnOrganizationConfigRule.OrganizationCustomRuleMetadataProperty.ResourceIdScope.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationcustomrulemetadata.html#cfn-config-organizationconfigrule-organizationcustomrulemetadata-resourceidscope

Return type

Optional[str]

resource_types_scope

CfnOrganizationConfigRule.OrganizationCustomRuleMetadataProperty.ResourceTypesScope.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationcustomrulemetadata.html#cfn-config-organizationconfigrule-organizationcustomrulemetadata-resourcetypesscope

Return type

Optional[List[str]]

tag_key_scope

CfnOrganizationConfigRule.OrganizationCustomRuleMetadataProperty.TagKeyScope.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationcustomrulemetadata.html#cfn-config-organizationconfigrule-organizationcustomrulemetadata-tagkeyscope

Return type

Optional[str]

tag_value_scope

CfnOrganizationConfigRule.OrganizationCustomRuleMetadataProperty.TagValueScope.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationcustomrulemetadata.html#cfn-config-organizationconfigrule-organizationcustomrulemetadata-tagvaluescope

Return type

Optional[str]

OrganizationManagedRuleMetadataProperty

class CfnOrganizationConfigRule.OrganizationManagedRuleMetadataProperty(*, rule_identifier, description=None, input_parameters=None, maximum_execution_frequency=None, resource_id_scope=None, resource_types_scope=None, tag_key_scope=None, tag_value_scope=None)

Bases: object

Parameters
  • rule_identifier (str) – CfnOrganizationConfigRule.OrganizationManagedRuleMetadataProperty.RuleIdentifier.

  • description (Optional[str]) – CfnOrganizationConfigRule.OrganizationManagedRuleMetadataProperty.Description.

  • input_parameters (Optional[str]) – CfnOrganizationConfigRule.OrganizationManagedRuleMetadataProperty.InputParameters.

  • maximum_execution_frequency (Optional[str]) – CfnOrganizationConfigRule.OrganizationManagedRuleMetadataProperty.MaximumExecutionFrequency.

  • resource_id_scope (Optional[str]) – CfnOrganizationConfigRule.OrganizationManagedRuleMetadataProperty.ResourceIdScope.

  • resource_types_scope (Optional[List[str]]) – CfnOrganizationConfigRule.OrganizationManagedRuleMetadataProperty.ResourceTypesScope.

  • tag_key_scope (Optional[str]) – CfnOrganizationConfigRule.OrganizationManagedRuleMetadataProperty.TagKeyScope.

  • tag_value_scope (Optional[str]) – CfnOrganizationConfigRule.OrganizationManagedRuleMetadataProperty.TagValueScope.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationmanagedrulemetadata.html

Attributes

description

CfnOrganizationConfigRule.OrganizationManagedRuleMetadataProperty.Description.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationmanagedrulemetadata.html#cfn-config-organizationconfigrule-organizationmanagedrulemetadata-description

Return type

Optional[str]

input_parameters

CfnOrganizationConfigRule.OrganizationManagedRuleMetadataProperty.InputParameters.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationmanagedrulemetadata.html#cfn-config-organizationconfigrule-organizationmanagedrulemetadata-inputparameters

Return type

Optional[str]

maximum_execution_frequency

CfnOrganizationConfigRule.OrganizationManagedRuleMetadataProperty.MaximumExecutionFrequency.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationmanagedrulemetadata.html#cfn-config-organizationconfigrule-organizationmanagedrulemetadata-maximumexecutionfrequency

Return type

Optional[str]

resource_id_scope

CfnOrganizationConfigRule.OrganizationManagedRuleMetadataProperty.ResourceIdScope.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationmanagedrulemetadata.html#cfn-config-organizationconfigrule-organizationmanagedrulemetadata-resourceidscope

Return type

Optional[str]

resource_types_scope

CfnOrganizationConfigRule.OrganizationManagedRuleMetadataProperty.ResourceTypesScope.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationmanagedrulemetadata.html#cfn-config-organizationconfigrule-organizationmanagedrulemetadata-resourcetypesscope

Return type

Optional[List[str]]

rule_identifier

CfnOrganizationConfigRule.OrganizationManagedRuleMetadataProperty.RuleIdentifier.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationmanagedrulemetadata.html#cfn-config-organizationconfigrule-organizationmanagedrulemetadata-ruleidentifier

Return type

str

tag_key_scope

CfnOrganizationConfigRule.OrganizationManagedRuleMetadataProperty.TagKeyScope.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationmanagedrulemetadata.html#cfn-config-organizationconfigrule-organizationmanagedrulemetadata-tagkeyscope

Return type

Optional[str]

tag_value_scope

CfnOrganizationConfigRule.OrganizationManagedRuleMetadataProperty.TagValueScope.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-organizationconfigrule-organizationmanagedrulemetadata.html#cfn-config-organizationconfigrule-organizationmanagedrulemetadata-tagvaluescope

Return type

Optional[str]