AWS::Config::RemediationConfiguration - AWS CloudFormation
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

AWS::Config::RemediationConfiguration

一个对象,它表示有关补救措施配置的详细信息,包括补救措施操作、参数和执行此操作的数据。

语法

要在 AWS CloudFormation 模板中声明此实体,请使用以下语法:

JSON

{ "Type" : "AWS::Config::RemediationConfiguration", "Properties" : { "Automatic" : Boolean, "ConfigRuleName" : String, "ExecutionControls" : ExecutionControls, "MaximumAutomaticAttempts" : Integer, "Parameters" : Json, "ResourceType" : String, "RetryAttemptSeconds" : Integer, "TargetId" : String, "TargetType" : String, "TargetVersion" : String } }

YAML

Type: AWS::Config::RemediationConfiguration Properties: Automatic: Boolean ConfigRuleName: String ExecutionControls: ExecutionControls MaximumAutomaticAttempts: Integer Parameters: Json ResourceType: String RetryAttemptSeconds: Integer TargetId: String TargetType: String TargetVersion: String

属性

Automatic

该补救措施将自动触发。

必需:否

类型:布尔值

Update requires: No interruption

ConfigRuleName

AWS Config 规则的名称。

必需:是

类型:字符串

最低1

最高128

模式.*\S.*

Update requires: Replacement

ExecutionControls

一个 ExecutionControls 对象。

必需:否

类型ExecutionControls

Update requires: No interruption

MaximumAutomaticAttempts

失败的自动补救的最大次数。如果您不选择一个数字,则默认为 5。

例如,如果您将 MaximumAutomaticAttempts 指定为 5,将 RetryAttemptSeconds 指定为 50 秒,则 AWS Config 在 50 秒内第 5 次尝试失败后,将代表您针对失败的源触发 RemediationException。

必需:否

类型:整数

最低1

最高25

Update requires: No interruption

Parameters

RemediationParameterValue 的对象。

注意

类型为字符串与 RemediationParameterValue 的映射。

必需:否

类型:Json

Update requires: No interruption

ResourceType

资源的类型。

必需:否

类型:字符串

Update requires: No interruption

RetryAttemptSeconds

AWS Config 运行自动补救的最长时间(以秒为单位)。如果您不选择一个数字,则默认为 60 秒。

例如,如果您将 RetryAttemptSeconds 指定为 50 秒,将 MaximumAutomaticAttempts 指定为 5,则在引发异常之前,AWS Config 将在 50 秒内运行 5 次自动补救。

必需:否

类型:整数

Update requires: No interruption

TargetId

目标 ID 是公有文档的名称。

必需:是

类型:字符串

最低1

最高256

Update requires: No interruption

TargetType

目标类型。目标执行补救措施。例如,SSM 文档。

必需:是

类型:字符串

允许的值SSM_DOCUMENT

Update requires: No interruption

TargetVersion

目标的版本。例如,SSM 文档的版本。

注意

如果您对 SSM 文档进行向后不兼容的更改,则必须再次调用 PutRemediationConfiguration API 以确保修复可以运行。

必需:否

类型:字符串

Update requires: No interruption

返回值

Ref

在将此资源的逻辑 ID 传递给内部 Ref 函数时,Ref 返回与 SSM 文档关联的补救措施操作。

For more information about using the Ref function, see Ref.

示例

补救措施配置

以下示例创建一个使用 AWS Systems Manager 文档的补救措施配置。

JSON

{ "BasicRemediationConfiguration": { "Type": "AWS::Config::RemediationConfiguration", "Properties": { "ConfigRuleName": "configRuleName", "Parameters": { "AutomationAssumeRole": { "StaticValue": { "Values": [ "automationAssumeRole" ] } }, "InstanceId": { "StaticValue": { "Values": [ "instanceId" ] } } }, "TargetId": "AWS-StartEC2Instance", "TargetType": "SSM_DOCUMENT", "TargetVersion": "1" } } }

YAML

BasicRemediationConfiguration: Type: "AWS::Config::RemediationConfiguration" Properties: ConfigRuleName: configRuleName Parameters: AutomationAssumeRole: StaticValue: Values: - automationAssumeRole InstanceId: StaticValue: Values: - instanceId TargetId: "AWS-StartEC2Instance" TargetType: "SSM_DOCUMENT" TargetVersion: "1"