libZSservicesZSamazonka-configZSamazonka-config
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Config.Types.RemediationConfiguration

Description

 
Synopsis

Documentation

data RemediationConfiguration Source #

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

See: newRemediationConfiguration smart constructor.

Constructors

RemediationConfiguration' 

Fields

  • resourceType :: Maybe Text

    The type of a resource.

  • arn :: Maybe Text

    Amazon Resource Name (ARN) of remediation configuration.

  • automatic :: Maybe Bool

    The remediation is triggered automatically.

  • createdByService :: Maybe Text

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

  • retryAttemptSeconds :: Maybe Natural

    Maximum time in seconds that 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, Config will run auto-remediations 5 times within 50 seconds before throwing an exception.

  • executionControls :: Maybe ExecutionControls

    An ExecutionControls object.

  • parameters :: Maybe (HashMap Text RemediationParameterValue)

    An object of the RemediationParameterValue.

  • maximumAutomaticAttempts :: Maybe Natural

    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.

  • targetVersion :: Maybe Text

    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.

  • configRuleName :: Text

    The name of the Config rule.

  • targetType :: RemediationTargetType

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

  • targetId :: Text

    Target ID is the name of the public document.

Instances

Instances details
Eq RemediationConfiguration Source # 
Instance details

Defined in Amazonka.Config.Types.RemediationConfiguration

Methods

(==) :: RemediationConfiguration -> RemediationConfiguration -> Bool #

(/=) :: RemediationConfiguration -> RemediationConfiguration -> Bool #

Read RemediationConfiguration Source # 
Instance details

Defined in Amazonka.Config.Types.RemediationConfiguration

Methods

readsPrec :: Int -> ReadS RemediationConfiguration #

readList :: ReadS [RemediationConfiguration] #

readPrec :: ReadPrec RemediationConfiguration #

readListPrec :: ReadPrec [RemediationConfiguration] #

Show RemediationConfiguration Source # 
Instance details

Defined in Amazonka.Config.Types.RemediationConfiguration

Methods

showsPrec :: Int -> RemediationConfiguration -> ShowS #

show :: RemediationConfiguration -> String #

showList :: [RemediationConfiguration] -> ShowS #

Generic RemediationConfiguration Source # 
Instance details

Defined in Amazonka.Config.Types.RemediationConfiguration

Associated Types

type Rep RemediationConfiguration :: Type -> Type #

Methods

from :: RemediationConfiguration -> Rep RemediationConfiguration x #

to :: Rep RemediationConfiguration x -> RemediationConfiguration #

NFData RemediationConfiguration Source # 
Instance details

Defined in Amazonka.Config.Types.RemediationConfiguration

Methods

rnf :: RemediationConfiguration -> () #

Hashable RemediationConfiguration Source # 
Instance details

Defined in Amazonka.Config.Types.RemediationConfiguration

Methods

hashWithSalt :: Int -> RemediationConfiguration -> Int #

hash :: RemediationConfiguration -> Int #

ToJSON RemediationConfiguration Source # 
Instance details

Defined in Amazonka.Config.Types.RemediationConfiguration

Methods

toJSON :: RemediationConfiguration -> Value #

toEncoding :: RemediationConfiguration -> Encoding #

toJSONList :: [RemediationConfiguration] -> Value #

toEncodingList :: [RemediationConfiguration] -> Encoding #

FromJSON RemediationConfiguration Source # 
Instance details

Defined in Amazonka.Config.Types.RemediationConfiguration

Methods

parseJSON :: Value -> Parser RemediationConfiguration #

parseJSONList :: Value -> Parser [RemediationConfiguration] #

type Rep RemediationConfiguration Source # 
Instance details

Defined in Amazonka.Config.Types.RemediationConfiguration

