Interface BaseServiceProps
- All Superinterfaces:
BaseServiceOptions,software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
BaseServiceProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
date="2023-06-19T16:30:47.022Z")
@Stability(Stable)
public interface BaseServiceProps
extends software.amazon.jsii.JsiiSerializable, BaseServiceOptions
Complete base service properties that are required to be supplied by the implementation of the BaseService class.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.ecs.*;
import software.amazon.awscdk.services.servicediscovery.*;
import software.amazon.awscdk.core.*;
Cluster cluster;
ContainerDefinition containerDefinition;
INamespace namespace;
BaseServiceProps baseServiceProps = BaseServiceProps.builder()
.cluster(cluster)
.launchType(LaunchType.EC2)
// 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)
.propagateTaskTagsFrom(PropagatedTagSource.SERVICE)
.serviceName("serviceName")
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forBaseServicePropsstatic final classAn implementation forBaseServiceProps -
Method Summary
Modifier and TypeMethodDescriptionstatic BaseServiceProps.Builderbuilder()The launch type on which to run your service.Methods inherited from interface software.amazon.awscdk.services.ecs.BaseServiceOptions
getCapacityProviderStrategies, getCircuitBreaker, getCloudMapOptions, getCluster, getDeploymentController, getDesiredCount, getEnableECSManagedTags, getEnableExecuteCommand, getHealthCheckGracePeriod, getMaxHealthyPercent, getMinHealthyPercent, getPropagateTags, getPropagateTaskTagsFrom, getServiceNameMethods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getLaunchType
The launch type on which to run your service.LaunchType will be omitted if capacity provider strategies are specified on the service.
-
builder
- Returns:
- a
BaseServiceProps.BuilderofBaseServiceProps
-