Struct aws_sdk_cloudformation::types::ResourceDetail

#[non_exhaustive]
pub struct ResourceDetail {
    pub resource_type: Option<String>,
    pub logical_resource_id: Option<String>,
    pub resource_identifier: Option<HashMap<String, String>>,
    pub resource_status: Option<GeneratedTemplateResourceStatus>,
    pub resource_status_reason: Option<String>,
    pub warnings: Option<Vec<WarningDetail>>,
}

Details about a resource in a generated template

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.

resource_type: Option<String>

The type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see IaC generator supported resource types In the CloudFormation User Guide

logical_resource_id: Option<String>

The logical id for this resource in the final generated template.

resource_identifier: Option<HashMap<String, String>>

A list of up to 256 key-value pairs that identifies the resource in the generated template. The key is the name of one of the primary identifiers for the resource. (Primary identifiers are specified in the primaryIdentifier list in the resource schema.) The value is the value of that primary identifier. For example, for a AWS::DynamoDB::Table resource, the primary identifiers is TableName so the key-value pair could be "TableName": "MyDDBTable". For more information, see primaryIdentifier in the CloudFormation Command Line Interface User guide for extension development.

resource_status: Option<GeneratedTemplateResourceStatus>

Status of the processing of a resource in a generated template.

InProgress

The resource processing is still in progress.

Complete

The resource processing is complete.

Pending

The resource processing is pending.

Failed

The resource processing has failed.

resource_status_reason: Option<String>

The reason for the resource detail, providing more information if a failure happened.

warnings: Option<Vec<WarningDetail>>

The warnings generated for this resource.

Implementations

impl ResourceDetail

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

The type of the resource, such as AWS::DynamoDB::Table. For the list of supported resources, see IaC generator supported resource types In the CloudFormation User Guide

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

The logical id for this resource in the final generated template.

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

A list of up to 256 key-value pairs that identifies the resource in the generated template. The key is the name of one of the primary identifiers for the resource. (Primary identifiers are specified in the primaryIdentifier list in the resource schema.) The value is the value of that primary identifier. For example, for a AWS::DynamoDB::Table resource, the primary identifiers is TableName so the key-value pair could be "TableName": "MyDDBTable". For more information, see primaryIdentifier in the CloudFormation Command Line Interface User guide for extension development.

pub fn resource_status(&self) -> Option<&GeneratedTemplateResourceStatus>

Status of the processing of a resource in a generated template.

InProgress

The resource processing is still in progress.

Complete

The resource processing is complete.

Pending

The resource processing is pending.

Failed

The resource processing has failed.

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

The reason for the resource detail, providing more information if a failure happened.

pub fn warnings(&self) -> &[WarningDetail]

The warnings generated for this resource.

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

impl ResourceDetail

pub fn builder() -> ResourceDetailBuilder

Creates a new builder-style object to manufacture ResourceDetail.

Trait Implementations

impl Clone for ResourceDetail

fn clone(&self) -> ResourceDetail

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ResourceDetail

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

Formats the value using the given formatter.

impl PartialEq for ResourceDetail

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