clean

Documentation

Overview

package clean provides structs that clean resources deployed by Copilot. It is used prior to deleting a workload or environment so that the corresponding CloudFormation stack delete runs successfully.

Index

• type NoOp
  • func (*NoOp) Clean() error
• type StaticSiteCleaner
  • func StaticSite(app, env, svc string, rg bucketResourceGetter, emptier bucketEmptier) *StaticSiteCleaner
  • func (s *StaticSiteCleaner) Clean() error

Types

type NoOp

type NoOp struct{}

NoOp does nothing.

func (*NoOp) Clean

func (*NoOp) Clean() error

Clean returns nil.

type StaticSiteCleaner

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

StaticSiteCleaner is used to clean up resources created for a static site.

func StaticSite

func StaticSite(app, env, svc string, rg bucketResourceGetter, emptier bucketEmptier) *StaticSiteCleaner

StaticSite returns an initialized static site cleaner.

func (*StaticSiteCleaner) Clean

func (s *StaticSiteCleaner) Clean() error

Clean looks for the S3 bucket for the service. If no bucket is found, it returns no error. If a bucket is found, it is emptied.