Builder

class Builder

Properties

Link copied to clipboard

Indicates whether to use Availability Zone rebalancing for the service.

Link copied to clipboard

The capacity provider strategy to use for the service.

Link copied to clipboard

An identifier that you provide to ensure the idempotency of the request. It must be unique and is case sensitive. Up to 36 ASCII characters in the range of 33-126 (inclusive) are allowed.

Link copied to clipboard

The short name or full Amazon Resource Name (ARN) of the cluster that you run your service on. If you do not specify a cluster, the default cluster is assumed.

Link copied to clipboard

Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.

Link copied to clipboard

The deployment controller to use for the service. If no deployment controller is specified, the default value of ECS is used.

Link copied to clipboard

The number of instantiations of the specified task definition to place and keep running in your service.

Link copied to clipboard

Specifies whether to turn on Amazon ECS managed tags for the tasks within the service. For more information, see Tagging your Amazon ECS resources in the Amazon Elastic Container Service Developer Guide.

Link copied to clipboard

Determines whether the execute command functionality is turned on for the service. If true, this enables execute command functionality on all containers in the service tasks.

Link copied to clipboard

The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing, VPC Lattice, and container health checks after a task has first started. If you don't specify a health check grace period value, the default value of 0 is used. If you don't use any of the health checks, then healthCheckGracePeriodSeconds is unused.

Link copied to clipboard

The infrastructure that you run your service on. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

Link copied to clipboard

A load balancer object representing the load balancers to use with your service. For more information, see Service load balancing in the Amazon Elastic Container Service Developer Guide.

Link copied to clipboard

The network configuration for the service. This parameter is required for task definitions that use the awsvpc network mode to receive their own elastic network interface, and it isn't supported for other network modes. For more information, see Task networking in the Amazon Elastic Container Service Developer Guide.

Link copied to clipboard

An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints for each task. This limit includes constraints in the task definition and those specified at runtime.

Link copied to clipboard

The placement strategy objects to use for tasks in your service. You can specify a maximum of 5 strategy rules for each service.

Link copied to clipboard

The platform version that your tasks in the service are running on. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.

Link copied to clipboard

Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.

Link copied to clipboard
var role: String?

The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is only permitted if you are using a load balancer with your service and your task definition doesn't use the awsvpc network mode. If you specify the role parameter, you must also specify a load balancer object with the loadBalancers parameter.

Link copied to clipboard

The scheduling strategy to use for the service. For more information, see Services.

Link copied to clipboard

The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.

Link copied to clipboard

The name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.

Link copied to clipboard

The details of the service discovery registry to associate with this service. For more information, see Service discovery.

Link copied to clipboard
var tags: List<Tag>?

The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. When a service is deleted, the tags are deleted as well.

Link copied to clipboard

The family and revision (family:revision) or full ARN of the task definition to run in your service. If a revision isn't specified, the latest ACTIVE revision is used.

Link copied to clipboard

The configuration for a volume specified in the task definition as a volume that is configured at launch time. Currently, the only supported volume type is an Amazon EBS volume.

Link copied to clipboard

The VPC Lattice configuration for the service being created.

Functions