cloudformation

package
v1.1.6 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 26, 2016 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

Package cloudformation provides a client for AWS CloudFormation.

Index

Examples

Constants

View Source 
const (
	// @enum OnFailure
	OnFailureDoNothing = "DO_NOTHING"
	// @enum OnFailure
	OnFailureRollback = "ROLLBACK"
	// @enum OnFailure
	OnFailureDelete = "DELETE"
)
View Source 
const (
	// @enum ResourceSignalStatus
	ResourceSignalStatusSuccess = "SUCCESS"
	// @enum ResourceSignalStatus
	ResourceSignalStatusFailure = "FAILURE"
)
View Source 
const (
	// @enum ResourceStatus
	ResourceStatusCreateInProgress = "CREATE_IN_PROGRESS"
	// @enum ResourceStatus
	ResourceStatusCreateFailed = "CREATE_FAILED"
	// @enum ResourceStatus
	ResourceStatusCreateComplete = "CREATE_COMPLETE"
	// @enum ResourceStatus
	ResourceStatusDeleteInProgress = "DELETE_IN_PROGRESS"
	// @enum ResourceStatus
	ResourceStatusDeleteFailed = "DELETE_FAILED"
	// @enum ResourceStatus
	ResourceStatusDeleteComplete = "DELETE_COMPLETE"
	// @enum ResourceStatus
	ResourceStatusDeleteSkipped = "DELETE_SKIPPED"
	// @enum ResourceStatus
	ResourceStatusUpdateInProgress = "UPDATE_IN_PROGRESS"
	// @enum ResourceStatus
	ResourceStatusUpdateFailed = "UPDATE_FAILED"
	// @enum ResourceStatus
	ResourceStatusUpdateComplete = "UPDATE_COMPLETE"
)
View Source 
const (
	// @enum StackStatus
	StackStatusCreateInProgress = "CREATE_IN_PROGRESS"
	// @enum StackStatus
	StackStatusCreateFailed = "CREATE_FAILED"
	// @enum StackStatus
	StackStatusCreateComplete = "CREATE_COMPLETE"
	// @enum StackStatus
	StackStatusRollbackInProgress = "ROLLBACK_IN_PROGRESS"
	// @enum StackStatus
	StackStatusRollbackFailed = "ROLLBACK_FAILED"
	// @enum StackStatus
	StackStatusRollbackComplete = "ROLLBACK_COMPLETE"
	// @enum StackStatus
	StackStatusDeleteInProgress = "DELETE_IN_PROGRESS"
	// @enum StackStatus
	StackStatusDeleteFailed = "DELETE_FAILED"
	// @enum StackStatus
	StackStatusDeleteComplete = "DELETE_COMPLETE"
	// @enum StackStatus
	StackStatusUpdateInProgress = "UPDATE_IN_PROGRESS"
	// @enum StackStatus
	StackStatusUpdateCompleteCleanupInProgress = "UPDATE_COMPLETE_CLEANUP_IN_PROGRESS"
	// @enum StackStatus
	StackStatusUpdateComplete = "UPDATE_COMPLETE"
	// @enum StackStatus
	StackStatusUpdateRollbackInProgress = "UPDATE_ROLLBACK_IN_PROGRESS"
	// @enum StackStatus
	StackStatusUpdateRollbackFailed = "UPDATE_ROLLBACK_FAILED"
	// @enum StackStatus
	StackStatusUpdateRollbackCompleteCleanupInProgress = "UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS"
	// @enum StackStatus
	StackStatusUpdateRollbackComplete = "UPDATE_ROLLBACK_COMPLETE"
)
View Source 
const (
	// @enum Capability
	CapabilityCapabilityIam = "CAPABILITY_IAM"
)
View Source 
const ServiceName = "cloudformation"

A ServiceName is the name of the service the client will make API calls to.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccountLimit added in v0.9.12 

type AccountLimit struct {

	// The name of the account limit. Currently, the only account limit is StackLimit.
	Name *string `type:"string"`

	// The value that is associated with the account limit name.
	Value *int64 `type:"integer"`
	// contains filtered or unexported fields
}

The AccountLimit data type.

func (AccountLimit) GoString added in v0.9.12 

func (s AccountLimit) GoString() string

GoString returns the string representation

func (AccountLimit) String added in v0.9.12 

func (s AccountLimit) String() string

String returns the string representation

type CancelUpdateStackInput 

type CancelUpdateStackInput struct {

	// The name or the unique stack ID that is associated with the stack.
	StackName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input for the CancelUpdateStack action.

func (CancelUpdateStackInput) GoString added in v0.6.6 

func (s CancelUpdateStackInput) GoString() string

GoString returns the string representation

func (CancelUpdateStackInput) String added in v0.6.6 

func (s CancelUpdateStackInput) String() string

String returns the string representation

type CancelUpdateStackOutput 

type CancelUpdateStackOutput struct {
	// contains filtered or unexported fields
}

func (CancelUpdateStackOutput) GoString added in v0.6.6 

func (s CancelUpdateStackOutput) GoString() string

GoString returns the string representation

func (CancelUpdateStackOutput) String added in v0.6.6 

func (s CancelUpdateStackOutput) String() string

String returns the string representation

type CloudFormation 

type CloudFormation struct {
	*client.Client
}

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 (http://aws.amazon.com/cloudformation/).

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://docs.aws.amazon.com/documentation/ (http://docs.aws.amazon.com/documentation/). The service client's operations are safe to be used concurrently. It is not safe to mutate any of the client's properties though.

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *CloudFormation

New creates a new instance of the CloudFormation client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

// Create a CloudFormation client from just a session.
svc := cloudformation.New(mySession)

// Create a CloudFormation client with additional configuration
svc := cloudformation.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*CloudFormation) CancelUpdateStack 

func (c *CloudFormation) CancelUpdateStack(input *CancelUpdateStackInput) (*CancelUpdateStackOutput, error)

Cancels an update on the specified stack. If the call completes successfully, the stack rolls back the update and reverts to the previous stack configuration.

You can cancel only stacks that are in the UPDATE_IN_PROGRESS state.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/cloudformation"
)

