Initialize connection to CloudFormation

Notes

options parameter must include values for :aws_access_key_id and :aws_secret_access_key in order to create a connection

Examples

  cf = CloudFormation.new(
   :aws_access_key_id => your_aws_access_key_id,
   :aws_secret_access_key => your_aws_secret_access_key
  )

Parameters

• options<~Hash> - config arguments for connection. Defaults to {}.

Returns

• CloudFormation object with connection to AWS.

Cancels an update on the specified stack.

@param stack_name String] Name of the stack to cancel update.

@return [Excon::Response]

@see docs.amazonwebservices.com/AWSCloudFormation/latest/APIReference/API_CancelUpdateStack.html

For a specified stack that is in the UPDATE_ROLLBACK_FAILED state, continues rolling it back to the UPDATE_ROLLBACK_COMPLETE state.

@param stack_name [String] The name or the unique ID of the stack that you want to continue rolling back.

@return [Excon::Response]

@see docs.amazonwebservices.com/AWSCloudFormation/latest/APIReference/API_ContinueUpdateRollback.html

Create a Change Set.

• stack_name [String] Name of the stack to create.
• options [Hash]:
  • ChangeSetName [String] The name of the change set.
  • Description [String] A description to help you identify this change set.
  • TemplateBody [String] Structure containing the template body.

  or (one of the two Template parameters is required)

  • TemplateURL [String] URL of file containing the template body.
  • UsePreviousTemplate [Boolean] Reuse the template that is associated with the stack to create the change set.
  • NotificationARNs [Array] List of SNS topics to publish events to.
  • Parameters [Hash] Hash of providers to supply to template.
  • Capabilities [Array] List of capabilties the stack is granted. Currently CAPABILITY_IAM for allowing the creation of IAM resources.

@return [Excon::Response]:

  * body [Hash:
    * Id [String] - The Amazon Resource Name (ARN) of the change set

@see docs.amazonwebservices.com/AWSCloudFormation/latest/APIReference/API_CreateChangeSet.html

Create a stack.

• stack_name [String] Name of the stack to create.
• options [Hash]:
  • TemplateBody [String] Structure containing the template body.

  or (one of the two Template parameters is required)

  • TemplateURL [String] URL of file containing the template body.
  • DisableRollback [Boolean] Controls rollback on stack creation failure, defaults to false.
  • OnFailure [String] Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING, ROLLBACK, or DELETE.
  • NotificationARNs [Array] List of SNS topics to publish events to.
  • Parameters [Hash] Hash of providers to supply to template
  • TimeoutInMinutes [Integer] Minutes to wait before status is set to CREATE_FAILED
  • Capabilities [Array] List of capabilties the stack is granted. Currently CAPABILITY_IAM for allowing the creation of IAM resources
  • StackPolicyBody [String] Structure containing the stack policy body.
  • StackPolicyURL [String] URL of file containing the stack policy.
  • Tags [Array] Key-value pairs to associate with this stack.

@return [Excon::Response]:

  * body [Hash:
    * StackId [String] - Id of the new stack

@see docs.amazonwebservices.com/AWSCloudFormation/latest/APIReference/API_CreateStack.html

Delete a change set.

@param ChangeSetName [String] The name of the change set to delete. @option options StackName [String] The Stack name or ID (ARN) that is associated with change set.

@return [Excon::Response]

@see docs.amazonwebservices.com/AWSCloudFormation/latest/APIReference/API_DeleteChangeSet.html

Delete a stack.

@param stack_name [String] Name of the stack to create.

@return [Excon::Response]

@see docs.amazonwebservices.com/AWSCloudFormation/latest/APIReference/API_DeleteStack.html

Describe account_limits.

@return [Excon::Response]

  * body [Hash]:
    * AccountLimits [Array]
    * member [Hash]:
      * StackLimit [Integer]

@see docs.amazonwebservices.com/AWSCloudFormation/latest/APIReference/API_DescribeAccountLimits.html

Describe change_set.

• ChangeSetName [String] The name of the change set to describe.

@param options [Hash] @option options StackName [String] Name of the stack for the change set.

@return [Excon::Response]

  * body [Hash]:
        * ChangeSetId [String] -
        * ChangeSetName [String] -
        * Description [String] -
        * CreationTime [Time] -
        * ExecutionStatus [String] -
        * StackId [String] -
        * StackName [String] -
        * Status [String] -
        * StackReason [String] -
        * NotificationARNs [Array] -
          * NotificationARN [String] -
        * Parameters [Array] -
          * parameter [Hash]:
            * ParameterKey [String] -
            * ParameterValue [String] -

@see docs.amazonwebservices.com/AWSCloudFormation/latest/APIReference/API_DescribeChangeSet.html

Describe stack events.

@param stack_name [String] stack name to return events for. @param options [Hash] @option options NextToken [String] Identifies the start of the next list of events, if there is one.

@return [Excon::Response]

  * body [Hash]:
    * StackEvents [Array] - Matching resources
      * event [Hash]:
        * EventId [String] -
        * StackId [String] -
        * StackName [String] -
        * LogicalResourceId [String] -
        * PhysicalResourceId [String] -
        * ResourceType [String] -
        * Timestamp [Time] -
        * ResourceStatus [String] -
        * ResourceStatusReason [String] -

@see docs.amazonwebservices.com/AWSCloudFormation/latest/APIReference/API_DescribeStackEvents.html

Describe stack resource.

@param options Hash]:

  * LogicalResourceId [String] Logical name of the resource as specified in the template
  * StackName [String] The name or the unique stack ID

@return [Excon::Response]

  * body [Hash]:
    * StackResourceDetail [Hash] - Matching resources
        *Description [String] -
        * LastUpdatedTimestamp [Timestamp] -
        * LogicalResourceId [String] -
        * Metadata [String] -
        * PhysicalResourceId [String] -
        * ResourceStatus [String] -
        * ResourceStatusReason [String] -
        * ResourceType [String] -
        * StackId [String] -
        * StackName [String] -

@see docs.amazonwebservices.com/AWSCloudFormation/latest/APIReference/API_DescribeStackResource.html

Describe stack resources.

@param options Hash]:

  * PhysicalResourceId [String] name or unique identifier that corresponds to a physical instance ID
  or (one of PhysicalResourceId and StackName is required)
  * StackName [String] Only return events related to this stack name
  * LogicalResourceId [String] Logical name of the resource as specified in the template

