Struct OrganizationCustomPolicyRuleMetadata

#[non_exhaustive]
pub struct OrganizationCustomPolicyRuleMetadata {
    pub description: Option<String>,
    pub organization_config_rule_trigger_types: Option<Vec<OrganizationConfigRuleTriggerTypeNoSn>>,
    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>,
    pub policy_runtime: String,
    pub policy_text: String,
    pub debug_log_delivery_accounts: Option<Vec<String>>,
}

An object that specifies metadata for your organization's Config Custom Policy rule. The metadata includes the runtime system in use, which accounts have debug logging enabled, and other custom rule metadata, such as resource type, resource ID of Amazon Web Services resource, and organization trigger types that initiate Config to evaluate Amazon Web Services resources against a rule.

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 Custom Policy rule.

organization_config_rule_trigger_types: Option<Vec<OrganizationConfigRuleTriggerTypeNoSn>>

The type of notification that initiates Config to run an evaluation for a rule. For Config Custom Policy rules, Config supports change-initiated notification types:

• ConfigurationItemChangeNotification - Initiates an evaluation when Config delivers a configuration item as a result of a resource change.

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

input_parameters: Option<String>

A string, in JSON format, that is passed to your organization Config Custom Policy rule.

maximum_execution_frequency: Option<MaximumExecutionFrequency>

The maximum frequency with which Config runs evaluations for a rule. Your Config Custom Policy rule is triggered when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.

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

policy_runtime: String

The runtime system for your organization Config Custom Policy rules. Guard is a policy-as-code language that allows you to write policies that are enforced by Config Custom Policy rules. For more information about Guard, see the Guard GitHub Repository.

policy_text: String

The policy definition containing the logic for your organization Config Custom Policy rule.

debug_log_delivery_accounts: Option<Vec<String>>

A list of accounts that you can enable debug logging for your organization Config Custom Policy rule. List is null when debug logging is enabled for all accounts.

Implementations

impl OrganizationCustomPolicyRuleMetadata

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

The description that you provide for your organization Config Custom Policy rule.

pub fn organization_config_rule_trigger_types( &self, ) -> &[OrganizationConfigRuleTriggerTypeNoSn]

The type of notification that initiates Config to run an evaluation for a rule. For Config Custom Policy rules, Config supports change-initiated notification types:

• ConfigurationItemChangeNotification - Initiates an evaluation when Config delivers a configuration item as a result of a resource change.

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

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

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

A string, in JSON format, that is passed to your organization Config Custom Policy rule.

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

The maximum frequency with which Config runs evaluations for a rule. Your Config Custom Policy rule is triggered when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.

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

pub fn policy_runtime(&self) -> &str

The runtime system for your organization Config Custom Policy rules. Guard is a policy-as-code language that allows you to write policies that are enforced by Config Custom Policy rules. For more information about Guard, see the Guard GitHub Repository.

pub fn policy_text(&self) -> &str

The policy definition containing the logic for your organization Config Custom Policy rule.

pub fn debug_log_delivery_accounts(&self) -> &[String]

A list of accounts that you can enable debug logging for your organization Config Custom Policy rule. List is null when debug logging is enabled for all accounts.

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

impl OrganizationCustomPolicyRuleMetadata

pub fn builder() -> OrganizationCustomPolicyRuleMetadataBuilder

Creates a new builder-style object to manufacture OrganizationCustomPolicyRuleMetadata.

Trait Implementations

impl Clone for OrganizationCustomPolicyRuleMetadata

fn clone(&self) -> OrganizationCustomPolicyRuleMetadata

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OrganizationCustomPolicyRuleMetadata

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

Formats the value using the given formatter.

impl PartialEq for OrganizationCustomPolicyRuleMetadata

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