Struct RemediationConfiguration

#[non_exhaustive]
pub struct RemediationConfiguration {
    pub config_rule_name: String,
    pub target_type: RemediationTargetType,
    pub target_id: String,
    pub target_version: Option<String>,
    pub parameters: Option<HashMap<String, RemediationParameterValue>>,
    pub resource_type: Option<String>,
    pub automatic: bool,
    pub execution_controls: Option<ExecutionControls>,
    pub maximum_automatic_attempts: Option<i32>,
    pub retry_attempt_seconds: Option<i64>,
    pub arn: Option<String>,
    pub created_by_service: Option<String>,
}

An object that represents the details about the remediation configuration that includes the remediation action, parameters, and data to execute the action.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

config_rule_name: String

The name of the Config rule.

target_type: RemediationTargetType

The type of the target. Target executes remediation. For example, SSM document.

target_id: String

Target ID is the name of the SSM document.

target_version: Option<String>

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.

parameters: Option<HashMap<String, RemediationParameterValue>>

An object of the RemediationParameterValue.

resource_type: Option<String>

The type of a resource.

automatic: bool

The remediation is triggered automatically.

execution_controls: Option<ExecutionControls>

An ExecutionControls object.

maximum_automatic_attempts: Option<i32>

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, Config will put a RemediationException on your behalf for the failing resource after the 5th failed attempt within 50 seconds.

retry_attempt_seconds: Option<i64>

Time window to determine whether or not to add a remediation exception to prevent infinite remediation attempts. If MaximumAutomaticAttempts remediation attempts have been made under RetryAttemptSeconds, a remediation exception will be added to the resource. 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, Config will run auto-remediations 5 times within 50 seconds before adding a remediation exception to the resource.

arn: Option<String>

Amazon Resource Name (ARN) of remediation configuration.

created_by_service: Option<String>

Name of the service that owns the service-linked rule, if applicable.

Implementations

impl RemediationConfiguration

pub fn config_rule_name(&self) -> &str

The name of the Config rule.

pub fn target_type(&self) -> &RemediationTargetType

The type of the target. Target executes remediation. For example, SSM document.

pub fn target_id(&self) -> &str

Target ID is the name of the SSM document.

pub fn target_version(&self) -> Option<&str>

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.

pub fn parameters(&self) -> Option<&HashMap<String, RemediationParameterValue>>

An object of the RemediationParameterValue.

pub fn resource_type(&self) -> Option<&str>

The type of a resource.

pub fn automatic(&self) -> bool

The remediation is triggered automatically.

pub fn execution_controls(&self) -> Option<&ExecutionControls>

An ExecutionControls object.

pub fn maximum_automatic_attempts(&self) -> Option<i32>

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, Config will put a RemediationException on your behalf for the failing resource after the 5th failed attempt within 50 seconds.

pub fn retry_attempt_seconds(&self) -> Option<i64>

Time window to determine whether or not to add a remediation exception to prevent infinite remediation attempts. If MaximumAutomaticAttempts remediation attempts have been made under RetryAttemptSeconds, a remediation exception will be added to the resource. 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, Config will run auto-remediations 5 times within 50 seconds before adding a remediation exception to the resource.

pub fn arn(&self) -> Option<&str>

Amazon Resource Name (ARN) of remediation configuration.

pub fn created_by_service(&self) -> Option<&str>

Name of the service that owns the service-linked rule, if applicable.

impl RemediationConfiguration

pub fn builder() -> RemediationConfigurationBuilder

Creates a new builder-style object to manufacture RemediationConfiguration.

Trait Implementations

impl Clone for RemediationConfiguration

fn clone(&self) -> RemediationConfiguration

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RemediationConfiguration

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for RemediationConfiguration

fn eq(&self, other: &RemediationConfiguration) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for RemediationConfiguration