BaseService

java.lang.Object
- software.constructs.Construct
- - software.amazon.awscdk.core.Construct
  - - software.amazon.awscdk.core.Resource
    - - software.amazon.awscdk.services.ecs.BaseService

All Implemented Interfaces:: IConstruct, IDependable, IResource, IConnectable, IBaseService, IService, ILoadBalancerTarget, IApplicationLoadBalancerTarget, INetworkLoadBalancerTarget

Direct Known Subclasses:: Ec2Service, ExternalService, FargateService

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-28T21:34:28.648Z")
public abstract class BaseService
extends Resource
implements IBaseService, IApplicationLoadBalancerTarget, INetworkLoadBalancerTarget, ILoadBalancerTarget

The base class for Ec2Service and FargateService services.

Example:

 import software.amazon.awscdk.services.ecs.*;
 IBaseService service = BaseService.fromServiceArnWithCluster(this, "EcsService", "arn:aws:ecs:us-east-1:123456789012:service/myClusterName/myServiceName");
 Pipeline pipeline = new Pipeline(this, "MyPipeline");
 Artifact buildOutput = new Artifact();
 // add source and build stages to the pipeline as usual...
 IStage deployStage = pipeline.addStage(StageOptions.builder()
         .stageName("Deploy")
         .actions(List.of(
             EcsDeployAction.Builder.create()
                     .actionName("DeployAction")
                     .service(service)
                     .input(buildOutput)
                     .build()))
         .build());

Nested Class Summary
- Nested classes/interfaces inherited from interface software.amazon.awscdk.services.ecs.IBaseService
  IBaseService.Jsii$Default
- Nested classes/interfaces inherited from interface software.amazon.awscdk.services.elasticloadbalancingv2.IApplicationLoadBalancerTarget
  IApplicationLoadBalancerTarget.Jsii$Default
- Nested classes/interfaces inherited from interface software.amazon.awscdk.services.elasticloadbalancingv2.INetworkLoadBalancerTarget
  INetworkLoadBalancerTarget.Jsii$Default
