Amazonka.Config.Types.OrganizationManagedRuleMetadata

Documentation

data OrganizationManagedRuleMetadata

An object that specifies organization managed rule metadata such as resource type and ID of Amazon Web Services resource along with the rule identifier. It also provides the frequency with which you want Config to run evaluations for the rule if the trigger type is periodic.

See: newOrganizationManagedRuleMetadata smart constructor.

Constructors

OrganizationManagedRuleMetadata'

Fields

• description :: Maybe Text

  The description that you provide for your organization Config rule.

• inputParameters :: Maybe Text

  A string, in JSON format, that is passed to your organization Config rule Lambda function.

• maximumExecutionFrequency :: Maybe MaximumExecutionFrequency

  The maximum frequency with which Config runs evaluations for a rule. This is for an Config managed rule that is triggered at a periodic frequency.

  By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.

• resourceIdScope :: Maybe Text

  The ID of the Amazon Web Services resource that was evaluated.

• resourceTypesScope :: Maybe [Text]

  The type of the Amazon Web Services resource that was evaluated.

• tagKeyScope :: Maybe Text

  One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

• tagValueScope :: Maybe Text

  The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

• ruleIdentifier :: Text

  For organization config managed rules, a predefined identifier from a list. For example, IAM_PASSWORD_POLICY is a managed rule. To reference a managed rule, see Using Config managed rules.

Instances

FromJSON OrganizationManagedRuleMetadata

Defined in Amazonka.Config.Types.OrganizationManagedRuleMetadata

Methods

parseJSON :: Value -> Parser OrganizationManagedRuleMetadata

parseJSONList :: Value -> Parser [OrganizationManagedRuleMetadata]

ToJSON OrganizationManagedRuleMetadata

Defined in Amazonka.Config.Types.OrganizationManagedRuleMetadata

Methods

toJSON :: OrganizationManagedRuleMetadata -> Value

toEncoding :: OrganizationManagedRuleMetadata -> Encoding

toJSONList :: [OrganizationManagedRuleMetadata] -> Value

toEncodingList :: [OrganizationManagedRuleMetadata] -> Encoding

Generic OrganizationManagedRuleMetadata

Defined in Amazonka.Config.Types.OrganizationManagedRuleMetadata

Associated Types

type Rep OrganizationManagedRuleMetadata :: Type -> Type

Methods

from :: OrganizationManagedRuleMetadata -> Rep OrganizationManagedRuleMetadata x

to :: Rep OrganizationManagedRuleMetadata x -> OrganizationManagedRuleMetadata

Read OrganizationManagedRuleMetadata

Defined in Amazonka.Config.Types.OrganizationManagedRuleMetadata

Methods

readsPrec :: Int -> ReadS OrganizationManagedRuleMetadata

readList :: ReadS [OrganizationManagedRuleMetadata]

readPrec :: ReadPrec OrganizationManagedRuleMetadata

readListPrec :: ReadPrec [OrganizationManagedRuleMetadata]

Show OrganizationManagedRuleMetadata

Defined in Amazonka.Config.Types.OrganizationManagedRuleMetadata

Methods

showsPrec :: Int -> OrganizationManagedRuleMetadata -> ShowS

show :: OrganizationManagedRuleMetadata -> String

showList :: [OrganizationManagedRuleMetadata] -> ShowS

NFData OrganizationManagedRuleMetadata

Defined in Amazonka.Config.Types.OrganizationManagedRuleMetadata

Methods

rnf :: OrganizationManagedRuleMetadata -> ()

Eq OrganizationManagedRuleMetadata

Defined in Amazonka.Config.Types.OrganizationManagedRuleMetadata

Methods

(==) :: OrganizationManagedRuleMetadata -> OrganizationManagedRuleMetadata -> Bool

(/=) :: OrganizationManagedRuleMetadata -> OrganizationManagedRuleMetadata -> Bool

Hashable OrganizationManagedRuleMetadata

Defined in Amazonka.Config.Types.OrganizationManagedRuleMetadata

Methods

hashWithSalt :: Int -> OrganizationManagedRuleMetadata -> Int

