GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  PAWS::CLOUDFORMATION (3)

.ds Aq ’

NAME

Paws::CloudFormation - Perl Interface to AWS AWS CloudFormation

CONTENTS

SYNOPSIS



  use Paws;

  my $obj = Paws->service(CloudFormation)->new;
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ V1, V2 ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => Val1 },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => Val1  }, { Att1 => Val2 } ],
  );



DESCRIPTION

AWS CloudFormation

AWS CloudFormation enables you to create and manage AWS infrastructure deployments predictably and repeatedly. AWS CloudFormation helps you leverage AWS products such as Amazon EC2, EBS, Amazon SNS, ELB, and Auto Scaling to build highly-reliable, highly scalable, cost effective applications without worrying about creating and configuring the underlying AWS infrastructure.

With AWS CloudFormation, you declare all of your resources and dependencies in a template file. The template defines a collection of resources as a single unit called a stack. AWS CloudFormation creates and deletes all member resources of the stack together and manages all dependencies between the resources for you.

For more information about this product, go to the CloudFormation Product Page.

Amazon CloudFormation makes use of other AWS products. If you need additional technical information about a specific AWS product, you can find the product’s technical documentation at http://aws.amazon.com/documentation/.

METHODS

    CancelUpdateStack(StackName => Str)

Each argument is described in detail in: Paws::CloudFormation::CancelUpdateStack

Returns: nothing

Cancels an update on the specified stack. If the call completes successfully, the stack will roll back the update and revert to the previous stack configuration.

Only stacks that are in the UPDATE_IN_PROGRESS state can be canceled.

    CreateStack(StackName => Str, [Capabilities => ArrayRef[Str], DisableRollback => Bool, NotificationARNs => ArrayRef[Str], OnFailure => Str, Parameters => ArrayRef[Paws::CloudFormation::Parameter], StackPolicyBody => Str, StackPolicyURL => Str, Tags => ArrayRef[Paws::CloudFormation::Tag], TemplateBody => Str, TemplateURL => Str, TimeoutInMinutes => Int])

Each argument is described in detail in: Paws::CloudFormation::CreateStack

Returns: a Paws::CloudFormation::CreateStackOutput instance

Creates a stack as specified in the template. After the call completes successfully, the stack creation starts. You can check the status of the stack via the DescribeStacks API.

    DeleteStack(StackName => Str)

Each argument is described in detail in: Paws::CloudFormation::DeleteStack

Returns: nothing

Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks do not show up in the DescribeStacks API if the deletion has been completed successfully.

    DescribeStackEvents([NextToken => Str, StackName => Str])

Each argument is described in detail in: Paws::CloudFormation::DescribeStackEvents

Returns: a Paws::CloudFormation::DescribeStackEventsOutput instance

Returns all stack related events for a specified stack. For more information about a stack’s event history, go to Stacks in the AWS CloudFormation User Guide.

You can list events for stacks that have failed to create or have been deleted by specifying the unique stack identifier (stack ID).

    DescribeStackResource(LogicalResourceId => Str, StackName => Str)

Each argument is described in detail in: Paws::CloudFormation::DescribeStackResource

Returns: a Paws::CloudFormation::DescribeStackResourceOutput instance

Returns a description of the specified resource in the specified stack.

For deleted stacks, DescribeStackResource returns resource information for up to 90 days after the stack has been deleted.

    DescribeStackResources([LogicalResourceId => Str, PhysicalResourceId => Str, StackName => Str])

Each argument is described in detail in: Paws::CloudFormation::DescribeStackResources

Returns: a Paws::CloudFormation::DescribeStackResourcesOutput instance

Returns AWS resource descriptions for running and deleted stacks. If StackName is specified, all the associated resources that are part of the stack are returned. If PhysicalResourceId is specified, the associated resources of the stack that the resource belongs to are returned.

Only the first 100 resources will be returned. If your stack has more resources than this, you should use ListStackResources instead.

For deleted stacks, DescribeStackResources returns resource information for up to 90 days after the stack has been deleted.

You must specify either StackName or PhysicalResourceId, but not both. In addition, you can specify LogicalResourceId to filter the returned result. For more information about resources, the LogicalResourceId and PhysicalResourceId, go to the AWS CloudFormation User Guide.

A ValidationError is returned if you specify both StackName and PhysicalResourceId in the same request.

    DescribeStacks([NextToken => Str, StackName => Str])

Each argument is described in detail in: Paws::CloudFormation::DescribeStacks

Returns: a Paws::CloudFormation::DescribeStacksOutput instance

Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created.

    EstimateTemplateCost([Parameters => ArrayRef[Paws::CloudFormation::Parameter], TemplateBody => Str, TemplateURL => Str])

