Struct rusoto_config::ConfigRule
[−]
[src]
pub struct ConfigRule { pub config_rule_arn: Option<String>, pub config_rule_id: Option<String>, pub config_rule_name: Option<String>, pub config_rule_state: Option<String>, pub description: Option<String>, pub input_parameters: Option<String>, pub maximum_execution_frequency: Option<String>, pub scope: Option<Scope>, pub source: Source, }
An AWS Config rule represents an AWS Lambda function that you create for a custom rule or a predefined function for an AWS managed rule. The function evaluates configuration items to assess whether your AWS resources comply with your desired configurations. This function can run when AWS Config detects a configuration change to an AWS resource and at a periodic frequency that you choose (for example, every 24 hours).
You can use the AWS CLI and AWS SDKs if you want to create a rule that triggers evaluations for your resources when AWS Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.
For more information about developing and using AWS Config rules, see Evaluating AWS Resource Configurations with AWS Config in the AWS Config Developer Guide.
Fields
config_rule_arn: Option<String>
The Amazon Resource Name (ARN) of the AWS Config rule.
config_rule_id: Option<String>
The ID of the AWS Config rule.
config_rule_name: Option<String>
The name that you assign to the AWS Config rule. The name is required if you are adding a new rule.
config_rule_state: Option<String>
Indicates whether the AWS Config rule is active or is currently being deleted by AWS Config. It can also indicate the evaluation status for the Config rule.
AWS Config sets the state of the rule to EVALUATING
temporarily after you use the StartConfigRulesEvaluation
request to evaluate your resources against the Config rule.
AWS Config sets the state of the rule to DELETING_RESULTS
temporarily after you use the DeleteEvaluationResults
request to delete the current evaluation results for the Config rule.
AWS Config sets the state of a rule to DELETING
temporarily after you use the DeleteConfigRule
request to delete the rule. After AWS Config deletes the rule, the rule and all of its evaluations are erased and are no longer available.
description: Option<String>
The description that you provide for the AWS Config rule.
input_parameters: Option<String>
A string in JSON format that is passed to the AWS Config rule Lambda function.
maximum_execution_frequency: Option<String>
The maximum frequency with which AWS Config runs evaluations for a rule. You can specify a value for MaximumExecutionFrequency
when:
-
You are using an AWS managed rule that is triggered at a periodic frequency.
-
Your custom rule is triggered when AWS 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.
scope: Option<Scope>
Defines which resources can trigger an evaluation for the rule. The scope can include one or more resource types, a combination of one resource type and one resource ID, or a combination of a tag key and value. Specify a scope to constrain the resources that can trigger an evaluation for the rule. If you do not specify a scope, evaluations are triggered when any resource in the recording group changes.
source: Source
Provides the rule owner (AWS or customer), the rule identifier, and the notifications that cause the function to evaluate your AWS resources.
Trait Implementations
impl Default for ConfigRule
[src]
fn default() -> ConfigRule
Returns the "default value" for a type. Read more
impl Debug for ConfigRule
[src]
impl Clone for ConfigRule
[src]
fn clone(&self) -> ConfigRule
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0
Performs copy-assignment from source
. Read more