Struct aws_sdk_backup::operation::describe_framework::DescribeFrameworkOutput

#[non_exhaustive]
pub struct DescribeFrameworkOutput {
    pub framework_name: Option<String>,
    pub framework_arn: Option<String>,
    pub framework_description: Option<String>,
    pub framework_controls: Option<Vec<FrameworkControl>>,
    pub creation_time: Option<DateTime>,
    pub deployment_status: Option<String>,
    pub framework_status: Option<String>,
    pub idempotency_token: Option<String>,
    /* 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.

framework_name: Option<String>

The unique name of a framework.

framework_arn: Option<String>

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

framework_description: Option<String>

An optional description of the framework.

framework_controls: Option<Vec<FrameworkControl>>

A list of the controls that make up the framework. Each control in the list has a name, input parameters, and scope.

creation_time: Option<DateTime>

The date and time that a framework is created, in ISO 8601 representation. The value of CreationTime is accurate to milliseconds. For example, 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 hours behind UTC.

deployment_status: Option<String>

The deployment status of a framework. The statuses are:

CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED

framework_status: Option<String>

A framework consists of one or more controls. Each control governs a resource, such as backup plans, backup selections, backup vaults, or recovery points. You can also turn Config recording on or off for each resource. The statuses are:

• ACTIVE when recording is turned on for all resources governed by the framework.

• PARTIALLY_ACTIVE when recording is turned off for at least one resource governed by the framework.

• INACTIVE when recording is turned off for all resources governed by the framework.

• UNAVAILABLE when Backup is unable to validate recording status at this time.

idempotency_token: Option<String>

A customer-chosen string that you can use to distinguish between otherwise identical calls to DescribeFrameworkOutput. Retrying a successful request with the same idempotency token results in a success message with no action taken.

Implementations

impl DescribeFrameworkOutput

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

The unique name of a framework.

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

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

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

An optional description of the framework.

pub fn framework_controls(&self) -> &[FrameworkControl]

A list of the controls that make up the framework. Each control in the list has a name, input parameters, and scope.

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

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

The date and time that a framework is created, in ISO 8601 representation. The value of CreationTime is accurate to milliseconds. For example, 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 hours behind UTC.

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

The deployment status of a framework. The statuses are:

CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED

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

A framework consists of one or more controls. Each control governs a resource, such as backup plans, backup selections, backup vaults, or recovery points. You can also turn Config recording on or off for each resource. The statuses are:

• ACTIVE when recording is turned on for all resources governed by the framework.

• PARTIALLY_ACTIVE when recording is turned off for at least one resource governed by the framework.

• INACTIVE when recording is turned off for all resources governed by the framework.

• UNAVAILABLE when Backup is unable to validate recording status at this time.

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

A customer-chosen string that you can use to distinguish between otherwise identical calls to DescribeFrameworkOutput. Retrying a successful request with the same idempotency token results in a success message with no action taken.

impl DescribeFrameworkOutput

pub fn builder() -> DescribeFrameworkOutputBuilder

Creates a new builder-style object to manufacture DescribeFrameworkOutput.

Trait Implementations

impl Clone for DescribeFrameworkOutput

fn clone(&self) -> DescribeFrameworkOutput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DescribeFrameworkOutput

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

Formats the value using the given formatter.

impl PartialEq for DescribeFrameworkOutput

fn eq(&self, other: &DescribeFrameworkOutput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RequestId for DescribeFrameworkOutput

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

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

impl StructuralPartialEq for DescribeFrameworkOutput