type Rep RemediationConfiguration = D1 ('MetaData "RemediationConfiguration" "Amazonka.Config.Types.RemediationConfiguration" "libZSservicesZSamazonka-configZSamazonka-config" 'False) (C1 ('MetaCons "RemediationConfiguration'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "resourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "automatic") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: (S1 ('MetaSel ('Just "createdByService") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "retryAttemptSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "executionControls") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExecutionControls))))) :*: ((S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text RemediationParameterValue))) :*: (S1 ('MetaSel ('Just "maximumAutomaticAttempts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "targetVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "configRuleName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "targetType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RemediationTargetType) :*: S1 ('MetaSel ('Just "targetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newRemediationConfiguration Source #

Arguments

:: Text

$sel:configRuleName:RemediationConfiguration'

-> RemediationTargetType

$sel:targetType:RemediationConfiguration'

-> Text

$sel:targetId:RemediationConfiguration'

-> RemediationConfiguration 

Create a value of RemediationConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:resourceType:RemediationConfiguration', remediationConfiguration_resourceType - The type of a resource.

$sel:arn:RemediationConfiguration', remediationConfiguration_arn - Amazon Resource Name (ARN) of remediation configuration.

$sel:automatic:RemediationConfiguration', remediationConfiguration_automatic - The remediation is triggered automatically.

$sel:createdByService:RemediationConfiguration', remediationConfiguration_createdByService - Name of the service that owns the service linked rule, if applicable.

$sel:retryAttemptSeconds:RemediationConfiguration', remediationConfiguration_retryAttemptSeconds - Maximum time in seconds that 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, Config will run auto-remediations 5 times within 50 seconds before throwing an exception.

$sel:executionControls:RemediationConfiguration', remediationConfiguration_executionControls - An ExecutionControls object.

$sel:parameters:RemediationConfiguration', remediationConfiguration_parameters - An object of the RemediationParameterValue.

$sel:maximumAutomaticAttempts:RemediationConfiguration', remediationConfiguration_maximumAutomaticAttempts - 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.

$sel:targetVersion:RemediationConfiguration', remediationConfiguration_targetVersion - 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.

$sel:configRuleName:RemediationConfiguration', remediationConfiguration_configRuleName - The name of the Config rule.

$sel:targetType:RemediationConfiguration', remediationConfiguration_targetType - The type of the target. Target executes remediation. For example, SSM document.

$sel:targetId:RemediationConfiguration', remediationConfiguration_targetId - Target ID is the name of the public document.

remediationConfiguration_resourceType :: Lens' RemediationConfiguration (Maybe Text) Source #

The type of a resource.

remediationConfiguration_arn :: Lens' RemediationConfiguration (Maybe Text) Source #

Amazon Resource Name (ARN) of remediation configuration.

remediationConfiguration_automatic :: Lens' RemediationConfiguration (Maybe Bool) Source #

The remediation is triggered automatically.

remediationConfiguration_createdByService :: Lens' RemediationConfiguration (Maybe Text) Source #

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

remediationConfiguration_retryAttemptSeconds :: Lens' RemediationConfiguration (Maybe Natural) Source #

Maximum time in seconds that 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, Config will run auto-remediations 5 times within 50 seconds before throwing an exception.

remediationConfiguration_executionControls :: Lens' RemediationConfiguration (Maybe ExecutionControls) Source #

An ExecutionControls object.

remediationConfiguration_parameters :: Lens' RemediationConfiguration (Maybe (HashMap Text RemediationParameterValue)) Source #

An object of the RemediationParameterValue.

remediationConfiguration_maximumAutomaticAttempts :: Lens' RemediationConfiguration (Maybe Natural) Source #

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.

remediationConfiguration_targetVersion :: Lens' RemediationConfiguration (Maybe Text) Source #

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.

remediationConfiguration_configRuleName :: Lens' RemediationConfiguration Text Source #

The name of the Config rule.

remediationConfiguration_targetType :: Lens' RemediationConfiguration RemediationTargetType Source #

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

remediationConfiguration_targetId :: Lens' RemediationConfiguration Text Source #

Target ID is the name of the public document.