Struct GetTemplateSummaryOutput

#[non_exhaustive]
pub struct GetTemplateSummaryOutput {
    pub parameters: Option<Vec<ParameterDeclaration>>,
    pub description: Option<String>,
    pub capabilities: Option<Vec<Capability>>,
    pub capabilities_reason: Option<String>,
    pub resource_types: Option<Vec<String>>,
    pub version: Option<String>,
    pub metadata: Option<String>,
    pub declared_transforms: Option<Vec<String>>,
    pub resource_identifier_summaries: Option<Vec<ResourceIdentifierSummary>>,
    pub warnings: Option<Warnings>,
    /* private fields */
}

The output for the GetTemplateSummary action.

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.

parameters: Option<Vec<ParameterDeclaration>>

A list of parameter declarations that describe various properties for each parameter.

description: Option<String>

The value that's defined in the Description property of the template.

capabilities: Option<Vec<Capability>>

The capabilities found within the template. If your template contains IAM resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error.

For more information, see Acknowledging IAM resources in CloudFormation templates.

capabilities_reason: Option<String>

The list of resources that generated the values in the Capabilities response element.

resource_types: Option<Vec<String>>

A list of all the template resource types that are defined in the template, such as AWS::EC2::Instance, AWS::Dynamo::Table, and Custom::MyCustomInstance.

version: Option<String>

The Amazon Web Services template format version, which identifies the capabilities of the template.

metadata: Option<String>

The value that's defined for the Metadata property of the template.

declared_transforms: Option<Vec<String>>

A list of the transforms that are declared in the template.

resource_identifier_summaries: Option<Vec<ResourceIdentifierSummary>>

A list of resource identifier summaries that describe the target resources of an import operation and the properties you can provide during the import to identify the target resources. For example, BucketName is a possible identifier property for an AWS::S3::Bucket resource.

warnings: Option<Warnings>

An object that contains any warnings returned.

Implementations

impl GetTemplateSummaryOutput

pub fn parameters(&self) -> &[ParameterDeclaration]

A list of parameter declarations that describe various properties for each parameter.

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

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

The value that's defined in the Description property of the template.

pub fn capabilities(&self) -> &[Capability]

The capabilities found within the template. If your template contains IAM resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error.

For more information, see Acknowledging IAM resources in CloudFormation templates.

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

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

The list of resources that generated the values in the Capabilities response element.

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

A list of all the template resource types that are defined in the template, such as AWS::EC2::Instance, AWS::Dynamo::Table, and Custom::MyCustomInstance.

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

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

The Amazon Web Services template format version, which identifies the capabilities of the template.

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

The value that's defined for the Metadata property of the template.

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

A list of the transforms that are declared in the template.

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

pub fn resource_identifier_summaries(&self) -> &[ResourceIdentifierSummary]

A list of resource identifier summaries that describe the target resources of an import operation and the properties you can provide during the import to identify the target resources. For example, BucketName is a possible identifier property for an AWS::S3::Bucket 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 .resource_identifier_summaries.is_none().

pub fn warnings(&self) -> Option<&Warnings>

An object that contains any warnings returned.

impl GetTemplateSummaryOutput

pub fn builder() -> GetTemplateSummaryOutputBuilder

Creates a new builder-style object to manufacture GetTemplateSummaryOutput.

Trait Implementations

impl Clone for GetTemplateSummaryOutput

fn clone(&self) -> GetTemplateSummaryOutput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GetTemplateSummaryOutput

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

Formats the value using the given formatter.

impl PartialEq for GetTemplateSummaryOutput

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

Tests for self and other values to be equal, and is used by ==.

const 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 GetTemplateSummaryOutput

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

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

impl StructuralPartialEq for GetTemplateSummaryOutput