software.amazon.awscdk.services.ecs

Interface BaseServiceOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

BaseServiceProps, Ec2ServiceProps, ExternalServiceProps, FargateServiceProps

All Known Implementing Classes:

BaseServiceOptions.Jsii$Proxy, BaseServiceProps.Jsii$Proxy, Ec2ServiceProps.Jsii$Proxy, ExternalServiceProps.Jsii$Proxy, FargateServiceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.577Z")
 @Stability(value=Stable)
public interface BaseServiceOptions
extends software.amazon.jsii.JsiiSerializable

The properties for the base Ec2Service or FargateService service.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 import software.amazon.awscdk.services.ecs.*;
 import software.amazon.awscdk.services.servicediscovery.*;
 Cluster cluster;
 ContainerDefinition containerDefinition;
 INamespace namespace;
 BaseServiceOptions baseServiceOptions = BaseServiceOptions.builder()
         .cluster(cluster)
         // the properties below are optional
         .capacityProviderStrategies(List.of(CapacityProviderStrategy.builder()
                 .capacityProvider("capacityProvider")
                 // the properties below are optional
                 .base(123)
                 .weight(123)
                 .build()))
         .circuitBreaker(DeploymentCircuitBreaker.builder()
                 .rollback(false)
                 .build())
         .cloudMapOptions(CloudMapOptions.builder()
                 .cloudMapNamespace(namespace)
                 .container(containerDefinition)
                 .containerPort(123)
                 .dnsRecordType(DnsRecordType.A)
                 .dnsTtl(Duration.minutes(30))
                 .failureThreshold(123)
                 .name("name")
                 .build())
         .deploymentController(DeploymentController.builder()
                 .type(DeploymentControllerType.ECS)
                 .build())
         .desiredCount(123)
         .enableECSManagedTags(false)
         .enableExecuteCommand(false)
         .healthCheckGracePeriod(Duration.minutes(30))
         .maxHealthyPercent(123)
         .minHealthyPercent(123)
         .propagateTags(PropagatedTagSource.SERVICE)
         .serviceName("serviceName")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	BaseServiceOptions.Builder A builder for BaseServiceOptions
static class	BaseServiceOptions.Jsii$Proxy An implementation for BaseServiceOptions

Method Summary

Modifier and Type	Method and Description
static BaseServiceOptions.Builder	builder()
default List<CapacityProviderStrategy>	getCapacityProviderStrategies() A list of Capacity Provider strategies used to place a service.
default DeploymentCircuitBreaker	getCircuitBreaker() Whether to enable the deployment circuit breaker.
default CloudMapOptions	getCloudMapOptions() The options for configuring an Amazon ECS service to use service discovery.
ICluster	getCluster() The name of the cluster that hosts the service.
default DeploymentController	getDeploymentController() Specifies which deployment controller to use for the service.
default Number	getDesiredCount() The desired number of instantiations of the task definition to keep running on the service.
default Boolean	getEnableECSManagedTags() Specifies whether to enable Amazon ECS managed tags for the tasks within the service.
default Boolean	getEnableExecuteCommand() Whether to enable the ability to execute into a container.
default Duration	getHealthCheckGracePeriod() The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started.
default Number	getMaxHealthyPercent() The maximum number of tasks, specified as a percentage of the Amazon ECS service's DesiredCount value, that can run in a service during a deployment.
default Number	getMinHealthyPercent() The minimum number of tasks, specified as a percentage of the Amazon ECS service's DesiredCount value, that must continue to run and remain healthy during a deployment.
default PropagatedTagSource	getPropagateTags() Specifies whether to propagate the tags from the task definition or the service to the tasks in the service.
default String	getServiceName() The name of the service.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getCluster

@Stability(value=Stable)
 @NotNull
ICluster getCluster()

The name of the cluster that hosts the service.

getCapacityProviderStrategies

@Stability(value=Stable)
 @Nullable
default List<CapacityProviderStrategy> getCapacityProviderStrategies()

A list of Capacity Provider strategies used to place a service.

Default: - undefined

getCircuitBreaker

@Stability(value=Stable)
 @Nullable
default DeploymentCircuitBreaker getCircuitBreaker()

Whether to enable the deployment circuit breaker.

If this property is defined, circuit breaker will be implicitly enabled.

Default: - disabled

getCloudMapOptions

@Stability(value=Stable)
 @Nullable
default CloudMapOptions getCloudMapOptions()

The options for configuring an Amazon ECS service to use service discovery.

Default: - AWS Cloud Map service discovery is not enabled.

getDeploymentController

@Stability(value=Stable)
 @Nullable
default DeploymentController getDeploymentController()

Specifies which deployment controller to use for the service.

For more information, see Amazon ECS Deployment Types

Default: - Rolling update (ECS)

getDesiredCount

@Stability(value=Stable)
 @Nullable
default Number getDesiredCount()

The desired number of instantiations of the task definition to keep running on the service.

Default: - When creating the service, default is 1; when updating the service, default uses the current task number.

getEnableECSManagedTags

@Stability(value=Stable)
 @Nullable
default Boolean getEnableECSManagedTags()

Specifies whether to enable Amazon ECS managed tags for the tasks within the service.

For more information, see Tagging Your Amazon ECS Resources

Default: false

getEnableExecuteCommand

@Stability(value=Stable)
 @Nullable
default Boolean getEnableExecuteCommand()

Whether to enable the ability to execute into a container.

Default: - undefined

getHealthCheckGracePeriod

@Stability(value=Stable)
 @Nullable
default Duration getHealthCheckGracePeriod()

The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started.

Default: - defaults to 60 seconds if at least one load balancer is in-use and it is not already set

getMaxHealthyPercent

@Stability(value=Stable)
 @Nullable
default Number getMaxHealthyPercent()

The maximum number of tasks, specified as a percentage of the Amazon ECS service's DesiredCount value, that can run in a service during a deployment.

Default: - 100 if daemon, otherwise 200

getMinHealthyPercent

@Stability(value=Stable)
 @Nullable
default Number getMinHealthyPercent()

The minimum number of tasks, specified as a percentage of the Amazon ECS service's DesiredCount value, that must continue to run and remain healthy during a deployment.

Default: - 0 if daemon, otherwise 50

getPropagateTags

@Stability(value=Stable)
 @Nullable
default PropagatedTagSource getPropagateTags()

Specifies whether to propagate the tags from the task definition or the service to the tasks in the service.

Valid values are: PropagatedTagSource.SERVICE, PropagatedTagSource.TASK_DEFINITION or PropagatedTagSource.NONE

Default: PropagatedTagSource.NONE

getServiceName

@Stability(value=Stable)
 @Nullable
default String getServiceName()

The name of the service.

Default: - CloudFormation-generated name.

builder

@Stability(value=Stable)
static BaseServiceOptions.Builder builder()

Returns:

a BaseServiceOptions.Builder of BaseServiceOptions