- Nested classes/interfaces inherited from interface software.amazon.awscdk.services.elasticloadbalancing.ILoadBalancerTarget
  ILoadBalancerTarget.Jsii$Default

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`BaseService(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`BaseService(software.amazon.jsii.JsiiObjectRef objRef)`
`protected`	`BaseService(software.constructs.Construct scope, java.lang.String id, BaseServiceProps props, java.lang.Object additionalProps, TaskDefinition taskDefinition)` Constructs a new instance of the BaseService class.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`associateCloudMapService(AssociateCloudMapServiceOptions options)` Associates this service with a CloudMap service.
`LoadBalancerTargetProps`	`attachToApplicationTargetGroup(IApplicationTargetGroup targetGroup)` This method is called to attach this service to an Application Load Balancer.
`void`	`attachToClassicLB(LoadBalancer loadBalancer)` Registers the service as a target of a Classic Load Balancer (CLB).
`LoadBalancerTargetProps`	`attachToNetworkTargetGroup(INetworkTargetGroup targetGroup)` This method is called to attach this service to a Network Load Balancer.
`ScalableTaskCount`	`autoScaleTaskCount(EnableScalingProps props)` An attribute representing the minimum and maximum task count for an AutoScalingGroup.
`protected void`	`configureAwsVpcNetworking(IVpc vpc)` Deprecated. use configureAwsVpcNetworkingWithSecurityGroups instead.
`protected void`	`configureAwsVpcNetworking(IVpc vpc, java.lang.Boolean assignPublicIp)` Deprecated. use configureAwsVpcNetworkingWithSecurityGroups instead.
`protected void`	`configureAwsVpcNetworking(IVpc vpc, java.lang.Boolean assignPublicIp, SubnetSelection vpcSubnets)` Deprecated. use configureAwsVpcNetworkingWithSecurityGroups instead.
`protected void`	`configureAwsVpcNetworking(IVpc vpc, java.lang.Boolean assignPublicIp, SubnetSelection vpcSubnets, ISecurityGroup securityGroup)` Deprecated. use configureAwsVpcNetworkingWithSecurityGroups instead.
`protected void`	`configureAwsVpcNetworkingWithSecurityGroups(IVpc vpc)` This method is called to create a networkConfiguration.
`protected void`	`configureAwsVpcNetworkingWithSecurityGroups(IVpc vpc, java.lang.Boolean assignPublicIp)` This method is called to create a networkConfiguration.
`protected void`	`configureAwsVpcNetworkingWithSecurityGroups(IVpc vpc, java.lang.Boolean assignPublicIp, SubnetSelection vpcSubnets)` This method is called to create a networkConfiguration.
`protected void`	`configureAwsVpcNetworkingWithSecurityGroups(IVpc vpc, java.lang.Boolean assignPublicIp, SubnetSelection vpcSubnets, java.util.List<ISecurityGroup> securityGroups)` This method is called to create a networkConfiguration.
`Service`	`enableCloudMap(CloudMapOptions options)` Enable CloudMap service discovery for the service.
`static IBaseService`	`fromServiceArnWithCluster(software.constructs.Construct scope, java.lang.String id, java.lang.String serviceArn)` Import an existing ECS/Fargate Service using the service cluster format.
`protected Service`	`getCloudmapService()` The details of the AWS Cloud Map service.
`IService`	`getCloudMapService()` The CloudMap service created for this service, if any.
`ICluster`	`getCluster()` The cluster that hosts the service.
`Connections`	`getConnections()` The security groups which manage the allowed network traffic for the service.
`protected java.util.List<CfnService.LoadBalancerProperty>`	`getLoadBalancers()` A list of Elastic Load Balancing load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.
`protected CfnService.NetworkConfigurationProperty`	`getNetworkConfiguration()` A list of Elastic Load Balancing load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.
`java.lang.String`	`getServiceArn()` The Amazon Resource Name (ARN) of the service.
`java.lang.String`	`getServiceName()` The name of the service.
`protected java.util.List<CfnService.ServiceRegistryProperty>`	`getServiceRegistries()` The details of the service discovery registries to assign to this service.
`TaskDefinition`	`getTaskDefinition()` The task definition to use for tasks in the service.
`IEcsLoadBalancerTarget`	`loadBalancerTarget(LoadBalancerTargetOptions options)` Return a load balancing target for a specific container and port.
`Metric`	`metric(java.lang.String metricName)` This method returns the specified CloudWatch metric name for this service.
`Metric`	`metric(java.lang.String metricName, MetricOptions props)` This method returns the specified CloudWatch metric name for this service.
`Metric`	`metricCpuUtilization()` This method returns the CloudWatch metric for this service's CPU utilization.
`Metric`	`metricCpuUtilization(MetricOptions props)` This method returns the CloudWatch metric for this service's CPU utilization.
`Metric`	`metricMemoryUtilization()` This method returns the CloudWatch metric for this service's memory utilization.
`Metric`	`metricMemoryUtilization(MetricOptions props)` This method returns the CloudWatch metric for this service's memory utilization.
`void`	`registerLoadBalancerTargets(EcsTarget... targets)` Use this function to create all load balancer targets to be registered in this service, add them to target groups, and attach target groups to listeners accordingly.
`protected void`	`setCloudmapService(Service value)` The details of the AWS Cloud Map service.
`protected void`	`setLoadBalancers(java.util.List<CfnService.LoadBalancerProperty> value)` A list of Elastic Load Balancing load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.
`protected void`	`setNetworkConfiguration(CfnService.NetworkConfigurationProperty value)` A list of Elastic Load Balancing load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.
`protected void`	`setServiceRegistries(java.util.List<CfnService.ServiceRegistryProperty> value)` The details of the service discovery registries to assign to this service.

Methods inherited from class software.amazon.awscdk.core.Resource
applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.core.IResource
applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct
getNode

- Constructor Detail
  - BaseService
```
protected BaseService(software.amazon.jsii.JsiiObjectRef objRef)
```
  - BaseService
```
protected BaseService(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - BaseService
```
protected BaseService(software.constructs.Construct scope,
                      java.lang.String id,
                      BaseServiceProps props,
                      java.lang.Object additionalProps,
                      TaskDefinition taskDefinition)
```
    Constructs a new instance of the BaseService class.
    
    Parameters:
    
    scope - This parameter is required.
    
    id - This parameter is required.
    
    props - This parameter is required.
    
    additionalProps - This parameter is required.
    
    taskDefinition - This parameter is required.
- Method Detail
  - fromServiceArnWithCluster
```
public static IBaseService fromServiceArnWithCluster(software.constructs.Construct scope,
                                                     java.lang.String id,
                                                     java.lang.String serviceArn)
```
    Import an existing ECS/Fargate Service using the service cluster format.
    The format is the "new" format "arn:aws:ecs:region:aws_account_id:service/cluster-name/service-name".
    
    Parameters:
    
    scope - This parameter is required.
    
    id - This parameter is required.
    
    serviceArn - This parameter is required.
    
    See Also:
    
    https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-account-settings.html#ecs-resource-ids
  - associateCloudMapService
```
public void associateCloudMapService(AssociateCloudMapServiceOptions options)
```
    Associates this service with a CloudMap service.
    
    Parameters:
    
    options - This parameter is required.
  - attachToApplicationTargetGroup
```
public LoadBalancerTargetProps attachToApplicationTargetGroup(IApplicationTargetGroup targetGroup)
```
    This method is called to attach this service to an Application Load Balancer.
    Don't call this function directly. Instead, call listener.addTargets() to add this service to a load balancer.
    
    Specified by:
    
    attachToApplicationTargetGroup in interface IApplicationLoadBalancerTarget
    
    Parameters:
    
    targetGroup - This parameter is required.
  - attachToClassicLB
```
public void attachToClassicLB(LoadBalancer loadBalancer)
```
    Registers the service as a target of a Classic Load Balancer (CLB).
    Don't call this. Call loadBalancer.addTarget() instead.
    
    Specified by:
    
    attachToClassicLB in interface ILoadBalancerTarget
    
    Parameters:
    
    loadBalancer - This parameter is required.
  - attachToNetworkTargetGroup
```
public LoadBalancerTargetProps attachToNetworkTargetGroup(INetworkTargetGroup targetGroup)
```
    This method is called to attach this service to a Network Load Balancer.
    Don't call this function directly. Instead, call listener.addTargets() to add this service to a load balancer.
    
    Specified by:
    
    attachToNetworkTargetGroup in interface INetworkLoadBalancerTarget
    
    Parameters:
    
    targetGroup - This parameter is required.
  - autoScaleTaskCount
```
public ScalableTaskCount autoScaleTaskCount(EnableScalingProps props)
```
    An attribute representing the minimum and maximum task count for an AutoScalingGroup.
    
    Parameters:
    
    props - This parameter is required.
  - configureAwsVpcNetworking
```
@Deprecated
protected void configureAwsVpcNetworking(IVpc vpc,
                                                     java.lang.Boolean assignPublicIp,
                                                     SubnetSelection vpcSubnets,
                                                     ISecurityGroup securityGroup)
```
    Deprecated. use configureAwsVpcNetworkingWithSecurityGroups instead.
    
    (deprecated) This method is called to create a networkConfiguration.
    
    Parameters:
    
    vpc - This parameter is required.
    
    assignPublicIp -
    
    vpcSubnets -
    
    securityGroup -
  - configureAwsVpcNetworking
```
@Deprecated
protected void configureAwsVpcNetworking(IVpc vpc,
                                                     java.lang.Boolean assignPublicIp,
                                                     SubnetSelection vpcSubnets)
```
    Deprecated. use configureAwsVpcNetworkingWithSecurityGroups instead.
    
    (deprecated) This method is called to create a networkConfiguration.
    
    Parameters:
    
    vpc - This parameter is required.
    
    assignPublicIp -
    
    vpcSubnets -
  - configureAwsVpcNetworking
```
@Deprecated
protected void configureAwsVpcNetworking(IVpc vpc,
                                                     java.lang.Boolean assignPublicIp)
```
    Deprecated. use configureAwsVpcNetworkingWithSecurityGroups instead.
    
    (deprecated) This method is called to create a networkConfiguration.
    
    Parameters:
    
    vpc - This parameter is required.
    
    assignPublicIp -
  - configureAwsVpcNetworking
```
@Deprecated
protected void configureAwsVpcNetworking(IVpc vpc)
```
    Deprecated. use configureAwsVpcNetworkingWithSecurityGroups instead.
    
    (deprecated) This method is called to create a networkConfiguration.
    
    Parameters:
    
    vpc - This parameter is required.
  - configureAwsVpcNetworkingWithSecurityGroups
```
protected void configureAwsVpcNetworkingWithSecurityGroups(IVpc vpc,
                                                           java.lang.Boolean assignPublicIp,
                                                           SubnetSelection vpcSubnets,
                                                           java.util.List<ISecurityGroup> securityGroups)
```
    This method is called to create a networkConfiguration.
    
    Parameters:
    
    vpc - This parameter is required.
    
    assignPublicIp -
    
    vpcSubnets -
    
    securityGroups -
  - configureAwsVpcNetworkingWithSecurityGroups
```
protected void configureAwsVpcNetworkingWithSecurityGroups(IVpc vpc,
                                                           java.lang.Boolean assignPublicIp,
                                                           SubnetSelection vpcSubnets)
```
    This method is called to create a networkConfiguration.
    
    Parameters:
    
    vpc - This parameter is required.
    
    assignPublicIp -
    
    vpcSubnets -
  - configureAwsVpcNetworkingWithSecurityGroups
```
protected void configureAwsVpcNetworkingWithSecurityGroups(IVpc vpc,
                                                           java.lang.Boolean assignPublicIp)
```
    This method is called to create a networkConfiguration.
    
    Parameters:
    
    vpc - This parameter is required.
    
    assignPublicIp -
  - configureAwsVpcNetworkingWithSecurityGroups
```
protected void configureAwsVpcNetworkingWithSecurityGroups(IVpc vpc)
```
    This method is called to create a networkConfiguration.
    
    Parameters:
    
    vpc - This parameter is required.
  - enableCloudMap
```
public Service enableCloudMap(CloudMapOptions options)
```
    Enable CloudMap service discovery for the service.
    
    Parameters:
    
    options - This parameter is required.
    
    Returns:
    
    The created CloudMap service
  - loadBalancerTarget
```
public IEcsLoadBalancerTarget loadBalancerTarget(LoadBalancerTargetOptions options)
```
    Return a load balancing target for a specific container and port.
    Use this function to create a load balancer target if you want to load balance to another container than the first essential container or the first mapped port on the container.
    Use the return value of this function where you would normally use a load balancer target, instead of the Service object itself.
    Example:
    ApplicationListener listener; BaseService service; listener.addTargets("ECS", AddApplicationTargetsProps.builder() .port(80) .targets(List.of(service.loadBalancerTarget(LoadBalancerTargetOptions.builder() .containerName("MyContainer") .containerPort(1234) .build()))) .build());
    Parameters:
    
    options - This parameter is required.
  - metric
```
public Metric metric(java.lang.String metricName,
                     MetricOptions props)
```
    This method returns the specified CloudWatch metric name for this service.
    
    Parameters:
    
    metricName - This parameter is required.
    
    props -
  - metric
```
public Metric metric(java.lang.String metricName)
```
    This method returns the specified CloudWatch metric name for this service.
    
    Parameters:
    
    metricName - This parameter is required.
  - metricCpuUtilization
```
public Metric metricCpuUtilization(MetricOptions props)
```
    This method returns the CloudWatch metric for this service's CPU utilization.
    Default: average over 5 minutes
    
    Parameters:
    
    props -
  - metricCpuUtilization
```
public Metric metricCpuUtilization()
```
    This method returns the CloudWatch metric for this service's CPU utilization.
    Default: average over 5 minutes
  - metricMemoryUtilization
```
public Metric metricMemoryUtilization(MetricOptions props)
```
    This method returns the CloudWatch metric for this service's memory utilization.
    Default: average over 5 minutes
    
    Parameters:
    
    props -
  - metricMemoryUtilization
```
public Metric metricMemoryUtilization()
```
    This method returns the CloudWatch metric for this service's memory utilization.
    Default: average over 5 minutes
  - registerLoadBalancerTargets
```
public void registerLoadBalancerTargets(EcsTarget... targets)
```
    Use this function to create all load balancer targets to be registered in this service, add them to target groups, and attach target groups to listeners accordingly.
    Alternatively, you can use listener.addTargets() to create targets and add them to target groups.
    Example:
    ApplicationListener listener; BaseService service; service.registerLoadBalancerTargets(EcsTarget.builder() .containerName("web") .containerPort(80) .newTargetGroupId("ECS") .listener(ListenerConfig.applicationListener(listener, AddApplicationTargetsProps.builder() .protocol(ApplicationProtocol.HTTPS) .build())) .build());
    Parameters:
    
    targets - This parameter is required.
  - getCluster
```
public ICluster getCluster()
```
    The cluster that hosts the service.
    
    Specified by:
    
    getCluster in interface IBaseService
  - getConnections
```
public Connections getConnections()
```
    The security groups which manage the allowed network traffic for the service.
    
    Specified by:
    
    getConnections in interface IConnectable
  - getServiceArn
```
public java.lang.String getServiceArn()
```
    The Amazon Resource Name (ARN) of the service.
    
    Specified by:
    
    getServiceArn in interface IService
  - getServiceName
```
public java.lang.String getServiceName()
```
    The name of the service.
    
    Specified by:
    
    getServiceName in interface IService
  - getTaskDefinition
```
public TaskDefinition getTaskDefinition()
```
    The task definition to use for tasks in the service.
  - getCloudMapService
```
public IService getCloudMapService()
```
    The CloudMap service created for this service, if any.
  - getLoadBalancers
```
protected java.util.List<CfnService.LoadBalancerProperty> getLoadBalancers()
```
    A list of Elastic Load Balancing load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.
  - setLoadBalancers
```
protected void setLoadBalancers(java.util.List<CfnService.LoadBalancerProperty> value)
```
    A list of Elastic Load Balancing load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.
  - getServiceRegistries
```
protected java.util.List<CfnService.ServiceRegistryProperty> getServiceRegistries()
```
    The details of the service discovery registries to assign to this service.
    For more information, see Service Discovery.
  - setServiceRegistries
```
protected void setServiceRegistries(java.util.List<CfnService.ServiceRegistryProperty> value)
```
    The details of the service discovery registries to assign to this service.
    For more information, see Service Discovery.
  - getCloudmapService
```
protected Service getCloudmapService()
```
    The details of the AWS Cloud Map service.
  - setCloudmapService
```
protected void setCloudmapService(Service value)
```
    The details of the AWS Cloud Map service.
  - getNetworkConfiguration
```
protected CfnService.NetworkConfigurationProperty getNetworkConfiguration()
```
    A list of Elastic Load Balancing load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.
  - setNetworkConfiguration
```
protected void setNetworkConfiguration(CfnService.NetworkConfigurationProperty value)
```
    A list of Elastic Load Balancing load balancer objects, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.

Class BaseService

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.ecs.IBaseService

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.elasticloadbalancingv2.IApplicationLoadBalancerTarget

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.elasticloadbalancingv2.INetworkLoadBalancerTarget

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.elasticloadbalancing.ILoadBalancerTarget

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.Resource

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awscdk.core.IResource

Methods inherited from interface software.amazon.awscdk.core.IConstruct

Constructor Detail

BaseService

BaseService

BaseService

Method Detail

fromServiceArnWithCluster

associateCloudMapService

attachToApplicationTargetGroup

attachToClassicLB

attachToNetworkTargetGroup

autoScaleTaskCount

configureAwsVpcNetworking

configureAwsVpcNetworking

configureAwsVpcNetworking

configureAwsVpcNetworking

configureAwsVpcNetworkingWithSecurityGroups

configureAwsVpcNetworkingWithSecurityGroups

configureAwsVpcNetworkingWithSecurityGroups

configureAwsVpcNetworkingWithSecurityGroups

enableCloudMap

loadBalancerTarget

metric

metric

metricCpuUtilization

metricCpuUtilization

metricMemoryUtilization

metricMemoryUtilization

registerLoadBalancerTargets

getCluster

getConnections

getServiceArn

getServiceName

getTaskDefinition

getCloudMapService

getLoadBalancers

setLoadBalancers

getServiceRegistries

setServiceRegistries

getCloudmapService

setCloudmapService

getNetworkConfiguration

setNetworkConfiguration