@return [Excon::Response]

  * body [Hash]:
    * StackResources [Array] - Matching resources
      * resource [Hash]:
        * StackId [String] -
        * StackName [String] -
        * LogicalResourceId [String] -
        * PhysicalResourceId [String] -
        * ResourceType [String] -
        * Timestamp [Time] -
        * ResourceStatus [String] -

@see docs.amazonwebservices.com/AWSCloudFormation/latest/APIReference/API_DescribeStackResources.html

Describe stacks.

@param options [Hash] @option options StackName [String] Name of the stack to describe.

@return [Excon::Response]

  * body [Hash]:
    * Stacks [Array] - Matching stacks
      * stack [Hash]:
        * StackName [String] -
        * StackId [String] -
        * CreationTime [String] -
        * StackStatus [String] -
        * DisableRollback [String] -
        * Outputs [Array] -
          * output [Hash]:
            * OutputKey [String] -
            * OutputValue [String] -

@see docs.amazonwebservices.com/AWSCloudFormation/latest/APIReference/API_DescribeStacks.html

Returns the estimated monthly cost of a template.

• options [Hash]:
  • TemplateBody [String] Structure containing the template body.

  or (one of the two Template parameters is required)

  • TemplateURL [String] URL of file containing the template body.
  • Parameters [Hash] Hash of providers to supply to template

