Skip to content

GetTemplateSummaryOutput

Source code in docs_src/capo_cloudformation/types/get_template_summary_output.py
class GetTemplateSummaryOutput(TypedDict, closed=True):
    parameters: NotRequired[
        "capo_cloudformation.types.parameter_declarations.ParameterDeclarations"
    ]
    """<p>A list of parameter declarations that describe various properties for each parameter.</p>"""
    description: NotRequired["capo_cloudformation.types.description.Description"]
    """<p>The value that's defined in the <code>Description</code> property of the template.</p>"""
    capabilities: NotRequired["capo_cloudformation.types.capabilities.Capabilities"]
    """<p>The capabilities found within the template. If your template contains IAM resources, you must specify the <code>CAPABILITY_IAM</code> or <code>CAPABILITY_NAMED_IAM</code> value for this parameter when you use the <a>CreateStack</a> or <a>UpdateStack</a> actions with your template; otherwise, those actions return an <code>InsufficientCapabilities</code> error.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/control-access-with-iam.html#using-iam-capabilities">Acknowledging IAM resources in CloudFormation templates</a>.</p>"""
    capabilities_reason: NotRequired[
        "capo_cloudformation.types.capabilities_reason.CapabilitiesReason"
    ]
    """<p>The list of resources that generated the values in the <code>Capabilities</code> response element.</p>"""
    resource_types: NotRequired[
        "capo_cloudformation.types.resource_types.ResourceTypes"
    ]
    """<p>A list of all the template resource types that are defined in the template, such as <code>AWS::EC2::Instance</code>, <code>AWS::Dynamo::Table</code>, and <code>Custom::MyCustomInstance</code>.</p>"""
    version: NotRequired["capo_cloudformation.types.version.Version"]
    """<p>The Amazon Web Services template format version, which identifies the capabilities of the template.</p>"""
    metadata: NotRequired["capo_cloudformation.types.metadata.Metadata"]
    """<p>The value that's defined for the <code>Metadata</code> property of the template.</p>"""
    declared_transforms: NotRequired[
        "capo_cloudformation.types.transforms_list.TransformsList"
    ]
    """<p>A list of the transforms that are declared in the template.</p>"""
    resource_identifier_summaries: NotRequired[
        "capo_cloudformation.types.resource_identifier_summaries.ResourceIdentifierSummaries"
    ]
    """<p>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, <code>BucketName</code> is a possible identifier property for an <code>AWS::S3::Bucket</code> resource.</p>"""
    warnings: NotRequired["capo_cloudformation.types.warnings.Warnings"]
    """<p>An object that contains any warnings returned.</p>"""

capabilities instance-attribute

capabilities: NotRequired[Capabilities]

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 instance-attribute

capabilities_reason: NotRequired[CapabilitiesReason]

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

declared_transforms instance-attribute

declared_transforms: NotRequired[TransformsList]

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

description instance-attribute

description: NotRequired[Description]

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

metadata instance-attribute

metadata: NotRequired[Metadata]

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

parameters instance-attribute

parameters: NotRequired[ParameterDeclarations]

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

resource_identifier_summaries instance-attribute

resource_identifier_summaries: NotRequired[ResourceIdentifierSummaries]

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.

resource_types instance-attribute

resource_types: NotRequired[ResourceTypes]

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 instance-attribute

version: NotRequired[Version]

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

warnings instance-attribute

warnings: NotRequired[Warnings]

An object that contains any warnings returned.