# Packages
Package artifactpath holds functions to generate the S3 object path for artifacts.
Package diff provides functionalities to compare two YAML documents.
Package mocks is a generated GoMock package.
Package override provides functionality to replace content from vended templates.
Package templatetest provides test doubles for embedded templates.
# Functions
AvailableEnvFeatures returns a list of the latest available feature, named after their corresponding parameter names.
DashReplacedLogicalIDToOriginal takes a "sanitized" logical ID and converts it back to its original form, with dashes.
EnvVarNameFunc converts an input resource name to LogicalIDSafe, then appends "Name" to the end.
EnvVarSecretFunc converts an input resource name to LogicalIDSafe, then appends "Secret" to the end.
FmtSliceFunc renders a string representation of a go string slice, surrounded by brackets and joined by commas.
FriendlyEnvFeatureName returns a user-friendly feature name given a env-controller managed parameter name.
ImportedFileSystemID returns a EFS FilesystemID that is imported from a stack.
ImportedSecurityGroup returns a SecurityGroup that should be imported from a stack.
ImportedVariable returns a Variable that should be imported from a stack.
IncFunc increments an integer value and returns the result.
IsARNFunc takes a string value and determines if it's an ARN or not.
LeastVersionForFeature maps each feature to the least environment template version it requires.
New returns a Template object that can be used to parse files under the "/templates/" directory.
PlainFileSystemID returns a EFS FilesystemID that is a plain string value.
PlainSecurityGroup returns a SecurityGroup that is a plain string value.
PlainVariable returns a Variable that is a plain string value.
QuoteSliceFunc places quotation marks around all elements of a go string slice.
ReplaceDashesFunc takes a CloudFormation logical ID, and sanitizes it by removing "-" characters (not allowed) and replacing them with "DASH" (allowed by CloudFormation but not permitted in ecs-cli generated resource names).
SecretFromImportedSSMOrARN returns a Secret that refers to imported name of SSM parameter or a secret ARN.
SecretFromPlainSSMOrARN returns a Secret that refers to an SSM parameter or a secret ARN.
SecretFromSecretsManager returns a Secret that refers to SecretsManager secret name.
StrconvUint16 returns string converted from uint16.
StripNonAlphaNumFunc strips non-alphanumeric characters from an input string.
ToSnakeCaseFunc transforms a CamelCase input string s into an upper SNAKE_CASE string and returns it.
TrimSlashPrefix takes a string value and removes slash prefix from the string if present.
URLSafeVersion takes a Copilot version and replaces the '+' character with the URL-safe '%2B'.
WithFuncs returns a template that can parse additional custom functions.
# Constants
AddonsStackLogicalID is the logical ID for the addon stack resource in the main template.
Available env-controller managed feature names.
Available env-controller managed feature names.
File names under "templates/".
Available env-controller managed feature names.
Constants for workload options.
Constants for workload options.
File names under "templates/".
File names under "templates/".
Constants for workload options.
File names under "templates/".
File names under "templates/".
Available env-controller managed feature names.
AWS VPC networking configuration.
Available env-controller managed feature names.
The minimum required environment template version for various features.
LastForceDeployIDOutputName is the logical ID of the deployment controller output.
Constants for stack resource logical IDs.
Available env-controller managed feature names.
NoExposedContainerPort indicates no port should be exposed for the service container.
RuntimePlatform configuration.
Constants for workload options.
Constants for workload options.
Constants for workload options.
Constants for workload options.
Alias 2019 as Default WindowsSever Core platform.
Alias 2019 as Default WindowsSever Full platform.
Constants for workload options.
Constants for workload options.
The minimum required environment template version for various features.
The minimum required environment template version for various features.
# Structs
Addons holds data about an aggregated addons stack.
AdvancedCount holds configuration for autoscaling and capacity provider parameters.
ALBListener holds configuration that's needed for an Application Load Balancer Listener.
ALBListenerRule holds configuration that's needed for an Application Load Balancer listener rule.
AutoscalingOpts holds configuration that's needed for Auto Scaling.
AutoscalingQueueDelayOpts holds configuration to scale SQS queues.
CapacityProviderStrategy holds the configuration needed for a CapacityProviderStrategyItem on a Service.
CDNConfig represents a Content Delivery Network deployed by CloudFront.
CDNStaticAssetConfig represents static assets config for a Content Delivery Network.
CFNResource represents a resource rendered in a CloudFormation template.
ContainerHealthCheck holds configuration for container health check.
Content represents the parsed template.
Cooldown holds configuration needed for autoscaling cooldown fields.
DeadLetterQueue holds information needed to render a dead-letter SQS Queue in a container definition.
DeploymentConfigurationOpts holds configuration for rolling deployments.
EFSPermission holds information needed to render an IAM policy statement.
EFSVolumeConfiguration contains information about how to specify externally managed file systems.
ELBAccessLogs represents configuration for ELB access logs S3 bucket.
EnvOpts holds data that can be provided to enable features in an environment stack template.
ExecuteCommandOpts holds configuration that's needed for ECS Execute Command.
FIFOQueueConfig holds information needed to render a FIFO SQS Queue in a container definition.
FIFOTopicConfig holds configuration needed if the topic is FIFO.
HTTPConfig represents configuration for a Load Balancer.
HTTPHealthCheckOpts holds configuration that's needed for HTTP Health Check.
ImportedALB holds the fields to import an existing ALB.
ImportVPC holds the fields to import VPC resources.
LBListener struct represents the listener of a load balancer.
LBSecurityGroup struct represents the security group of a load balancer.
LogConfigOpts holds configuration that's needed if the service is configured with Firelens to route its logs.
ManagedVolumeCreationInfo holds information about how to create Copilot-managed access points.
ManagedVPC holds the fields to configure a managed VPC.
MountPoint holds information needed to render a MountPoint in a containerdefinition.
NetworkLoadBalancer holds configuration that's needed for a Network Load Balancer.
NetworkLoadBalancerListener holds configuration that's need for a Network Load Balancer listener.
NetworkOpts holds AWS networking configuration for the workloads.
NLBHealthCheck holds configuration for Network Load Balancer health check.
ObservabilityOpts holds configurations for observability.
PortMapping holds container port mapping configuration.
PrivateHTTPConfig represents configuration for an internal Load Balancer.
PublicHTTPConfig represents configuration for a public facing Load Balancer.
PublishOpts holds configuration needed if the service has publishers.
RollingUpdateRollbackConfig holds config for rollback alarms.
RuntimePlatformOpts holds configuration needed for Platform configuration.
S3ObjectLocation represents an object stored in an S3 bucket.
SecurityGroupConfig holds the fields to import security group config.
SecurityGroupRule holds the fields to import security group rule.
ServiceConnectOpts defines the options for service connect.
ServiceConnectServer defines the container name and port which a service routes Service Connect through.
SidecarOpts holds configuration that's needed if the service has sidecar containers.
SidecarStorageOpts holds data structures for rendering Mount Points inside of a sidecar.
SQSQueue holds information needed to render a SQS Queue in a container definition.
StateMachineOpts holds configuration needed for State Machine retries and timeout.
StorageOpts holds data structures for rendering Volumes and Mount Points.
SubscribeOpts holds configuration needed if the service has subscriptions.
Telemetry represents optional observability and monitoring configuration.
Template represents the "/templates/" directory that holds static files to be embedded in the binary.
Topic holds information needed to render a SNSTopic in a container definition.
TopicSubscription holds information needed to render a SNS Topic Subscription in a container definition.
Uploadable is an uploadable file.
Volume contains fields that render a volume, its name, and EFSVolumeConfiguration.
VPCConfig represents the VPC configuration.
VPCFlowLogs holds the fields to configure logging IP traffic using VPC flow logs.
WorkloadNestedStackOpts holds configuration that's needed if the workload stack has a nested stack.
WorkloadOpts holds optional data that can be provided to enable features in a workload stack template.
# Interfaces
CDKImport is the interface to import a CDK package.
Parser is the interface that wraps the Parse method.
Reader is the interface that wraps the Read method.
ReadParser is the interface that wraps the Read and Parse methods.
# Type aliases
AliasesForHostedZone maps hosted zone IDs to aliases that belong to it.
CFNType is a CloudFormation resource type such as "AWS::ECS::Service".
FileSystemID represnts the EFS FilesystemID.
ParseOption represents a functional option for the Parse method.
A Secret represents an SSM or SecretsManager secret that can be rendered in CloudFormation.
SecurityGroup represents the ID of an additional security group associated with the tasks.
Variable represents the value of an environment variable.
WalkDirFunc is the type of the function called by any Walk functions while visiting each file under a directory.