The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

Paws::CloudFormation::GetTemplateSummary - Arguments for method GetTemplateSummary on Paws::CloudFormation

DESCRIPTION

This class represents the parameters used for calling the method GetTemplateSummary on the AWS CloudFormation service. Use the attributes of this class as arguments to method GetTemplateSummary.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetTemplateSummary.

SYNOPSIS

    my $cloudformation = Paws->service('CloudFormation');
    my $GetTemplateSummaryOutput = $cloudformation->GetTemplateSummary(
      CallAs       => 'SELF',                  # OPTIONAL
      StackName    => 'MyStackNameOrId',       # OPTIONAL
      StackSetName => 'MyStackSetNameOrId',    # OPTIONAL
      TemplateBody => 'MyTemplateBody',        # OPTIONAL
      TemplateURL  => 'MyTemplateURL',         # OPTIONAL
    );

    # Results:
    my $Capabilities       = $GetTemplateSummaryOutput->Capabilities;
    my $CapabilitiesReason = $GetTemplateSummaryOutput->CapabilitiesReason;
    my $DeclaredTransforms = $GetTemplateSummaryOutput->DeclaredTransforms;
    my $Description        = $GetTemplateSummaryOutput->Description;
    my $Metadata           = $GetTemplateSummaryOutput->Metadata;
    my $Parameters         = $GetTemplateSummaryOutput->Parameters;
    my $ResourceIdentifierSummaries =
      $GetTemplateSummaryOutput->ResourceIdentifierSummaries;
    my $ResourceTypes = $GetTemplateSummaryOutput->ResourceTypes;
    my $Version       = $GetTemplateSummaryOutput->Version;

    # Returns a L<Paws::CloudFormation::GetTemplateSummaryOutput> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/cloudformation/GetTemplateSummary

ATTRIBUTES

CallAs => Str

[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.

By default, SELF is specified. Use SELF for stack sets with self-managed permissions.

  • If you are signed in to the management account, specify SELF.

  • If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.

    Your AWS account must be registered as a delegated administrator in the management account. For more information, see Register a delegated administrator (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html) in the AWS CloudFormation User Guide.

Valid values are: "SELF", "DELEGATED_ADMIN"

StackName => Str

The name or the stack ID that is associated with the stack, which are not always interchangeable. For running stacks, you can specify either the stack's name or its unique stack ID. For deleted stack, you must specify the unique stack ID.

Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.

StackSetName => Str

The name or unique ID of the stack set from which the stack was created.

Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.

TemplateBody => Str

Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information about templates, see Template Anatomy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) in the AWS CloudFormation User Guide.

Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.

TemplateURL => Str

Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket or a Systems Manager document. For more information about templates, see Template Anatomy (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) in the AWS CloudFormation User Guide.

Conditional: You must specify only one of the following parameters: StackName, StackSetName, TemplateBody, or TemplateURL.

SEE ALSO

This class forms part of Paws, documenting arguments for method GetTemplateSummary in Paws::CloudFormation

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues