Class ExternalService
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.Resource
software.amazon.awscdk.services.ecs.BaseService
software.amazon.awscdk.services.ecs.ExternalService
- All Implemented Interfaces:
IResource
,IConnectable
,IBaseService
,IExternalService
,IService
,ILoadBalancerTarget
,IApplicationLoadBalancerTarget
,INetworkLoadBalancerTarget
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2024-11-27T16:50:57.012Z")
@Stability(Stable)
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/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
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.ecs.IBaseService
IBaseService.Jsii$Default
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
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.elasticloadbalancing.ILoadBalancerTarget
ILoadBalancerTarget.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.IResource
IResource.Jsii$Default
-
Constructor Summary
ModifierConstructorDescriptionprotected
ExternalService
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
ExternalService
(software.amazon.jsii.JsiiObjectRef objRef) ExternalService
(software.constructs.Construct scope, String id, ExternalServiceProps props) Constructs a new instance of the ExternalService class. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Overriden method to throw error asassociateCloudMapService
is not supported for external service.attachToApplicationTargetGroup
(IApplicationTargetGroup _targetGroup) Overriden method to throw error asattachToApplicationTargetGroup
is not supported for external service.autoScaleTaskCount
(EnableScalingProps _props) Overriden method to throw error asautoScaleTaskCount
is not supported for external service.protected void
Overriden method to throw error asconfigureAwsVpcNetworkingWithSecurityGroups
is not supported for external service.protected void
configureAwsVpcNetworkingWithSecurityGroups
(IVpc _vpc, Boolean _assignPublicIp) Overriden method to throw error asconfigureAwsVpcNetworkingWithSecurityGroups
is not supported for external service.protected void
configureAwsVpcNetworkingWithSecurityGroups
(IVpc _vpc, Boolean _assignPublicIp, SubnetSelection _vpcSubnets) Overriden method to throw error asconfigureAwsVpcNetworkingWithSecurityGroups
is not supported for external service.protected void
configureAwsVpcNetworkingWithSecurityGroups
(IVpc _vpc, Boolean _assignPublicIp, SubnetSelection _vpcSubnets, List<ISecurityGroup> _securityGroups) Overriden method to throw error asconfigureAwsVpcNetworkingWithSecurityGroups
is not supported for external service.enableCloudMap
(CloudMapOptions _options) Overriden method to throw error asenableCloudMap
is not supported for external service.static IExternalService
fromExternalServiceArn
(software.constructs.Construct scope, String id, String externalServiceArn) Imports from the specified service ARN.static IBaseService
fromExternalServiceAttributes
(software.constructs.Construct scope, String id, ExternalServiceAttributes attrs) Imports from the specified service attributes.loadBalancerTarget
(LoadBalancerTargetOptions _options) Overriden method to throw error asloadBalancerTarget
is not supported for external service.void
registerLoadBalancerTargets
(@NotNull EcsTarget... _targets) Overriden method to throw error asregisterLoadBalancerTargets
is not supported for external service.Methods inherited from class software.amazon.awscdk.services.ecs.BaseService
addVolume, attachToClassicLB, attachToNetworkTargetGroup, enableDeploymentAlarms, enableDeploymentAlarms, enableServiceConnect, enableServiceConnect, fromServiceArnWithCluster, getCloudmapService, getCloudMapService, getCluster, getConnections, getDeploymentAlarms, getLoadBalancers, getNetworkConfiguration, getServiceArn, getServiceName, getServiceRegistries, getTaskDefinition, metric, metric, metricCpuUtilization, metricCpuUtilization, metricMemoryUtilization, metricMemoryUtilization, setCloudmapService, setDeploymentAlarms, setLoadBalancers, setNetworkConfiguration, setServiceRegistries
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.constructs.IConstruct
getNode
Methods inherited from interface software.amazon.awscdk.IResource
applyRemovalPolicy, getEnv, getStack
Methods inherited from interface software.amazon.awscdk.services.ecs.IService
getServiceArn, getServiceName
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Constructor Details
-
ExternalService
protected ExternalService(software.amazon.jsii.JsiiObjectRef objRef) -
ExternalService
protected ExternalService(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
ExternalService
@Stability(Stable) public ExternalService(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull 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 Details
-
fromExternalServiceArn
@Stability(Stable) @NotNull public static IExternalService fromExternalServiceArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull 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
@Stability(Stable) @NotNull public static IBaseService fromExternalServiceAttributes(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull 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
@Stability(Stable) public void associateCloudMapService(@NotNull AssociateCloudMapServiceOptions _options) Overriden method to throw error asassociateCloudMapService
is not supported for external service.- Overrides:
associateCloudMapService
in classBaseService
- Parameters:
_options
- This parameter is required.
-
attachToApplicationTargetGroup
@Stability(Stable) @NotNull public LoadBalancerTargetProps attachToApplicationTargetGroup(@NotNull IApplicationTargetGroup _targetGroup) Overriden method to throw error asattachToApplicationTargetGroup
is not supported for external service.- Specified by:
attachToApplicationTargetGroup
in interfaceIApplicationLoadBalancerTarget
- Overrides:
attachToApplicationTargetGroup
in classBaseService
- Parameters:
_targetGroup
- This parameter is required.
-
autoScaleTaskCount
@Stability(Stable) @NotNull public ScalableTaskCount autoScaleTaskCount(@NotNull EnableScalingProps _props) Overriden method to throw error asautoScaleTaskCount
is not supported for external service.- Overrides:
autoScaleTaskCount
in classBaseService
- Parameters:
_props
- This parameter is required.
-
configureAwsVpcNetworkingWithSecurityGroups
@Stability(Stable) protected void configureAwsVpcNetworkingWithSecurityGroups(@NotNull IVpc _vpc, @Nullable Boolean _assignPublicIp, @Nullable SubnetSelection _vpcSubnets, @Nullable List<ISecurityGroup> _securityGroups) Overriden method to throw error asconfigureAwsVpcNetworkingWithSecurityGroups
is not supported for external service.- Overrides:
configureAwsVpcNetworkingWithSecurityGroups
in classBaseService
- Parameters:
_vpc
- This parameter is required._assignPublicIp
-_vpcSubnets
-_securityGroups
-
-
configureAwsVpcNetworkingWithSecurityGroups
@Stability(Stable) protected void configureAwsVpcNetworkingWithSecurityGroups(@NotNull IVpc _vpc, @Nullable Boolean _assignPublicIp, @Nullable SubnetSelection _vpcSubnets) Overriden method to throw error asconfigureAwsVpcNetworkingWithSecurityGroups
is not supported for external service.- Overrides:
configureAwsVpcNetworkingWithSecurityGroups
in classBaseService
- Parameters:
_vpc
- This parameter is required._assignPublicIp
-_vpcSubnets
-
-
configureAwsVpcNetworkingWithSecurityGroups
@Stability(Stable) protected void configureAwsVpcNetworkingWithSecurityGroups(@NotNull IVpc _vpc, @Nullable Boolean _assignPublicIp) Overriden method to throw error asconfigureAwsVpcNetworkingWithSecurityGroups
is not supported for external service.- Overrides:
configureAwsVpcNetworkingWithSecurityGroups
in classBaseService
- Parameters:
_vpc
- This parameter is required._assignPublicIp
-
-
configureAwsVpcNetworkingWithSecurityGroups
Overriden method to throw error asconfigureAwsVpcNetworkingWithSecurityGroups
is not supported for external service.- Overrides:
configureAwsVpcNetworkingWithSecurityGroups
in classBaseService
- Parameters:
_vpc
- This parameter is required.
-
enableCloudMap
Overriden method to throw error asenableCloudMap
is not supported for external service.- Overrides:
enableCloudMap
in classBaseService
- Parameters:
_options
- This parameter is required.- Returns:
- The created CloudMap service
-
loadBalancerTarget
@Stability(Stable) @NotNull public IEcsLoadBalancerTarget loadBalancerTarget(@NotNull LoadBalancerTargetOptions _options) Overriden method to throw error asloadBalancerTarget
is not supported for external service.- Overrides:
loadBalancerTarget
in classBaseService
- Parameters:
_options
- This parameter is required.
-
registerLoadBalancerTargets
Overriden method to throw error asregisterLoadBalancerTargets
is not supported for external service.- Overrides:
registerLoadBalancerTargets
in classBaseService
- Parameters:
_targets
- This parameter is required.
-