@return [Excon::Response]:

  * body [Hash:
    * Url [String] - An AWS Simple Monthly Calculator URL with a query string that describes the resources required to run the template.

@see docs.amazonwebservices.com/AWSCloudFormation/latest/APIReference/API_EstimateTemplateCost.html

Execute a change set.

@param ChangeSetName [String] The name of the change set to delete. @option options StackName [String] The Stack name or ID (ARN) that is associated with change set.

@return [Excon::Response]

@see docs.amazonwebservices.com/AWSCloudFormation/latest/APIReference/API_ExecuteChangeSet.html

Describe stacks.

@param stack_name [String] The name or unique stack ID that is associated with the stack whose policy you want to get.

@return [Excon::Response]

  * body [Hash]:
    * StackPolicyBody [String] - Structure containing the stack policy body.

@see docs.amazonwebservices.com/AWSCloudFormation/latest/APIReference/API_GetStackPolicy.html

Describe stacks.

@param stack_name [String] stack name to get template from

@return [Excon::Response]

  * body [Hash]:
    * TemplateBody [String] - structure containing the template body (json)

@see docs.amazonwebservices.com/AWSCloudFormation/latest/APIReference/API_GetTemplate.html

Returns information about a new or existing template.

• options [Hash]:
  • stack_name [String] Name of the stack or the stack ID.

  or

  • TemplateBody [String] Structure containing the template body.

  or

  • TemplateURL [String] URL of file containing the template body.

@return [Excon::Response]:

  * body [Hash:
    * Capabilities [Array] List of capabilties in the template.
    * CapabilitiesReason [String] The list of resources that generated the values in the Capabilities response element.
    * Description [String] Template Description.
    * Metadata [String] Template Metadata.
    * Parameters [Array] A list of parameter declarations that describe various properties for each parameter.
    * ResourceTypes [Array] all the template resource types that are defined in the template

@see docs.amazonwebservices.com/AWSCloudFormation/latest/APIReference/API_GetTemplateSummary.html

List change sets.

@param stack_name String] Name or the ARN of the stack for which you want to list change sets.

@option options StackName [String] Name of the stack to describe.

@return [Excon::Response]

  * body [Hash]:
    * Summaries [Array] - Matching change sets
      * stack [Hash]:
        * ChangeSetId [String] -
        * ChangeSetName [String] -
        * Description [String] -
        * CreationTime [Time] -
        * ExecutionStatus [String] -
        * StackId [String] -
        * StackName [String] -
        * Status [String] -
        * StackReason [String] -

@see docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ListChangeSets.html

List stack resources.

@param options [Hash] @option options StackName [String] Name of the stack to describe.

@return [Excon::Response]

  * body [Hash]:
    * StackResourceSummaries [Array] - Matching stacks
      * resources [Hash]:
        * ResourceStatus [String] -
        * LogicalResourceId [String] -
        * PhysicalResourceId [String] -
        * ResourceType [String] -
        * LastUpdatedTimestamp [Time] -

@see docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ListStacks.html

List stacks.

@param options [Hash]

@return [Excon::Response]

  * body [Hash]:
    * StackSummaries [Array] - Matching stacks
      * stack [Hash]:
        * StackId [String] -
        * StackName [String] -
        * TemplateDescription [String] -
        * CreationTime [Time] -
        * DeletionTime [Time] -
        * StackStatus [String] -
        * DeletionTime [String] -

@see docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_ListStacks.html

Sets a stack policy for a specified stack.

@param stack_name [String] Name or unique stack ID that you want to associate a policy with.

• options [Hash]:
  • StackPolicyBody [String] Structure containing the stack policy body.

  or (one of the two StackPolicy parameters is required)

  • StackPolicyURL [String] URL of file containing the stack policy.
  • Parameters [Hash] Hash of providers to supply to StackPolicy

@return [Excon::Response]:

@see docs.amazonwebservices.com/AWSCloudFormation/latest/APIReference/API_SetStackPolicy.html

Sends a signal to the specified resource.

@param options Hash]:

  * LogicalResourceId [String] The logical ID of the resource that you want to signal.
  * StackName [String] The stack name or unique stack ID that includes the resource that you want to signal.
  * Status [String] The status of the signal, which is either success or failure.
  * UniqueId [String] A unique ID of the signal.

@return [Excon::Response]

@see docs.amazonwebservices.com/AWSCloudFormation/latest/APIReference/API_SignalResource.html

Update a stack.

@param [String] stack_name Name of the stack to update. @param [Hash] options

  * TemplateBody [String] Structure containing the template body.
  or (one of the two Template parameters is required)
  * TemplateURL [String] URL of file containing the template body.
  * Parameters [Hash] Hash of providers to supply to template.
  * Capabilities [Array] List of capabilties the stack is granted. Currently CAPABILITY_IAM for allowing the creation of IAM resources.
  * NotificationARNs [Array] List of SNS topics to publish events to.
  * ResourceTypes [Array] The template resource types that you have permissions to work.
  * StackPolicyBody [String] Structure containing the stack policy body.
  * StackPolicyURL [String] URL of file containing the stack policy.
  * StackPolicyDuringUpdateBody [String] Structure containing the stack policy body to use during update.
  * StackPolicyDuringUpdateURL [String] URL of file containing the stack policy to use during update.
  * Tags [Array] Key-value pairs to associate with this stack.
  * UsePreviousTemplate [Boolean] Reuse the existing template that is associated with the stack that you are updating.

@return [Excon::Response]

  * body [Hash]:
    * StackId [String] - Id of the stack being updated

@see docs.amazonwebservices.com/AWSCloudFormation/latest/APIReference/API_UpdateStack.html

Describe stacks.

@param [Hash] options @option options [String] TemplateBody template structure @option options [String] TemplateURL template url

@return [Excon::Response]

  * body [Hash]:
    * Description [String] - description found within the template
    * Parameters [String] - list of template parameter structures

@see docs.amazonwebservices.com/AWSCloudFormation/latest/APIReference/API_ValidateTemplate.html