Documentation ¶
Overview ¶
Package cloudformation provides a client for AWS CloudFormation.
Index ¶
- Constants
- type AccountLimit
- type CancelUpdateStackInput
- type CancelUpdateStackOutput
- type Change
- type ChangeSetSummary
- type CloudFormation
- func (c *CloudFormation) CancelUpdateStack(input *CancelUpdateStackInput) (*CancelUpdateStackOutput, error)
- func (c *CloudFormation) CancelUpdateStackRequest(input *CancelUpdateStackInput) (req *request.Request, output *CancelUpdateStackOutput)
- func (c *CloudFormation) ContinueUpdateRollback(input *ContinueUpdateRollbackInput) (*ContinueUpdateRollbackOutput, error)
- func (c *CloudFormation) ContinueUpdateRollbackRequest(input *ContinueUpdateRollbackInput) (req *request.Request, output *ContinueUpdateRollbackOutput)
- func (c *CloudFormation) CreateChangeSet(input *CreateChangeSetInput) (*CreateChangeSetOutput, error)
- func (c *CloudFormation) CreateChangeSetRequest(input *CreateChangeSetInput) (req *request.Request, output *CreateChangeSetOutput)
- func (c *CloudFormation) CreateStack(input *CreateStackInput) (*CreateStackOutput, error)
- func (c *CloudFormation) CreateStackRequest(input *CreateStackInput) (req *request.Request, output *CreateStackOutput)
- func (c *CloudFormation) DeleteChangeSet(input *DeleteChangeSetInput) (*DeleteChangeSetOutput, error)
- func (c *CloudFormation) DeleteChangeSetRequest(input *DeleteChangeSetInput) (req *request.Request, output *DeleteChangeSetOutput)
- func (c *CloudFormation) DeleteStack(input *DeleteStackInput) (*DeleteStackOutput, error)
- func (c *CloudFormation) DeleteStackRequest(input *DeleteStackInput) (req *request.Request, output *DeleteStackOutput)
- func (c *CloudFormation) DescribeAccountLimits(input *DescribeAccountLimitsInput) (*DescribeAccountLimitsOutput, error)
- func (c *CloudFormation) DescribeAccountLimitsRequest(input *DescribeAccountLimitsInput) (req *request.Request, output *DescribeAccountLimitsOutput)
- func (c *CloudFormation) DescribeChangeSet(input *DescribeChangeSetInput) (*DescribeChangeSetOutput, error)
- func (c *CloudFormation) DescribeChangeSetRequest(input *DescribeChangeSetInput) (req *request.Request, output *DescribeChangeSetOutput)
- func (c *CloudFormation) DescribeStackEvents(input *DescribeStackEventsInput) (*DescribeStackEventsOutput, error)
- func (c *CloudFormation) DescribeStackEventsPages(input *DescribeStackEventsInput, ...) error
- func (c *CloudFormation) DescribeStackEventsRequest(input *DescribeStackEventsInput) (req *request.Request, output *DescribeStackEventsOutput)
- func (c *CloudFormation) DescribeStackResource(input *DescribeStackResourceInput) (*DescribeStackResourceOutput, error)
- func (c *CloudFormation) DescribeStackResourceRequest(input *DescribeStackResourceInput) (req *request.Request, output *DescribeStackResourceOutput)
- func (c *CloudFormation) DescribeStackResources(input *DescribeStackResourcesInput) (*DescribeStackResourcesOutput, error)
- func (c *CloudFormation) DescribeStackResourcesRequest(input *DescribeStackResourcesInput) (req *request.Request, output *DescribeStackResourcesOutput)
- func (c *CloudFormation) DescribeStacks(input *DescribeStacksInput) (*DescribeStacksOutput, error)
- func (c *CloudFormation) DescribeStacksPages(input *DescribeStacksInput, ...) error
- func (c *CloudFormation) DescribeStacksRequest(input *DescribeStacksInput) (req *request.Request, output *DescribeStacksOutput)
- func (c *CloudFormation) EstimateTemplateCost(input *EstimateTemplateCostInput) (*EstimateTemplateCostOutput, error)
- func (c *CloudFormation) EstimateTemplateCostRequest(input *EstimateTemplateCostInput) (req *request.Request, output *EstimateTemplateCostOutput)
- func (c *CloudFormation) ExecuteChangeSet(input *ExecuteChangeSetInput) (*ExecuteChangeSetOutput, error)
- func (c *CloudFormation) ExecuteChangeSetRequest(input *ExecuteChangeSetInput) (req *request.Request, output *ExecuteChangeSetOutput)
- func (c *CloudFormation) GetStackPolicy(input *GetStackPolicyInput) (*GetStackPolicyOutput, error)
- func (c *CloudFormation) GetStackPolicyRequest(input *GetStackPolicyInput) (req *request.Request, output *GetStackPolicyOutput)
- func (c *CloudFormation) GetTemplate(input *GetTemplateInput) (*GetTemplateOutput, error)
- func (c *CloudFormation) GetTemplateRequest(input *GetTemplateInput) (req *request.Request, output *GetTemplateOutput)
- func (c *CloudFormation) GetTemplateSummary(input *GetTemplateSummaryInput) (*GetTemplateSummaryOutput, error)
- func (c *CloudFormation) GetTemplateSummaryRequest(input *GetTemplateSummaryInput) (req *request.Request, output *GetTemplateSummaryOutput)
- func (c *CloudFormation) ListChangeSets(input *ListChangeSetsInput) (*ListChangeSetsOutput, error)
- func (c *CloudFormation) ListChangeSetsRequest(input *ListChangeSetsInput) (req *request.Request, output *ListChangeSetsOutput)
- func (c *CloudFormation) ListStackResources(input *ListStackResourcesInput) (*ListStackResourcesOutput, error)
- func (c *CloudFormation) ListStackResourcesPages(input *ListStackResourcesInput, ...) error
- func (c *CloudFormation) ListStackResourcesRequest(input *ListStackResourcesInput) (req *request.Request, output *ListStackResourcesOutput)
- func (c *CloudFormation) ListStacks(input *ListStacksInput) (*ListStacksOutput, error)
- func (c *CloudFormation) ListStacksPages(input *ListStacksInput, ...) error
- func (c *CloudFormation) ListStacksRequest(input *ListStacksInput) (req *request.Request, output *ListStacksOutput)
- func (c *CloudFormation) SetStackPolicy(input *SetStackPolicyInput) (*SetStackPolicyOutput, error)
- func (c *CloudFormation) SetStackPolicyRequest(input *SetStackPolicyInput) (req *request.Request, output *SetStackPolicyOutput)
- func (c *CloudFormation) SignalResource(input *SignalResourceInput) (*SignalResourceOutput, error)
- func (c *CloudFormation) SignalResourceRequest(input *SignalResourceInput) (req *request.Request, output *SignalResourceOutput)
- func (c *CloudFormation) UpdateStack(input *UpdateStackInput) (*UpdateStackOutput, error)
- func (c *CloudFormation) UpdateStackRequest(input *UpdateStackInput) (req *request.Request, output *UpdateStackOutput)
- func (c *CloudFormation) ValidateTemplate(input *ValidateTemplateInput) (*ValidateTemplateOutput, error)
- func (c *CloudFormation) ValidateTemplateRequest(input *ValidateTemplateInput) (req *request.Request, output *ValidateTemplateOutput)
- func (c *CloudFormation) WaitUntilStackCreateComplete(input *DescribeStacksInput) error
- func (c *CloudFormation) WaitUntilStackDeleteComplete(input *DescribeStacksInput) error
- func (c *CloudFormation) WaitUntilStackExists(input *DescribeStacksInput) error
- func (c *CloudFormation) WaitUntilStackUpdateComplete(input *DescribeStacksInput) error
- type ContinueUpdateRollbackInput
- type ContinueUpdateRollbackOutput
- type CreateChangeSetInput
- type CreateChangeSetOutput
- type CreateStackInput
- type CreateStackOutput
- type DeleteChangeSetInput
- type DeleteChangeSetOutput
- type DeleteStackInput
- type DeleteStackOutput
- type DescribeAccountLimitsInput
- type DescribeAccountLimitsOutput
- type DescribeChangeSetInput
- type DescribeChangeSetOutput
- type DescribeStackEventsInput
- type DescribeStackEventsOutput
- type DescribeStackResourceInput
- type DescribeStackResourceOutput
- type DescribeStackResourcesInput
- type DescribeStackResourcesOutput
- type DescribeStacksInput
- type DescribeStacksOutput
- type EstimateTemplateCostInput
- type EstimateTemplateCostOutput
- type ExecuteChangeSetInput
- type ExecuteChangeSetOutput
- type GetStackPolicyInput
- type GetStackPolicyOutput
- type GetTemplateInput
- type GetTemplateOutput
- type GetTemplateSummaryInput
- type GetTemplateSummaryOutput
- type ListChangeSetsInput
- type ListChangeSetsOutput
- type ListStackResourcesInput
- type ListStackResourcesOutput
- type ListStacksInput
- type ListStacksOutput
- type Output
- type Parameter
- type ParameterConstraints
- type ParameterDeclaration
- type ResourceChange
- type ResourceChangeDetail
- type ResourceTargetDefinition
- type SetStackPolicyInput
- type SetStackPolicyOutput
- type SignalResourceInput
- type SignalResourceOutput
- type Stack
- type StackEvent
- type StackResource
- type StackResourceDetail
- type StackResourceSummary
- type StackSummary
- type Tag
- type TemplateParameter
- type UpdateStackInput
- type UpdateStackOutput
- type ValidateTemplateInput
- type ValidateTemplateOutput
Examples ¶
- CloudFormation.CancelUpdateStack
- CloudFormation.ContinueUpdateRollback
- CloudFormation.CreateChangeSet
- CloudFormation.CreateStack
- CloudFormation.DeleteChangeSet
- CloudFormation.DeleteStack
- CloudFormation.DescribeAccountLimits
- CloudFormation.DescribeChangeSet
- CloudFormation.DescribeStackEvents
- CloudFormation.DescribeStackResource
- CloudFormation.DescribeStackResources
- CloudFormation.DescribeStacks
- CloudFormation.EstimateTemplateCost
- CloudFormation.ExecuteChangeSet
- CloudFormation.GetStackPolicy
- CloudFormation.GetTemplate
- CloudFormation.GetTemplateSummary
- CloudFormation.ListChangeSets
- CloudFormation.ListStackResources
- CloudFormation.ListStacks
- CloudFormation.SetStackPolicy
- CloudFormation.SignalResource
- CloudFormation.UpdateStack
- CloudFormation.ValidateTemplate
Constants ¶
const ( // CapabilityCapabilityIam is a Capability enum value CapabilityCapabilityIam = "CAPABILITY_IAM" // CapabilityCapabilityNamedIam is a Capability enum value CapabilityCapabilityNamedIam = "CAPABILITY_NAMED_IAM" )
const ( // ChangeActionAdd is a ChangeAction enum value ChangeActionAdd = "Add" // ChangeActionModify is a ChangeAction enum value ChangeActionModify = "Modify" // ChangeActionRemove is a ChangeAction enum value ChangeActionRemove = "Remove" )
const ( // ChangeSetStatusCreatePending is a ChangeSetStatus enum value ChangeSetStatusCreatePending = "CREATE_PENDING" // ChangeSetStatusCreateInProgress is a ChangeSetStatus enum value ChangeSetStatusCreateInProgress = "CREATE_IN_PROGRESS" // ChangeSetStatusCreateComplete is a ChangeSetStatus enum value ChangeSetStatusCreateComplete = "CREATE_COMPLETE" // ChangeSetStatusDeleteComplete is a ChangeSetStatus enum value ChangeSetStatusDeleteComplete = "DELETE_COMPLETE" // ChangeSetStatusFailed is a ChangeSetStatus enum value ChangeSetStatusFailed = "FAILED" )
const ( // ChangeSourceResourceReference is a ChangeSource enum value ChangeSourceResourceReference = "ResourceReference" // ChangeSourceParameterReference is a ChangeSource enum value ChangeSourceParameterReference = "ParameterReference" // ChangeSourceResourceAttribute is a ChangeSource enum value ChangeSourceResourceAttribute = "ResourceAttribute" // ChangeSourceDirectModification is a ChangeSource enum value ChangeSourceDirectModification = "DirectModification" // ChangeSourceAutomatic is a ChangeSource enum value ChangeSourceAutomatic = "Automatic" )
const ( // EvaluationTypeStatic is a EvaluationType enum value EvaluationTypeStatic = "Static" // EvaluationTypeDynamic is a EvaluationType enum value EvaluationTypeDynamic = "Dynamic" )
const ( // ExecutionStatusAvailable is a ExecutionStatus enum value ExecutionStatusAvailable = "AVAILABLE" // ExecutionStatusExecuteInProgress is a ExecutionStatus enum value ExecutionStatusExecuteInProgress = "EXECUTE_IN_PROGRESS" // ExecutionStatusExecuteComplete is a ExecutionStatus enum value ExecutionStatusExecuteComplete = "EXECUTE_COMPLETE" // ExecutionStatusExecuteFailed is a ExecutionStatus enum value ExecutionStatusExecuteFailed = "EXECUTE_FAILED" // ExecutionStatusObsolete is a ExecutionStatus enum value ExecutionStatusObsolete = "OBSOLETE" )ExecutionStatusUnavailable = "UNAVAILABLE"
const ( // OnFailureDoNothing is a OnFailure enum value OnFailureDoNothing = "DO_NOTHING" // OnFailureRollback is a OnFailure enum value OnFailureRollback = "ROLLBACK" // OnFailureDelete is a OnFailure enum value OnFailureDelete = "DELETE" )
const ( // ReplacementTrue is a Replacement enum value ReplacementTrue = "True" // ReplacementFalse is a Replacement enum value ReplacementFalse = "False" // ReplacementConditional is a Replacement enum value ReplacementConditional = "Conditional" )
const ( // RequiresRecreationNever is a RequiresRecreation enum value RequiresRecreationNever = "Never" // RequiresRecreationConditionally is a RequiresRecreation enum value RequiresRecreationConditionally = "Conditionally" // RequiresRecreationAlways is a RequiresRecreation enum value RequiresRecreationAlways = "Always" )
const ( // ResourceAttributeProperties is a ResourceAttribute enum value ResourceAttributeProperties = "Properties" // ResourceAttributeMetadata is a ResourceAttribute enum value ResourceAttributeMetadata = "Metadata" // ResourceAttributeCreationPolicy is a ResourceAttribute enum value ResourceAttributeCreationPolicy = "CreationPolicy" // ResourceAttributeUpdatePolicy is a ResourceAttribute enum value ResourceAttributeUpdatePolicy = "UpdatePolicy" // ResourceAttributeDeletionPolicy is a ResourceAttribute enum value ResourceAttributeDeletionPolicy = "DeletionPolicy" // ResourceAttributeTags is a ResourceAttribute enum value ResourceAttributeTags = "Tags" )
const ( // ResourceSignalStatusSuccess is a ResourceSignalStatus enum value ResourceSignalStatusSuccess = "SUCCESS" // ResourceSignalStatusFailure is a ResourceSignalStatus enum value ResourceSignalStatusFailure = "FAILURE" )
const ( // ResourceStatusCreateInProgress is a ResourceStatus enum value ResourceStatusCreateInProgress = "CREATE_IN_PROGRESS" // ResourceStatusCreateFailed is a ResourceStatus enum value ResourceStatusCreateFailed = "CREATE_FAILED" // ResourceStatusCreateComplete is a ResourceStatus enum value ResourceStatusCreateComplete = "CREATE_COMPLETE" // ResourceStatusDeleteInProgress is a ResourceStatus enum value ResourceStatusDeleteInProgress = "DELETE_IN_PROGRESS" // ResourceStatusDeleteFailed is a ResourceStatus enum value ResourceStatusDeleteFailed = "DELETE_FAILED" // ResourceStatusDeleteComplete is a ResourceStatus enum value ResourceStatusDeleteComplete = "DELETE_COMPLETE" // ResourceStatusDeleteSkipped is a ResourceStatus enum value ResourceStatusDeleteSkipped = "DELETE_SKIPPED" // ResourceStatusUpdateInProgress is a ResourceStatus enum value ResourceStatusUpdateInProgress = "UPDATE_IN_PROGRESS" // ResourceStatusUpdateFailed is a ResourceStatus enum value ResourceStatusUpdateFailed = "UPDATE_FAILED" // ResourceStatusUpdateComplete is a ResourceStatus enum value ResourceStatusUpdateComplete = "UPDATE_COMPLETE" )
const ( // StackStatusCreateInProgress is a StackStatus enum value StackStatusCreateInProgress = "CREATE_IN_PROGRESS" // StackStatusCreateFailed is a StackStatus enum value StackStatusCreateFailed = "CREATE_FAILED" // StackStatusCreateComplete is a StackStatus enum value StackStatusCreateComplete = "CREATE_COMPLETE" // StackStatusRollbackInProgress is a StackStatus enum value StackStatusRollbackInProgress = "ROLLBACK_IN_PROGRESS" // StackStatusRollbackFailed is a StackStatus enum value StackStatusRollbackFailed = "ROLLBACK_FAILED" // StackStatusRollbackComplete is a StackStatus enum value StackStatusRollbackComplete = "ROLLBACK_COMPLETE" // StackStatusDeleteInProgress is a StackStatus enum value StackStatusDeleteInProgress = "DELETE_IN_PROGRESS" // StackStatusDeleteFailed is a StackStatus enum value StackStatusDeleteFailed = "DELETE_FAILED" // StackStatusDeleteComplete is a StackStatus enum value StackStatusDeleteComplete = "DELETE_COMPLETE" // StackStatusUpdateInProgress is a StackStatus enum value StackStatusUpdateInProgress = "UPDATE_IN_PROGRESS" // StackStatusUpdateCompleteCleanupInProgress is a StackStatus enum value StackStatusUpdateCompleteCleanupInProgress = "UPDATE_COMPLETE_CLEANUP_IN_PROGRESS" // StackStatusUpdateComplete is a StackStatus enum value StackStatusUpdateComplete = "UPDATE_COMPLETE" // StackStatusUpdateRollbackInProgress is a StackStatus enum value StackStatusUpdateRollbackInProgress = "UPDATE_ROLLBACK_IN_PROGRESS" // StackStatusUpdateRollbackFailed is a StackStatus enum value StackStatusUpdateRollbackFailed = "UPDATE_ROLLBACK_FAILED" // StackStatusUpdateRollbackCompleteCleanupInProgress is a StackStatus enum value StackStatusUpdateRollbackCompleteCleanupInProgress = "UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS" // StackStatusUpdateRollbackComplete is a StackStatus enum value StackStatusUpdateRollbackComplete = "UPDATE_ROLLBACK_COMPLETE" )
const (
// ChangeTypeResource is a ChangeType enum value
ChangeTypeResource = "Resource"
)
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 ¶
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 ¶
func (s AccountLimit) GoString() string
GoString returns the string representation
func (AccountLimit) String ¶
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 is a required field StackName *string `type:"string" required:"true"` // contains filtered or unexported fields }
The input for the CancelUpdateStack action.
func (CancelUpdateStackInput) GoString ¶
func (s CancelUpdateStackInput) GoString() string
GoString returns the string representation
func (CancelUpdateStackInput) String ¶
func (s CancelUpdateStackInput) String() string
String returns the string representation
func (*CancelUpdateStackInput) Validate ¶
func (s *CancelUpdateStackInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CancelUpdateStackOutput ¶
type CancelUpdateStackOutput struct {
// contains filtered or unexported fields
}
func (CancelUpdateStackOutput) GoString ¶
func (s CancelUpdateStackOutput) GoString() string
GoString returns the string representation
func (CancelUpdateStackOutput) String ¶
func (s CancelUpdateStackOutput) String() string
String returns the string representation
type Change ¶
type Change struct { // A ResourceChange structure that describes the resource and action that AWS // CloudFormation will perform. ResourceChange *ResourceChange `type:"structure"` // The type of entity that AWS CloudFormation changes. Currently, the only entity // type is Resource. Type *string `type:"string" enum:"ChangeType"` // contains filtered or unexported fields }
The Change structure describes the changes AWS CloudFormation will perform if you execute the change set.
type ChangeSetSummary ¶
type ChangeSetSummary struct { // The ID of the change set. ChangeSetId *string `min:"1" type:"string"` // The name of the change set. ChangeSetName *string `min:"1" type:"string"` // The start time when the change set was created, in UTC. CreationTime *time.Time `type:"timestamp" timestampFormat:"iso8601"` // Descriptive information about the change set. Description *string `min:"1" type:"string"` // If the change set execution status is AVAILABLE, you can execute the change // set. If you can’t execute the change set, the status indicates why. For example, // a change set might be in an UNAVAILABLE state because AWS CloudFormation // is still creating it or in an OBSOLETE state because the stack was already // updated. ExecutionStatus *string `type:"string" enum:"ExecutionStatus"` // The ID of the stack with which the change set is associated. StackId *string `type:"string"` // The name of the stack with which the change set is associated. StackName *string `type:"string"` // The state of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, // or FAILED. Status *string `type:"string" enum:"ChangeSetStatus"` // A description of the change set's status. For example, if your change set // is in the FAILED state, AWS CloudFormation shows the error message. StatusReason *string `type:"string"` // contains filtered or unexported fields }
The ChangeSetSummary structure describes a change set, its status, and the stack with which it's associated.
func (ChangeSetSummary) GoString ¶
func (s ChangeSetSummary) GoString() string
GoString returns the string representation
func (ChangeSetSummary) String ¶
func (s ChangeSetSummary) String() string
String returns the string representation
type CloudFormation ¶
AWS CloudFormation enables you to create and manage AWS infrastructure deployments predictably and repeatedly. AWS CloudFormation helps you leverage AWS products such as Amazon EC2, EBS, Amazon SNS, ELB, and Auto Scaling to build highly-reliable, highly scalable, cost effective applications without worrying about creating and configuring the underlying AWS infrastructure.
With AWS CloudFormation, you declare all of your resources and dependencies in a template file. The template defines a collection of resources as a single unit called a stack. AWS CloudFormation creates and deletes all member resources of the stack together and manages all dependencies between the resources for you.
For more information about this product, go to the CloudFormation Product Page (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/ (http://docs.aws.amazon.com/). 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)
CancelUpdateStack API operation for AWS CloudFormation.
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.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS CloudFormation's API operation CancelUpdateStack for usage and error information.
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() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := cloudformation.New(sess) 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 "aws/request.Request" representing the client's request for the CancelUpdateStack operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See CancelUpdateStack for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CancelUpdateStack method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the CancelUpdateStackRequest method. req, resp := client.CancelUpdateStackRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*CloudFormation) ContinueUpdateRollback ¶
func (c *CloudFormation) ContinueUpdateRollback(input *ContinueUpdateRollbackInput) (*ContinueUpdateRollbackOutput, error)
ContinueUpdateRollback API operation for AWS CloudFormation.
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.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS CloudFormation's API operation ContinueUpdateRollback for usage and error information.
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() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := cloudformation.New(sess) params := &cloudformation.ContinueUpdateRollbackInput{ StackName: aws.String("StackNameOrId"), // Required RoleARN: aws.String("RoleARN"), } 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 ¶
func (c *CloudFormation) ContinueUpdateRollbackRequest(input *ContinueUpdateRollbackInput) (req *request.Request, output *ContinueUpdateRollbackOutput)
ContinueUpdateRollbackRequest generates a "aws/request.Request" representing the client's request for the ContinueUpdateRollback operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See ContinueUpdateRollback for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ContinueUpdateRollback method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the ContinueUpdateRollbackRequest method. req, resp := client.ContinueUpdateRollbackRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*CloudFormation) CreateChangeSet ¶
func (c *CloudFormation) CreateChangeSet(input *CreateChangeSetInput) (*CreateChangeSetOutput, error)
CreateChangeSet API operation for AWS CloudFormation.
Creates a list of changes for a stack. AWS CloudFormation generates the change set by comparing the stack's information with the information that you submit. A change set can help you understand which resources AWS CloudFormation will change and how it will change them before you update your stack. Change sets allow you to check before you make a change so that you don't delete or replace critical resources.
AWS CloudFormation doesn't make any changes to the stack when you create a change set. To make the specified changes, you must execute the change set by using the ExecuteChangeSet action.
After the call successfully completes, AWS CloudFormation starts creating the change set. To check the status of the change set, use the DescribeChangeSet action.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS CloudFormation's API operation CreateChangeSet for usage and error information.
Returned Error Codes:
AlreadyExistsException Resource with the name requested already exists.
InsufficientCapabilitiesException The template contains resources with capabilities that were not specified in the Capabilities parameter.
LimitExceededException Quota for the resource has already been reached.
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() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := cloudformation.New(sess) params := &cloudformation.CreateChangeSetInput{ ChangeSetName: aws.String("ChangeSetName"), // Required StackName: aws.String("StackNameOrId"), // Required Capabilities: []*string{ aws.String("Capability"), // Required // More values... }, ClientToken: aws.String("ClientToken"), Description: aws.String("Description"), 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... }, RoleARN: aws.String("RoleARN"), 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.CreateChangeSet(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) CreateChangeSetRequest ¶
func (c *CloudFormation) CreateChangeSetRequest(input *CreateChangeSetInput) (req *request.Request, output *CreateChangeSetOutput)
CreateChangeSetRequest generates a "aws/request.Request" representing the client's request for the CreateChangeSet operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See CreateChangeSet for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateChangeSet method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the CreateChangeSetRequest method. req, resp := client.CreateChangeSetRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*CloudFormation) CreateStack ¶
func (c *CloudFormation) CreateStack(input *CreateStackInput) (*CreateStackOutput, error)
CreateStack API operation for AWS CloudFormation.
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.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS CloudFormation's API operation CreateStack for usage and error information.
Returned Error Codes:
LimitExceededException Quota for the resource has already been reached.
AlreadyExistsException Resource with the name requested already exists.
InsufficientCapabilitiesException The template contains resources with capabilities that were not specified in the Capabilities parameter.
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() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := cloudformation.New(sess) 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... }, RoleARN: aws.String("RoleARN"), 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 "aws/request.Request" representing the client's request for the CreateStack operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See CreateStack for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateStack method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the CreateStackRequest method. req, resp := client.CreateStackRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*CloudFormation) DeleteChangeSet ¶
func (c *CloudFormation) DeleteChangeSet(input *DeleteChangeSetInput) (*DeleteChangeSetOutput, error)
DeleteChangeSet API operation for AWS CloudFormation.
Deletes the specified change set. Deleting change sets ensures that no one executes the wrong change set.
If the call successfully completes, AWS CloudFormation successfully deleted the change set.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS CloudFormation's API operation DeleteChangeSet for usage and error information.
Returned Error Codes:
- InvalidChangeSetStatus The specified change set cannot be used to update the stack. For example, the change set status might be CREATE_IN_PROGRESS or the stack status might be UPDATE_IN_PROGRESS.
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() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := cloudformation.New(sess) params := &cloudformation.DeleteChangeSetInput{ ChangeSetName: aws.String("ChangeSetNameOrId"), // Required StackName: aws.String("StackNameOrId"), } resp, err := svc.DeleteChangeSet(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) DeleteChangeSetRequest ¶
func (c *CloudFormation) DeleteChangeSetRequest(input *DeleteChangeSetInput) (req *request.Request, output *DeleteChangeSetOutput)
DeleteChangeSetRequest generates a "aws/request.Request" representing the client's request for the DeleteChangeSet operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See DeleteChangeSet for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteChangeSet method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DeleteChangeSetRequest method. req, resp := client.DeleteChangeSetRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*CloudFormation) DeleteStack ¶
func (c *CloudFormation) DeleteStack(input *DeleteStackInput) (*DeleteStackOutput, error)
DeleteStack API operation for AWS CloudFormation.
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.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS CloudFormation's API operation DeleteStack for usage and error information.
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() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := cloudformation.New(sess) params := &cloudformation.DeleteStackInput{ StackName: aws.String("StackName"), // Required RetainResources: []*string{ aws.String("LogicalResourceId"), // Required // More values... }, RoleARN: aws.String("RoleARN"), } 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 "aws/request.Request" representing the client's request for the DeleteStack operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See DeleteStack for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteStack method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DeleteStackRequest method. req, resp := client.DeleteStackRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*CloudFormation) DescribeAccountLimits ¶
func (c *CloudFormation) DescribeAccountLimits(input *DescribeAccountLimitsInput) (*DescribeAccountLimitsOutput, error)
DescribeAccountLimits API operation for AWS CloudFormation.
Retrieves your account's AWS CloudFormation limits, such as the maximum number of stacks that you can create in your account.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS CloudFormation's API operation DescribeAccountLimits for usage and error information.
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() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := cloudformation.New(sess) 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 ¶
func (c *CloudFormation) DescribeAccountLimitsRequest(input *DescribeAccountLimitsInput) (req *request.Request, output *DescribeAccountLimitsOutput)
DescribeAccountLimitsRequest generates a "aws/request.Request" representing the client's request for the DescribeAccountLimits operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See DescribeAccountLimits for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeAccountLimits method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DescribeAccountLimitsRequest method. req, resp := client.DescribeAccountLimitsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*CloudFormation) DescribeChangeSet ¶
func (c *CloudFormation) DescribeChangeSet(input *DescribeChangeSetInput) (*DescribeChangeSetOutput, error)
DescribeChangeSet API operation for AWS CloudFormation.
Returns the inputs for the change set and a list of changes that AWS CloudFormation will make if you execute the change set. For more information, see Updating Stacks Using Change Sets (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-changesets.html) in the AWS CloudFormation User Guide.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS CloudFormation's API operation DescribeChangeSet for usage and error information.
Returned Error Codes:
- ChangeSetNotFound The specified change set name or ID doesn't exit. To view valid change sets for a stack, use the ListChangeSets action.
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() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := cloudformation.New(sess) params := &cloudformation.DescribeChangeSetInput{ ChangeSetName: aws.String("ChangeSetNameOrId"), // Required NextToken: aws.String("NextToken"), StackName: aws.String("StackNameOrId"), } resp, err := svc.DescribeChangeSet(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) DescribeChangeSetRequest ¶
func (c *CloudFormation) DescribeChangeSetRequest(input *DescribeChangeSetInput) (req *request.Request, output *DescribeChangeSetOutput)
DescribeChangeSetRequest generates a "aws/request.Request" representing the client's request for the DescribeChangeSet operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See DescribeChangeSet for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeChangeSet method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DescribeChangeSetRequest method. req, resp := client.DescribeChangeSetRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*CloudFormation) DescribeStackEvents ¶
func (c *CloudFormation) DescribeStackEvents(input *DescribeStackEventsInput) (*DescribeStackEventsOutput, error)
DescribeStackEvents API operation for AWS CloudFormation.
Returns all stack related events for a specified stack in reverse chronological order. 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).
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS CloudFormation's API operation DescribeStackEvents for usage and error information.
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() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := cloudformation.New(sess) 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
DescribeStackEventsPages iterates over the pages of a DescribeStackEvents operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See DescribeStackEvents method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a DescribeStackEvents operation. pageNum := 0 err := client.DescribeStackEventsPages(params, func(page *DescribeStackEventsOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (*CloudFormation) DescribeStackEventsRequest ¶
func (c *CloudFormation) DescribeStackEventsRequest(input *DescribeStackEventsInput) (req *request.Request, output *DescribeStackEventsOutput)
DescribeStackEventsRequest generates a "aws/request.Request" representing the client's request for the DescribeStackEvents operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See DescribeStackEvents for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeStackEvents method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DescribeStackEventsRequest method. req, resp := client.DescribeStackEventsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*CloudFormation) DescribeStackResource ¶
func (c *CloudFormation) DescribeStackResource(input *DescribeStackResourceInput) (*DescribeStackResourceOutput, error)
DescribeStackResource API operation for AWS CloudFormation.
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.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS CloudFormation's API operation DescribeStackResource for usage and error information.
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() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := cloudformation.New(sess) 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 "aws/request.Request" representing the client's request for the DescribeStackResource operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See DescribeStackResource for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeStackResource method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DescribeStackResourceRequest method. req, resp := client.DescribeStackResourceRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*CloudFormation) DescribeStackResources ¶
func (c *CloudFormation) DescribeStackResources(input *DescribeStackResourcesInput) (*DescribeStackResourcesOutput, error)
DescribeStackResources API operation for AWS CloudFormation.
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.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS CloudFormation's API operation DescribeStackResources for usage and error information.
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() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := cloudformation.New(sess) 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 "aws/request.Request" representing the client's request for the DescribeStackResources operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See DescribeStackResources for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeStackResources method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DescribeStackResourcesRequest method. req, resp := client.DescribeStackResourcesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*CloudFormation) DescribeStacks ¶
func (c *CloudFormation) DescribeStacks(input *DescribeStacksInput) (*DescribeStacksOutput, error)
DescribeStacks API operation for AWS CloudFormation.
Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created.
If the stack does not exist, an AmazonCloudFormationException is returned.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS CloudFormation's API operation DescribeStacks for usage and error information.
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() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := cloudformation.New(sess) 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
DescribeStacksPages iterates over the pages of a DescribeStacks operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See DescribeStacks method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a DescribeStacks operation. pageNum := 0 err := client.DescribeStacksPages(params, func(page *DescribeStacksOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (*CloudFormation) DescribeStacksRequest ¶
func (c *CloudFormation) DescribeStacksRequest(input *DescribeStacksInput) (req *request.Request, output *DescribeStacksOutput)
DescribeStacksRequest generates a "aws/request.Request" representing the client's request for the DescribeStacks operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See DescribeStacks for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeStacks method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DescribeStacksRequest method. req, resp := client.DescribeStacksRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*CloudFormation) EstimateTemplateCost ¶
func (c *CloudFormation) EstimateTemplateCost(input *EstimateTemplateCostInput) (*EstimateTemplateCostOutput, error)
EstimateTemplateCost API operation for AWS CloudFormation.
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.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS CloudFormation's API operation EstimateTemplateCost for usage and error information.
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() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := cloudformation.New(sess) 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 "aws/request.Request" representing the client's request for the EstimateTemplateCost operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See EstimateTemplateCost for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the EstimateTemplateCost method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the EstimateTemplateCostRequest method. req, resp := client.EstimateTemplateCostRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*CloudFormation) ExecuteChangeSet ¶
func (c *CloudFormation) ExecuteChangeSet(input *ExecuteChangeSetInput) (*ExecuteChangeSetOutput, error)
ExecuteChangeSet API operation for AWS CloudFormation.
Updates a stack using the input information that was provided when the specified change set was created. After the call successfully completes, AWS CloudFormation starts updating the stack. Use the DescribeStacks action to view the status of the update.
When you execute a change set, AWS CloudFormation deletes all other change sets associated with the stack because they aren't valid for the updated stack.
If a stack policy is associated with the stack, AWS CloudFormation enforces the policy during the update. You can't specify a temporary stack policy that overrides the current policy.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS CloudFormation's API operation ExecuteChangeSet for usage and error information.
Returned Error Codes:
InvalidChangeSetStatus The specified change set cannot be used to update the stack. For example, the change set status might be CREATE_IN_PROGRESS or the stack status might be UPDATE_IN_PROGRESS.
ChangeSetNotFound The specified change set name or ID doesn't exit. To view valid change sets for a stack, use the ListChangeSets action.
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() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := cloudformation.New(sess) params := &cloudformation.ExecuteChangeSetInput{ ChangeSetName: aws.String("ChangeSetNameOrId"), // Required StackName: aws.String("StackNameOrId"), } resp, err := svc.ExecuteChangeSet(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) ExecuteChangeSetRequest ¶
func (c *CloudFormation) ExecuteChangeSetRequest(input *ExecuteChangeSetInput) (req *request.Request, output *ExecuteChangeSetOutput)
ExecuteChangeSetRequest generates a "aws/request.Request" representing the client's request for the ExecuteChangeSet operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See ExecuteChangeSet for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ExecuteChangeSet method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the ExecuteChangeSetRequest method. req, resp := client.ExecuteChangeSetRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*CloudFormation) GetStackPolicy ¶
func (c *CloudFormation) GetStackPolicy(input *GetStackPolicyInput) (*GetStackPolicyOutput, error)
GetStackPolicy API operation for AWS CloudFormation.
Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS CloudFormation's API operation GetStackPolicy for usage and error information.
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() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := cloudformation.New(sess) 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 "aws/request.Request" representing the client's request for the GetStackPolicy operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See GetStackPolicy for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetStackPolicy method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetStackPolicyRequest method. req, resp := client.GetStackPolicyRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*CloudFormation) GetTemplate ¶
func (c *CloudFormation) GetTemplate(input *GetTemplateInput) (*GetTemplateOutput, error)
GetTemplate API operation for AWS CloudFormation.
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.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS CloudFormation's API operation GetTemplate for usage and error information.
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() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := cloudformation.New(sess) 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 "aws/request.Request" representing the client's request for the GetTemplate operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See GetTemplate for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetTemplate method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetTemplateRequest method. req, resp := client.GetTemplateRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*CloudFormation) GetTemplateSummary ¶
func (c *CloudFormation) GetTemplateSummary(input *GetTemplateSummaryInput) (*GetTemplateSummaryOutput, error)
GetTemplateSummary API operation for AWS CloudFormation.
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.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS CloudFormation's API operation GetTemplateSummary for usage and error information.
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() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := cloudformation.New(sess) 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 "aws/request.Request" representing the client's request for the GetTemplateSummary operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See GetTemplateSummary for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetTemplateSummary method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetTemplateSummaryRequest method. req, resp := client.GetTemplateSummaryRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*CloudFormation) ListChangeSets ¶
func (c *CloudFormation) ListChangeSets(input *ListChangeSetsInput) (*ListChangeSetsOutput, error)
ListChangeSets API operation for AWS CloudFormation.
Returns the ID and status of each active change set for a stack. For example, AWS CloudFormation lists change sets that are in the CREATE_IN_PROGRESS or CREATE_PENDING state.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS CloudFormation's API operation ListChangeSets for usage and error information.
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() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := cloudformation.New(sess) params := &cloudformation.ListChangeSetsInput{ StackName: aws.String("StackNameOrId"), // Required NextToken: aws.String("NextToken"), } resp, err := svc.ListChangeSets(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) ListChangeSetsRequest ¶
func (c *CloudFormation) ListChangeSetsRequest(input *ListChangeSetsInput) (req *request.Request, output *ListChangeSetsOutput)
ListChangeSetsRequest generates a "aws/request.Request" representing the client's request for the ListChangeSets operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See ListChangeSets for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListChangeSets method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the ListChangeSetsRequest method. req, resp := client.ListChangeSetsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*CloudFormation) ListStackResources ¶
func (c *CloudFormation) ListStackResources(input *ListStackResourcesInput) (*ListStackResourcesOutput, error)
ListStackResources API operation for AWS CloudFormation.
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.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS CloudFormation's API operation ListStackResources for usage and error information.
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() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := cloudformation.New(sess) 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
ListStackResourcesPages iterates over the pages of a ListStackResources operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListStackResources method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListStackResources operation. pageNum := 0 err := client.ListStackResourcesPages(params, func(page *ListStackResourcesOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (*CloudFormation) ListStackResourcesRequest ¶
func (c *CloudFormation) ListStackResourcesRequest(input *ListStackResourcesInput) (req *request.Request, output *ListStackResourcesOutput)
ListStackResourcesRequest generates a "aws/request.Request" representing the client's request for the ListStackResources operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See ListStackResources for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListStackResources method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the ListStackResourcesRequest method. req, resp := client.ListStackResourcesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*CloudFormation) ListStacks ¶
func (c *CloudFormation) ListStacks(input *ListStacksInput) (*ListStacksOutput, error)
ListStacks API operation for AWS CloudFormation.
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).
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS CloudFormation's API operation ListStacks for usage and error information.
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() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := cloudformation.New(sess) 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
ListStacksPages iterates over the pages of a ListStacks operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListStacks method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListStacks operation. pageNum := 0 err := client.ListStacksPages(params, func(page *ListStacksOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (*CloudFormation) ListStacksRequest ¶
func (c *CloudFormation) ListStacksRequest(input *ListStacksInput) (req *request.Request, output *ListStacksOutput)
ListStacksRequest generates a "aws/request.Request" representing the client's request for the ListStacks operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See ListStacks for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListStacks method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the ListStacksRequest method. req, resp := client.ListStacksRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*CloudFormation) SetStackPolicy ¶
func (c *CloudFormation) SetStackPolicy(input *SetStackPolicyInput) (*SetStackPolicyOutput, error)
SetStackPolicy API operation for AWS CloudFormation.
Sets a stack policy for a specified stack.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS CloudFormation's API operation SetStackPolicy for usage and error information.
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() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := cloudformation.New(sess) 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 "aws/request.Request" representing the client's request for the SetStackPolicy operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See SetStackPolicy for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the SetStackPolicy method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the SetStackPolicyRequest method. req, resp := client.SetStackPolicyRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*CloudFormation) SignalResource ¶
func (c *CloudFormation) SignalResource(input *SignalResourceInput) (*SignalResourceOutput, error)
SignalResource API operation for AWS CloudFormation.
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.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS CloudFormation's API operation SignalResource for usage and error information.
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() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := cloudformation.New(sess) 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 "aws/request.Request" representing the client's request for the SignalResource operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See SignalResource for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the SignalResource method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the SignalResourceRequest method. req, resp := client.SignalResourceRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*CloudFormation) UpdateStack ¶
func (c *CloudFormation) UpdateStack(input *UpdateStackInput) (*UpdateStackOutput, error)
UpdateStack API operation for AWS CloudFormation.
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).
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS CloudFormation's API operation UpdateStack for usage and error information.
Returned Error Codes:
- InsufficientCapabilitiesException The template contains resources with capabilities that were not specified in the Capabilities parameter.
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() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := cloudformation.New(sess) 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... }, RoleARN: aws.String("RoleARN"), 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 "aws/request.Request" representing the client's request for the UpdateStack operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See UpdateStack for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateStack method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the UpdateStackRequest method. req, resp := client.UpdateStackRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*CloudFormation) ValidateTemplate ¶
func (c *CloudFormation) ValidateTemplate(input *ValidateTemplateInput) (*ValidateTemplateOutput, error)
ValidateTemplate API operation for AWS CloudFormation.
Validates a specified template. AWS CloudFormation first checks if the template is valid JSON. If it isn't, AWS CloudFormation checks if the template is valid YAML. If both these checks fail, AWS CloudFormation returns a template validation error.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS CloudFormation's API operation ValidateTemplate for usage and error information.
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() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := cloudformation.New(sess) 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 "aws/request.Request" representing the client's request for the ValidateTemplate operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
See ValidateTemplate for usage and error information.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ValidateTemplate method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the ValidateTemplateRequest method. req, resp := client.ValidateTemplateRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*CloudFormation) WaitUntilStackCreateComplete ¶
func (c *CloudFormation) WaitUntilStackCreateComplete(input *DescribeStacksInput) error
WaitUntilStackCreateComplete uses the AWS CloudFormation API operation DescribeStacks to wait for a condition to be met before returning. If the condition is not meet within the max attempt window an error will be returned.
func (*CloudFormation) WaitUntilStackDeleteComplete ¶
func (c *CloudFormation) WaitUntilStackDeleteComplete(input *DescribeStacksInput) error
WaitUntilStackDeleteComplete uses the AWS CloudFormation API operation DescribeStacks to wait for a condition to be met before returning. If the condition is not meet within the max attempt window an error will be returned.
func (*CloudFormation) WaitUntilStackExists ¶
func (c *CloudFormation) WaitUntilStackExists(input *DescribeStacksInput) error
WaitUntilStackExists uses the AWS CloudFormation API operation DescribeStacks to wait for a condition to be met before returning. If the condition is not meet within the max attempt window an error will be returned.
func (*CloudFormation) WaitUntilStackUpdateComplete ¶
func (c *CloudFormation) WaitUntilStackUpdateComplete(input *DescribeStacksInput) error
WaitUntilStackUpdateComplete uses the AWS CloudFormation API operation DescribeStacks to wait for a condition to be met before returning. If the condition is not meet within the max attempt window an error will be returned.
type ContinueUpdateRollbackInput ¶
type ContinueUpdateRollbackInput struct { // The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) // role that AWS CloudFormation assumes to roll back the stack. AWS CloudFormation // uses the role's credentials to make calls on your behalf. AWS CloudFormation // always uses this role for all future operations on the stack. As long as // users have permission to operate on the stack, AWS CloudFormation uses this // role even if the users don't have permission to pass it. Ensure that the // role grants least privilege. // // If you don't specify a value, AWS CloudFormation uses the role that was previously // associated with the stack. If no role is available, AWS CloudFormation uses // a temporary session that is generated from your user credentials. RoleARN *string `min:"20" type:"string"` // The name or the unique ID of the stack that you want to continue rolling // back. // // StackName is a required field StackName *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
The input for the ContinueUpdateRollback action.
func (ContinueUpdateRollbackInput) GoString ¶
func (s ContinueUpdateRollbackInput) GoString() string
GoString returns the string representation
func (ContinueUpdateRollbackInput) String ¶
func (s ContinueUpdateRollbackInput) String() string
String returns the string representation
func (*ContinueUpdateRollbackInput) Validate ¶
func (s *ContinueUpdateRollbackInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ContinueUpdateRollbackOutput ¶
type ContinueUpdateRollbackOutput struct {
// contains filtered or unexported fields
}
The output for a ContinueUpdateRollback action.
func (ContinueUpdateRollbackOutput) GoString ¶
func (s ContinueUpdateRollbackOutput) GoString() string
GoString returns the string representation
func (ContinueUpdateRollbackOutput) String ¶
func (s ContinueUpdateRollbackOutput) String() string
String returns the string representation
type CreateChangeSetInput ¶
type CreateChangeSetInput struct { // A list of values that you must specify before AWS CloudFormation can update // certain stacks. Some stack templates might include resources that can affect // permissions in your AWS account, for example, by creating new AWS Identity // and Access Management (IAM) users. For those stacks, you must explicitly // acknowledge their capabilities by specifying this parameter. // // The only valid values are CAPABILITY_IAM and CAPABILITY_NAMED_IAM. The following // resources require you to specify this parameter: 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 // all permissions associated with them and edit their permissions if necessary. // // If you have IAM resources, you can specify either capability. If you have // IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM. If // you don't specify this parameter, this action returns an InsufficientCapabilities // error. // // For more information, see Acknowledging IAM Resources in AWS CloudFormation // Templates (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities). Capabilities []*string `type:"list"` // The name of the change set. The name must be unique among all change sets // that are associated with the specified stack. // // A change set name can contain only alphanumeric, case sensitive characters // and hyphens. It must start with an alphabetic character and cannot exceed // 128 characters. // // ChangeSetName is a required field ChangeSetName *string `min:"1" type:"string" required:"true"` // A unique identifier for this CreateChangeSet request. Specify this token // if you plan to retry requests so that AWS CloudFormation knows that you're // not attempting to create another change set with the same name. You might // retry CreateChangeSet requests to ensure that AWS CloudFormation successfully // received them. ClientToken *string `min:"1" type:"string"` // A description to help you identify this change set. Description *string `min:"1" type:"string"` // The Amazon Resource Names (ARNs) of Amazon Simple Notification Service (Amazon // SNS) topics that AWS CloudFormation associates with the stack. To remove // all associated notification topics, specify an empty list. NotificationARNs []*string `type:"list"` // A list of Parameter structures that specify input parameters for the change // set. 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 if you // execute this change set, such as AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance. // // If the list of resource types doesn't include a resource type 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 condition keys in IAM policies for AWS CloudFormation. For // more information, see Controlling Access with AWS Identity and Access Management // (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html) // in the AWS CloudFormation User Guide. ResourceTypes []*string `type:"list"` // The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) // role that AWS CloudFormation assumes when executing the change set. AWS CloudFormation // uses the role's credentials to make calls on your behalf. AWS CloudFormation // always uses this role for all future operations on the stack. As long as // users have permission to operate on the stack, AWS CloudFormation uses this // role even if the users don't have permission to pass it. Ensure that the // role grants least privilege. // // If you don't specify a value, AWS CloudFormation uses the role that was previously // associated with the stack. If no role is available, AWS CloudFormation uses // a temporary session that is generated from your user credentials. RoleARN *string `min:"20" type:"string"` // The name or the unique ID of the stack for which you are creating a change // set. AWS CloudFormation generates the change set by comparing this stack's // information with the information that you submit, such as a modified template // or different parameter input values. // // StackName is a required field StackName *string `min:"1" type:"string" required:"true"` // Key-value pairs to associate with this stack. AWS CloudFormation also propagates // these tags to resources in the stack. You can specify a maximum of 10 tags. Tags []*Tag `type:"list"` // A structure that contains the body of the revised template, with a minimum // length of 1 byte and a maximum length of 51,200 bytes. AWS CloudFormation // generates the change set by comparing this template with the template of // the stack that you specified. // // Conditional: You must specify only TemplateBody or TemplateURL. TemplateBody *string `min:"1" type:"string"` // The location of the file that contains the revised template. The URL must // point to a template (max size: 460,800 bytes) that is located in an S3 bucket. // AWS CloudFormation generates the change set by comparing this template with // the stack that you specified. // // Conditional: You must specify only TemplateBody or TemplateURL. TemplateURL *string `min:"1" type:"string"` // Whether to reuse the template that is associated with the stack to create // the change set. UsePreviousTemplate *bool `type:"boolean"` // contains filtered or unexported fields }
The input for the CreateChangeSet action.
func (CreateChangeSetInput) GoString ¶
func (s CreateChangeSetInput) GoString() string
GoString returns the string representation
func (CreateChangeSetInput) String ¶
func (s CreateChangeSetInput) String() string
String returns the string representation
func (*CreateChangeSetInput) Validate ¶
func (s *CreateChangeSetInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateChangeSetOutput ¶
type CreateChangeSetOutput struct { // The Amazon Resource Name (ARN) of the change set. Id *string `min:"1" type:"string"` // contains filtered or unexported fields }
The output for the CreateChangeSet action.
func (CreateChangeSetOutput) GoString ¶
func (s CreateChangeSetOutput) GoString() string
GoString returns the string representation
func (CreateChangeSetOutput) String ¶
func (s CreateChangeSetOutput) String() string
String returns the string representation
type CreateStackInput ¶
type CreateStackInput struct { // A list of values that you must specify before AWS CloudFormation can create // certain stacks. Some stack templates might include resources that can affect // permissions in your AWS account, for example, by creating new AWS Identity // and Access Management (IAM) users. For those stacks, you must explicitly // acknowledge their capabilities by specifying this parameter. // // The only valid values are CAPABILITY_IAM and CAPABILITY_NAMED_IAM. The following // resources require you to specify this parameter: 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 // all permissions associated with them and edit their permissions if necessary. // // If you have IAM resources, you can specify either capability. If you have // IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM. If // you don't specify this parameter, this action returns an InsufficientCapabilities // error. // // For more information, see Acknowledging IAM Resources in AWS CloudFormation // Templates (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities). 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 (https://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 Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) // role that AWS CloudFormation assumes to create the stack. AWS CloudFormation // uses the role's credentials to make calls on your behalf. AWS CloudFormation // always uses this role for all future operations on the stack. As long as // users have permission to operate on the stack, AWS CloudFormation uses this // role even if the users don't have permission to pass it. Ensure that the // role grants least privilege. // // If you don't specify a value, AWS CloudFormation uses the role that was previously // associated with the stack. If no role is available, AWS CloudFormation uses // a temporary session that is generated from your user credentials. RoleARN *string `min:"20" type:"string"` // 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 is a required field 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 // (maximum size: 16 KB) 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 ¶
func (s CreateStackInput) GoString() string
GoString returns the string representation
func (CreateStackInput) String ¶
func (s CreateStackInput) String() string
String returns the string representation
func (*CreateStackInput) Validate ¶
func (s *CreateStackInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 ¶
func (s CreateStackOutput) GoString() string
GoString returns the string representation
func (CreateStackOutput) String ¶
func (s CreateStackOutput) String() string
String returns the string representation
type DeleteChangeSetInput ¶
type DeleteChangeSetInput struct { // The name or Amazon Resource Name (ARN) of the change set that you want to // delete. // // ChangeSetName is a required field ChangeSetName *string `min:"1" type:"string" required:"true"` // If you specified the name of a change set to delete, specify the stack name // or ID (ARN) that is associated with it. StackName *string `min:"1" type:"string"` // contains filtered or unexported fields }
The input for the DeleteChangeSet action.
func (DeleteChangeSetInput) GoString ¶
func (s DeleteChangeSetInput) GoString() string
GoString returns the string representation
func (DeleteChangeSetInput) String ¶
func (s DeleteChangeSetInput) String() string
String returns the string representation
func (*DeleteChangeSetInput) Validate ¶
func (s *DeleteChangeSetInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteChangeSetOutput ¶
type DeleteChangeSetOutput struct {
// contains filtered or unexported fields
}
The output for the DeleteChangeSet action.
func (DeleteChangeSetOutput) GoString ¶
func (s DeleteChangeSetOutput) GoString() string
GoString returns the string representation
func (DeleteChangeSetOutput) String ¶
func (s DeleteChangeSetOutput) 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 Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) // role that AWS CloudFormation assumes to delete the stack. AWS CloudFormation // uses the role's credentials to make calls on your behalf. // // If you don't specify a value, AWS CloudFormation uses the role that was previously // associated with the stack. If no role is available, AWS CloudFormation uses // a temporary session that is generated from your user credentials. RoleARN *string `min:"20" type:"string"` // The name or the unique stack ID that is associated with the stack. // // StackName is a required field StackName *string `type:"string" required:"true"` // contains filtered or unexported fields }
The input for DeleteStack action.
func (DeleteStackInput) GoString ¶
func (s DeleteStackInput) GoString() string
GoString returns the string representation
func (DeleteStackInput) String ¶
func (s DeleteStackInput) String() string
String returns the string representation
func (*DeleteStackInput) Validate ¶
func (s *DeleteStackInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteStackOutput ¶
type DeleteStackOutput struct {
// contains filtered or unexported fields
}
func (DeleteStackOutput) GoString ¶
func (s DeleteStackOutput) GoString() string
GoString returns the string representation
func (DeleteStackOutput) String ¶
func (s DeleteStackOutput) String() string
String returns the string representation
type DescribeAccountLimitsInput ¶
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 ¶
func (s DescribeAccountLimitsInput) GoString() string
GoString returns the string representation
func (DescribeAccountLimitsInput) String ¶
func (s DescribeAccountLimitsInput) String() string
String returns the string representation
func (*DescribeAccountLimitsInput) Validate ¶
func (s *DescribeAccountLimitsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeAccountLimitsOutput ¶
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 ¶
func (s DescribeAccountLimitsOutput) GoString() string
GoString returns the string representation
func (DescribeAccountLimitsOutput) String ¶
func (s DescribeAccountLimitsOutput) String() string
String returns the string representation
type DescribeChangeSetInput ¶
type DescribeChangeSetInput struct { // The name or Amazon Resource Name (ARN) of the change set that you want to // describe. // // ChangeSetName is a required field ChangeSetName *string `min:"1" type:"string" required:"true"` // A string (provided by the DescribeChangeSet response output) that identifies // the next page of information that you want to retrieve. NextToken *string `min:"1" type:"string"` // If you specified the name of a change set, specify the stack name or ID (ARN) // of the change set you want to describe. StackName *string `min:"1" type:"string"` // contains filtered or unexported fields }
The input for the DescribeChangeSet action.
func (DescribeChangeSetInput) GoString ¶
func (s DescribeChangeSetInput) GoString() string
GoString returns the string representation
func (DescribeChangeSetInput) String ¶
func (s DescribeChangeSetInput) String() string
String returns the string representation
func (*DescribeChangeSetInput) Validate ¶
func (s *DescribeChangeSetInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeChangeSetOutput ¶
type DescribeChangeSetOutput struct { // If you execute the change set, the list of capabilities that were explicitly // acknowledged when the change set was created. Capabilities []*string `type:"list"` // The ARN of the change set. ChangeSetId *string `min:"1" type:"string"` // The name of the change set. ChangeSetName *string `min:"1" type:"string"` // A list of Change structures that describes the resources AWS CloudFormation // changes if you execute the change set. Changes []*Change `type:"list"` // The start time when the change set was created, in UTC. CreationTime *time.Time `type:"timestamp" timestampFormat:"iso8601"` // Information about the change set. Description *string `min:"1" type:"string"` // If the change set execution status is AVAILABLE, you can execute the change // set. If you can’t execute the change set, the status indicates why. For example, // a change set might be in an UNAVAILABLE state because AWS CloudFormation // is still creating it or in an OBSOLETE state because the stack was already // updated. ExecutionStatus *string `type:"string" enum:"ExecutionStatus"` // If the output exceeds 1 MB, a string that identifies the next page of changes. // If there is no additional page, this value is null. NextToken *string `min:"1" type:"string"` // The ARNs of the Amazon Simple Notification Service (Amazon SNS) topics that // will be associated with the stack if you execute the change set. NotificationARNs []*string `type:"list"` // A list of Parameter structures that describes the input parameters and their // values used to create the change set. For more information, see the Parameter // (http://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html) // data type. Parameters []*Parameter `type:"list"` // The ARN of the stack that is associated with the change set. StackId *string `type:"string"` // The name of the stack that is associated with the change set. StackName *string `type:"string"` // The current status of the change set, such as CREATE_IN_PROGRESS, CREATE_COMPLETE, // or FAILED. Status *string `type:"string" enum:"ChangeSetStatus"` // A description of the change set's status. For example, if your attempt to // create a change set failed, AWS CloudFormation shows the error message. StatusReason *string `type:"string"` // If you execute the change set, the tags that will be associated with the // stack. Tags []*Tag `type:"list"` // contains filtered or unexported fields }
The output for the DescribeChangeSet action.
func (DescribeChangeSetOutput) GoString ¶
func (s DescribeChangeSetOutput) GoString() string
GoString returns the string representation
func (DescribeChangeSetOutput) String ¶
func (s DescribeChangeSetOutput) 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 ¶
func (s DescribeStackEventsInput) GoString() string
GoString returns the string representation
func (DescribeStackEventsInput) String ¶
func (s DescribeStackEventsInput) String() string
String returns the string representation
func (*DescribeStackEventsInput) Validate ¶
func (s *DescribeStackEventsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 ¶
func (s DescribeStackEventsOutput) GoString() string
GoString returns the string representation
func (DescribeStackEventsOutput) String ¶
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 is a required field 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 is a required field StackName *string `type:"string" required:"true"` // contains filtered or unexported fields }
The input for DescribeStackResource action.
func (DescribeStackResourceInput) GoString ¶
func (s DescribeStackResourceInput) GoString() string
GoString returns the string representation
func (DescribeStackResourceInput) String ¶
func (s DescribeStackResourceInput) String() string
String returns the string representation
func (*DescribeStackResourceInput) Validate ¶
func (s *DescribeStackResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 ¶
func (s DescribeStackResourceOutput) GoString() string
GoString returns the string representation
func (DescribeStackResourceOutput) String ¶
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 ¶
func (s DescribeStackResourcesInput) GoString() string
GoString returns the string representation
func (DescribeStackResourcesInput) String ¶
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 ¶
func (s DescribeStackResourcesOutput) GoString() string
GoString returns the string representation
func (DescribeStackResourcesOutput) String ¶
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 ¶
func (s DescribeStacksInput) GoString() string
GoString returns the string representation
func (DescribeStacksInput) String ¶
func (s DescribeStacksInput) String() string
String returns the string representation
func (*DescribeStacksInput) Validate ¶
func (s *DescribeStacksInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 ¶
func (s DescribeStacksOutput) GoString() string
GoString returns the string representation
func (DescribeStacksOutput) String ¶
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 }
The input for an EstimateTemplateCost action.
func (EstimateTemplateCostInput) GoString ¶
func (s EstimateTemplateCostInput) GoString() string
GoString returns the string representation
func (EstimateTemplateCostInput) String ¶
func (s EstimateTemplateCostInput) String() string
String returns the string representation
func (*EstimateTemplateCostInput) Validate ¶
func (s *EstimateTemplateCostInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 ¶
func (s EstimateTemplateCostOutput) GoString() string
GoString returns the string representation
func (EstimateTemplateCostOutput) String ¶
func (s EstimateTemplateCostOutput) String() string
String returns the string representation
type ExecuteChangeSetInput ¶
type ExecuteChangeSetInput struct { // The name or ARN of the change set that you want use to update the specified // stack. // // ChangeSetName is a required field ChangeSetName *string `min:"1" type:"string" required:"true"` // If you specified the name of a change set, specify the stack name or ID (ARN) // that is associated with the change set you want to execute. StackName *string `min:"1" type:"string"` // contains filtered or unexported fields }
The input for the ExecuteChangeSet action.
func (ExecuteChangeSetInput) GoString ¶
func (s ExecuteChangeSetInput) GoString() string
GoString returns the string representation
func (ExecuteChangeSetInput) String ¶
func (s ExecuteChangeSetInput) String() string
String returns the string representation
func (*ExecuteChangeSetInput) Validate ¶
func (s *ExecuteChangeSetInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ExecuteChangeSetOutput ¶
type ExecuteChangeSetOutput struct {
// contains filtered or unexported fields
}
The output for the ExecuteChangeSet action.
func (ExecuteChangeSetOutput) GoString ¶
func (s ExecuteChangeSetOutput) GoString() string
GoString returns the string representation
func (ExecuteChangeSetOutput) String ¶
func (s ExecuteChangeSetOutput) 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 is a required field StackName *string `type:"string" required:"true"` // contains filtered or unexported fields }
The input for the GetStackPolicy action.
func (GetStackPolicyInput) GoString ¶
func (s GetStackPolicyInput) GoString() string
GoString returns the string representation
func (GetStackPolicyInput) String ¶
func (s GetStackPolicyInput) String() string
String returns the string representation
func (*GetStackPolicyInput) Validate ¶
func (s *GetStackPolicyInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 ¶
func (s GetStackPolicyOutput) GoString() string
GoString returns the string representation
func (GetStackPolicyOutput) String ¶
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 is a required field StackName *string `type:"string" required:"true"` // contains filtered or unexported fields }
The input for a GetTemplate action.
func (GetTemplateInput) GoString ¶
func (s GetTemplateInput) GoString() string
GoString returns the string representation
func (GetTemplateInput) String ¶
func (s GetTemplateInput) String() string
String returns the string representation
func (*GetTemplateInput) Validate ¶
func (s *GetTemplateInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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.) // // AWS CloudFormation returns the same template that was used when the stack // was created. TemplateBody *string `min:"1" type:"string"` // contains filtered or unexported fields }
The output for GetTemplate action.
func (GetTemplateOutput) GoString ¶
func (s GetTemplateOutput) GoString() string
GoString returns the string representation
func (GetTemplateOutput) String ¶
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 ¶
func (s GetTemplateSummaryInput) GoString() string
GoString returns the string representation
func (GetTemplateSummaryInput) String ¶
func (s GetTemplateSummaryInput) String() string
String returns the string representation
func (*GetTemplateSummaryInput) Validate ¶
func (s *GetTemplateSummaryInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetTemplateSummaryOutput ¶
type GetTemplateSummaryOutput struct { // The capabilities found within the template. If your template contains IAM // resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value // for this parameter when you use the CreateStack or UpdateStack actions with // your template; otherwise, those actions return an InsufficientCapabilities // error. // // For more information, see Acknowledging IAM Resources in AWS CloudFormation // Templates (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities). 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 `min:"1" 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 ¶
func (s GetTemplateSummaryOutput) GoString() string
GoString returns the string representation
func (GetTemplateSummaryOutput) String ¶
func (s GetTemplateSummaryOutput) String() string
String returns the string representation
type ListChangeSetsInput ¶
type ListChangeSetsInput struct { // A string (provided by the ListChangeSets response output) that identifies // the next page of change sets that you want to retrieve. NextToken *string `min:"1" type:"string"` // The name or the Amazon Resource Name (ARN) of the stack for which you want // to list change sets. // // StackName is a required field StackName *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
The input for the ListChangeSets action.
func (ListChangeSetsInput) GoString ¶
func (s ListChangeSetsInput) GoString() string
GoString returns the string representation
func (ListChangeSetsInput) String ¶
func (s ListChangeSetsInput) String() string
String returns the string representation
func (*ListChangeSetsInput) Validate ¶
func (s *ListChangeSetsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListChangeSetsOutput ¶
type ListChangeSetsOutput struct { // If the output exceeds 1 MB, a string that identifies the next page of change // sets. If there is no additional page, this value is null. NextToken *string `min:"1" type:"string"` // A list of ChangeSetSummary structures that provides the ID and status of // each change set for the specified stack. Summaries []*ChangeSetSummary `type:"list"` // contains filtered or unexported fields }
The output for the ListChangeSets action.
func (ListChangeSetsOutput) GoString ¶
func (s ListChangeSetsOutput) GoString() string
GoString returns the string representation
func (ListChangeSetsOutput) String ¶
func (s ListChangeSetsOutput) 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 is a required field StackName *string `type:"string" required:"true"` // contains filtered or unexported fields }
The input for the ListStackResource action.
func (ListStackResourcesInput) GoString ¶
func (s ListStackResourcesInput) GoString() string
GoString returns the string representation
func (ListStackResourcesInput) String ¶
func (s ListStackResourcesInput) String() string
String returns the string representation
func (*ListStackResourcesInput) Validate ¶
func (s *ListStackResourcesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListStackResourcesOutput ¶
type ListStackResourcesOutput struct { // If the output exceeds 1 MB, 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 ¶
func (s ListStackResourcesOutput) GoString() string
GoString returns the string representation
func (ListStackResourcesOutput) String ¶
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 ¶
func (s ListStacksInput) GoString() string
GoString returns the string representation
func (ListStacksInput) String ¶
func (s ListStacksInput) String() string
String returns the string representation
func (*ListStacksInput) Validate ¶
func (s *ListStacksInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 ¶
func (s ListStacksOutput) GoString() string
GoString returns the string representation
func (ListStacksOutput) String ¶
func (s ListStacksOutput) String() string
String returns the string representation
type Output ¶
type Output struct { // User defined description associated with the output. Description *string `min:"1" 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.
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.
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 ¶
func (s ParameterConstraints) GoString() string
GoString returns the string representation
func (ParameterConstraints) String ¶
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 `min:"1" 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 ¶
func (s ParameterDeclaration) GoString() string
GoString returns the string representation
func (ParameterDeclaration) String ¶
func (s ParameterDeclaration) String() string
String returns the string representation
type ResourceChange ¶
type ResourceChange struct { // The action that AWS CloudFormation takes on the resource, such as Add (adds // a new resource), Modify (changes a resource), or Remove (deletes a resource). Action *string `type:"string" enum:"ChangeAction"` // For the Modify action, a list of ResourceChangeDetail structures that describes // the changes that AWS CloudFormation will make to the resource. Details []*ResourceChangeDetail `type:"list"` // The resource's logical ID, which is defined in the stack's template. LogicalResourceId *string `type:"string"` // The resource's physical ID (resource name). Resources that you are adding // don't have physical IDs because they haven't been created. PhysicalResourceId *string `type:"string"` // For the Modify action, indicates whether AWS CloudFormation will replace // the resource by creating a new one and deleting the old one. This value depends // on the value of the RequiresRecreation property in the ResourceTargetDefinition // structure. For example, if the RequiresRecreation field is Always and the // Evaluation field is Static, Replacement is True. If the RequiresRecreation // field is Always and the Evaluation field is Dynamic, Replacement is Conditionally. // // If you have multiple changes with different RequiresRecreation values, the // Replacement value depends on the change with the most impact. A RequiresRecreation // value of Always has the most impact, followed by Conditionally, and then // Never. Replacement *string `type:"string" enum:"Replacement"` // The type of AWS CloudFormation resource, such as AWS::S3::Bucket. ResourceType *string `min:"1" type:"string"` // For the Modify action, indicates which resource attribute is triggering this // update, such as a change in the resource attribute's Metadata, Properties, // or Tags. Scope []*string `type:"list"` // contains filtered or unexported fields }
The ResourceChange structure describes the resource and the action that AWS CloudFormation will perform on it if you execute this change set.
func (ResourceChange) GoString ¶
func (s ResourceChange) GoString() string
GoString returns the string representation
func (ResourceChange) String ¶
func (s ResourceChange) String() string
String returns the string representation
type ResourceChangeDetail ¶
type ResourceChangeDetail struct { // The identity of the entity that triggered this change. This entity is a member // of the group that is specified by the ChangeSource field. For example, if // you modified the value of the KeyPairName parameter, the CausingEntity is // the name of the parameter (KeyPairName). // // If the ChangeSource value is DirectModification, no value is given for CausingEntity. CausingEntity *string `type:"string"` // The group to which the CausingEntity value belongs. There are five entity // groups: // // * ResourceReference entities are Ref intrinsic functions that refer to // resources in the template, such as { "Ref" : "MyEC2InstanceResource" }. // // * ParameterReference entities are Ref intrinsic functions that get template // parameter values, such as { "Ref" : "MyPasswordParameter" }. // // * ResourceAttribute entities are Fn::GetAtt intrinsic functions that get // resource attribute values, such as { "Fn::GetAtt" : [ "MyEC2InstanceResource", // "PublicDnsName" ] }. // // * DirectModification entities are changes that are made directly to the // template. // // * Automatic entities are AWS::CloudFormation::Stack resource types, which // are also known as nested stacks. If you made no changes to the AWS::CloudFormation::Stack // resource, AWS CloudFormation sets the ChangeSource to Automatic because // the nested stack's template might have changed. Changes to a nested stack's // template aren't visible to AWS CloudFormation until you run an update // on the parent stack. ChangeSource *string `type:"string" enum:"ChangeSource"` // Indicates whether AWS CloudFormation can determine the target value, and // whether the target value will change before you execute a change set. // // For Static evaluations, AWS CloudFormation can determine that the target // value will change, and its value. For example, if you directly modify the // InstanceType property of an EC2 instance, AWS CloudFormation knows that this // property value will change, and its value, so this is a Static evaluation. // // For Dynamic evaluations, cannot determine the target value because it depends // on the result of an intrinsic function, such as a Ref or Fn::GetAtt intrinsic // function, when the stack is updated. For example, if your template includes // a reference to a resource that is conditionally recreated, the value of the // reference (the physical ID of the resource) might change, depending on if // the resource is recreated. If the resource is recreated, it will have a new // physical ID, so all references to that resource will also be updated. Evaluation *string `type:"string" enum:"EvaluationType"` // A ResourceTargetDefinition structure that describes the field that AWS CloudFormation // will change and whether the resource will be recreated. Target *ResourceTargetDefinition `type:"structure"` // contains filtered or unexported fields }
For a resource with Modify as the action, the ResourceChange structure describes the changes AWS CloudFormation will make to that resource.
func (ResourceChangeDetail) GoString ¶
func (s ResourceChangeDetail) GoString() string
GoString returns the string representation
func (ResourceChangeDetail) String ¶
func (s ResourceChangeDetail) String() string
String returns the string representation
type ResourceTargetDefinition ¶
type ResourceTargetDefinition struct { // Indicates which resource attribute is triggering this update, such as a change // in the resource attribute's Metadata, Properties, or Tags. Attribute *string `type:"string" enum:"ResourceAttribute"` // If the Attribute value is Properties, the name of the property. For all other // attributes, the value is null. Name *string `type:"string"` // If the Attribute value is Properties, indicates whether a change to this // property causes the resource to be recreated. The value can be Never, Always, // or Conditionally. To determine the conditions for a Conditionally recreation, // see the update behavior for that property (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) // in the AWS CloudFormation User Guide. RequiresRecreation *string `type:"string" enum:"RequiresRecreation"` // contains filtered or unexported fields }
The field that AWS CloudFormation will change, such as the name of a resource's property, and whether the resource will be recreated.
func (ResourceTargetDefinition) GoString ¶
func (s ResourceTargetDefinition) GoString() string
GoString returns the string representation
func (ResourceTargetDefinition) String ¶
func (s ResourceTargetDefinition) 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 is a required field 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 // (maximum size: 16 KB) 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 ¶
func (s SetStackPolicyInput) GoString() string
GoString returns the string representation
func (SetStackPolicyInput) String ¶
func (s SetStackPolicyInput) String() string
String returns the string representation
func (*SetStackPolicyInput) Validate ¶
func (s *SetStackPolicyInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type SetStackPolicyOutput ¶
type SetStackPolicyOutput struct {
// contains filtered or unexported fields
}
func (SetStackPolicyOutput) GoString ¶
func (s SetStackPolicyOutput) GoString() string
GoString returns the string representation
func (SetStackPolicyOutput) String ¶
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 is a required field LogicalResourceId *string `type:"string" required:"true"` // The stack name or unique stack ID that includes the resource that you want // to signal. // // StackName is a required field 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 is a required field 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 is a required field UniqueId *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
The input for the SignalResource action.
func (SignalResourceInput) GoString ¶
func (s SignalResourceInput) GoString() string
GoString returns the string representation
func (SignalResourceInput) String ¶
func (s SignalResourceInput) String() string
String returns the string representation
func (*SignalResourceInput) Validate ¶
func (s *SignalResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type SignalResourceOutput ¶
type SignalResourceOutput struct {
// contains filtered or unexported fields
}
func (SignalResourceOutput) GoString ¶
func (s SignalResourceOutput) GoString() string
GoString returns the string representation
func (SignalResourceOutput) String ¶
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 is a required field CreationTime *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"` // A user-defined description associated with the stack. Description *string `min:"1" 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"` // The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) // role that is associated with the stack. During a stack operation, AWS CloudFormation // uses this role's credentials to make calls on your behalf. RoleARN *string `min:"20" type:"string"` // Unique identifier of the stack. StackId *string `type:"string"` // The name associated with the stack. // // StackName is a required field StackName *string `type:"string" required:"true"` // Current status of the stack. // // StackStatus is a required field 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 information about 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.
type StackEvent ¶
type StackEvent struct { // The unique ID of this event. // // EventId is a required field 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 `min:"1" type:"string"` // The unique ID name of the instance of the stack. // // StackId is a required field StackId *string `type:"string" required:"true"` // The name associated with a stack. // // StackName is a required field StackName *string `type:"string" required:"true"` // Time the status was updated. // // Timestamp is a required field Timestamp *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"` // contains filtered or unexported fields }
The StackEvent data type.
func (StackEvent) GoString ¶
func (s StackEvent) GoString() string
GoString returns the string representation
func (StackEvent) String ¶
func (s StackEvent) String() string
String returns the string representation
type StackResource ¶
type StackResource struct { // User defined description associated with the resource. Description *string `min:"1" type:"string"` // The logical name of the resource specified in the template. // // LogicalResourceId is a required field 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 is a required field 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 is a required field ResourceType *string `min:"1" 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 is a required field Timestamp *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"` // contains filtered or unexported fields }
The StackResource data type.
func (StackResource) GoString ¶
func (s StackResource) GoString() string
GoString returns the string representation
func (StackResource) String ¶
func (s StackResource) String() string
String returns the string representation
type StackResourceDetail ¶
type StackResourceDetail struct { // User defined description associated with the resource. Description *string `min:"1" type:"string"` // Time the status was updated. // // LastUpdatedTimestamp is a required field LastUpdatedTimestamp *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"` // The logical name of the resource specified in the template. // // LogicalResourceId is a required field LogicalResourceId *string `type:"string" required:"true"` // The 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 is a required field 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 is a required field ResourceType *string `min:"1" 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 ¶
func (s StackResourceDetail) GoString() string
GoString returns the string representation
func (StackResourceDetail) String ¶
func (s StackResourceDetail) String() string
String returns the string representation
type StackResourceSummary ¶
type StackResourceSummary struct { // Time the status was updated. // // LastUpdatedTimestamp is a required field LastUpdatedTimestamp *time.Time `type:"timestamp" timestampFormat:"iso8601" required:"true"` // The logical name of the resource specified in the template. // // LogicalResourceId is a required field 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 is a required field 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 is a required field ResourceType *string `min:"1" type:"string" required:"true"` // contains filtered or unexported fields }
Contains high-level information about the specified stack resource.
func (StackResourceSummary) GoString ¶
func (s StackResourceSummary) GoString() string
GoString returns the string representation
func (StackResourceSummary) String ¶
func (s StackResourceSummary) String() string
String returns the string representation
type StackSummary ¶
type StackSummary struct { // The time the stack was created. // // CreationTime is a required field 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 is a required field StackName *string `type:"string" required:"true"` // The current status of the stack. // // StackStatus is a required field 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 ¶
func (s StackSummary) GoString() string
GoString returns the string representation
func (StackSummary) String ¶
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 enables you to specify a key-value pair that can be used to store information about an AWS CloudFormation stack.
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 `min:"1" 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 ¶
func (s TemplateParameter) GoString() string
GoString returns the string representation
func (TemplateParameter) String ¶
func (s TemplateParameter) String() string
String returns the string representation
type UpdateStackInput ¶
type UpdateStackInput struct { // A list of values that you must specify before AWS CloudFormation can update // certain stacks. Some stack templates might include resources that can affect // permissions in your AWS account, for example, by creating new AWS Identity // and Access Management (IAM) users. For those stacks, you must explicitly // acknowledge their capabilities by specifying this parameter. // // The only valid values are CAPABILITY_IAM and CAPABILITY_NAMED_IAM. The following // resources require you to specify this parameter: 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 // all permissions associated with them and edit their permissions if necessary. // // If you have IAM resources, you can specify either capability. If you have // IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM. If // you don't specify this parameter, this action returns an InsufficientCapabilities // error. // // For more information, see Acknowledging IAM Resources in AWS CloudFormation // Templates (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities). 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 Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) // role that AWS CloudFormation assumes to update the stack. AWS CloudFormation // uses the role's credentials to make calls on your behalf. AWS CloudFormation // always uses this role for all future operations on the stack. As long as // users have permission to operate on the stack, AWS CloudFormation uses this // role even if the users don't have permission to pass it. Ensure that the // role grants least privilege. // // If you don't specify a value, AWS CloudFormation uses the role that was previously // associated with the stack. If no role is available, AWS CloudFormation uses // a temporary session that is generated from your user credentials. RoleARN *string `min:"20" type:"string"` // The name or unique stack ID of the stack to update. // // StackName is a required field 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 an UpdateStack action.
func (UpdateStackInput) GoString ¶
func (s UpdateStackInput) GoString() string
GoString returns the string representation
func (UpdateStackInput) String ¶
func (s UpdateStackInput) String() string
String returns the string representation
func (*UpdateStackInput) Validate ¶
func (s *UpdateStackInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateStackOutput ¶
type UpdateStackOutput struct { // Unique identifier of the stack. StackId *string `type:"string"` // contains filtered or unexported fields }
The output for an UpdateStack action.
func (UpdateStackOutput) GoString ¶
func (s UpdateStackOutput) GoString() string
GoString returns the string representation
func (UpdateStackOutput) String ¶
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 ¶
func (s ValidateTemplateInput) GoString() string
GoString returns the string representation
func (ValidateTemplateInput) String ¶
func (s ValidateTemplateInput) String() string
String returns the string representation
func (*ValidateTemplateInput) Validate ¶
func (s *ValidateTemplateInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ValidateTemplateOutput ¶
type ValidateTemplateOutput struct { // The capabilities found within the template. If your template contains IAM // resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value // for this parameter when you use the CreateStack or UpdateStack actions with // your template; otherwise, those actions return an InsufficientCapabilities // error. // // For more information, see Acknowledging IAM Resources in AWS CloudFormation // Templates (http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities). 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 `min:"1" type:"string"` // A list of TemplateParameter structures. Parameters []*TemplateParameter `type:"list"` // contains filtered or unexported fields }
The output for ValidateTemplate action.
func (ValidateTemplateOutput) GoString ¶
func (s ValidateTemplateOutput) GoString() string
GoString returns the string representation
func (ValidateTemplateOutput) String ¶
func (s ValidateTemplateOutput) String() string
String returns the string representation
Directories ¶
Path | Synopsis |
---|---|
Package cloudformationiface provides an interface to enable mocking the AWS CloudFormation service client for testing your code.
|
Package cloudformationiface provides an interface to enable mocking the AWS CloudFormation service client for testing your code. |