Struct GetRuleOutput

#[non_exhaustive]
pub struct GetRuleOutput {
    pub identifier: Option<String>,
    pub description: Option<String>,
    pub resource_type: Option<ResourceType>,
    pub retention_period: Option<RetentionPeriod>,
    pub resource_tags: Option<Vec<ResourceTag>>,
    pub status: Option<RuleStatus>,
    pub lock_configuration: Option<LockConfiguration>,
    pub lock_state: Option<LockState>,
    pub lock_end_time: Option<DateTime>,
    pub rule_arn: Option<String>,
    pub exclude_resource_tags: Option<Vec<ResourceTag>>,
    /* private fields */
}

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.

identifier: Option<String>

The unique ID of the retention rule.

description: Option<String>

The retention rule description.

resource_type: Option<ResourceType>

The resource type retained by the retention rule.

retention_period: Option<RetentionPeriod>

Information about the retention period for which the retention rule is to retain resources.

resource_tags: Option<Vec<ResourceTag>>

\[Tag-level retention rules only\] Information about the resource tags used to identify resources that are retained by the retention rule.

status: Option<RuleStatus>

The state of the retention rule. Only retention rules that are in the available state retain resources.

lock_configuration: Option<LockConfiguration>

Information about the retention rule lock configuration.

lock_state: Option<LockState>

\[Region-level retention rules only\] The lock state for the retention rule.

• locked - The retention rule is locked and can't be modified or deleted.

• pending_unlock - The retention rule has been unlocked but it is still within the unlock delay period. The retention rule can be modified or deleted only after the unlock delay period has expired.

• unlocked - The retention rule is unlocked and it can be modified or deleted by any user with the required permissions.

• null - The retention rule has never been locked. Once a retention rule has been locked, it can transition between the locked and unlocked states only; it can never transition back to null.

lock_end_time: Option<DateTime>

The date and time at which the unlock delay is set to expire. Only returned for retention rules that have been unlocked and that are still within the unlock delay period.

rule_arn: Option<String>

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

exclude_resource_tags: Option<Vec<ResourceTag>>

\[Region-level retention rules only\] Information about the exclusion tags used to identify resources that are to be excluded, or ignored, by the retention rule.

Implementations

impl GetRuleOutput

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

The unique ID of the retention rule.

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

The retention rule description.

pub fn resource_type(&self) -> Option<&ResourceType>

The resource type retained by the retention rule.

pub fn retention_period(&self) -> Option<&RetentionPeriod>

Information about the retention period for which the retention rule is to retain resources.

pub fn resource_tags(&self) -> &[ResourceTag]

\[Tag-level retention rules only\] Information about the resource tags used to identify resources that are retained by the retention rule.

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_tags.is_none().

pub fn status(&self) -> Option<&RuleStatus>

The state of the retention rule. Only retention rules that are in the available state retain resources.

pub fn lock_configuration(&self) -> Option<&LockConfiguration>

Information about the retention rule lock configuration.

pub fn lock_state(&self) -> Option<&LockState>

\[Region-level retention rules only\] The lock state for the retention rule.

• locked - The retention rule is locked and can't be modified or deleted.

• pending_unlock - The retention rule has been unlocked but it is still within the unlock delay period. The retention rule can be modified or deleted only after the unlock delay period has expired.

• unlocked - The retention rule is unlocked and it can be modified or deleted by any user with the required permissions.

• null - The retention rule has never been locked. Once a retention rule has been locked, it can transition between the locked and unlocked states only; it can never transition back to null.

pub fn lock_end_time(&self) -> Option<&DateTime>

The date and time at which the unlock delay is set to expire. Only returned for retention rules that have been unlocked and that are still within the unlock delay period.

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

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

pub fn exclude_resource_tags(&self) -> &[ResourceTag]

\[Region-level retention rules only\] Information about the exclusion tags used to identify resources that are to be excluded, or ignored, by the retention rule.

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

impl GetRuleOutput

pub fn builder() -> GetRuleOutputBuilder

Creates a new builder-style object to manufacture GetRuleOutput.

Trait Implementations

impl Clone for GetRuleOutput

fn clone(&self) -> GetRuleOutput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GetRuleOutput

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

Formats the value using the given formatter.

impl PartialEq for GetRuleOutput

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

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for GetRuleOutput