func main() {
	svc := cloudformation.New(session.New())

	params := &cloudformation.CancelUpdateStackInput{
		StackName: aws.String("StackName"), // Required
	}
	resp, err := svc.CancelUpdateStack(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*CloudFormation) CancelUpdateStackRequest 

func (c *CloudFormation) CancelUpdateStackRequest(input *CancelUpdateStackInput) (req *request.Request, output *CancelUpdateStackOutput)

CancelUpdateStackRequest generates a request for the CancelUpdateStack operation.

func (*CloudFormation) ContinueUpdateRollback added in v1.0.11 

func (c *CloudFormation) ContinueUpdateRollback(input *ContinueUpdateRollbackInput) (*ContinueUpdateRollbackOutput, error)

For a specified stack that is in the UPDATE_ROLLBACK_FAILED state, continues rolling it back to the UPDATE_ROLLBACK_COMPLETE state. Depending on the cause of the failure, you can manually fix the error (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/troubleshooting.html#troubleshooting-errors-update-rollback-failed) and continue the rollback. By continuing the rollback, you can return your stack to a working state (the UPDATE_ROLLBACK_COMPLETE state), and then try to update the stack again.

A stack goes into the UPDATE_ROLLBACK_FAILED state when AWS CloudFormation cannot roll back all changes after a failed stack update. For example, you might have a stack that is rolling back to an old database instance that was deleted outside of AWS CloudFormation. Because AWS CloudFormation doesn't know the database was deleted, it assumes that the database instance still exists and attempts to roll back to it, causing the update rollback to fail.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/cloudformation"
)

func main() {
	svc := cloudformation.New(session.New())

	params := &cloudformation.ContinueUpdateRollbackInput{
		StackName: aws.String("StackNameOrId"), // Required
	}
	resp, err := svc.ContinueUpdateRollback(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*CloudFormation) ContinueUpdateRollbackRequest added in v1.0.11 

func (c *CloudFormation) ContinueUpdateRollbackRequest(input *ContinueUpdateRollbackInput) (req *request.Request, output *ContinueUpdateRollbackOutput)

ContinueUpdateRollbackRequest generates a request for the ContinueUpdateRollback operation.

func (*CloudFormation) CreateStack 

func (c *CloudFormation) CreateStack(input *CreateStackInput) (*CreateStackOutput, error)

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.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/cloudformation"
)

func main() {
	svc := cloudformation.New(session.New())

	params := &cloudformation.CreateStackInput{
		StackName: aws.String("StackName"), // Required
		Capabilities: []*string{
			aws.String("Capability"), // Required
			// More values...
		},
		DisableRollback: aws.Bool(true),
		NotificationARNs: []*string{
			aws.String("NotificationARN"), // Required
			// More values...
		},
		OnFailure: aws.String("OnFailure"),
		Parameters: []*cloudformation.Parameter{
			{ // Required
				ParameterKey:     aws.String("ParameterKey"),
				ParameterValue:   aws.String("ParameterValue"),
				UsePreviousValue: aws.Bool(true),
			},
			// More values...
		},
		ResourceTypes: []*string{
			aws.String("ResourceType"), // Required
			// More values...
		},
		StackPolicyBody: aws.String("StackPolicyBody"),
		StackPolicyURL:  aws.String("StackPolicyURL"),
		Tags: []*cloudformation.Tag{
			{ // Required
				Key:   aws.String("TagKey"),
				Value: aws.String("TagValue"),
			},
			// More values...
		},
		TemplateBody:     aws.String("TemplateBody"),
		TemplateURL:      aws.String("TemplateURL"),
		TimeoutInMinutes: aws.Int64(1),
	}
	resp, err := svc.CreateStack(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*CloudFormation) CreateStackRequest 

func (c *CloudFormation) CreateStackRequest(input *CreateStackInput) (req *request.Request, output *CreateStackOutput)

CreateStackRequest generates a request for the CreateStack operation.

func (*CloudFormation) DeleteStack 

func (c *CloudFormation) DeleteStack(input *DeleteStackInput) (*DeleteStackOutput, error)

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.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/cloudformation"
)

func main() {
	svc := cloudformation.New(session.New())

	params := &cloudformation.DeleteStackInput{
		StackName: aws.String("StackName"), // Required
		RetainResources: []*string{
			aws.String("LogicalResourceId"), // Required
			// More values...
		},
	}
	resp, err := svc.DeleteStack(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*CloudFormation) DeleteStackRequest 

func (c *CloudFormation) DeleteStackRequest(input *DeleteStackInput) (req *request.Request, output *DeleteStackOutput)

DeleteStackRequest generates a request for the DeleteStack operation.

func (*CloudFormation) DescribeAccountLimits added in v0.9.12 

func (c *CloudFormation) DescribeAccountLimits(input *DescribeAccountLimitsInput) (*DescribeAccountLimitsOutput, error)

Retrieves your account's AWS CloudFormation limits, such as the maximum number of stacks that you can create in your account.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/cloudformation"
)

func main() {
	svc := cloudformation.New(session.New())

	params := &cloudformation.DescribeAccountLimitsInput{
		NextToken: aws.String("NextToken"),
	}
	resp, err := svc.DescribeAccountLimits(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*CloudFormation) DescribeAccountLimitsRequest added in v0.9.12 

func (c *CloudFormation) DescribeAccountLimitsRequest(input *DescribeAccountLimitsInput) (req *request.Request, output *DescribeAccountLimitsOutput)

DescribeAccountLimitsRequest generates a request for the DescribeAccountLimits operation.

func (*CloudFormation) DescribeStackEvents 

func (c *CloudFormation) DescribeStackEvents(input *DescribeStackEventsInput) (*DescribeStackEventsOutput, error)

Returns all stack related events for a specified stack. For more information about a stack's event history, go to Stacks (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/concept-stack.html) 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).

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/cloudformation"
)

func main() {
	svc := cloudformation.New(session.New())

	params := &cloudformation.DescribeStackEventsInput{
		NextToken: aws.String("NextToken"),
		StackName: aws.String("StackName"),
	}
	resp, err := svc.DescribeStackEvents(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*CloudFormation) DescribeStackEventsPages 

func (c *CloudFormation) DescribeStackEventsPages(input *DescribeStackEventsInput, fn func(p *DescribeStackEventsOutput, lastPage bool) (shouldContinue bool)) error

func (*CloudFormation) DescribeStackEventsRequest 

func (c *CloudFormation) DescribeStackEventsRequest(input *DescribeStackEventsInput) (req *request.Request, output *DescribeStackEventsOutput)

DescribeStackEventsRequest generates a request for the DescribeStackEvents operation.

func (*CloudFormation) DescribeStackResource 

func (c *CloudFormation) DescribeStackResource(input *DescribeStackResourceInput) (*DescribeStackResourceOutput, error)

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.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/cloudformation"
)

func main() {
	svc := cloudformation.New(session.New())

	params := &cloudformation.DescribeStackResourceInput{
		LogicalResourceId: aws.String("LogicalResourceId"), // Required
		StackName:         aws.String("StackName"),         // Required
	}
	resp, err := svc.DescribeStackResource(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*CloudFormation) DescribeStackResourceRequest 

func (c *CloudFormation) DescribeStackResourceRequest(input *DescribeStackResourceInput) (req *request.Request, output *DescribeStackResourceOutput)

DescribeStackResourceRequest generates a request for the DescribeStackResource operation.

func (*CloudFormation) DescribeStackResources 

func (c *CloudFormation) DescribeStackResources(input *DescribeStackResourcesInput) (*DescribeStackResourcesOutput, error)

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 (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/).

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

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/cloudformation"
)

func main() {
	svc := cloudformation.New(session.New())

	params := &cloudformation.DescribeStackResourcesInput{
		LogicalResourceId:  aws.String("LogicalResourceId"),
		PhysicalResourceId: aws.String("PhysicalResourceId"),
		StackName:          aws.String("StackName"),
	}
	resp, err := svc.DescribeStackResources(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*CloudFormation) DescribeStackResourcesRequest 

func (c *CloudFormation) DescribeStackResourcesRequest(input *DescribeStackResourcesInput) (req *request.Request, output *DescribeStackResourcesOutput)

DescribeStackResourcesRequest generates a request for the DescribeStackResources operation.

func (*CloudFormation) DescribeStacks 

func (c *CloudFormation) DescribeStacks(input *DescribeStacksInput) (*DescribeStacksOutput, error)

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

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/cloudformation"
)

func main() {
	svc := cloudformation.New(session.New())

	params := &cloudformation.DescribeStacksInput{
		NextToken: aws.String("NextToken"),
		StackName: aws.String("StackName"),
	}
	resp, err := svc.DescribeStacks(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*CloudFormation) DescribeStacksPages 

func (c *CloudFormation) DescribeStacksPages(input *DescribeStacksInput, fn func(p *DescribeStacksOutput, lastPage bool) (shouldContinue bool)) error

func (*CloudFormation) DescribeStacksRequest 

func (c *CloudFormation) DescribeStacksRequest(input *DescribeStacksInput) (req *request.Request, output *DescribeStacksOutput)

DescribeStacksRequest generates a request for the DescribeStacks operation.

func (*CloudFormation) EstimateTemplateCost 

func (c *CloudFormation) EstimateTemplateCost(input *EstimateTemplateCostInput) (*EstimateTemplateCostOutput, error)

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.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/cloudformation"
)

func main() {
	svc := cloudformation.New(session.New())

	params := &cloudformation.EstimateTemplateCostInput{
		Parameters: []*cloudformation.Parameter{
			{ // Required
				ParameterKey:     aws.String("ParameterKey"),
				ParameterValue:   aws.String("ParameterValue"),
				UsePreviousValue: aws.Bool(true),
			},
			// More values...
		},
		TemplateBody: aws.String("TemplateBody"),
		TemplateURL:  aws.String("TemplateURL"),
	}
	resp, err := svc.EstimateTemplateCost(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*CloudFormation) EstimateTemplateCostRequest 

func (c *CloudFormation) EstimateTemplateCostRequest(input *EstimateTemplateCostInput) (req *request.Request, output *EstimateTemplateCostOutput)

EstimateTemplateCostRequest generates a request for the EstimateTemplateCost operation.

func (*CloudFormation) GetStackPolicy 

func (c *CloudFormation) GetStackPolicy(input *GetStackPolicyInput) (*GetStackPolicyOutput, error)

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

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/cloudformation"
)

func main() {
	svc := cloudformation.New(session.New())

	params := &cloudformation.GetStackPolicyInput{
		StackName: aws.String("StackName"), // Required
	}
	resp, err := svc.GetStackPolicy(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*CloudFormation) GetStackPolicyRequest 

func (c *CloudFormation) GetStackPolicyRequest(input *GetStackPolicyInput) (req *request.Request, output *GetStackPolicyOutput)

GetStackPolicyRequest generates a request for the GetStackPolicy operation.

func (*CloudFormation) GetTemplate 

func (c *CloudFormation) GetTemplate(input *GetTemplateInput) (*GetTemplateOutput, error)

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.
Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/cloudformation"
)

func main() {
	svc := cloudformation.New(session.New())

	params := &cloudformation.GetTemplateInput{
		StackName: aws.String("StackName"), // Required
	}
	resp, err := svc.GetTemplate(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*CloudFormation) GetTemplateRequest 

func (c *CloudFormation) GetTemplateRequest(input *GetTemplateInput) (req *request.Request, output *GetTemplateOutput)

GetTemplateRequest generates a request for the GetTemplate operation.

func (*CloudFormation) GetTemplateSummary 

func (c *CloudFormation) GetTemplateSummary(input *GetTemplateSummaryInput) (*GetTemplateSummaryOutput, error)

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.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/cloudformation"
)

func main() {
	svc := cloudformation.New(session.New())

	params := &cloudformation.GetTemplateSummaryInput{
		StackName:    aws.String("StackNameOrId"),
		TemplateBody: aws.String("TemplateBody"),
		TemplateURL:  aws.String("TemplateURL"),
	}
	resp, err := svc.GetTemplateSummary(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*CloudFormation) GetTemplateSummaryRequest 

func (c *CloudFormation) GetTemplateSummaryRequest(input *GetTemplateSummaryInput) (req *request.Request, output *GetTemplateSummaryOutput)

GetTemplateSummaryRequest generates a request for the GetTemplateSummary operation.

func (*CloudFormation) ListStackResources 

func (c *CloudFormation) ListStackResources(input *ListStackResourcesInput) (*ListStackResourcesOutput, error)

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.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/cloudformation"
)

func main() {
	svc := cloudformation.New(session.New())

	params := &cloudformation.ListStackResourcesInput{
		StackName: aws.String("StackName"), // Required
		NextToken: aws.String("NextToken"),
	}
	resp, err := svc.ListStackResources(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*CloudFormation) ListStackResourcesPages 

func (c *CloudFormation) ListStackResourcesPages(input *ListStackResourcesInput, fn func(p *ListStackResourcesOutput, lastPage bool) (shouldContinue bool)) error

func (*CloudFormation) ListStackResourcesRequest 

func (c *CloudFormation) ListStackResourcesRequest(input *ListStackResourcesInput) (req *request.Request, output *ListStackResourcesOutput)

ListStackResourcesRequest generates a request for the ListStackResources operation.

func (*CloudFormation) ListStacks 

func (c *CloudFormation) ListStacks(input *ListStacksInput) (*ListStacksOutput, error)

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

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/cloudformation"
)

func main() {
	svc := cloudformation.New(session.New())

	params := &cloudformation.ListStacksInput{
		NextToken: aws.String("NextToken"),
		StackStatusFilter: []*string{
			aws.String("StackStatus"), // Required
			// More values...
		},
	}
	resp, err := svc.ListStacks(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*CloudFormation) ListStacksPages 

func (c *CloudFormation) ListStacksPages(input *ListStacksInput, fn func(p *ListStacksOutput, lastPage bool) (shouldContinue bool)) error

func (*CloudFormation) ListStacksRequest 

func (c *CloudFormation) ListStacksRequest(input *ListStacksInput) (req *request.Request, output *ListStacksOutput)

ListStacksRequest generates a request for the ListStacks operation.

func (*CloudFormation) SetStackPolicy 

func (c *CloudFormation) SetStackPolicy(input *SetStackPolicyInput) (*SetStackPolicyOutput, error)

Sets a stack policy for a specified stack.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/cloudformation"
)

func main() {
	svc := cloudformation.New(session.New())

	params := &cloudformation.SetStackPolicyInput{
		StackName:       aws.String("StackName"), // Required
		StackPolicyBody: aws.String("StackPolicyBody"),
		StackPolicyURL:  aws.String("StackPolicyURL"),
	}
	resp, err := svc.SetStackPolicy(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*CloudFormation) SetStackPolicyRequest 

func (c *CloudFormation) SetStackPolicyRequest(input *SetStackPolicyInput) (req *request.Request, output *SetStackPolicyOutput)

SetStackPolicyRequest generates a request for the SetStackPolicy operation.

func (*CloudFormation) SignalResource 

func (c *CloudFormation) SignalResource(input *SignalResourceInput) (*SignalResourceOutput, error)

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.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/cloudformation"
)

func main() {
	svc := cloudformation.New(session.New())

	params := &cloudformation.SignalResourceInput{
		LogicalResourceId: aws.String("LogicalResourceId"),      // Required
		StackName:         aws.String("StackNameOrId"),          // Required
		Status:            aws.String("ResourceSignalStatus"),   // Required
		UniqueId:          aws.String("ResourceSignalUniqueId"), // Required
	}
	resp, err := svc.SignalResource(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*CloudFormation) SignalResourceRequest 

func (c *CloudFormation) SignalResourceRequest(input *SignalResourceInput) (req *request.Request, output *SignalResourceOutput)

SignalResourceRequest generates a request for the SignalResource operation.

func (*CloudFormation) UpdateStack 

func (c *CloudFormation) UpdateStack(input *UpdateStackInput) (*UpdateStackOutput, error)

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.

For more information about creating an update template, updating a stack, and monitoring the progress of the update, see Updating a Stack (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html).

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/cloudformation"
)

func main() {
	svc := cloudformation.New(session.New())

	params := &cloudformation.UpdateStackInput{
		StackName: aws.String("StackName"), // Required
		Capabilities: []*string{
			aws.String("Capability"), // Required
			// More values...
		},
		NotificationARNs: []*string{
			aws.String("NotificationARN"), // Required
			// More values...
		},
		Parameters: []*cloudformation.Parameter{
			{ // Required
				ParameterKey:     aws.String("ParameterKey"),
				ParameterValue:   aws.String("ParameterValue"),
				UsePreviousValue: aws.Bool(true),
			},
			// More values...
		},
		ResourceTypes: []*string{
			aws.String("ResourceType"), // Required
			// More values...
		},
		StackPolicyBody:             aws.String("StackPolicyBody"),
		StackPolicyDuringUpdateBody: aws.String("StackPolicyDuringUpdateBody"),
		StackPolicyDuringUpdateURL:  aws.String("StackPolicyDuringUpdateURL"),
		StackPolicyURL:              aws.String("StackPolicyURL"),
		Tags: []*cloudformation.Tag{
			{ // Required
				Key:   aws.String("TagKey"),
				Value: aws.String("TagValue"),
			},
			// More values...
		},
		TemplateBody:        aws.String("TemplateBody"),
		TemplateURL:         aws.String("TemplateURL"),
		UsePreviousTemplate: aws.Bool(true),
	}
	resp, err := svc.UpdateStack(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*CloudFormation) UpdateStackRequest 

func (c *CloudFormation) UpdateStackRequest(input *UpdateStackInput) (req *request.Request, output *UpdateStackOutput)

UpdateStackRequest generates a request for the UpdateStack operation.

func (*CloudFormation) ValidateTemplate 

func (c *CloudFormation) ValidateTemplate(input *ValidateTemplateInput) (*ValidateTemplateOutput, error)

Validates a specified template.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/cloudformation"
)

func main() {
	svc := cloudformation.New(session.New())

	params := &cloudformation.ValidateTemplateInput{
		TemplateBody: aws.String("TemplateBody"),
		TemplateURL:  aws.String("TemplateURL"),
	}
	resp, err := svc.ValidateTemplate(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*CloudFormation) ValidateTemplateRequest 

func (c *CloudFormation) ValidateTemplateRequest(input *ValidateTemplateInput) (req *request.Request, output *ValidateTemplateOutput)

ValidateTemplateRequest generates a request for the ValidateTemplate operation.

func (*CloudFormation) WaitUntilStackCreateComplete added in v0.10.3 

func (c *CloudFormation) WaitUntilStackCreateComplete(input *DescribeStacksInput) error

func (*CloudFormation) WaitUntilStackDeleteComplete added in v0.10.3 

func (c *CloudFormation) WaitUntilStackDeleteComplete(input *DescribeStacksInput) error

func (*CloudFormation) WaitUntilStackUpdateComplete added in v0.10.3 

func (c *CloudFormation) WaitUntilStackUpdateComplete(input *DescribeStacksInput) error

type ContinueUpdateRollbackInput added in v1.0.11 

type ContinueUpdateRollbackInput struct {

	// The name or the unique ID of the stack that you want to continue rolling
	// back.
	StackName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input for the ContinueUpdateRollback action.

func (ContinueUpdateRollbackInput) GoString added in v1.0.11 

func (s ContinueUpdateRollbackInput) GoString() string

GoString returns the string representation

func (ContinueUpdateRollbackInput) String added in v1.0.11 

func (s ContinueUpdateRollbackInput) String() string

String returns the string representation

type ContinueUpdateRollbackOutput added in v1.0.11 

type ContinueUpdateRollbackOutput struct {
	// contains filtered or unexported fields
}

The output for a ContinueUpdateRollback action.

func (ContinueUpdateRollbackOutput) GoString added in v1.0.11 

func (s ContinueUpdateRollbackOutput) GoString() string

GoString returns the string representation

func (ContinueUpdateRollbackOutput) String added in v1.0.11 

func (s ContinueUpdateRollbackOutput) String() string

String returns the string representation

type CreateStackInput 

type CreateStackInput struct {

	// A list of capabilities that you must specify before AWS CloudFormation can
	// create or update certain stacks. Some stack templates might include resources
	// that can affect permissions in your AWS account. For those stacks, you must
	// explicitly acknowledge their capabilities by specifying this parameter.
	//
	// Currently, the only valid value is CAPABILITY_IAM, which is required for
	// the following resources:  AWS::IAM::AccessKey (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html),
	//  AWS::IAM::Group (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html),
	//  AWS::IAM::InstanceProfile (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html),
	//  AWS::IAM::Policy (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html),
	//  AWS::IAM::Role (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html),
	//  AWS::IAM::User (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html),
	// and  AWS::IAM::UserToGroupAddition (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html).
	// If your stack template contains these resources, we recommend that you review
	// any permissions associated with them. If you don't specify this parameter,
	// this action returns an InsufficientCapabilities error.
	Capabilities []*string `type:"list"`

	// Set to true to disable rollback of the stack if stack creation failed. You
	// can specify either DisableRollback or OnFailure, but not both.
	//
	// Default: false
	DisableRollback *bool `type:"boolean"`

	// The Simple Notification Service (SNS) topic ARNs to publish stack related
	// events. You can find your SNS topic ARNs using the SNS console (http://console.aws.amazon.com/sns)
	// or your Command Line Interface (CLI).
	NotificationARNs []*string `type:"list"`

	// Determines what action will be taken if stack creation fails. This must be
	// one of: DO_NOTHING, ROLLBACK, or DELETE. You can specify either OnFailure
	// or DisableRollback, but not both.
	//
	// Default: ROLLBACK
	OnFailure *string `type:"string" enum:"OnFailure"`

	// A list of Parameter structures that specify input parameters for the stack.
	// For more information, see the Parameter (http://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html)
	// data type.
	Parameters []*Parameter `type:"list"`

	// The template resource types that you have permissions to work with for this
	// create stack action, such as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.
	// Use the following syntax to describe template resource types: AWS::* (for
	// all AWS resource), Custom::* (for all custom resources), Custom::logical_ID
	// (for a specific custom resource), AWS::service_name::* (for all resources
	// of a particular AWS service), and AWS::service_name::resource_logical_ID
	// (for a specific AWS resource).
	//
	// If the list of resource types doesn't include a resource that you're creating,
	// the stack creation fails. By default, AWS CloudFormation grants permissions
	// to all resource types. AWS Identity and Access Management (IAM) uses this
	// parameter for AWS CloudFormation-specific condition keys in IAM policies.
	// For more information, see Controlling Access with AWS Identity and Access
	// Management (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html).
	ResourceTypes []*string `type:"list"`

	// The name that is associated with the stack. The name must be unique in the
	// region in which you are creating the stack.
	//
	// A stack name can contain only alphanumeric characters (case sensitive) and
	// hyphens. It must start with an alphabetic character and cannot be longer
	// than 128 characters.
	StackName *string `type:"string" required:"true"`

	// Structure containing the stack policy body. For more information, go to
	// Prevent Updates to Stack Resources (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html)
	// in the AWS CloudFormation User Guide. You can specify either the StackPolicyBody
	// or the StackPolicyURL parameter, but not both.
	StackPolicyBody *string `min:"1" type:"string"`

	// Location of a file containing the stack policy. The URL must point to a policy
	// (max size: 16KB) located in an S3 bucket in the same region as the stack.
	// You can specify either the StackPolicyBody or the StackPolicyURL parameter,
	// but not both.
	StackPolicyURL *string `min:"1" type:"string"`

	// Key-value pairs to associate with this stack. AWS CloudFormation also propagates
	// these tags to the resources created in the stack. A maximum number of 10
	// tags can be specified.
	Tags []*Tag `type:"list"`

	// Structure containing the template body with a minimum length of 1 byte and
	// a maximum length of 51,200 bytes. For more information, go to Template Anatomy
	// (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html)
	// in the AWS CloudFormation User Guide.
	//
	// Conditional: You must specify either the TemplateBody or the TemplateURL
	// parameter, but not both.
	TemplateBody *string `min:"1" type:"string"`

	// 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. For more
	// information, go to the Template Anatomy (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html)
	// in the AWS CloudFormation User Guide.
	//
	// Conditional: You must specify either the TemplateBody or the TemplateURL
	// parameter, but not both.
	TemplateURL *string `min:"1" type:"string"`

	// The amount of time that can pass before the stack status becomes CREATE_FAILED;
	// if DisableRollback is not set or is set to false, the stack will be rolled
	// back.
	TimeoutInMinutes *int64 `min:"1" type:"integer"`
	// contains filtered or unexported fields
}

The input for CreateStack action.

func (CreateStackInput) GoString added in v0.6.6 

func (s CreateStackInput) GoString() string

GoString returns the string representation

func (CreateStackInput) String added in v0.6.6 

func (s CreateStackInput) String() string

String returns the string representation

type CreateStackOutput 

type CreateStackOutput struct {

	// Unique identifier of the stack.
	StackId *string `type:"string"`
	// contains filtered or unexported fields
}

The output for a CreateStack action.

func (CreateStackOutput) GoString added in v0.6.6 

func (s CreateStackOutput) GoString() string

GoString returns the string representation

func (CreateStackOutput) String added in v0.6.6 

func (s CreateStackOutput) String() string

String returns the string representation

type DeleteStackInput 

type DeleteStackInput struct {

	// For stacks in the DELETE_FAILED state, a list of resource logical IDs that
	// are associated with the resources you want to retain. During deletion, AWS
	// CloudFormation deletes the stack but does not delete the retained resources.
	//
	// Retaining resources is useful when you cannot delete a resource, such as
	// a non-empty S3 bucket, but you want to delete the stack.
	RetainResources []*string `type:"list"`

	// The name or the unique stack ID that is associated with the stack.
	StackName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input for DeleteStack action.

func (DeleteStackInput) GoString added in v0.6.6 

func (s DeleteStackInput) GoString() string

GoString returns the string representation

func (DeleteStackInput) String added in v0.6.6 

func (s DeleteStackInput) String() string

String returns the string representation

type DeleteStackOutput 

type DeleteStackOutput struct {
	// contains filtered or unexported fields
}

func (DeleteStackOutput) GoString added in v0.6.6 

func (s DeleteStackOutput) GoString() string

GoString returns the string representation

func (DeleteStackOutput) String added in v0.6.6 

func (s DeleteStackOutput) String() string

String returns the string representation

type DescribeAccountLimitsInput added in v0.9.12 

type DescribeAccountLimitsInput struct {

	// A string that identifies the next page of limits that you want to retrieve.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The input for the DescribeAccountLimits action.

func (DescribeAccountLimitsInput) GoString added in v0.9.12 

func (s DescribeAccountLimitsInput) GoString() string

GoString returns the string representation

func (DescribeAccountLimitsInput) String added in v0.9.12 

func (s DescribeAccountLimitsInput) String() string

String returns the string representation

type DescribeAccountLimitsOutput added in v0.9.12 

type DescribeAccountLimitsOutput struct {

	// An account limit structure that contain a list of AWS CloudFormation account
	// limits and their values.
	AccountLimits []*AccountLimit `type:"list"`

	// If the output exceeds 1 MB in size, a string that identifies the next page
	// of limits. If no additional page exists, this value is null.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The output for the DescribeAccountLimits action.

func (DescribeAccountLimitsOutput) GoString added in v0.9.12 

func (s DescribeAccountLimitsOutput) GoString() string

GoString returns the string representation

func (DescribeAccountLimitsOutput) String added in v0.9.12 

func (s DescribeAccountLimitsOutput) String() string

String returns the string representation

type DescribeStackEventsInput 

type DescribeStackEventsInput struct {

	// A string that identifies the next page of events that you want to retrieve.
	NextToken *string `min:"1" type:"string"`

	// The name or the unique stack ID that is associated with the stack, which
	// are not always interchangeable:
	//
	//  Running stacks: You can specify either the stack's name or its unique stack
	// ID. Deleted stacks: You must specify the unique stack ID.  Default: There
	// is no default value.
	StackName *string `type:"string"`
	// contains filtered or unexported fields
}

The input for DescribeStackEvents action.

func (DescribeStackEventsInput) GoString added in v0.6.6 

func (s DescribeStackEventsInput) GoString() string

GoString returns the string representation

func (DescribeStackEventsInput) String added in v0.6.6 

func (s DescribeStackEventsInput) String() string

String returns the string representation

type DescribeStackEventsOutput 

type DescribeStackEventsOutput struct {

	// If the output exceeds 1 MB in size, a string that identifies the next page
	// of events. If no additional page exists, this value is null.
	NextToken *string `min:"1" type:"string"`

	// A list of StackEvents structures.
	StackEvents []*StackEvent `type:"list"`
	// contains filtered or unexported fields
}

The output for a DescribeStackEvents action.

func (DescribeStackEventsOutput) GoString added in v0.6.6 

func (s DescribeStackEventsOutput) GoString() string

GoString returns the string representation

func (DescribeStackEventsOutput) String added in v0.6.6 

func (s DescribeStackEventsOutput) String() string

String returns the string representation

type DescribeStackResourceInput 

type DescribeStackResourceInput struct {

	// The logical name of the resource as specified in the template.
	//
	// Default: There is no default value.
	LogicalResourceId *string `type:"string" required:"true"`

	// The name or the unique stack ID that is associated with the stack, which
	// are not always interchangeable:
	//
	//  Running stacks: You can specify either the stack's name or its unique stack
	// ID. Deleted stacks: You must specify the unique stack ID.  Default: There
	// is no default value.
	StackName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input for DescribeStackResource action.

func (DescribeStackResourceInput) GoString added in v0.6.6 

func (s DescribeStackResourceInput) GoString() string

GoString returns the string representation

func (DescribeStackResourceInput) String added in v0.6.6 

func (s DescribeStackResourceInput) String() string

String returns the string representation

type DescribeStackResourceOutput 

type DescribeStackResourceOutput struct {

	// A StackResourceDetail structure containing the description of the specified
	// resource in the specified stack.
	StackResourceDetail *StackResourceDetail `type:"structure"`
	// contains filtered or unexported fields
}

The output for a DescribeStackResource action.

func (DescribeStackResourceOutput) GoString added in v0.6.6 

func (s DescribeStackResourceOutput) GoString() string

GoString returns the string representation

func (DescribeStackResourceOutput) String added in v0.6.6 

func (s DescribeStackResourceOutput) String() string

String returns the string representation

type DescribeStackResourcesInput 

type DescribeStackResourcesInput struct {

	// The logical name of the resource as specified in the template.
	//
	// Default: There is no default value.
	LogicalResourceId *string `type:"string"`

	// The name or unique identifier that corresponds to a physical instance ID
	// of a resource supported by AWS CloudFormation.
	//
	// For example, for an Amazon Elastic Compute Cloud (EC2) instance, PhysicalResourceId
	// corresponds to the InstanceId. You can pass the EC2 InstanceId to DescribeStackResources
	// to find which stack the instance belongs to and what other resources are
	// part of the stack.
	//
	// Required: Conditional. If you do not specify PhysicalResourceId, you must
	// specify StackName.
	//
	// Default: There is no default value.
	PhysicalResourceId *string `type:"string"`

	// The name or the unique stack ID that is associated with the stack, which
	// are not always interchangeable:
	//
	//  Running stacks: You can specify either the stack's name or its unique stack
	// ID. Deleted stacks: You must specify the unique stack ID.  Default: There
	// is no default value.
	//
	// Required: Conditional. If you do not specify StackName, you must specify
	// PhysicalResourceId.
	StackName *string `type:"string"`
	// contains filtered or unexported fields
}

The input for DescribeStackResources action.

func (DescribeStackResourcesInput) GoString added in v0.6.6 

func (s DescribeStackResourcesInput) GoString() string

GoString returns the string representation

func (DescribeStackResourcesInput) String added in v0.6.6 

func (s DescribeStackResourcesInput) String() string

String returns the string representation

type DescribeStackResourcesOutput 

type DescribeStackResourcesOutput struct {

	// A list of StackResource structures.
	StackResources []*StackResource `type:"list"`
	// contains filtered or unexported fields
}

The output for a DescribeStackResources action.

func (DescribeStackResourcesOutput) GoString added in v0.6.6 

func (s DescribeStackResourcesOutput) GoString() string

GoString returns the string representation

func (DescribeStackResourcesOutput) String added in v0.6.6 

func (s DescribeStackResourcesOutput) String() string

String returns the string representation

type DescribeStacksInput 

type DescribeStacksInput struct {

	// A string that identifies the next page of stacks that you want to retrieve.
	NextToken *string `min:"1" type:"string"`

	// The name or the unique stack ID that is associated with the stack, which
	// are not always interchangeable:
	//
	//  Running stacks: You can specify either the stack's name or its unique stack
	// ID. Deleted stacks: You must specify the unique stack ID.  Default: There
	// is no default value.
	StackName *string `type:"string"`
	// contains filtered or unexported fields
}

The input for DescribeStacks action.

func (DescribeStacksInput) GoString added in v0.6.6 

func (s DescribeStacksInput) GoString() string

GoString returns the string representation

func (DescribeStacksInput) String added in v0.6.6 

func (s DescribeStacksInput) String() string

String returns the string representation

type DescribeStacksOutput 

type DescribeStacksOutput struct {

	// If the output exceeds 1 MB in size, a string that identifies the next page
	// of stacks. If no additional page exists, this value is null.
	NextToken *string `min:"1" type:"string"`

	// A list of stack structures.
	Stacks []*Stack `type:"list"`
	// contains filtered or unexported fields
}

The output for a DescribeStacks action.

func (DescribeStacksOutput) GoString added in v0.6.6 

func (s DescribeStacksOutput) GoString() string

GoString returns the string representation

func (DescribeStacksOutput) String added in v0.6.6 

func (s DescribeStacksOutput) String() string

String returns the string representation

type EstimateTemplateCostInput 

type EstimateTemplateCostInput struct {

	// A list of Parameter structures that specify input parameters.
	Parameters []*Parameter `type:"list"`

	// Structure containing the template body with a minimum length of 1 byte and
	// a maximum length of 51,200 bytes. (For more information, go to Template Anatomy
	// (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html)
	// in the AWS CloudFormation User Guide.)
	//
	// Conditional: You must pass TemplateBody or TemplateURL. If both are passed,
	// only TemplateBody is used.
	TemplateBody *string `min:"1" type:"string"`

	// Location of file containing the template body. The URL must point to a template
	// that is located in an Amazon S3 bucket. For more information, go to Template
	// Anatomy (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html)
	// in the AWS CloudFormation User Guide.
	//
	// Conditional: You must pass TemplateURL or TemplateBody. If both are passed,
	// only TemplateBody is used.
	TemplateURL *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (EstimateTemplateCostInput) GoString added in v0.6.6 

func (s EstimateTemplateCostInput) GoString() string

GoString returns the string representation

func (EstimateTemplateCostInput) String added in v0.6.6 

func (s EstimateTemplateCostInput) String() string

String returns the string representation

type EstimateTemplateCostOutput 

type EstimateTemplateCostOutput struct {

	// An AWS Simple Monthly Calculator URL with a query string that describes the
	// resources required to run the template.
	Url *string `type:"string"`
	// contains filtered or unexported fields
}

The output for a EstimateTemplateCost action.

func (EstimateTemplateCostOutput) GoString added in v0.6.6 

func (s EstimateTemplateCostOutput) GoString() string

GoString returns the string representation

func (EstimateTemplateCostOutput) String added in v0.6.6 

func (s EstimateTemplateCostOutput) String() string

String returns the string representation

type GetStackPolicyInput 

type GetStackPolicyInput struct {

	// The name or unique stack ID that is associated with the stack whose policy
	// you want to get.
	StackName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input for the GetStackPolicy action.

func (GetStackPolicyInput) GoString added in v0.6.6 

func (s GetStackPolicyInput) GoString() string

GoString returns the string representation

func (GetStackPolicyInput) String added in v0.6.6 

func (s GetStackPolicyInput) String() string

String returns the string representation

type GetStackPolicyOutput 

type GetStackPolicyOutput struct {

	// Structure containing the stack policy body. (For more information, go to
	//  Prevent Updates to Stack Resources (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html)
	// in the AWS CloudFormation User Guide.)
	StackPolicyBody *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The output for the GetStackPolicy action.

func (GetStackPolicyOutput) GoString added in v0.6.6 

func (s GetStackPolicyOutput) GoString() string

GoString returns the string representation

func (GetStackPolicyOutput) String added in v0.6.6 

func (s GetStackPolicyOutput) String() string

String returns the string representation

type GetTemplateInput 

type GetTemplateInput struct {

	// The name or the unique stack ID that is associated with the stack, which
	// are not always interchangeable:
	//
	//  Running stacks: You can specify either the stack's name or its unique stack
	// ID. Deleted stacks: You must specify the unique stack ID.  Default: There
	// is no default value.
	StackName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input for a GetTemplate action.

func (GetTemplateInput) GoString added in v0.6.6 

func (s GetTemplateInput) GoString() string

GoString returns the string representation

func (GetTemplateInput) String added in v0.6.6 

func (s GetTemplateInput) String() string

String returns the string representation

type GetTemplateOutput 

type GetTemplateOutput struct {

	// Structure containing the template body. (For more information, go to Template
	// Anatomy (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html)
	// in the AWS CloudFormation User Guide.)
	TemplateBody *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The output for GetTemplate action.

func (GetTemplateOutput) GoString added in v0.6.6 

func (s GetTemplateOutput) GoString() string

GoString returns the string representation

func (GetTemplateOutput) String added in v0.6.6 

func (s GetTemplateOutput) String() string

String returns the string representation

type GetTemplateSummaryInput 

type GetTemplateSummaryInput struct {

	// 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,
	// TemplateBody, or TemplateURL.
	StackName *string `min:"1" type:"string"`

	// 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 (http://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,
	// TemplateBody, or TemplateURL.
	TemplateBody *string `min:"1" type:"string"`

	// 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. For more
	// information about templates, see Template Anatomy (http://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,
	// TemplateBody, or TemplateURL.
	TemplateURL *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The input for the GetTemplateSummary action.

func (GetTemplateSummaryInput) GoString added in v0.6.6 

func (s GetTemplateSummaryInput) GoString() string

GoString returns the string representation

func (GetTemplateSummaryInput) String added in v0.6.6 

func (s GetTemplateSummaryInput) String() string

String returns the string representation

type GetTemplateSummaryOutput 

type GetTemplateSummaryOutput struct {

	// The capabilities found within the template. Currently, AWS CloudFormation
	// supports only the CAPABILITY_IAM capability. If your template contains IAM
	// resources, you must specify the CAPABILITY_IAM value for this parameter when
	// you use the CreateStack or UpdateStack actions with your template; otherwise,
	// those actions return an InsufficientCapabilities error.
	Capabilities []*string `type:"list"`

	// The list of resources that generated the values in the Capabilities response
	// element.
	CapabilitiesReason *string `type:"string"`

	// The value that is defined in the Description property of the template.
	Description *string `type:"string"`

	// The value that is defined for the Metadata property of the template.
	Metadata *string `type:"string"`

	// A list of parameter declarations that describe various properties for each
	// parameter.
	Parameters []*ParameterDeclaration `type:"list"`

	// 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.
	ResourceTypes []*string `type:"list"`

	// The AWS template format version, which identifies the capabilities of the
	// template.
	Version *string `type:"string"`
	// contains filtered or unexported fields
}

The output for the GetTemplateSummary action.

func (GetTemplateSummaryOutput) GoString added in v0.6.6 

func (s GetTemplateSummaryOutput) GoString() string

GoString returns the string representation

func (GetTemplateSummaryOutput) String added in v0.6.6 

func (s GetTemplateSummaryOutput) String() string

String returns the string representation

type ListStackResourcesInput 

type ListStackResourcesInput struct {

	// A string that identifies the next page of stack resources that you want to
	// retrieve.
	NextToken *string `min:"1" type:"string"`

	// The name or the unique stack ID that is associated with the stack, which
	// are not always interchangeable:
	//
	//  Running stacks: You can specify either the stack's name or its unique stack
	// ID. Deleted stacks: You must specify the unique stack ID.  Default: There
	// is no default value.
	StackName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input for the ListStackResource action.

func (ListStackResourcesInput) GoString added in v0.6.6 

func (s ListStackResourcesInput) GoString() string

GoString returns the string representation

func (ListStackResourcesInput) String added in v0.6.6 

func (s ListStackResourcesInput) String() string

String returns the string representation

type ListStackResourcesOutput 

type ListStackResourcesOutput struct {

	// If the output exceeds 1 MB in size, a string that identifies the next page
	// of stack resources. If no additional page exists, this value is null.
	NextToken *string `min:"1" type:"string"`

	// A list of StackResourceSummary structures.
	StackResourceSummaries []*StackResourceSummary `type:"list"`
	// contains filtered or unexported fields
}

The output for a ListStackResources action.

func (ListStackResourcesOutput) GoString added in v0.6.6 

func (s ListStackResourcesOutput) GoString() string

GoString returns the string representation

func (ListStackResourcesOutput) String added in v0.6.6 

func (s ListStackResourcesOutput) String() string

String returns the string representation

type ListStacksInput 

type ListStacksInput struct {

	// A string that identifies the next page of stacks that you want to retrieve.
	NextToken *string `min:"1" type:"string"`

	// Stack status to use as a filter. Specify one or more stack status codes to
	// list only stacks with the specified status codes. For a complete list of
	// stack status codes, see the StackStatus parameter of the Stack data type.
	StackStatusFilter []*string `type:"list"`
	// contains filtered or unexported fields
}

The input for ListStacks action.

func (ListStacksInput) GoString added in v0.6.6 

func (s ListStacksInput) GoString() string

GoString returns the string representation

func (ListStacksInput) String added in v0.6.6 

func (s ListStacksInput) String() string

String returns the string representation

type ListStacksOutput 

type ListStacksOutput struct {

	// If the output exceeds 1 MB in size, a string that identifies the next page
	// of stacks. If no additional page exists, this value is null.
	NextToken *string `min:"1" type:"string"`

	// A list of StackSummary structures containing information about the specified
	// stacks.
	StackSummaries []*StackSummary `type:"list"`
	// contains filtered or unexported fields
}

The output for ListStacks action.

func (ListStacksOutput) GoString added in v0.6.6 

func (s ListStacksOutput) GoString() string

GoString returns the string representation

func (ListStacksOutput) String added in v0.6.6 

func (s ListStacksOutput) String() string

String returns the string representation

type Output 

type Output struct {

	// User defined description associated with the output.
	Description *string `type:"string"`

	// The key associated with the output.
	OutputKey *string `type:"string"`

	// The value associated with the output.
	OutputValue *string `type:"string"`
	// contains filtered or unexported fields
}

The Output data type.

func (Output) GoString added in v0.6.6 

func (s Output) GoString() string

GoString returns the string representation

func (Output) String added in v0.6.6 

func (s Output) String() string

String returns the string representation

type Parameter 

type Parameter struct {

	// The key associated with the parameter. If you don't specify a key and value
	// for a particular parameter, AWS CloudFormation uses the default value that
	// is specified in your template.
	ParameterKey *string `type:"string"`

	// The value associated with the parameter.
	ParameterValue *string `type:"string"`

	// During a stack update, use the existing parameter value that the stack is
	// using for a given parameter key. If you specify true, do not specify a parameter
	// value.
	UsePreviousValue *bool `type:"boolean"`
	// contains filtered or unexported fields
}

The Parameter data type.

func (Parameter) GoString added in v0.6.6 

func (s Parameter) GoString() string

GoString returns the string representation

func (Parameter) String added in v0.6.6 

func (s Parameter) String() string

String returns the string representation

type ParameterConstraints 

type ParameterConstraints struct {

	// A list of values that are permitted for a parameter.
	AllowedValues []*string `type:"list"`
	// contains filtered or unexported fields
}

A set of criteria that AWS CloudFormation uses to validate parameter values. Although other constraints might be defined in the stack template, AWS CloudFormation returns only the AllowedValues property.

func (ParameterConstraints) GoString added in v0.6.6 

func (s ParameterConstraints) GoString() string

GoString returns the string representation

func (ParameterConstraints) String added in v0.6.6 

func (s ParameterConstraints) String() string

String returns the string representation

type ParameterDeclaration 

type ParameterDeclaration struct {

	// The default value of the parameter.
	DefaultValue *string `type:"string"`

	// The description that is associate with the parameter.
	Description *string `type:"string"`

	// Flag that indicates whether the parameter value is shown as plain text in
	// logs and in the AWS Management Console.
	NoEcho *bool `type:"boolean"`

	// The criteria that AWS CloudFormation uses to validate parameter values.
	ParameterConstraints *ParameterConstraints `type:"structure"`

	// The name that is associated with the parameter.
	ParameterKey *string `type:"string"`

	// The type of parameter.
	ParameterType *string `type:"string"`
	// contains filtered or unexported fields
}

The ParameterDeclaration data type.

func (ParameterDeclaration) GoString added in v0.6.6 

func (s ParameterDeclaration) GoString() string

GoString returns the string representation

func (ParameterDeclaration) String added in v0.6.6 

func (s ParameterDeclaration) String() string

String returns the string representation

type SetStackPolicyInput 

type SetStackPolicyInput struct {

	// The name or unique stack ID that you want to associate a policy with.
	StackName *string `type:"string" required:"true"`

	// Structure containing the stack policy body. For more information, go to
	// Prevent Updates to Stack Resources (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html)
	// in the AWS CloudFormation User Guide. You can specify either the StackPolicyBody
	// or the StackPolicyURL parameter, but not both.
	StackPolicyBody *string `min:"1" type:"string"`

	// Location of a file containing the stack policy. The URL must point to a policy
	// (max size: 16KB) located in an S3 bucket in the same region as the stack.
	// You can specify either the StackPolicyBody or the StackPolicyURL parameter,
	// but not both.
	StackPolicyURL *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The input for the SetStackPolicy action.

func (SetStackPolicyInput) GoString added in v0.6.6 

func (s SetStackPolicyInput) GoString() string

GoString returns the string representation

func (SetStackPolicyInput) String added in v0.6.6 

func (s SetStackPolicyInput) String() string

String returns the string representation

type SetStackPolicyOutput 

type SetStackPolicyOutput struct {
	// contains filtered or unexported fields
}

func (SetStackPolicyOutput) GoString added in v0.6.6 

func (s SetStackPolicyOutput) GoString() string

GoString returns the string representation

func (SetStackPolicyOutput) String added in v0.6.6 

func (s SetStackPolicyOutput) String() string

String returns the string representation

type SignalResourceInput 

type SignalResourceInput struct {

	// The logical ID of the resource that you want to signal. The logical ID is
	// the name of the resource that given in the template.
	LogicalResourceId *string `type:"string" required:"true"`

	// The stack name or unique stack ID that includes the resource that you want
	// to signal.
	StackName *string `min:"1" type:"string" required:"true"`

	// The status of the signal, which is either success or failure. A failure signal
	// causes AWS CloudFormation to immediately fail the stack creation or update.
	Status *string `type:"string" required:"true" enum:"ResourceSignalStatus"`

	// A unique ID of the signal. When you signal Amazon EC2 instances or Auto Scaling
	// groups, specify the instance ID that you are signaling as the unique ID.
	// If you send multiple signals to a single resource (such as signaling a wait
	// condition), each signal requires a different unique ID.
	UniqueId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

The input for the SignalResource action.

func (SignalResourceInput) GoString added in v0.6.6 

func (s SignalResourceInput) GoString() string

GoString returns the string representation

func (SignalResourceInput) String added in v0.6.6 

func (s SignalResourceInput) String() string

String returns the string representation

type SignalResourceOutput 

type SignalResourceOutput struct {
	// contains filtered or unexported fields
}

func (SignalResourceOutput) GoString added in v0.6.6 

func (s SignalResourceOutput) GoString() string

GoString returns the string representation

func (SignalResourceOutput) String added in v0.6.6 

func (s SignalResourceOutput) String() string

String returns the string representation

type Stack 

type Stack struct {

	// The capabilities allowed in the stack.
	Capabilities []*string `type:"list"`

	// The time at which the stack was created.
	CreationTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// A user-defined description associated with the stack.
	Description *string `type:"string"`

	// Boolean to enable or disable rollback on stack creation failures:
	//
	//   true: disable rollback false: enable rollback
	DisableRollback *bool `type:"boolean"`

	// The time the stack was last updated. This field will only be returned if
	// the stack has been updated at least once.
	LastUpdatedTime *time.Time `type:"timestamp" timestampFormat:"iso8601"`

	// SNS topic ARNs to which stack related events are published.
	NotificationARNs []*string `type:"list"`

	// A list of output structures.
	Outputs []*Output `type:"list"`

	// A list of Parameter structures.
	Parameters []*Parameter `type:"list"`

	// Unique identifier of the stack.
	StackId *string `type:"string"`

	// The name associated with the stack.
	StackName *string `type:"string" required:"true"`

	// Current status of the stack.
	StackStatus *string `type:"string" required:"true" enum:"StackStatus"`

	// Success/failure message associated with the stack status.
	StackStatusReason *string `type:"string"`

	// A list of Tags that specify cost allocation information for the stack.
	Tags []*Tag `type:"list"`

	// The amount of time within which stack creation should complete.
	TimeoutInMinutes *int64 `min:"1" type:"integer"`
	// contains filtered or unexported fields
}

The Stack data type.

func (Stack) GoString added in v0.6.6 

func (s Stack) GoString() string

GoString returns the string representation

func (Stack) String added in v0.6.6 

func (s Stack) String() string

String returns the string representation

type StackEvent 

type StackEvent struct {

	// The unique ID of this event.
	EventId *string `type:"string" required:"true"`

	// The logical name of the resource specified in the template.
	LogicalResourceId *string `type:"string"`

	// The name or unique identifier associated with the physical instance of the
	// resource.
	PhysicalResourceId *string `type:"string"`

	// BLOB of the properties used to create the resource.
	ResourceProperties *string `type:"string"`

	// Current status of the resource.
	ResourceStatus *string `type:"string" enum:"ResourceStatus"`

	// Success/failure message associated with the resource.
	ResourceStatusReason *string `type:"string"`

	// Type of resource. (For more information, go to  AWS Resource Types Reference
	// (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html)
	// in the AWS CloudFormation User Guide.)
	ResourceType *string `type:"string"`

	// The unique ID name of the instance of the stack.
	StackId *string `type:"string" required:"true"`

	// The name associated with a stack.
	StackName *string `type:"string" required:"true"`

	// Time the status was updated.
	Timestamp *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`
	// contains filtered or unexported fields
}

The StackEvent data type.

func (StackEvent) GoString added in v0.6.6 

func (s StackEvent) GoString() string

GoString returns the string representation

func (StackEvent) String added in v0.6.6 

func (s StackEvent) String() string

String returns the string representation

type StackResource 

type StackResource struct {

	// User defined description associated with the resource.
	Description *string `type:"string"`

	// The logical name of the resource specified in the template.
	LogicalResourceId *string `type:"string" required:"true"`

	// The name or unique identifier that corresponds to a physical instance ID
	// of a resource supported by AWS CloudFormation.
	PhysicalResourceId *string `type:"string"`

	// Current status of the resource.
	ResourceStatus *string `type:"string" required:"true" enum:"ResourceStatus"`

	// Success/failure message associated with the resource.
	ResourceStatusReason *string `type:"string"`

	// Type of resource. (For more information, go to  AWS Resource Types Reference
	// (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html)
	// in the AWS CloudFormation User Guide.)
	ResourceType *string `type:"string" required:"true"`

	// Unique identifier of the stack.
	StackId *string `type:"string"`

	// The name associated with the stack.
	StackName *string `type:"string"`

	// Time the status was updated.
	Timestamp *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`
	// contains filtered or unexported fields
}

The StackResource data type.

func (StackResource) GoString added in v0.6.6 

func (s StackResource) GoString() string

GoString returns the string representation

func (StackResource) String added in v0.6.6 

func (s StackResource) String() string

String returns the string representation

type StackResourceDetail 

type StackResourceDetail struct {

	// User defined description associated with the resource.
	Description *string `type:"string"`

	// Time the status was updated.
	LastUpdatedTimestamp *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// The logical name of the resource specified in the template.
	LogicalResourceId *string `type:"string" required:"true"`

	// The JSON format content of the Metadata attribute declared for the resource.
	// For more information, see Metadata Attribute (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-metadata.html)
	// in the AWS CloudFormation User Guide.
	Metadata *string `type:"string"`

	// The name or unique identifier that corresponds to a physical instance ID
	// of a resource supported by AWS CloudFormation.
	PhysicalResourceId *string `type:"string"`

	// Current status of the resource.
	ResourceStatus *string `type:"string" required:"true" enum:"ResourceStatus"`

	// Success/failure message associated with the resource.
	ResourceStatusReason *string `type:"string"`

	// Type of resource. ((For more information, go to  AWS Resource Types Reference
	// (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html)
	// in the AWS CloudFormation User Guide.)
	ResourceType *string `type:"string" required:"true"`

	// Unique identifier of the stack.
	StackId *string `type:"string"`

	// The name associated with the stack.
	StackName *string `type:"string"`
	// contains filtered or unexported fields
}

Contains detailed information about the specified stack resource.

func (StackResourceDetail) GoString added in v0.6.6 

func (s StackResourceDetail) GoString() string

GoString returns the string representation

func (StackResourceDetail) String added in v0.6.6 

func (s StackResourceDetail) String() string

String returns the string representation

type StackResourceSummary 

type StackResourceSummary struct {

	// Time the status was updated.
	LastUpdatedTimestamp *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// The logical name of the resource specified in the template.
	LogicalResourceId *string `type:"string" required:"true"`

	// The name or unique identifier that corresponds to a physical instance ID
	// of the resource.
	PhysicalResourceId *string `type:"string"`

	// Current status of the resource.
	ResourceStatus *string `type:"string" required:"true" enum:"ResourceStatus"`

	// Success/failure message associated with the resource.
	ResourceStatusReason *string `type:"string"`

	// Type of resource. (For more information, go to  AWS Resource Types Reference
	// (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html)
	// in the AWS CloudFormation User Guide.)
	ResourceType *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains high-level information about the specified stack resource.

func (StackResourceSummary) GoString added in v0.6.6 

func (s StackResourceSummary) GoString() string

GoString returns the string representation

func (StackResourceSummary) String added in v0.6.6 

func (s StackResourceSummary) String() string

String returns the string representation

type StackSummary 

type StackSummary struct {

	// The time the stack was created.
	CreationTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"`

	// The time the stack was deleted.
	DeletionTime *time.Time `type:"timestamp" timestampFormat:"iso8601"`

	// The time the stack was last updated. This field will only be returned if
	// the stack has been updated at least once.
	LastUpdatedTime *time.Time `type:"timestamp" timestampFormat:"iso8601"`

	// Unique stack identifier.
	StackId *string `type:"string"`

	// The name associated with the stack.
	StackName *string `type:"string" required:"true"`

	// The current status of the stack.
	StackStatus *string `type:"string" required:"true" enum:"StackStatus"`

	// Success/Failure message associated with the stack status.
	StackStatusReason *string `type:"string"`

	// The template description of the template used to create the stack.
	TemplateDescription *string `type:"string"`
	// contains filtered or unexported fields
}

The StackSummary Data Type

func (StackSummary) GoString added in v0.6.6 

func (s StackSummary) GoString() string

GoString returns the string representation

func (StackSummary) String added in v0.6.6 

func (s StackSummary) String() string

String returns the string representation

type Tag 

type Tag struct {

	// Required. A string used to identify this tag. You can specify a maximum of
	// 128 characters for a tag key. Tags owned by Amazon Web Services (AWS) have
	// the reserved prefix: aws:.
	Key *string `type:"string"`

	// Required. A string containing the value for this tag. You can specify a maximum
	// of 256 characters for a tag value.
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

The Tag type is used by CreateStack in the Tags parameter. It allows you to specify a key-value pair that can be used to store information related to cost allocation for an AWS CloudFormation stack.

func (Tag) GoString added in v0.6.6 

func (s Tag) GoString() string

GoString returns the string representation

func (Tag) String added in v0.6.6 

func (s Tag) String() string

String returns the string representation

type TemplateParameter 

type TemplateParameter struct {

	// The default value associated with the parameter.
	DefaultValue *string `type:"string"`

	// User defined description associated with the parameter.
	Description *string `type:"string"`

	// Flag indicating whether the parameter should be displayed as plain text in
	// logs and UIs.
	NoEcho *bool `type:"boolean"`

	// The name associated with the parameter.
	ParameterKey *string `type:"string"`
	// contains filtered or unexported fields
}

The TemplateParameter data type.

func (TemplateParameter) GoString added in v0.6.6 

func (s TemplateParameter) GoString() string

GoString returns the string representation

func (TemplateParameter) String added in v0.6.6 

func (s TemplateParameter) String() string

String returns the string representation

type UpdateStackInput 

type UpdateStackInput struct {

	// A list of capabilities that you must specify before AWS CloudFormation can
	// create or update certain stacks. Some stack templates might include resources
	// that can affect permissions in your AWS account. For those stacks, you must
	// explicitly acknowledge their capabilities by specifying this parameter. Currently,
	// the only valid value is CAPABILITY_IAM, which is required for the following
	// resources:  AWS::IAM::AccessKey (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html),
	//  AWS::IAM::Group (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html),
	//  AWS::IAM::InstanceProfile (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html),
	//  AWS::IAM::Policy (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html),
	//  AWS::IAM::Role (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html),
	//  AWS::IAM::User (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html),
	// and  AWS::IAM::UserToGroupAddition (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html).
	// If your stack template contains these resources, we recommend that you review
	// any permissions associated with them. If you don't specify this parameter,
	// this action returns an InsufficientCapabilities error.
	Capabilities []*string `type:"list"`

	// Amazon Simple Notification Service topic Amazon Resource Names (ARNs) that
	// AWS CloudFormation associates with the stack. Specify an empty list to remove
	// all notification topics.
	NotificationARNs []*string `type:"list"`

	// A list of Parameter structures that specify input parameters for the stack.
	// For more information, see the Parameter (http://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html)
	// data type.
	Parameters []*Parameter `type:"list"`

	// The template resource types that you have permissions to work with for this
	// update stack action, such as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance.
	//
	// If the list of resource types doesn't include a resource that you're updating,
	// the stack update fails. By default, AWS CloudFormation grants permissions
	// to all resource types. AWS Identity and Access Management (IAM) uses this
	// parameter for AWS CloudFormation-specific condition keys in IAM policies.
	// For more information, see Controlling Access with AWS Identity and Access
	// Management (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html).
	ResourceTypes []*string `type:"list"`

	// The name or unique stack ID of the stack to update.
	StackName *string `type:"string" required:"true"`

	// Structure containing a new stack policy body. You can specify either the
	// StackPolicyBody or the StackPolicyURL parameter, but not both.
	//
	// You might update the stack policy, for example, in order to protect a new
	// resource that you created during a stack update. If you do not specify a
	// stack policy, the current policy that is associated with the stack is unchanged.
	StackPolicyBody *string `min:"1" type:"string"`

	// Structure containing the temporary overriding stack policy body. You can
	// specify either the StackPolicyDuringUpdateBody or the StackPolicyDuringUpdateURL
	// parameter, but not both.
	//
	// If you want to update protected resources, specify a temporary overriding
	// stack policy during this update. If you do not specify a stack policy, the
	// current policy that is associated with the stack will be used.
	StackPolicyDuringUpdateBody *string `min:"1" type:"string"`

	// Location of a file containing the temporary overriding stack policy. The
	// URL must point to a policy (max size: 16KB) located in an S3 bucket in the
	// same region as the stack. You can specify either the StackPolicyDuringUpdateBody
	// or the StackPolicyDuringUpdateURL parameter, but not both.
	//
	// If you want to update protected resources, specify a temporary overriding
	// stack policy during this update. If you do not specify a stack policy, the
	// current policy that is associated with the stack will be used.
	StackPolicyDuringUpdateURL *string `min:"1" type:"string"`

	// Location of a file containing the updated stack policy. The URL must point
	// to a policy (max size: 16KB) located in an S3 bucket in the same region as
	// the stack. You can specify either the StackPolicyBody or the StackPolicyURL
	// parameter, but not both.
	//
	// You might update the stack policy, for example, in order to protect a new
	// resource that you created during a stack update. If you do not specify a
	// stack policy, the current policy that is associated with the stack is unchanged.
	StackPolicyURL *string `min:"1" type:"string"`

	// Key-value pairs to associate with this stack. AWS CloudFormation also propagates
	// these tags to supported resources in the stack. You can specify a maximum
	// number of 10 tags.
	//
	// If you don't specify this parameter, AWS CloudFormation doesn't modify the
	// stack's tags. If you specify an empty value, AWS CloudFormation removes all
	// associated tags.
	Tags []*Tag `type:"list"`

	// Structure containing the template body with a minimum length of 1 byte and
	// a maximum length of 51,200 bytes. (For more information, go to Template Anatomy
	// (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html)
	// in the AWS CloudFormation User Guide.)
	//
	// Conditional: You must specify either the TemplateBody or the TemplateURL
	// parameter, but not both.
	TemplateBody *string `min:"1" type:"string"`

	// Location of file containing the template body. The URL must point to a template
	// that is located in an Amazon S3 bucket. For more information, go to Template
	// Anatomy (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html)
	// in the AWS CloudFormation User Guide.
	//
	// Conditional: You must specify either the TemplateBody or the TemplateURL
	// parameter, but not both.
	TemplateURL *string `min:"1" type:"string"`

	// Reuse the existing template that is associated with the stack that you are
	// updating.
	UsePreviousTemplate *bool `type:"boolean"`
	// contains filtered or unexported fields
}

The input for UpdateStack action.

func (UpdateStackInput) GoString added in v0.6.6 

func (s UpdateStackInput) GoString() string

GoString returns the string representation

func (UpdateStackInput) String added in v0.6.6 

func (s UpdateStackInput) String() string

String returns the string representation

type UpdateStackOutput 

type UpdateStackOutput struct {

	// Unique identifier of the stack.
	StackId *string `type:"string"`
	// contains filtered or unexported fields
}

The output for a UpdateStack action.

func (UpdateStackOutput) GoString added in v0.6.6 

func (s UpdateStackOutput) GoString() string

GoString returns the string representation

func (UpdateStackOutput) String added in v0.6.6 

func (s UpdateStackOutput) String() string

String returns the string representation

type ValidateTemplateInput 

type ValidateTemplateInput struct {

	// Structure containing the template body with a minimum length of 1 byte and
	// a maximum length of 51,200 bytes. For more information, go to Template Anatomy
	// (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html)
	// in the AWS CloudFormation User Guide.
	//
	// Conditional: You must pass TemplateURL or TemplateBody. If both are passed,
	// only TemplateBody is used.
	TemplateBody *string `min:"1" type:"string"`

	// 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. For more
	// information, go to Template Anatomy (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html)
	// in the AWS CloudFormation User Guide.
	//
	// Conditional: You must pass TemplateURL or TemplateBody. If both are passed,
	// only TemplateBody is used.
	TemplateURL *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The input for ValidateTemplate action.

func (ValidateTemplateInput) GoString added in v0.6.6 

func (s ValidateTemplateInput) GoString() string

GoString returns the string representation

func (ValidateTemplateInput) String added in v0.6.6 

func (s ValidateTemplateInput) String() string

String returns the string representation

type ValidateTemplateOutput 

type ValidateTemplateOutput struct {

	// The capabilities found within the template. Currently, AWS CloudFormation
	// supports only the CAPABILITY_IAM capability. If your template contains IAM
	// resources, you must specify the CAPABILITY_IAM value for this parameter when
	// you use the CreateStack or UpdateStack actions with your template; otherwise,
	// those actions return an InsufficientCapabilities error.
	Capabilities []*string `type:"list"`

	// The list of resources that generated the values in the Capabilities response
	// element.
	CapabilitiesReason *string `type:"string"`

	// The description found within the template.
	Description *string `type:"string"`

	// A list of TemplateParameter structures.
	Parameters []*TemplateParameter `type:"list"`
	// contains filtered or unexported fields
}

The output for ValidateTemplate action.

func (ValidateTemplateOutput) GoString added in v0.6.6 

func (s ValidateTemplateOutput) GoString() string

GoString returns the string representation

func (ValidateTemplateOutput) String added in v0.6.6 

func (s ValidateTemplateOutput) String() string

String returns the string representation

Source Files

View all Source files

Directories

Path Synopsis
Package cloudformationiface provides an interface for the AWS CloudFormation.
 Package cloudformationiface provides an interface for the AWS CloudFormation.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.