package
0.7.0
Repository: https://github.com/aws/copilot-cli.git
Documentation: pkg.go.dev

# Functions

JobDockerfileBuildRequired returns if the job container image should be built from local Dockerfile.
NewBackendService applies the props to a default backend service configuration with minimal task sizes, single replica, no healthcheck, and then returns it.
NewLoadBalancedWebService creates a new public load balanced web service, receives all the requests from the load balancer, has a single task with minimal CPU and memory thresholds, and sets the default health check path to "/".
NewPipelineManifest returns a pipeline manifest object.
NewProvider creates a source provider based on the type of the provided provider-specific configurations.
NewScheduledJob creates a new.
ServiceDockerfileBuildRequired returns if the service container image should be built from local Dockerfile.
UnmarshalPipeline deserializes the YAML input stream into a pipeline manifest object.
UnmarshalWorkload deserializes the YAML input stream into a workload manifest object.

# Constants

BackendServiceType is a service that cannot be accessed from the internet but can be reached from other services.
No description provided by the author
No description provided by the author
LoadBalancedWebServiceType is a web service with a load balancer and Fargate as compute.
LogRetentionInDays is the default log retention time in days.
ScheduledJobType is a recurring ECS Fargate task which runs on a schedule.
Ver1 is the current schema major version of the pipeline.yml file.

# Variables

JobTypes holds the valid job "architectures".
ServiceTypes are the supported service manifest types.
WorkloadTypes holds all workload manifest types.

# Structs

Autoscaling represents the configurable options for Auto Scaling.
BackendService holds the configuration to create a backend service manifest.
BackendServiceConfig holds the configuration that can be overriden per environments.
BackendServiceProps represents the configuration needed to create a backend service.
BuildArgsOrString is a custom type which supports unmarshaling yaml which can either be of type string or type DockerBuildArgs.
ContainerHealthCheck holds the configuration to determine if the service container is healthy.
Count is a custom type which supports unmarshaling yaml which can either be of type int or type Autoscaling.
DockerBuildArgs represents the options specifiable under the "build" field of Docker Compose services.
ErrInvalidPipelineManifestVersion occurs when the pipeline.yml file contains invalid schema version during unmarshalling.
ErrInvalidWorkloadType occurs when a user requested a manifest template type that doesn't exist.
ErrUnknownProvider occurs CreateProvider() is called with configurations that do not map to any supported provider.
GitHubProperties contain information for configuring a Github source provider.
HealthCheckArgsOrString is a custom type which supports unmarshaling yaml which can either be of type string or type HealthCheckArgs.
HTTPHealthCheckArgs holds the configuration to determine if the load balanced web service is healthy.
Image represents the workload's container image.
JobFailureHandlerConfig represents the error handling configuration for the job.
JobTriggerConfig represents the configuration for the event that triggers the job.
LoadBalancedWebService holds the configuration to build a container image with an exposed port that receives requests through a load balancer with AWS Fargate as the compute engine.
LoadBalancedWebServiceConfig holds the configuration for a load balanced web service.
LoadBalancedWebServiceProps contains properties for creating a new load balanced fargate service manifest.
Logging holds configuration for Firelens to route your logs.
PipelineManifest contains information that defines the relationship and deployment ordering of your environments.
PipelineStage represents a stage in the pipeline manifest.
RoutingRule holds the path to route requests to the service.
ScheduledJob holds the configuration to build a container image that is run periodically in a given environment with timeout and retry logic.
ScheduledJobConfig holds the configuration for a scheduled job.
ScheduledJobProps contains properties for creating a new scheduled job manifest.
ServiceImageWithPort represents a container image with an exposed port.
Sidecar holds configuration for all sidecar containers in a workload.
SidecarConfig represents the configurable options for setting up a sidecar container.
Source defines the source of the artifacts to be built and deployed.
TaskConfig represents the resource boundaries and environment variables for the containers in the task.
Workload holds the basic data that every workload manifest file needs to have.
WorkloadProps contains properties for creating a new workload manifest.

# Interfaces

Provider defines a source of the artifacts that will be built and deployed via a pipeline.

# Type aliases

PipelineSchemaMajorVersion is the major version number of the pipeline manifest schema.
Range is a number range with maximum and minimum values.