Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Config.Types.OrganizationCustomRuleMetadata

Description

Synopsis

Documentation

data OrganizationCustomRuleMetadata Source #

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

inputParameters :: Maybe Text
A string, in JSON format, that is passed to organization config rule Lambda function.
resourceIdScope :: Maybe Text
The ID of the Amazon Web Services resource that was evaluated.
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).
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.
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.
resourceTypesScope :: Maybe [Text]
The type of the Amazon Web Services resource that was evaluated.
description :: Maybe Text
The description that you provide for organization config rule.
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

Instances details

Eq OrganizationCustomRuleMetadata Source #
Instance details Defined in Amazonka.Config.Types.OrganizationCustomRuleMetadata Methods (==) :: OrganizationCustomRuleMetadata -> OrganizationCustomRuleMetadata -> Bool # (/=) :: OrganizationCustomRuleMetadata -> OrganizationCustomRuleMetadata -> Bool #
Read OrganizationCustomRuleMetadata Source #
Instance details Defined in Amazonka.Config.Types.OrganizationCustomRuleMetadata Methods readsPrec :: Int -> ReadS OrganizationCustomRuleMetadata # readList :: ReadS [OrganizationCustomRuleMetadata] # readPrec :: ReadPrec OrganizationCustomRuleMetadata # readListPrec :: ReadPrec [OrganizationCustomRuleMetadata] #
Show OrganizationCustomRuleMetadata Source #
Instance details Defined in Amazonka.Config.Types.OrganizationCustomRuleMetadata Methods showsPrec :: Int -> OrganizationCustomRuleMetadata -> ShowS # show :: OrganizationCustomRuleMetadata -> String # showList :: [OrganizationCustomRuleMetadata] -> ShowS #
Generic OrganizationCustomRuleMetadata Source #
Instance details Defined in Amazonka.Config.Types.OrganizationCustomRuleMetadata Associated Types type Rep OrganizationCustomRuleMetadata :: Type -> Type # Methods from :: OrganizationCustomRuleMetadata -> Rep OrganizationCustomRuleMetadata x # to :: Rep OrganizationCustomRuleMetadata x -> OrganizationCustomRuleMetadata #
NFData OrganizationCustomRuleMetadata Source #
Instance details Defined in Amazonka.Config.Types.OrganizationCustomRuleMetadata Methods rnf :: OrganizationCustomRuleMetadata -> () #
Hashable OrganizationCustomRuleMetadata Source #
Instance details Defined in Amazonka.Config.Types.OrganizationCustomRuleMetadata Methods hashWithSalt :: Int -> OrganizationCustomRuleMetadata -> Int # hash :: OrganizationCustomRuleMetadata -> Int #
ToJSON OrganizationCustomRuleMetadata Source #
Instance details Defined in Amazonka.Config.Types.OrganizationCustomRuleMetadata Methods toJSON :: OrganizationCustomRuleMetadata -> Value # toEncoding :: OrganizationCustomRuleMetadata -> Encoding # toJSONList :: [OrganizationCustomRuleMetadata] -> Value # toEncodingList :: [OrganizationCustomRuleMetadata] -> Encoding #
FromJSON OrganizationCustomRuleMetadata Source #
Instance details Defined in Amazonka.Config.Types.OrganizationCustomRuleMetadata Methods parseJSON :: Value -> Parser OrganizationCustomRuleMetadata # parseJSONList :: Value -> Parser [OrganizationCustomRuleMetadata] #
type Rep OrganizationCustomRuleMetadata Source #
Instance details Defined in Amazonka.Config.Types.OrganizationCustomRuleMetadata type Rep OrganizationCustomRuleMetadata = D1 ('MetaData "OrganizationCustomRuleMetadata" "Amazonka.Config.Types.OrganizationCustomRuleMetadata" "libZSservicesZSamazonka-configZSamazonka-config" 'False) (C1 ('MetaCons "OrganizationCustomRuleMetadata'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "inputParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "resourceIdScope") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "tagValueScope") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maximumExecutionFrequency") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MaximumExecutionFrequency)))) :: ((S1 ('MetaSel ('Just "tagKeyScope") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "resourceTypesScope") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "description") '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 Source #

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:inputParameters:OrganizationCustomRuleMetadata', organizationCustomRuleMetadata_inputParameters - A string, in JSON format, that is passed to organization config rule Lambda function.

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

$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: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: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:resourceTypesScope:OrganizationCustomRuleMetadata', organizationCustomRuleMetadata_resourceTypesScope - The type of the Amazon Web Services resource that was evaluated.

$sel:description:OrganizationCustomRuleMetadata', organizationCustomRuleMetadata_description - The description that you provide for organization config rule.

$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_inputParameters :: Lens' OrganizationCustomRuleMetadata (Maybe Text) Source #

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

organizationCustomRuleMetadata_resourceIdScope :: Lens' OrganizationCustomRuleMetadata (Maybe Text) Source #

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

organizationCustomRuleMetadata_tagValueScope :: Lens' OrganizationCustomRuleMetadata (Maybe Text) Source #

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_maximumExecutionFrequency :: Lens' OrganizationCustomRuleMetadata (Maybe MaximumExecutionFrequency) Source #

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_tagKeyScope :: Lens' OrganizationCustomRuleMetadata (Maybe Text) Source #

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_resourceTypesScope :: Lens' OrganizationCustomRuleMetadata (Maybe [Text]) Source #

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

organizationCustomRuleMetadata_description :: Lens' OrganizationCustomRuleMetadata (Maybe Text) Source #

The description that you provide for organization config rule.

organizationCustomRuleMetadata_lambdaFunctionArn :: Lens' OrganizationCustomRuleMetadata Text Source #

The lambda function ARN.

organizationCustomRuleMetadata_organizationConfigRuleTriggerTypes :: Lens' OrganizationCustomRuleMetadata [OrganizationConfigRuleTriggerType] Source #

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.