Struct ControlScope

#[non_exhaustive]
pub struct ControlScope {
    pub compliance_resource_ids: Option<Vec<String>>,
    pub compliance_resource_types: Option<Vec<String>>,
    pub tags: Option<HashMap<String, String>>,
}

A framework consists of one or more controls. Each control has its own control scope. The control scope can include one or more resource types, a combination of a tag key and value, or a combination of one resource type and one resource ID. If no scope is specified, evaluations for the rule are triggered when any resource in your recording group changes in configuration.

To set a control scope that includes all of a particular resource, leave the ControlScope empty or do not pass it when calling CreateFramework.

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.

compliance_resource_ids: Option<Vec<String>>

The ID of the only Amazon Web Services resource that you want your control scope to contain.

compliance_resource_types: Option<Vec<String>>

Describes whether the control scope includes one or more types of resources, such as EFS or RDS.

tags: Option<HashMap<String, String>>

The tag key-value pair applied to those Amazon Web Services resources that you want to trigger an evaluation for a rule. A maximum of one key-value pair can be provided. The tag value is optional, but it cannot be an empty string if you are creating or editing a framework from the console (though the value can be an empty string when included in a CloudFormation template).

The structure to assign a tag is: \[{"Key":"string","Value":"string"}\].

Implementations

impl ControlScope

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

The ID of the only Amazon Web Services resource that you want your control scope to contain.

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

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

Describes whether the control scope includes one or more types of resources, such as EFS or RDS.

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

pub fn tags(&self) -> Option<&HashMap<String, String>>

The tag key-value pair applied to those Amazon Web Services resources that you want to trigger an evaluation for a rule. A maximum of one key-value pair can be provided. The tag value is optional, but it cannot be an empty string if you are creating or editing a framework from the console (though the value can be an empty string when included in a CloudFormation template).

The structure to assign a tag is: \[{"Key":"string","Value":"string"}\].

impl ControlScope

pub fn builder() -> ControlScopeBuilder

Creates a new builder-style object to manufacture ControlScope.

Trait Implementations

impl Clone for ControlScope

fn clone(&self) -> ControlScope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ControlScope

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

Formats the value using the given formatter.

impl PartialEq for ControlScope

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