CfnRemediationConfiguration
- class aws_cdk.aws_config.CfnRemediationConfiguration(scope, id, *, config_rule_name, target_id, target_type, automatic=None, execution_controls=None, maximum_automatic_attempts=None, parameters=None, resource_type=None, retry_attempt_seconds=None, target_version=None)
Bases:
CfnResourceA CloudFormation
AWS::Config::RemediationConfiguration.An object that represents the details about the remediation configuration that includes the remediation action, parameters, and data to execute the action.
- CloudformationResource:
AWS::Config::RemediationConfiguration
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_config as config # parameters: Any cfn_remediation_configuration = config.CfnRemediationConfiguration(self, "MyCfnRemediationConfiguration", config_rule_name="configRuleName", target_id="targetId", target_type="targetType", # the properties below are optional automatic=False, execution_controls=config.CfnRemediationConfiguration.ExecutionControlsProperty( ssm_controls=config.CfnRemediationConfiguration.SsmControlsProperty( concurrent_execution_rate_percentage=123, error_percentage=123 ) ), maximum_automatic_attempts=123, parameters=parameters, resource_type="resourceType", retry_attempt_seconds=123, target_version="targetVersion" )
Create a new
AWS::Config::RemediationConfiguration.- Parameters:
scope (
Construct) –scope in which this resource is defined.
id (
str) –scoped id of the resource.
config_rule_name (
str) – The name of the AWS Config rule.target_id (
str) – Target ID is the name of the SSM document.target_type (
str) – The type of the target. Target executes remediation. For example, SSM document.automatic (
Union[bool,IResolvable,None]) – The remediation is triggered automatically.execution_controls (
Union[IResolvable,ExecutionControlsProperty,Dict[str,Any],None]) – An ExecutionControls object.maximum_automatic_attempts (
Union[int,float,None]) – The maximum number of failed attempts for auto-remediation. If you do not select a number, the default is 5. For example, if you specify MaximumAutomaticAttempts as 5 with RetryAttemptSeconds as 50 seconds, AWS Config will put a RemediationException on your behalf for the failing resource after the 5th failed attempt within 50 seconds.parameters (
Optional[Any]) – An object of the RemediationParameterValue. For more information, see RemediationParameterValue . .. epigraph:: The type is a map of strings to RemediationParameterValue.resource_type (
Optional[str]) – The type of a resource.retry_attempt_seconds (
Union[int,float,None]) – Maximum time in seconds that AWS Config runs auto-remediation. If you do not select a number, the default is 60 seconds. For example, if you specify RetryAttemptSeconds as 50 seconds and MaximumAutomaticAttempts as 5, AWS Config will run auto-remediations 5 times within 50 seconds before throwing an exception.target_version (
Optional[str]) – Version of the target. For example, version of the SSM document. .. epigraph:: If you make backward incompatible changes to the SSM document, you must call PutRemediationConfiguration API again to ensure the remediations can run.
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:
- Return type:
None
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.
- 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 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.
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).- 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 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:
- get_metadata(key)
Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters:
key (
str) –- See:
- Return type:
Any
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.
- inspect(inspector)
Examines the CloudFormation resource and discloses attributes.
- Parameters:
inspector (
TreeInspector) –tree inspector to collect and process attributes.
- 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 type:
str- Returns:
a string representation of this resource
Attributes
- CFN_RESOURCE_TYPE_NAME = 'AWS::Config::RemediationConfiguration'
- automatic
The remediation is triggered automatically.
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- config_rule_name
The name of the AWS Config rule.
- 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.
- execution_controls
An ExecutionControls object.
- 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.
- maximum_automatic_attempts
The maximum number of failed attempts for auto-remediation. If you do not select a number, the default is 5.
For example, if you specify MaximumAutomaticAttempts as 5 with RetryAttemptSeconds as 50 seconds, AWS Config will put a RemediationException on your behalf for the failing resource after the 5th failed attempt within 50 seconds.
- node
The construct tree node associated with this construct.
- parameters
//docs.aws.amazon.com/config/latest/APIReference/API_RemediationParameterValue.html>`_ .
The type is a map of strings to RemediationParameterValue.
- Link:
- Type:
An object of the RemediationParameterValue. For more information, see `RemediationParameterValue <https
- 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 }).
- resource_type
The type of a resource.
- retry_attempt_seconds
Maximum time in seconds that AWS Config runs auto-remediation.
If you do not select a number, the default is 60 seconds.
For example, if you specify RetryAttemptSeconds as 50 seconds and MaximumAutomaticAttempts as 5, AWS Config will run auto-remediations 5 times within 50 seconds before throwing an exception.
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- target_id
Target ID is the name of the SSM document.
- target_type
The type of the target.
Target executes remediation. For example, SSM document.
- target_version
Version of the target. For example, version of the SSM document.
If you make backward incompatible changes to the SSM document, you must call PutRemediationConfiguration API again to ensure the remediations can run.
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_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
ExecutionControlsProperty
- class CfnRemediationConfiguration.ExecutionControlsProperty(*, ssm_controls=None)
Bases:
objectAn ExecutionControls object.
- Parameters:
ssm_controls (
Union[IResolvable,SsmControlsProperty,Dict[str,Any],None]) – A SsmControls object.- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_config as config execution_controls_property = config.CfnRemediationConfiguration.ExecutionControlsProperty( ssm_controls=config.CfnRemediationConfiguration.SsmControlsProperty( concurrent_execution_rate_percentage=123, error_percentage=123 ) )
Attributes
RemediationParameterValueProperty
- class CfnRemediationConfiguration.RemediationParameterValueProperty(*, resource_value=None, static_value=None)
Bases:
objectThe value is either a dynamic (resource) value or a static value.
You must select either a dynamic value or a static value.
- Parameters:
resource_value (
Union[IResolvable,ResourceValueProperty,Dict[str,Any],None]) – The value is dynamic and changes at run-time.static_value (
Union[IResolvable,StaticValueProperty,Dict[str,Any],None]) – The value is static and does not change at run-time.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_config as config remediation_parameter_value_property = config.CfnRemediationConfiguration.RemediationParameterValueProperty( resource_value=config.CfnRemediationConfiguration.ResourceValueProperty( value="value" ), static_value=config.CfnRemediationConfiguration.StaticValueProperty( values=["values"] ) )
Attributes
- resource_value
The value is dynamic and changes at run-time.
- static_value
The value is static and does not change at run-time.
ResourceValueProperty
- class CfnRemediationConfiguration.ResourceValueProperty(*, value=None)
Bases:
objectThe dynamic value of the resource.
- Parameters:
value (
Optional[str]) – The value is a resource ID.- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_config as config resource_value_property = config.CfnRemediationConfiguration.ResourceValueProperty( value="value" )
Attributes
SsmControlsProperty
- class CfnRemediationConfiguration.SsmControlsProperty(*, concurrent_execution_rate_percentage=None, error_percentage=None)
Bases:
objectAWS Systems Manager (SSM) specific remediation controls.
- Parameters:
concurrent_execution_rate_percentage (
Union[int,float,None]) – The maximum percentage of remediation actions allowed to run in parallel on the non-compliant resources for that specific rule. You can specify a percentage, such as 10%. The default value is 10.error_percentage (
Union[int,float,None]) – The percentage of errors that are allowed before SSM stops running automations on non-compliant resources for that specific rule. You can specify a percentage of errors, for example 10%. If you do not specifiy a percentage, the default is 50%. For example, if you set the ErrorPercentage to 40% for 10 non-compliant resources, then SSM stops running the automations when the fifth error is received.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_config as config ssm_controls_property = config.CfnRemediationConfiguration.SsmControlsProperty( concurrent_execution_rate_percentage=123, error_percentage=123 )
Attributes
- concurrent_execution_rate_percentage
The maximum percentage of remediation actions allowed to run in parallel on the non-compliant resources for that specific rule.
You can specify a percentage, such as 10%. The default value is 10.
- error_percentage
The percentage of errors that are allowed before SSM stops running automations on non-compliant resources for that specific rule.
You can specify a percentage of errors, for example 10%. If you do not specifiy a percentage, the default is 50%. For example, if you set the ErrorPercentage to 40% for 10 non-compliant resources, then SSM stops running the automations when the fifth error is received.
StaticValueProperty
- class CfnRemediationConfiguration.StaticValueProperty(*, values=None)
Bases:
objectThe static value of the resource.
- Parameters:
values (
Optional[Sequence[str]]) – A list of values. For example, the ARN of the assumed role.- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_config as config static_value_property = config.CfnRemediationConfiguration.StaticValueProperty( values=["values"] )
Attributes
- values
A list of values.
For example, the ARN of the assumed role.