Struct ConfigRule

#[non_exhaustive]
pub struct ConfigRule {
    pub config_rule_name: Option<String>,
    pub config_rule_arn: Option<String>,
    pub config_rule_id: Option<String>,
    pub description: Option<String>,
    pub scope: Option<Scope>,
    pub source: Option<Source>,
    pub input_parameters: Option<String>,
    pub maximum_execution_frequency: Option<MaximumExecutionFrequency>,
    pub config_rule_state: Option<ConfigRuleState>,
    pub created_by: Option<String>,
    pub evaluation_modes: Option<Vec<EvaluationModeConfiguration>>,
}

Config rules evaluate the configuration settings of your Amazon Web Services resources. A rule can run when Config detects a configuration change to an Amazon Web Services resource or at a periodic frequency that you choose (for example, every 24 hours). There are two types of rules: Config Managed Rules and Config Custom Rules.

Config Managed Rules are predefined, customizable rules created by Config. For a list of managed rules, see List of Config Managed Rules.

Config Custom Rules are rules that you create from scratch. There are two ways to create Config custom rules: with Lambda functions ( Lambda Developer Guide) and with Guard (Guard GitHub Repository), a policy-as-code language. Config custom rules created with Lambda are called Config Custom Lambda Rules and Config custom rules created with Guard are called Config Custom Policy Rules.

For more information about developing and using Config rules, see Evaluating Resource with Config Rules in the Config Developer Guide.

You can use the Amazon Web Services CLI and Amazon Web Services SDKs if you want to create a rule that triggers evaluations for your resources when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

config_rule_name: Option<String>

The name that you assign to the Config rule. The name is required if you are adding a new rule.

config_rule_arn: Option<String>

The Amazon Resource Name (ARN) of the Config rule.

config_rule_id: Option<String>

The ID of the Config rule.

description: Option<String>

The description that you provide for the Config rule.

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.

The scope can be empty.

source: Option<Source>

Provides the rule owner (Amazon Web Services for managed rules, CUSTOM_POLICY for Custom Policy rules, and CUSTOM_LAMBDA for Custom Lambda rules), the rule identifier, and the notifications that cause the function to evaluate your Amazon Web Services resources.

input_parameters: Option<String>

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

maximum_execution_frequency: Option<MaximumExecutionFrequency>

The maximum frequency with which Config runs evaluations for a rule. You can specify a value for MaximumExecutionFrequency when:

• This is for an Config managed rule that is triggered at a periodic frequency.

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

config_rule_state: Option<ConfigRuleState>

Indicates whether the Config rule is active or is currently being deleted by Config. It can also indicate the evaluation status for the Config rule.

Config sets the state of the rule to EVALUATING temporarily after you use the StartConfigRulesEvaluation request to evaluate your resources against the Config rule.

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.

Config temporarily sets the state of a rule to DELETING after you use the DeleteConfigRule request to delete the rule. After Config deletes the rule, the rule and all of its evaluations are erased and are no longer available.

created_by: Option<String>

Service principal name of the service that created the rule.

The field is populated only if the service-linked rule is created by a service. The field is empty if you create your own rule.

evaluation_modes: Option<Vec<EvaluationModeConfiguration>>

The modes the Config rule can be evaluated in. The valid values are distinct objects. By default, the value is Detective evaluation mode only.

Implementations

impl ConfigRule

pub fn config_rule_name(&self) -> Option<&str>

The name that you assign to the Config rule. The name is required if you are adding a new rule.

pub fn config_rule_arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) of the Config rule.

pub fn config_rule_id(&self) -> Option<&str>

The ID of the Config rule.

pub fn description(&self) -> Option<&str>

The description that you provide for the Config rule.

pub fn scope(&self) -> 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.

The scope can be empty.

pub fn source(&self) -> Option<&Source>

Provides the rule owner (Amazon Web Services for managed rules, CUSTOM_POLICY for Custom Policy rules, and CUSTOM_LAMBDA for Custom Lambda rules), the rule identifier, and the notifications that cause the function to evaluate your Amazon Web Services resources.

pub fn input_parameters(&self) -> Option<&str>

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

pub fn maximum_execution_frequency(&self) -> Option<&MaximumExecutionFrequency>

The maximum frequency with which Config runs evaluations for a rule. You can specify a value for MaximumExecutionFrequency when:

• This is for an Config managed rule that is triggered at a periodic frequency.

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

pub fn config_rule_state(&self) -> Option<&ConfigRuleState>

Indicates whether the Config rule is active or is currently being deleted by Config. It can also indicate the evaluation status for the Config rule.

Config sets the state of the rule to EVALUATING temporarily after you use the StartConfigRulesEvaluation request to evaluate your resources against the Config rule.

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.

Config temporarily sets the state of a rule to DELETING after you use the DeleteConfigRule request to delete the rule. After Config deletes the rule, the rule and all of its evaluations are erased and are no longer available.

pub fn created_by(&self) -> Option<&str>

Service principal name of the service that created the rule.

The field is populated only if the service-linked rule is created by a service. The field is empty if you create your own rule.

pub fn evaluation_modes(&self) -> &[EvaluationModeConfiguration]

The modes the Config rule can be evaluated in. The valid values are distinct objects. By default, the value is Detective evaluation mode only.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .evaluation_modes.is_none().

impl ConfigRule

pub fn builder() -> ConfigRuleBuilder

Creates a new builder-style object to manufacture ConfigRule.

Trait Implementations

impl Clone for ConfigRule

fn clone(&self) -> ConfigRule

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ConfigRule

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for ConfigRule

fn eq(&self, other: &ConfigRule) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ConfigRule