Struct OrganizationCustomRuleMetadata

#[non_exhaustive]
pub struct OrganizationCustomRuleMetadata {
    pub description: Option<String>,
    pub lambda_function_arn: String,
    pub organization_config_rule_trigger_types: Vec<OrganizationConfigRuleTriggerType>,
    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 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.

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.

lambda_function_arn: String

The lambda function ARN.

organization_config_rule_trigger_types: Vec<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.

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

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 OrganizationCustomRuleMetadata

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

The description that you provide for your organization Config rule.

pub fn lambda_function_arn(&self) -> &str

The lambda function ARN.

pub fn organization_config_rule_trigger_types( &self, ) -> &[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.

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

pub fn builder() -> OrganizationCustomRuleMetadataBuilder

Creates a new builder-style object to manufacture OrganizationCustomRuleMetadata.

Trait Implementations

impl Clone for OrganizationCustomRuleMetadata

fn clone(&self) -> OrganizationCustomRuleMetadata

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OrganizationCustomRuleMetadata

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

Formats the value using the given formatter.

impl PartialEq for OrganizationCustomRuleMetadata

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