Amazonka.Config.Types.OrganizationCustomRuleMetadata

Documentation

data OrganizationCustomRuleMetadata

An object that specifies organization custom rule metadata such as resource type, resource ID of Amazon Web Services resource, Lambda function ARN, and organization trigger types that trigger Config to evaluate your Amazon Web Services resources against a rule. It also provides the frequency with which you want Config to run evaluations for the rule if the trigger type is periodic.

See: newOrganizationCustomRuleMetadata smart constructor.

Constructors

OrganizationCustomRuleMetadata'

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. Your custom rule is triggered when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.

  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).

• lambdaFunctionArn :: Text

  The lambda function ARN.

• organizationConfigRuleTriggerTypes :: [OrganizationConfigRuleTriggerType]

  The type of notification that triggers Config to run an evaluation for a rule. You can specify the following notification types:

  • ConfigurationItemChangeNotification - Triggers an evaluation when Config delivers a configuration item as a result of a resource change.
  • OversizedConfigurationItemChangeNotification - Triggers an evaluation when Config delivers an oversized configuration item. Config may generate this notification type when a resource changes and the notification exceeds the maximum size allowed by Amazon SNS.
  • ScheduledNotification - Triggers a periodic evaluation at the frequency specified for MaximumExecutionFrequency.

Instances

FromJSON OrganizationCustomRuleMetadata

Defined in Amazonka.Config.Types.OrganizationCustomRuleMetadata

Methods

parseJSON :: Value -> Parser OrganizationCustomRuleMetadata

parseJSONList :: Value -> Parser [OrganizationCustomRuleMetadata]

ToJSON OrganizationCustomRuleMetadata

Defined in Amazonka.Config.Types.OrganizationCustomRuleMetadata

Methods

toJSON :: OrganizationCustomRuleMetadata -> Value

toEncoding :: OrganizationCustomRuleMetadata -> Encoding

toJSONList :: [OrganizationCustomRuleMetadata] -> Value

toEncodingList :: [OrganizationCustomRuleMetadata] -> Encoding

Generic OrganizationCustomRuleMetadata

Defined in Amazonka.Config.Types.OrganizationCustomRuleMetadata

Associated Types

type Rep OrganizationCustomRuleMetadata :: Type -> Type

Methods

from :: OrganizationCustomRuleMetadata -> Rep OrganizationCustomRuleMetadata x

to :: Rep OrganizationCustomRuleMetadata x -> OrganizationCustomRuleMetadata

Read OrganizationCustomRuleMetadata

Defined in Amazonka.Config.Types.OrganizationCustomRuleMetadata

Methods

readsPrec :: Int -> ReadS OrganizationCustomRuleMetadata

readList :: ReadS [OrganizationCustomRuleMetadata]

readPrec :: ReadPrec OrganizationCustomRuleMetadata

readListPrec :: ReadPrec [OrganizationCustomRuleMetadata]

Show OrganizationCustomRuleMetadata

Defined in Amazonka.Config.Types.OrganizationCustomRuleMetadata

Methods

showsPrec :: Int -> OrganizationCustomRuleMetadata -> ShowS

show :: OrganizationCustomRuleMetadata -> String

showList :: [OrganizationCustomRuleMetadata] -> ShowS

NFData OrganizationCustomRuleMetadata

Defined in Amazonka.Config.Types.OrganizationCustomRuleMetadata

Methods

rnf :: OrganizationCustomRuleMetadata -> ()

Eq OrganizationCustomRuleMetadata

Defined in Amazonka.Config.Types.OrganizationCustomRuleMetadata

Methods

(==) :: OrganizationCustomRuleMetadata -> OrganizationCustomRuleMetadata -> Bool

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

Hashable OrganizationCustomRuleMetadata

Defined in Amazonka.Config.Types.OrganizationCustomRuleMetadata

Methods

hashWithSalt :: Int -> OrganizationCustomRuleMetadata -> Int

hash :: OrganizationCustomRuleMetadata -> Int

type Rep OrganizationCustomRuleMetadata

