customresource

Documentation

Overview

Package customresource provides functionality to upload Copilot custom resources.

Index

• func Upload(upload UploadFunc, crs []*CustomResource) (map[string]string, error)
• type CustomResource
  • func Backend(fs template.Reader) ([]*CustomResource, error)
  • func Env(fs template.Reader) ([]*CustomResource, error)
  • func LBWS(fs template.Reader) ([]*CustomResource, error)
  • func RDWS(fs template.Reader) ([]*CustomResource, error)
  • func ScheduledJob(fs template.Reader) ([]*CustomResource, error)
  • func StaticSite(fs template.Reader) ([]*CustomResource, error)
  • func Worker(fs template.Reader) ([]*CustomResource, error)
  • func (cr *CustomResource) ArtifactPath() string
  • func (cr *CustomResource) Name() string
• type UploadFunc

Functions

func Upload

func Upload(upload UploadFunc, crs []*CustomResource) (map[string]string, error)

Upload zips all the Files for each CustomResource and uploads the zip files individually to S3. Returns a map of the CustomResource FunctionName to the S3 URL where the zip file is stored.

Types

type CustomResource

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

CustomResource represents a CloudFormation custom resource backed by a Lambda function.

func Backend

func Backend(fs template.Reader) ([]*CustomResource, error)

Backend returns the custom resources for a backend service.

func Env

func Env(fs template.Reader) ([]*CustomResource, error)

Env returns the custom resources for an environment.

func LBWS

func LBWS(fs template.Reader) ([]*CustomResource, error)

LBWS returns the custom resources for a load-balanced web service.

func RDWS

func RDWS(fs template.Reader) ([]*CustomResource, error)

RDWS returns the custom resources for a request-driven web service.

func ScheduledJob

func ScheduledJob(fs template.Reader) ([]*CustomResource, error)

ScheduledJob returns the custom resources for a scheduled job.

func StaticSite

func StaticSite(fs template.Reader) ([]*CustomResource, error)

StaticSite returns the custom resources for a static site service.

func Worker

func Worker(fs template.Reader) ([]*CustomResource, error)

Worker returns the custom resources for a worker service.

func (*CustomResource) ArtifactPath

func (cr *CustomResource) ArtifactPath() string

ArtifactPath returns the S3 object key where the custom resource should be stored.

func (*CustomResource) Name

func (cr *CustomResource) Name() string

Name returns the name of the custom resource.

type UploadFunc

type UploadFunc func(key string, contents io.Reader) (url string, err error)

UploadFunc is the function signature to upload contents under a key within a S3 bucket.