Documentation
¶
Overview ¶
Package deploy holds the structures to deploy a workload.
Index ¶
- func NewBackendDeployer(in *WorkloadDeployerInput) (*backendSvcDeployer, error)
- func NewEnvDeployer(in *NewEnvDeployerInput) (*envDeployer, error)
- func NewJobDeployer(in *WorkloadDeployerInput) (*jobDeployer, error)
- func NewLBWSDeployer(in *WorkloadDeployerInput) (*lbWebSvcDeployer, error)
- func NewRDWSDeployer(in *WorkloadDeployerInput) (*rdwsDeployer, error)
- func NewWorkerSvcDeployer(in *WorkloadDeployerInput) (*workerSvcDeployer, error)
- type ActionRecommender
- type DeployEnvironmentInput
- type DeployWorkloadInput
- type GenerateCloudFormationTemplateInput
- type GenerateCloudFormationTemplateOutput
- type NewEnvDeployerInput
- type Options
- type StackRuntimeConfiguration
- type UploadArtifactsOutput
- type WorkloadDeployerInput
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewBackendDeployer ¶
func NewBackendDeployer(in *WorkloadDeployerInput) (*backendSvcDeployer, error)
NewBackendDeployer is the constructor for backendSvcDeployer.
func NewEnvDeployer ¶ added in v1.20.0
func NewEnvDeployer(in *NewEnvDeployerInput) (*envDeployer, error)
NewEnvDeployer constructs an environment deployer.
func NewJobDeployer ¶
func NewJobDeployer(in *WorkloadDeployerInput) (*jobDeployer, error)
NewJobDeployer is the constructor for jobDeployer.
func NewLBWSDeployer ¶ added in v1.20.0
func NewLBWSDeployer(in *WorkloadDeployerInput) (*lbWebSvcDeployer, error)
NewLBWSDeployer is the constructor for lbWebSvcDeployer.
func NewRDWSDeployer ¶
func NewRDWSDeployer(in *WorkloadDeployerInput) (*rdwsDeployer, error)
NewRDWSDeployer is the constructor for RDWSDeployer.
func NewWorkerSvcDeployer ¶
func NewWorkerSvcDeployer(in *WorkloadDeployerInput) (*workerSvcDeployer, error)
NewWorkerSvcDeployer is the constructor for workerSvcDeployer.
Types ¶
type ActionRecommender ¶
type ActionRecommender interface {
RecommendedActions() []string
}
ActionRecommender contains methods that output action recommendation.
type DeployEnvironmentInput ¶ added in v1.19.0
type DeployEnvironmentInput struct { RootUserARN string CustomResourcesURLs map[string]string Manifest *manifest.Environment ForceNewUpdate bool RawManifest []byte PermissionsBoundary string DisableRollback bool }
DeployEnvironmentInput contains information used to deploy the environment.
type DeployWorkloadInput ¶
type DeployWorkloadInput struct { StackRuntimeConfiguration Options }
DeployWorkloadInput is the input of DeployWorkload.
type GenerateCloudFormationTemplateInput ¶ added in v1.16.0
type GenerateCloudFormationTemplateInput struct {
StackRuntimeConfiguration
}
GenerateCloudFormationTemplateInput is the input of GenerateCloudFormationTemplate.
type GenerateCloudFormationTemplateOutput ¶ added in v1.16.0
GenerateCloudFormationTemplateOutput is the output of GenerateCloudFormationTemplate.
type NewEnvDeployerInput ¶ added in v1.20.0
type NewEnvDeployerInput struct { App *config.Application Env *config.Environment SessionProvider *sessions.Provider ConfigStore describe.ConfigStoreSvc }
NewEnvDeployerInput contains information needed to construct an environment deployer.
type StackRuntimeConfiguration ¶ added in v1.16.0
type StackRuntimeConfiguration struct { // Use *string for three states (see https://github.com/aws/copilot-cli/pull/3268#discussion_r806060230) // This is mainly to keep the `workload package` behavior backward-compatible, otherwise our old pipeline buildspec would break, // since previously we parsed the env region from a mock ECR URL that we generated from `workload package“. ImageDigest *string EnvFileARN string AddonsURL string RootUserARN string Tags map[string]string CustomResourceURLs map[string]string }
StackRuntimeConfiguration contains runtime configuration for a workload CloudFormation stack.
type UploadArtifactsOutput ¶
type UploadArtifactsOutput struct { ImageDigest *string EnvFileARN string AddonsURL string CustomResourceURLs map[string]string }
UploadArtifactsOutput is the output of UploadArtifacts.
type WorkloadDeployerInput ¶
type WorkloadDeployerInput struct { SessionProvider *sessions.Provider Name string App *config.Application Env *config.Environment ImageTag string Mft interface{} // Interpolated, applied, and unmarshaled manifest. RawMft []byte // Content of the manifest file without any transformations. EnvVersionGetter versionGetter }
WorkloadDeployerInput is the input to for workloadDeployer constructor.