Struct OrganizationManagedRuleMetadata

#[non_exhaustive]
pub struct OrganizationManagedRuleMetadata {
    pub description: Option<String>,
    pub rule_identifier: String,
    pub input_parameters: Option<String>,
    pub maximum_execution_frequency: Option<MaximumExecutionFrequency>,
    pub resource_types_scope: Option<Vec<String>>,
    pub resource_id_scope: Option<String>,
    pub tag_key_scope: Option<String>,
    pub tag_value_scope: Option<String>,
}

An object that specifies organization managed rule metadata such as resource type and ID of Amazon Web Services resource along with the rule identifier. It also provides the frequency with which you want Config to run evaluations for the rule if the trigger type is periodic.

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.

description: Option<String>

The description that you provide for your organization Config rule.

rule_identifier: String

For organization config managed rules, a predefined identifier from a list. For example, IAM_PASSWORD_POLICY is a managed rule. To reference a managed rule, see Using Config managed rules.

input_parameters: Option<String>

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

maximum_execution_frequency: Option<MaximumExecutionFrequency>

The maximum frequency with which Config runs evaluations for a rule. This is for an Config managed rule that is triggered at a periodic frequency.

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

resource_types_scope: Option<Vec<String>>

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

resource_id_scope: Option<String>

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

tag_key_scope: Option<String>

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.

tag_value_scope: Option<String>

The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

Implementations

impl OrganizationManagedRuleMetadata

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

The description that you provide for your organization Config rule.

pub fn rule_identifier(&self) -> &str

For organization config managed rules, a predefined identifier from a list. For example, IAM_PASSWORD_POLICY is a managed rule. To reference a managed rule, see Using Config managed rules.

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

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

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

The maximum frequency with which Config runs evaluations for a rule. This is for an Config managed rule that is triggered at a periodic frequency.

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 resource_types_scope(&self) -> &[String]

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

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

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

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

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

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.

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

The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

impl OrganizationManagedRuleMetadata

pub fn builder() -> OrganizationManagedRuleMetadataBuilder

Creates a new builder-style object to manufacture OrganizationManagedRuleMetadata.

Trait Implementations

impl Clone for OrganizationManagedRuleMetadata

fn clone(&self) -> OrganizationManagedRuleMetadata

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OrganizationManagedRuleMetadata

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

Formats the value using the given formatter.

impl PartialEq for OrganizationManagedRuleMetadata

fn eq(&self, other: &OrganizationManagedRuleMetadata) -> 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 OrganizationManagedRuleMetadata