Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data OrganizationCustomRuleMetadata = OrganizationCustomRuleMetadata' {
- description :: Maybe Text
- inputParameters :: Maybe Text
- maximumExecutionFrequency :: Maybe MaximumExecutionFrequency
- resourceIdScope :: Maybe Text
- resourceTypesScope :: Maybe [Text]
- tagKeyScope :: Maybe Text
- tagValueScope :: Maybe Text
- lambdaFunctionArn :: Text
- organizationConfigRuleTriggerTypes :: [OrganizationConfigRuleTriggerType]
- newOrganizationCustomRuleMetadata :: Text -> OrganizationCustomRuleMetadata
- organizationCustomRuleMetadata_description :: Lens' OrganizationCustomRuleMetadata (Maybe Text)
- organizationCustomRuleMetadata_inputParameters :: Lens' OrganizationCustomRuleMetadata (Maybe Text)
- organizationCustomRuleMetadata_maximumExecutionFrequency :: Lens' OrganizationCustomRuleMetadata (Maybe MaximumExecutionFrequency)
- organizationCustomRuleMetadata_resourceIdScope :: Lens' OrganizationCustomRuleMetadata (Maybe Text)
- organizationCustomRuleMetadata_resourceTypesScope :: Lens' OrganizationCustomRuleMetadata (Maybe [Text])
- organizationCustomRuleMetadata_tagKeyScope :: Lens' OrganizationCustomRuleMetadata (Maybe Text)
- organizationCustomRuleMetadata_tagValueScope :: Lens' OrganizationCustomRuleMetadata (Maybe Text)
- organizationCustomRuleMetadata_lambdaFunctionArn :: Lens' OrganizationCustomRuleMetadata Text
- organizationCustomRuleMetadata_organizationConfigRuleTriggerTypes :: Lens' OrganizationCustomRuleMetadata [OrganizationConfigRuleTriggerType]
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.
OrganizationCustomRuleMetadata' | |
|
Instances
newOrganizationCustomRuleMetadata Source #
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 forMaximumExecutionFrequency
.
organizationCustomRuleMetadata_description :: Lens' OrganizationCustomRuleMetadata (Maybe Text) Source #
The description that you provide for your organization Config rule.
organizationCustomRuleMetadata_inputParameters :: Lens' OrganizationCustomRuleMetadata (Maybe Text) Source #
A string, in JSON format, that is passed to your organization Config rule Lambda function.
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_resourceIdScope :: Lens' OrganizationCustomRuleMetadata (Maybe Text) Source #
The ID of the Amazon Web Services resource that was evaluated.
organizationCustomRuleMetadata_resourceTypesScope :: Lens' OrganizationCustomRuleMetadata (Maybe [Text]) Source #
The type of the Amazon Web Services resource that was evaluated.
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_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_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 forMaximumExecutionFrequency
.