hash :: OrganizationManagedRuleMetadata -> Int

type Rep OrganizationManagedRuleMetadata

Defined in Amazonka.Config.Types.OrganizationManagedRuleMetadata

type Rep OrganizationManagedRuleMetadata = D1 ('MetaData "OrganizationManagedRuleMetadata" "Amazonka.Config.Types.OrganizationManagedRuleMetadata" "amazonka-config-2.0-7GF0fBbVw65uROwJwpcE3" 'False) (C1 ('MetaCons "OrganizationManagedRuleMetadata'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "inputParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "maximumExecutionFrequency") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MaximumExecutionFrequency)) :*: S1 ('MetaSel ('Just "resourceIdScope") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "resourceTypesScope") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "tagKeyScope") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "tagValueScope") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "ruleIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newOrganizationManagedRuleMetadata

Arguments

:: Text

$sel:ruleIdentifier:OrganizationManagedRuleMetadata'

-> OrganizationManagedRuleMetadata

Create a value of OrganizationManagedRuleMetadata 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:description:OrganizationManagedRuleMetadata', organizationManagedRuleMetadata_description - The description that you provide for your organization Config rule.

$sel:inputParameters:OrganizationManagedRuleMetadata', organizationManagedRuleMetadata_inputParameters - A string, in JSON format, that is passed to your organization Config rule Lambda function.

$sel:maximumExecutionFrequency:OrganizationManagedRuleMetadata', organizationManagedRuleMetadata_maximumExecutionFrequency - The maximum frequency with which Config runs evaluations for a rule. This is for an Config managed rule that is triggered at a periodic frequency.

By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.

$sel:resourceIdScope:OrganizationManagedRuleMetadata', organizationManagedRuleMetadata_resourceIdScope - The ID of the Amazon Web Services resource that was evaluated.

$sel:resourceTypesScope:OrganizationManagedRuleMetadata', organizationManagedRuleMetadata_resourceTypesScope - The type of the Amazon Web Services resource that was evaluated.

$sel:tagKeyScope:OrganizationManagedRuleMetadata', organizationManagedRuleMetadata_tagKeyScope - One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

$sel:tagValueScope:OrganizationManagedRuleMetadata', organizationManagedRuleMetadata_tagValueScope - The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

$sel:ruleIdentifier:OrganizationManagedRuleMetadata', organizationManagedRuleMetadata_ruleIdentifier - For organization config managed rules, a predefined identifier from a list. For example, IAM_PASSWORD_POLICY is a managed rule. To reference a managed rule, see Using Config managed rules.

organizationManagedRuleMetadata_description :: Lens' OrganizationManagedRuleMetadata (Maybe Text)

The description that you provide for your organization Config rule.

organizationManagedRuleMetadata_inputParameters :: Lens' OrganizationManagedRuleMetadata (Maybe Text)

A string, in JSON format, that is passed to your organization Config rule Lambda function.

organizationManagedRuleMetadata_maximumExecutionFrequency :: Lens' OrganizationManagedRuleMetadata (Maybe MaximumExecutionFrequency)

The maximum frequency with which Config runs evaluations for a rule. This is for an Config managed rule that is triggered at a periodic frequency.

By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.

organizationManagedRuleMetadata_resourceIdScope :: Lens' OrganizationManagedRuleMetadata (Maybe Text)

The ID of the Amazon Web Services resource that was evaluated.

organizationManagedRuleMetadata_resourceTypesScope :: Lens' OrganizationManagedRuleMetadata (Maybe [Text])

The type of the Amazon Web Services resource that was evaluated.

organizationManagedRuleMetadata_tagKeyScope :: Lens' OrganizationManagedRuleMetadata (Maybe Text)

One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

organizationManagedRuleMetadata_tagValueScope :: Lens' OrganizationManagedRuleMetadata (Maybe Text)

The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

organizationManagedRuleMetadata_ruleIdentifier :: Lens' OrganizationManagedRuleMetadata Text

For organization config managed rules, a predefined identifier from a list. For example, IAM_PASSWORD_POLICY is a managed rule. To reference a managed rule, see Using Config managed rules.