Interface BaseServiceProps
- All Superinterfaces:
BaseServiceOptions,software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
BaseServiceProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
date="2025-11-17T14:40:50.288Z")
@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.*;
import software.amazon.awscdk.services.ecs.*;
import software.amazon.awscdk.services.iam.*;
import software.amazon.awscdk.services.servicediscovery.*;
import software.amazon.awscdk.interfaces.kms.*;
Cluster cluster;
ContainerDefinition containerDefinition;
IDeploymentLifecycleHookTarget deploymentLifecycleHookTarget;
IKeyRef keyRef;
LogDriver logDriver;
INamespace namespace;
Role role;
ServiceManagedVolume serviceManagedVolume;
TaskDefinitionRevision taskDefinitionRevision;
BaseServiceProps baseServiceProps = BaseServiceProps.builder()
.cluster(cluster)
.launchType(LaunchType.EC2)
// the properties below are optional
.bakeTime(Duration.minutes(30))
.capacityProviderStrategies(List.of(CapacityProviderStrategy.builder()
.capacityProvider("capacityProvider")
// the properties below are optional
.base(123)
.weight(123)
.build()))
.circuitBreaker(DeploymentCircuitBreaker.builder()
.enable(false)
.rollback(false)
.build())
.cloudMapOptions(CloudMapOptions.builder()
.cloudMapNamespace(namespace)
.container(containerDefinition)
.containerPort(123)
.dnsRecordType(DnsRecordType.A)
.dnsTtl(Duration.minutes(30))
.failureThreshold(123)
.name("name")
.build())
.deploymentAlarms(DeploymentAlarmConfig.builder()
.alarmNames(List.of("alarmNames"))
// the properties below are optional
.behavior(AlarmBehavior.ROLLBACK_ON_ALARM)
.build())
.deploymentController(DeploymentController.builder()
.type(DeploymentControllerType.ECS)
.build())
.deploymentStrategy(DeploymentStrategy.ROLLING)
.desiredCount(123)
.enableECSManagedTags(false)
.enableExecuteCommand(false)
.healthCheckGracePeriod(Duration.minutes(30))
.lifecycleHooks(List.of(deploymentLifecycleHookTarget))
.maxHealthyPercent(123)
.minHealthyPercent(123)
.propagateTags(PropagatedTagSource.SERVICE)
.serviceConnectConfiguration(ServiceConnectProps.builder()
.logDriver(logDriver)
.namespace("namespace")
.services(List.of(ServiceConnectService.builder()
.portMappingName("portMappingName")
// the properties below are optional
.discoveryName("discoveryName")
.dnsName("dnsName")
.idleTimeout(Duration.minutes(30))
.ingressPortOverride(123)
.perRequestTimeout(Duration.minutes(30))
.port(123)
.tls(ServiceConnectTlsConfiguration.builder()
.awsPcaAuthorityArn("awsPcaAuthorityArn")
.kmsKey(keyRef)
.role(role)
.build())
.build()))
.build())
.serviceName("serviceName")
.taskDefinitionRevision(taskDefinitionRevision)
.volumeConfigurations(List.of(serviceManagedVolume))
.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
getBakeTime, getCapacityProviderStrategies, getCircuitBreaker, getCloudMapOptions, getCluster, getDeploymentAlarms, getDeploymentController, getDeploymentStrategy, getDesiredCount, getEnableECSManagedTags, getEnableExecuteCommand, getHealthCheckGracePeriod, getLifecycleHooks, getMaxHealthyPercent, getMinHealthyPercent, getPropagateTags, getServiceConnectConfiguration, getServiceName, getTaskDefinitionRevision, getVolumeConfigurationsMethods 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.
- See Also:
-
builder
- Returns:
- a
BaseServiceProps.BuilderofBaseServiceProps
-