BaseServiceOptions (software.amazon.awscdk:monocdk 1.180.0.DEVPREVIEW API)

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.70.0 (build 03c2f6f)",
           date="2022-11-01T13:16:47.293Z")
 @Stability(value=Experimental)
public interface BaseServiceOptions
extends software.amazon.jsii.JsiiSerializable

(experimental) 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.core.*;
 import software.amazon.awscdk.services.ecs.*;
 import software.amazon.awscdk.services.servicediscovery.*;
 Cluster cluster;
 ContainerDefinition containerDefinition;
 Duration duration;
 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)
                 .failureThreshold(123)
                 .name("name")
                 .build())
         .deploymentController(DeploymentController.builder()
                 .type(DeploymentControllerType.ECS)
                 .build())
         .desiredCount(123)
         .enableECSManagedTags(false)
         .enableExecuteCommand(false)
         .healthCheckGracePeriod(duration)
         .maxHealthyPercent(123)
         .minHealthyPercent(123)
         .propagateTags(PropagatedTagSource.SERVICE)
         .propagateTaskTagsFrom(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

All Methods Static Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`static BaseServiceOptions.Builder`	`builder()`
`default List<CapacityProviderStrategy>`	`getCapacityProviderStrategies()` (experimental) A list of Capacity Provider strategies used to place a service.
`default DeploymentCircuitBreaker`	`getCircuitBreaker()` (experimental) Whether to enable the deployment circuit breaker.
`default CloudMapOptions`	`getCloudMapOptions()` (experimental) The options for configuring an Amazon ECS service to use service discovery.
`ICluster`	`getCluster()` (experimental) The name of the cluster that hosts the service.
`default DeploymentController`	`getDeploymentController()` (experimental) Specifies which deployment controller to use for the service.
`default Number`	`getDesiredCount()` (experimental) The desired number of instantiations of the task definition to keep running on the service.
`default Boolean`	`getEnableECSManagedTags()` (experimental) Specifies whether to enable Amazon ECS managed tags for the tasks within the service.
`default Boolean`	`getEnableExecuteCommand()` (experimental) Whether to enable the ability to execute into a container.
`default Duration`	`getHealthCheckGracePeriod()` (experimental) 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()` (experimental) 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()` (experimental) 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()` (experimental) Specifies whether to propagate the tags from the task definition or the service to the tasks in the service.
`default PropagatedTagSource`	`getPropagateTaskTagsFrom()` Deprecated. Use `propagateTags` instead.
`default String`	`getServiceName()` (experimental) The name of the service.

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

- Method Detail
  - getCluster
```
@Stability(value=Experimental)
 @NotNull
ICluster getCluster()
```
    (experimental) The name of the cluster that hosts the service.
  - getCapacityProviderStrategies
```
@Stability(value=Experimental)
 @Nullable
default List<CapacityProviderStrategy> getCapacityProviderStrategies()
```
    (experimental) A list of Capacity Provider strategies used to place a service.
    Default: - undefined
  - getCircuitBreaker
```
@Stability(value=Experimental)
 @Nullable
default DeploymentCircuitBreaker getCircuitBreaker()
```
    (experimental) Whether to enable the deployment circuit breaker.
    If this property is defined, circuit breaker will be implicitly enabled.
    Default: - disabled
  - getCloudMapOptions
```
@Stability(value=Experimental)
 @Nullable
default CloudMapOptions getCloudMapOptions()
```
    (experimental) The options for configuring an Amazon ECS service to use service discovery.
    Default: - AWS Cloud Map service discovery is not enabled.
  - getDeploymentController
```
@Stability(value=Experimental)
 @Nullable
default DeploymentController getDeploymentController()
```
    (experimental) Specifies which deployment controller to use for the service.
    For more information, see Amazon ECS Deployment Types
    Default: - Rolling update (ECS)
  - getDesiredCount
```
@Stability(value=Experimental)
 @Nullable
default Number getDesiredCount()
```
    (experimental) 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=Experimental)
 @Nullable
default Boolean getEnableECSManagedTags()
```
    (experimental) 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=Experimental)
 @Nullable
default Boolean getEnableExecuteCommand()
```
    (experimental) Whether to enable the ability to execute into a container.
    Default: - undefined
  - getHealthCheckGracePeriod
```
@Stability(value=Experimental)
 @Nullable
default Duration getHealthCheckGracePeriod()
```
    (experimental) 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=Experimental)
 @Nullable
default Number getMaxHealthyPercent()
```
    (experimental) 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=Experimental)
 @Nullable
default Number getMinHealthyPercent()
```
    (experimental) 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=Experimental)
 @Nullable
default PropagatedTagSource getPropagateTags()
```
    (experimental) 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
  - getPropagateTaskTagsFrom
```
@Stability(value=Deprecated)
 @Deprecated
 @Nullable
default PropagatedTagSource getPropagateTaskTagsFrom()
```
    Deprecated. Use `propagateTags` instead.
    
    (deprecated) Specifies whether to propagate the tags from the task definition or the service to the tasks in the service.
    Tags can only be propagated to the tasks within the service during service creation.
    Default: PropagatedTagSource.NONE
  - getServiceName
```
@Stability(value=Experimental)
 @Nullable
default String getServiceName()
```
    (experimental) The name of the service.
    Default: - CloudFormation-generated name.
  - builder
```
@Stability(value=Experimental)
static BaseServiceOptions.Builder builder()
```
    Returns:
    
    a BaseServiceOptions.Builder of BaseServiceOptions

Interface BaseServiceOptions

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Detail

getCluster

getCapacityProviderStrategies

getCircuitBreaker

getCloudMapOptions

getDeploymentController

getDesiredCount

getEnableECSManagedTags

getEnableExecuteCommand

getHealthCheckGracePeriod

getMaxHealthyPercent

getMinHealthyPercent

getPropagateTags

getPropagateTaskTagsFrom

getServiceName

builder