Each argument is described in detail in: Paws::CloudFormation::EstimateTemplateCost

Returns: a Paws::CloudFormation::EstimateTemplateCostOutput instance

Returns the estimated monthly cost of a template. The return value is an AWS Simple Monthly Calculator URL with a query string that describes the resources required to run the template.

    GetStackPolicy(StackName => Str)

Each argument is described in detail in: Paws::CloudFormation::GetStackPolicy

Returns: a Paws::CloudFormation::GetStackPolicyOutput instance

Returns the stack policy for a specified stack. If a stack doesn’t have a policy, a null value is returned.

    GetTemplate(StackName => Str)

Each argument is described in detail in: Paws::CloudFormation::GetTemplate

Returns: a Paws::CloudFormation::GetTemplateOutput instance

Returns the template body for a specified stack. You can get the template for running or deleted stacks.

For deleted stacks, GetTemplate returns the template for up to 90 days after the stack has been deleted.

If the template does not exist, a ValidationError is returned.

    GetTemplateSummary([StackName => Str, TemplateBody => Str, TemplateURL => Str])

Each argument is described in detail in: Paws::CloudFormation::GetTemplateSummary

Returns: a Paws::CloudFormation::GetTemplateSummaryOutput instance

Returns information about a new or existing template. The GetTemplateSummary action is useful for viewing parameter information, such as default parameter values and parameter types, before you create or update a stack.

You can use the GetTemplateSummary action when you submit a template, or you can get template information for a running or deleted stack.

For deleted stacks, GetTemplateSummary returns the template information for up to 90 days after the stack has been deleted. If the template does not exist, a ValidationError is returned.

    ListStackResources(StackName => Str, [NextToken => Str])

Each argument is described in detail in: Paws::CloudFormation::ListStackResources

Returns: a Paws::CloudFormation::ListStackResourcesOutput instance

Returns descriptions of all resources of the specified stack.

For deleted stacks, ListStackResources returns resource information for up to 90 days after the stack has been deleted.

    ListStacks([NextToken => Str, StackStatusFilter => ArrayRef[Str]])

Each argument is described in detail in: Paws::CloudFormation::ListStacks

Returns: a Paws::CloudFormation::ListStacksOutput instance

Returns the summary information for stacks whose status matches the specified StackStatusFilter. Summary information for stacks that have been deleted is kept for 90 days after the stack is deleted. If no StackStatusFilter is specified, summary information for all stacks is returned (including existing stacks and stacks that have been deleted).

    SetStackPolicy(StackName => Str, [StackPolicyBody => Str, StackPolicyURL => Str])

Each argument is described in detail in: Paws::CloudFormation::SetStackPolicy

Returns: nothing

Sets a stack policy for a specified stack.

    SignalResource(LogicalResourceId => Str, StackName => Str, Status => Str, UniqueId => Str)

Each argument is described in detail in: Paws::CloudFormation::SignalResource

Returns: nothing

Sends a signal to the specified resource with a success or failure status. You can use the SignalResource API in conjunction with a creation policy or update policy. AWS CloudFormation doesn’t proceed with a stack creation or update until resources receive the required number of signals or the timeout period is exceeded. The SignalResource API is useful in cases where you want to send signals from anywhere other than an Amazon EC2 instance.

    UpdateStack(StackName => Str, [Capabilities => ArrayRef[Str], NotificationARNs => ArrayRef[Str], Parameters => ArrayRef[Paws::CloudFormation::Parameter], StackPolicyBody => Str, StackPolicyDuringUpdateBody => Str, StackPolicyDuringUpdateURL => Str, StackPolicyURL => Str, TemplateBody => Str, TemplateURL => Str, UsePreviousTemplate => Bool])

Each argument is described in detail in: Paws::CloudFormation::UpdateStack

Returns: a Paws::CloudFormation::UpdateStackOutput instance

Updates a stack as specified in the template. After the call completes successfully, the stack update starts. You can check the status of the stack via the DescribeStacks action.

To get a copy of the template for an existing stack, you can use the GetTemplate action.

Tags that were associated with this stack during creation time will still be associated with the stack after an UpdateStack operation.

For more information about creating an update template, updating a stack, and monitoring the progress of the update, see Updating a Stack.

    ValidateTemplate([TemplateBody => Str, TemplateURL => Str])

Each argument is described in detail in: Paws::CloudFormation::ValidateTemplate

Returns: a Paws::CloudFormation::ValidateTemplateOutput instance

Validates a specified template.

SEE ALSO

This service class forms part of Paws

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

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 PAWS::CLOUDFORMATION (3) 2015-08-06

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.