# Packages
Package manifestinfo provides access to information embedded in a manifest.
Package mocks is a generated GoMock package.
# Functions
AdvancedToUnion creates a new Union[Basic, Advanced] with the underlying type set to Advanced, holding val.
BasicToUnion creates a new Union[Basic, Advanced] with the underlying type set to Basic, holding val.
ContainerDependencies returns a map of ContainerDependency objects from workload manifest.
FromEnvConfig transforms an environment configuration into a manifest.
IsArmArch returns whether or not the arch is ARM.
NewBackendService applies the props to a default backend service configuration with minimal task sizes, single replica, no healthcheck, and then returns it.
NewDefaultContainerHealthCheck returns container health check configuration that's identical to a load balanced web service's defaults.
NewEnvironment creates a new environment manifest object.
NewInterpolator initiates a new Interpolator.
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 "/".
NewPipeline returns a pipeline manifest object.
NewProvider creates a source provider based on the type of the provided provider-specific configurations.
NewRequestDrivenWebService creates a new Request-Driven Web Service manifest with default values.
NewScheduledJob creates a new scheduled job object.
NewStaticSite creates a new static site service with props.
NewWorkerService applies the props to a default Worker service configuration with minimal cpu/memory thresholds, single replica, no healthcheck, and then returns it.
ParsePortMapping parses port-protocol string into individual port and protocol strings.
RedirectPlatform returns a platform that's supported for the given manifest type.
UnmarshalEnvironment deserializes the YAML input stream into an environment manifest object.
UnmarshalPipeline deserializes the YAML input stream into a pipeline manifest object.
UnmarshalWorkload deserializes the YAML input stream into a workload manifest object.
# Constants
Platform related settings.
Platform related settings.
Platform related settings.
Platform related settings.
Valid source providers for Copilot Pipelines.
Valid source providers for Copilot Pipelines.
Default values for HTTPHealthCheck for a load balanced web service.
Default values for HTTPHealthCheck for a load balanced web service.
Default values for HTTPHealthCheck for a load balanced web service.
Default values for HTTPHealthCheck for a load balanced web service.
deployment strategies.
Platform related settings.
Environmentmanifestinfo identifies that the type of manifest is environment manifest.
Defaults for Firelens configuration.
Valid source providers for Copilot Pipelines.
Valid source providers for Copilot Pipelines.
GRPCProtocol is the HTTP protocol version for gRPC.
Minimum CPU and mem values required for Windows-based tasks.
Platform related settings.
Platform related settings.
Platform related settings.
Platform related settings.
Platform related settings.
Platform related settings.
Platform related settings.
AWS VPC subnet placement options.
AWS VPC subnet placement options.
TCP is the tcp protocol for NLB.
TLS is the tls protocol for NLB.
UDP is the udp protocol for NLB.
Ver1 is the current schema major version of the pipelines/*/manifest.yml file.
# Variables
Error definitions.
PipelineProviders is the list of all available source integrations.
# Structs
AdvancedAlias represents advanced alias configuration.
AdvancedCDNConfig represents an advanced configuration for a Content Delivery Network.
AdvancedCount represents the configurable options for Auto Scaling as well as Capacity configuration (spot).
AdvancedScalingConfig represents advanced configurable options for a scaling policy.
AlarmArgs represents specs of CloudWatch alarms for deployment rollbacks.
Alias is a custom type which supports unmarshaling "http.alias" yaml which can either be of type advancedAlias slice or type StringSliceOrString.
AppRunnerInstanceConfig contains the instance configuration properties for an App Runner service.
AuthorizationConfig holds options relating to access points and IAM authorization.
BackendService holds the configuration to create a backend service manifest.
BackendServiceConfig holds the configuration that can be overridden per environments.
BackendServiceProps represents the configuration needed to create a backend service.
BitbucketProperties contains information for configuring a Bitbucket source provider.
Build defines the build project to build and test image.
BuildArgsOrString is a custom type which supports unmarshaling yaml which can either be of type string or type DockerBuildArgs.
CDNStaticConfig represents the static config for CDN.
CodeCommitProperties contains information for configuring a CodeCommit source provider.
ContainerDependency represents order of container startup and shutdown.
ContainerHealthCheck holds the configuration to determine if the service container is healthy.
Cooldown represents the autoscaling cooldown of resources.
Count is a custom type which supports unmarshaling yaml which can either be of type int or type AdvancedCount.
DeadLetterQueue represents the configurable options for setting up a Dead-Letter Queue.
Deployment is a cloudformation stack deployment configuration.
DeploymentConfig represents the deployment config for an ECS service.
DeploymentControllerConfig represents deployment strategies for a service.
DeprecatedALBSecurityGroupsConfig represents security group configuration settings for an ALB.
DeprecatedIngress represents allowed ingress traffic from specified fields.
DockerBuildArgs represents the options specifiable under the "build" field of Docker Compose services.
DynamicWorkloadManifest represents a dynamically populated workload manifest.
EFSConfigOrBool contains custom unmarshaling logic for the `efs` field in the manifest.
EFSVolumeConfiguration holds options which tell ECS how to reach out to the EFS filesystem.
ELBAccessLogsArgs holds the access logs configuration.
ELBAccessLogsArgsOrBool is a custom type which supports unmarshaling yaml which can either be of type bool or type ELBAccessLogsArgs.
Environment is the manifest configuration for an environment.
EnvironmentCDNConfig represents configuration of a CDN.
EnvironmentConfig defines the configuration settings for an environment manifest.
EnvironmentHTTPConfig defines the configuration settings for an environment group's HTTP connections.
EnvironmentProps contains properties for creating a new environment manifest.
ErrInvalidPipelineManifestVersion occurs when the pipeline.yml/manifest.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.
ExecuteCommand is a custom type which supports unmarshaling yaml which can either be of type bool or type ExecuteCommandConfig.
ExecuteCommandConfig represents the configuration for ECS Execute Command.
ExposedPort will hold the port mapping configuration.
ExposedPortsIndex holds exposed ports configuration.
FIFOAdvanceConfig represents the advanced fifo queue config.
FIFOAdvanceConfigOrBool represents the configurable options for fifo queues.
FIFOTopicAdvanceConfig represents the advanced fifo topic config.
FIFOTopicAdvanceConfigOrBool represents the configurable options for fifo topics.
FileUpload represents the options for file uploading.
GitHubProperties contains information for configuring a GitHubv2 source provider.
GitHubV1Properties contain information for configuring a Githubv1 source provider.
HealthCheckArgsOrString is a custom type which supports unmarshaling yaml which can either be of type string or type HealthCheckArgs.
HTTP holds options for application load balancer.
HTTPHealthCheckArgs holds the configuration to determine if the load balanced web service is healthy.
HTTPOrBool holds advanced configuration for routing rule or a boolean switch.
Image represents the workload's container image.
ImageLocationOrBuild represents the docker build arguments and location of the existing image.
ImageOverride holds fields that override Dockerfile image defaults.
ImageWithHealthcheck represents a container image with health check.
ImageWithHealthcheckAndOptionalPort represents a container image with an optional exposed port and health check.
ImageWithOptionalPort represents a container image with an optional exposed port.
ImageWithPort represents a container image with an exposed port.
ImageWithPortAndHealthcheck represents a container image with an exposed port and health check.
Interpolator substitutes variables in a manifest.
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.
MountPointOpts is shared between Volumes for the main container and MountPoints for sidecars.
NetworkConfig represents options for network connection to AWS resources within a VPC.
NetworkLoadBalancerConfiguration holds options for a network load balancer.
NetworkLoadBalancerListener holds listener configuration for NLB.
NLBHealthCheckArgs holds the configuration to determine if the network load balanced web service is healthy.
Observability holds configuration for observability to the service.
OverrideRule holds the manifest overriding rule for CloudFormation template.
Pipeline contains information that defines the relationship and deployment ordering of your environments.
PipelineStage represents a stage in the pipeline manifest.
PlacementArgOrString represents where to place tasks.
PlacementArgs represents where to place tasks.
PlatformArgs represents the specifics of a target OS.
PlatformArgsOrString is a custom type which supports unmarshaling yaml which can either be of type string or type PlatformArgs.
PrePostDeployment is the config for a pre- or post-deployment action backed by CodeBuild.
PublicHTTPConfig represents the configuration settings for an environment public ALB.
PublishConfig represents the configurable options for setting up publishers.
QueueScaling represents the configuration to scale a service based on a SQS queue.
Range contains either a Range or a range configuration for Autoscaling ranges.
RangeConfig containers a Min/Max and an optional SpotFrom field which specifies the number of services you want to start placing on spot.
RelaxedIngress contains ingress configuration to add to a security group.
RequestDrivenWebService holds the configuration to create a Request-Driven Web Service.
RequestDrivenWebServiceConfig holds the configuration that can be overridden per environments.
RequestDrivenWebServiceHttpConfig represents options for configuring http.
RequestDrivenWebServiceNetworkConfig represents options for network connection to AWS resources for a Request-Driven Web Service.
RequestDrivenWebServiceProps contains properties for creating a new request-driven web service manifest.
RestrictiveIngress represents ingress fields which restrict default behavior of allowing all public ingress.
RoutingRule holds listener rule configuration for ALB.
ScalingConfigOrT represents a resource that has autoscaling configurations or a generic value.
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.
Secret represents an identifier for sensitive data stored in either SSM or SecretsManager.
SecurityGroupsConfig represents which security groups are attached to a task and if default security group is applied.
SecurityGroupsIDsOrConfig represents security groups attached to task.
ServiceConnectArgs includes the advanced configuration for ECS Service Connect.
ServiceConnectBoolOrArgs represents ECS Service Connect configuration.
ServiceConnectTargetContainer contains the name of a container and port to expose to ECS Service Connect.
SidecarConfig represents the configurable options for setting up a sidecar container.
SidecarMountPoint is used to let sidecars mount volumes defined in `storage`.
Source defines the source of the artifacts to be built and deployed.
SQSQueue represents the configurable options for setting up a SQS Queue.
SQSQueueOrBool is a custom type which supports unmarshaling yaml which can either be of type bool or type SQSQueue.
StaticSite holds the configuration to configure and upload static assets to the static site service.
StaticSiteConfig holds the configuration for a static site service.
StaticSiteHTTP defines the http configuration for the static site.
StaticSiteProps represents the configuration needed to create a static site service.
Storage represents the options for external and native storage.
StringOrFromCFN represents a choice between a plain string value and a value retrieved from CloudFormation.
StringSliceOrString is a custom type that can either be of type string or type slice of string.
SubnetArgs represents what subnets to place tasks.
SubnetListOrArgs represents what subnets to place tasks.
SubscribeConfig represents the configurable options for setting up subscriptions.
TaskConfig represents the resource boundaries and environment variables for the containers in the task.
Topic represents the configurable options for setting up a SNS Topic.
TopicSubscription represents the configurable options for setting up a SNS Topic Subscription.
Union is a type used for yaml keys that may be of type Basic or Advanced.
Variable represents an identifier for the value of an environment variable.
Volume is an abstraction which merges the MountPoint and Volumes concepts from the ECS Task Definition.
VPCEndpoint is used to configure a pre-existing VPC endpoint.
VPCFlowLogsArgs holds the flow logs configuration.
WorkerAlarmArgs represents specs of CloudWatch alarms for Worker Service deployment rollbacks.
WorkerDeploymentConfig represents the deployment strategies for a worker service.
WorkerService holds the configuration to create a worker service.
WorkerServiceConfig holds the configuration that can be overridden per environments.
WorkerServiceProps represents the configuration needed to create a worker service.
Workload holds the basic data that every workload manifest file needs to have.
WorkloadProps contains properties for creating a new workload manifest.
# Interfaces
DynamicWorkload represents a dynamically populated workload.
Provider defines a source of the artifacts that will be built and deployed via a pipeline.
# Type aliases
CommandOverride is a custom type which supports unmarshalling "command" yaml which can either be of type string or type slice of string.
DependsOn represents container dependency for a container.
Deployments represent a directed graph of cloudformation deployments.
EntryPointOverride is a custom type which supports unmarshalling "entrypoint" yaml which can either be of type string or type slice of string.
IntRangeBand is a number range with maximum and minimum values.
IPNet represents an IP network string.
Percentage represents a valid percentage integer ranging from 0 to 100.
PipelineSchemaMajorVersion is the major version number of the pipeline manifest schema.
PlacementString represents what types of subnets (public or private subnets) to place tasks.
PlatformString represents the string format of Platform.
PrePostDeployments represent a directed graph of cloudformation deployments.
Tags represents the aws tags which take string as key and slice of string as values.