Sign In to the Console
AWS SDK for Go (PILOT)
API Reference

AWS Documentation » AWS SDK for Go » API Reference » cloudformation » Type » RollbackConfiguration

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

RollbackConfiguration

import "github.com/aws/aws-sdk-go/service/cloudformation" 

type RollbackConfiguration struct {
	MonitoringTimeInMinutes *int64 `type:"integer"`
	RollbackTriggers []*RollbackTrigger `type:"list"`
}

Structure containing the rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.

Rollback triggers enable you to have AWS CloudFormation monitor the state of your application during stack creation and updating, and to roll back that operation if the application breaches the threshold of any of the alarms you've specified. For more information, see Monitor and Roll Back Stack Operations (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-rollback-triggers.html).

MonitoringTimeInMinutes

Type: *int64

The amount of time, in minutes, during which CloudFormation should monitor all the rollback triggers after the stack creation or update operation deploys all necessary resources.

The default is 0 minutes.

If you specify a monitoring period but do not specify any rollback triggers, CloudFormation still waits the specified period of time before cleaning up old resources after update operations. You can use this monitoring period to perform any manual stack validation desired, and manually cancel the stack creation or update (using CancelUpdateStack (https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CancelUpdateStack.html), for example) as necessary.

If you specify 0 for this parameter, CloudFormation still monitors the specified rollback triggers during stack creation and update operations. Then, for update operations, it begins disposing of old resources immediately once the operation completes.

RollbackTriggers

A rollback trigger AWS CloudFormation monitors during creation and updating of stacks. If any of the alarms you specify goes to ALARM state during the stack operation or within the specified monitoring period afterwards, CloudFormation rolls back the entire stack operation.

Method

GoString

func (s RollbackConfiguration) GoString() string

GoString returns the string representation

SetMonitoringTimeInMinutes

func (s *RollbackConfiguration) SetMonitoringTimeInMinutes(v int64) *RollbackConfiguration

SetMonitoringTimeInMinutes sets the MonitoringTimeInMinutes field's value.

SetRollbackTriggers

func (s *RollbackConfiguration) SetRollbackTriggers(v []*RollbackTrigger) *RollbackConfiguration

SetRollbackTriggers sets the RollbackTriggers field's value.

String

func (s RollbackConfiguration) String() string

String returns the string representation

Validate

func (s *RollbackConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: