software.amazon.awscdk.services.ecs

Class BaseService

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.ecs.BaseService

All Implemented Interfaces:

IResource, IConnectable, IBaseService, IService, ILoadBalancerTarget, IApplicationLoadBalancerTarget, INetworkLoadBalancerTarget, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

Direct Known Subclasses:

Ec2Service, ExternalService, FargateService

@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)",
           date="2022-08-08T20:48:12.802Z")
 @Stability(value=Stable)
public abstract class BaseService
extends Resource
implements IBaseService, IApplicationLoadBalancerTarget, INetworkLoadBalancerTarget, ILoadBalancerTarget

The base class for Ec2Service and FargateService services.

Example:

 // Example automatically generated from non-compiling source. May contain errors.
 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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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.constructs.Construct scope, String id, BaseServiceProps props, Object additionalProps, TaskDefinition taskDefinition) Constructs a new instance of the BaseService class.
protected	BaseService(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	BaseService(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

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	configureAwsVpcNetworkingWithSecurityGroups(IVpc vpc) This method is called to create a networkConfiguration.
protected void	configureAwsVpcNetworkingWithSecurityGroups(IVpc vpc, Boolean assignPublicIp) This method is called to create a networkConfiguration.
protected void	configureAwsVpcNetworkingWithSecurityGroups(IVpc vpc, Boolean assignPublicIp, SubnetSelection vpcSubnets) This method is called to create a networkConfiguration.
protected void	configureAwsVpcNetworkingWithSecurityGroups(IVpc vpc, Boolean assignPublicIp, SubnetSelection vpcSubnets, 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, String id, 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 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.
String	getServiceArn() The Amazon Resource Name (ARN) of the service.
String	getServiceName() The name of the service.
protected 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(String metricName) This method returns the specified CloudWatch metric name for this service.
Metric	metric(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(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(List<CfnService.ServiceRegistryProperty> value) The details of the service discovery registries to assign to this service.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

BaseService

protected BaseService(software.amazon.jsii.JsiiObjectRef objRef)

BaseService

protected BaseService(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

BaseService

@Stability(value=Stable)
protected BaseService(@NotNull
                                               software.constructs.Construct scope,
                                               @NotNull
                                               String id,
                                               @NotNull
                                               BaseServiceProps props,
                                               @NotNull
                                               Object additionalProps,
                                               @NotNull
                                               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

@Stability(value=Stable)
 @NotNull
public static IBaseService fromServiceArnWithCluster(@NotNull
                                                                                        software.constructs.Construct scope,
                                                                                        @NotNull
                                                                                        String id,
                                                                                        @NotNull
                                                                                        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

@Stability(value=Stable)
public void associateCloudMapService(@NotNull
                                                              AssociateCloudMapServiceOptions options)

Associates this service with a CloudMap service.

Parameters:

options - This parameter is required.

attachToApplicationTargetGroup

@Stability(value=Stable)
 @NotNull
public LoadBalancerTargetProps attachToApplicationTargetGroup(@NotNull
                                                                                                 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

@Stability(value=Stable)
public void attachToClassicLB(@NotNull
                                                       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

@Stability(value=Stable)
 @NotNull
public LoadBalancerTargetProps attachToNetworkTargetGroup(@NotNull
                                                                                             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

@Stability(value=Stable)
 @NotNull
public ScalableTaskCount autoScaleTaskCount(@NotNull
                                                                               EnableScalingProps props)

An attribute representing the minimum and maximum task count for an AutoScalingGroup.

Parameters:

props - This parameter is required.

configureAwsVpcNetworkingWithSecurityGroups

@Stability(value=Stable)
protected void configureAwsVpcNetworkingWithSecurityGroups(@NotNull
                                                                                    IVpc vpc,
                                                                                    @Nullable
                                                                                    Boolean assignPublicIp,
                                                                                    @Nullable
                                                                                    SubnetSelection vpcSubnets,
                                                                                    @Nullable
                                                                                    List<ISecurityGroup> securityGroups)

This method is called to create a networkConfiguration.

Parameters:

vpc - This parameter is required.

assignPublicIp -

vpcSubnets -

securityGroups -

configureAwsVpcNetworkingWithSecurityGroups

@Stability(value=Stable)
protected void configureAwsVpcNetworkingWithSecurityGroups(@NotNull
                                                                                    IVpc vpc,
                                                                                    @Nullable
                                                                                    Boolean assignPublicIp,
                                                                                    @Nullable
                                                                                    SubnetSelection vpcSubnets)

This method is called to create a networkConfiguration.

Parameters:

vpc - This parameter is required.

assignPublicIp -

vpcSubnets -

configureAwsVpcNetworkingWithSecurityGroups

@Stability(value=Stable)
protected void configureAwsVpcNetworkingWithSecurityGroups(@NotNull
                                                                                    IVpc vpc,
                                                                                    @Nullable
                                                                                    Boolean assignPublicIp)

This method is called to create a networkConfiguration.

Parameters:

vpc - This parameter is required.

assignPublicIp -

configureAwsVpcNetworkingWithSecurityGroups

@Stability(value=Stable)
protected void configureAwsVpcNetworkingWithSecurityGroups(@NotNull
                                                                                    IVpc vpc)

This method is called to create a networkConfiguration.

Parameters:

vpc - This parameter is required.

enableCloudMap

@Stability(value=Stable)
 @NotNull
public Service enableCloudMap(@NotNull
                                                                 CloudMapOptions options)

Enable CloudMap service discovery for the service.

Parameters:

options - This parameter is required.

Returns:

The created CloudMap service

loadBalancerTarget

@Stability(value=Stable)
 @NotNull
public IEcsLoadBalancerTarget loadBalancerTarget(@NotNull
                                                                                    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

@Stability(value=Stable)
 @NotNull
public Metric metric(@NotNull
                                                        String metricName,
                                                        @Nullable
                                                        MetricOptions props)

This method returns the specified CloudWatch metric name for this service.

Parameters:

metricName - This parameter is required.

props -

metric

@Stability(value=Stable)
 @NotNull
public Metric metric(@NotNull
                                                        String metricName)

This method returns the specified CloudWatch metric name for this service.

Parameters:

metricName - This parameter is required.

metricCpuUtilization

@Stability(value=Stable)
 @NotNull
public Metric metricCpuUtilization(@Nullable
                                                                      MetricOptions props)

This method returns the CloudWatch metric for this service's CPU utilization.

Default: average over 5 minutes

Parameters:

props -

metricCpuUtilization

@Stability(value=Stable)
 @NotNull
public Metric metricCpuUtilization()

This method returns the CloudWatch metric for this service's CPU utilization.

Default: average over 5 minutes

metricMemoryUtilization

@Stability(value=Stable)
 @NotNull
public Metric metricMemoryUtilization(@Nullable
                                                                         MetricOptions props)

This method returns the CloudWatch metric for this service's memory utilization.

Default: average over 5 minutes

Parameters:

props -

metricMemoryUtilization

@Stability(value=Stable)
 @NotNull
public Metric metricMemoryUtilization()

This method returns the CloudWatch metric for this service's memory utilization.

Default: average over 5 minutes

registerLoadBalancerTargets

@Stability(value=Stable)
public void registerLoadBalancerTargets(@NotNull
                                                                 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

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

The cluster that hosts the service.

Specified by:

getCluster in interface IBaseService

getConnections

@Stability(value=Stable)
 @NotNull
public Connections getConnections()

The security groups which manage the allowed network traffic for the service.

Specified by:

getConnections in interface IConnectable

getServiceArn

@Stability(value=Stable)
 @NotNull
public String getServiceArn()

The Amazon Resource Name (ARN) of the service.

Specified by:

getServiceArn in interface IService

getServiceName

@Stability(value=Stable)
 @NotNull
public String getServiceName()

The name of the service.

Specified by:

getServiceName in interface IService

getTaskDefinition

@Stability(value=Stable)
 @NotNull
public TaskDefinition getTaskDefinition()

The task definition to use for tasks in the service.

getCloudMapService

@Stability(value=Stable)
 @Nullable
public IService getCloudMapService()

The CloudMap service created for this service, if any.

getLoadBalancers

@Stability(value=Stable)
 @NotNull
protected 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

@Stability(value=Stable)
protected void setLoadBalancers(@NotNull
                                                         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

@Stability(value=Stable)
 @NotNull
protected List<CfnService.ServiceRegistryProperty> getServiceRegistries()

The details of the service discovery registries to assign to this service.

For more information, see Service Discovery.

setServiceRegistries

@Stability(value=Stable)
protected void setServiceRegistries(@NotNull
                                                             List<CfnService.ServiceRegistryProperty> value)

The details of the service discovery registries to assign to this service.

For more information, see Service Discovery.

getCloudmapService

@Stability(value=Stable)
 @Nullable
protected Service getCloudmapService()

The details of the AWS Cloud Map service.

setCloudmapService

@Stability(value=Stable)
protected void setCloudmapService(@Nullable
                                                           Service value)

The details of the AWS Cloud Map service.

getNetworkConfiguration

@Stability(value=Stable)
 @Nullable
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

@Stability(value=Stable)
protected void setNetworkConfiguration(@Nullable
                                                                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.