Defined in Amazonka.Config.Types.OrganizationCustomRuleMetadata

type Rep OrganizationCustomRuleMetadata = D1 ('MetaData "OrganizationCustomRuleMetadata" "Amazonka.Config.Types.OrganizationCustomRuleMetadata" "amazonka-config-2.0-7GF0fBbVw65uROwJwpcE3" 'False) (C1 ('MetaCons "OrganizationCustomRuleMetadata'" '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 "lambdaFunctionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "organizationConfigRuleTriggerTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [OrganizationConfigRuleTriggerType]))))))

newOrganizationCustomRuleMetadata

Arguments

:: Text

$sel:lambdaFunctionArn:OrganizationCustomRuleMetadata'

-> OrganizationCustomRuleMetadata

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

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

$sel:maximumExecutionFrequency:OrganizationCustomRuleMetadata', organizationCustomRuleMetadata_maximumExecutionFrequency - The maximum frequency with which Config runs evaluations for a rule. Your custom rule is triggered when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.

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:OrganizationCustomRuleMetadata', organizationCustomRuleMetadata_resourceIdScope - The ID of the Amazon Web Services resource that was evaluated.

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

$sel:tagKeyScope:OrganizationCustomRuleMetadata', organizationCustomRuleMetadata_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:OrganizationCustomRuleMetadata', organizationCustomRuleMetadata_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:lambdaFunctionArn:OrganizationCustomRuleMetadata', organizationCustomRuleMetadata_lambdaFunctionArn - The lambda function ARN.

$sel:organizationConfigRuleTriggerTypes:OrganizationCustomRuleMetadata', organizationCustomRuleMetadata_organizationConfigRuleTriggerTypes - The type of notification that triggers Config to run an evaluation for a rule. You can specify the following notification types:

• ConfigurationItemChangeNotification - Triggers an evaluation when Config delivers a configuration item as a result of a resource change.
• OversizedConfigurationItemChangeNotification - Triggers an evaluation when Config delivers an oversized configuration item. Config may generate this notification type when a resource changes and the notification exceeds the maximum size allowed by Amazon SNS.
• ScheduledNotification - Triggers a periodic evaluation at the frequency specified for MaximumExecutionFrequency.

organizationCustomRuleMetadata_description :: Lens' OrganizationCustomRuleMetadata (Maybe Text)

The description that you provide for your organization Config rule.

organizationCustomRuleMetadata_inputParameters :: Lens' OrganizationCustomRuleMetadata (Maybe Text)

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

organizationCustomRuleMetadata_maximumExecutionFrequency :: Lens' OrganizationCustomRuleMetadata (Maybe MaximumExecutionFrequency)

The maximum frequency with which Config runs evaluations for a rule. Your custom rule is triggered when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.

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

organizationCustomRuleMetadata_resourceIdScope :: Lens' OrganizationCustomRuleMetadata (Maybe Text)

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

organizationCustomRuleMetadata_resourceTypesScope :: Lens' OrganizationCustomRuleMetadata (Maybe [Text])

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

organizationCustomRuleMetadata_tagKeyScope :: Lens' OrganizationCustomRuleMetadata (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.

organizationCustomRuleMetadata_tagValueScope :: Lens' OrganizationCustomRuleMetadata (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).

organizationCustomRuleMetadata_lambdaFunctionArn :: Lens' OrganizationCustomRuleMetadata Text

The lambda function ARN.

organizationCustomRuleMetadata_organizationConfigRuleTriggerTypes :: Lens' OrganizationCustomRuleMetadata [OrganizationConfigRuleTriggerType]

The type of notification that triggers Config to run an evaluation for a rule. You can specify the following notification types:

• ConfigurationItemChangeNotification - Triggers an evaluation when Config delivers a configuration item as a result of a resource change.
• OversizedConfigurationItemChangeNotification - Triggers an evaluation when Config delivers an oversized configuration item. Config may generate this notification type when a resource changes and the notification exceeds the maximum size allowed by Amazon SNS.
• ScheduledNotification - Triggers a periodic evaluation at the frequency specified for MaximumExecutionFrequency.