software.amazon.awscdk.services.ecs

Class ExternalService

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.ecs.BaseService

software.amazon.awscdk.services.ecs.ExternalService

All Implemented Interfaces:

IConstruct, IDependable, IResource, IConnectable, IBaseService, IExternalService, IService, ILoadBalancerTarget, IApplicationLoadBalancerTarget, INetworkLoadBalancerTarget

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-11-29T04:32:27.394Z")
public class ExternalService
extends BaseService
implements IExternalService

This creates a service using the External launch type on an ECS cluster.

Example:

 Cluster cluster;
 TaskDefinition taskDefinition;
 ExternalService service = ExternalService.Builder.create(this, "Service")
         .cluster(cluster)
         .taskDefinition(taskDefinition)
         .desiredCount(5)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExternalService.Builder A fluent builder for ExternalService.

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

IExternalService.Jsii$Default, IExternalService.Jsii$Proxy

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	ExternalService(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	ExternalService(software.amazon.jsii.JsiiObjectRef objRef)
	ExternalService(software.constructs.Construct scope, java.lang.String id, ExternalServiceProps props) Constructs a new instance of the ExternalService class.

Method Summary

Modifier and Type	Method and Description
void	associateCloudMapService(AssociateCloudMapServiceOptions _options) Overriden method to throw error as `associateCloudMapService` is not supported for external service.
LoadBalancerTargetProps	attachToApplicationTargetGroup(IApplicationTargetGroup _targetGroup) Overriden method to throw error as `attachToApplicationTargetGroup` is not supported for external service.
ScalableTaskCount	autoScaleTaskCount(EnableScalingProps _props) Overriden method to throw error as `autoScaleTaskCount` is not supported for external service.
protected void	configureAwsVpcNetworkingWithSecurityGroups(IVpc _vpc) Overriden method to throw error as `configureAwsVpcNetworkingWithSecurityGroups` is not supported for external service.
protected void	configureAwsVpcNetworkingWithSecurityGroups(IVpc _vpc, java.lang.Boolean _assignPublicIp) Overriden method to throw error as `configureAwsVpcNetworkingWithSecurityGroups` is not supported for external service.
protected void	configureAwsVpcNetworkingWithSecurityGroups(IVpc _vpc, java.lang.Boolean _assignPublicIp, SubnetSelection _vpcSubnets) Overriden method to throw error as `configureAwsVpcNetworkingWithSecurityGroups` is not supported for external service.
protected void	configureAwsVpcNetworkingWithSecurityGroups(IVpc _vpc, java.lang.Boolean _assignPublicIp, SubnetSelection _vpcSubnets, java.util.List<ISecurityGroup> _securityGroups) Overriden method to throw error as `configureAwsVpcNetworkingWithSecurityGroups` is not supported for external service.
Service	enableCloudMap(CloudMapOptions _options) Overriden method to throw error as `enableCloudMap` is not supported for external service.
static IExternalService	fromExternalServiceArn(software.constructs.Construct scope, java.lang.String id, java.lang.String externalServiceArn) Imports from the specified service ARN.
static IBaseService	fromExternalServiceAttributes(software.constructs.Construct scope, java.lang.String id, ExternalServiceAttributes attrs) Imports from the specified service attributes.
IEcsLoadBalancerTarget	loadBalancerTarget(LoadBalancerTargetOptions _options) Overriden method to throw error as `loadBalancerTarget` is not supported for external service.
void	registerLoadBalancerTargets(EcsTarget... _targets) Overriden method to throw error as `registerLoadBalancerTargets` is not supported for external service.

Methods inherited from class software.amazon.awscdk.services.ecs.BaseService

attachToClassicLB, attachToNetworkTargetGroup, configureAwsVpcNetworking, configureAwsVpcNetworking, configureAwsVpcNetworking, configureAwsVpcNetworking, fromServiceArnWithCluster, getCloudmapService, getCloudMapService, getCluster, getConnections, getLoadBalancers, getNetworkConfiguration, getServiceArn, getServiceName, getServiceRegistries, getTaskDefinition, metric, metric, metricCpuUtilization, metricCpuUtilization, metricMemoryUtilization, metricMemoryUtilization, setCloudmapService, setLoadBalancers, setNetworkConfiguration, setServiceRegistries

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.services.ecs.IService

getServiceArn, getServiceName

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

applyRemovalPolicy, getEnv, getStack

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

getNode

Constructor Detail

ExternalService

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

ExternalService

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

ExternalService

public ExternalService(software.constructs.Construct scope,
                       java.lang.String id,
                       ExternalServiceProps props)

Constructs a new instance of the ExternalService class.

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromExternalServiceArn

public static IExternalService fromExternalServiceArn(software.constructs.Construct scope,
                                                      java.lang.String id,
                                                      java.lang.String externalServiceArn)

Imports from the specified service ARN.

Parameters:

scope - This parameter is required.

id - This parameter is required.

externalServiceArn - This parameter is required.

fromExternalServiceAttributes

public static IBaseService fromExternalServiceAttributes(software.constructs.Construct scope,
                                                         java.lang.String id,
                                                         ExternalServiceAttributes attrs)

Imports from the specified service attributes.

Parameters:

scope - This parameter is required.

id - This parameter is required.

attrs - This parameter is required.

associateCloudMapService

public void associateCloudMapService(AssociateCloudMapServiceOptions _options)

Overriden method to throw error as `associateCloudMapService` is not supported for external service.

Overrides:

associateCloudMapService in class BaseService

Parameters:

_options - This parameter is required.

attachToApplicationTargetGroup

public LoadBalancerTargetProps attachToApplicationTargetGroup(IApplicationTargetGroup _targetGroup)

Overriden method to throw error as `attachToApplicationTargetGroup` is not supported for external service.

Specified by:

attachToApplicationTargetGroup in interface IApplicationLoadBalancerTarget

Overrides:

attachToApplicationTargetGroup in class BaseService

Parameters:

_targetGroup - This parameter is required.

autoScaleTaskCount

public ScalableTaskCount autoScaleTaskCount(EnableScalingProps _props)

Overriden method to throw error as `autoScaleTaskCount` is not supported for external service.

Overrides:

autoScaleTaskCount in class BaseService

Parameters:

_props - This parameter is required.

configureAwsVpcNetworkingWithSecurityGroups

protected void configureAwsVpcNetworkingWithSecurityGroups(IVpc _vpc,
                                                           java.lang.Boolean _assignPublicIp,
                                                           SubnetSelection _vpcSubnets,
                                                           java.util.List<ISecurityGroup> _securityGroups)

Overriden method to throw error as `configureAwsVpcNetworkingWithSecurityGroups` is not supported for external service.

Overrides:

configureAwsVpcNetworkingWithSecurityGroups in class BaseService

Parameters:

_vpc - This parameter is required.

_assignPublicIp -

_vpcSubnets -

_securityGroups -

configureAwsVpcNetworkingWithSecurityGroups

protected void configureAwsVpcNetworkingWithSecurityGroups(IVpc _vpc,
                                                           java.lang.Boolean _assignPublicIp,
                                                           SubnetSelection _vpcSubnets)

Overriden method to throw error as `configureAwsVpcNetworkingWithSecurityGroups` is not supported for external service.

Overrides:

configureAwsVpcNetworkingWithSecurityGroups in class BaseService

Parameters:

_vpc - This parameter is required.

_assignPublicIp -

_vpcSubnets -

configureAwsVpcNetworkingWithSecurityGroups

protected void configureAwsVpcNetworkingWithSecurityGroups(IVpc _vpc,
                                                           java.lang.Boolean _assignPublicIp)

Overriden method to throw error as `configureAwsVpcNetworkingWithSecurityGroups` is not supported for external service.

Overrides:

configureAwsVpcNetworkingWithSecurityGroups in class BaseService

Parameters:

_vpc - This parameter is required.

_assignPublicIp -

configureAwsVpcNetworkingWithSecurityGroups

protected void configureAwsVpcNetworkingWithSecurityGroups(IVpc _vpc)

Overriden method to throw error as `configureAwsVpcNetworkingWithSecurityGroups` is not supported for external service.

Overrides:

configureAwsVpcNetworkingWithSecurityGroups in class BaseService

Parameters:

_vpc - This parameter is required.

enableCloudMap

public Service enableCloudMap(CloudMapOptions _options)

Overriden method to throw error as `enableCloudMap` is not supported for external service.

Overrides:

enableCloudMap in class BaseService

Parameters:

_options - This parameter is required.

Returns:

The created CloudMap service

loadBalancerTarget

public IEcsLoadBalancerTarget loadBalancerTarget(LoadBalancerTargetOptions _options)

Overriden method to throw error as `loadBalancerTarget` is not supported for external service.

Overrides:

loadBalancerTarget in class BaseService

Parameters:

_options - This parameter is required.

registerLoadBalancerTargets

public void registerLoadBalancerTargets(EcsTarget... _targets)

Overriden method to throw error as `registerLoadBalancerTargets` is not supported for external service.

Overrides:

registerLoadBalancerTargets in class BaseService

Parameters:

_targets - This parameter is required.