software.amazon.awscdk.services.ecs

Class BaseServiceProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.ecs.BaseServiceProps.Jsii$Proxy

All Implemented Interfaces:

BaseServiceOptions, BaseServiceProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

BaseServiceProps

@Stability(value=Experimental)
 @Internal
public static final class BaseServiceProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements BaseServiceProps

An implementation for BaseServiceProps

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.BaseServiceProps

BaseServiceProps.Builder, BaseServiceProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.
protected	Jsii$Proxy(LaunchType launchType, ICluster cluster, List<? extends CapacityProviderStrategy> capacityProviderStrategies, DeploymentCircuitBreaker circuitBreaker, CloudMapOptions cloudMapOptions, DeploymentController deploymentController, Number desiredCount, Boolean enableEcsManagedTags, Boolean enableExecuteCommand, Duration healthCheckGracePeriod, Number maxHealthyPercent, Number minHealthyPercent, PropagatedTagSource propagateTags, String serviceName) Constructor that initializes the object based on literal property values passed by the BaseServiceProps.Builder.

Method Summary

Modifier and Type	Method and Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
boolean	equals(Object o)
List<CapacityProviderStrategy>	getCapacityProviderStrategies() (experimental) A list of Capacity Provider strategies used to place a service.
DeploymentCircuitBreaker	getCircuitBreaker() (experimental) Whether to enable the deployment circuit breaker.
CloudMapOptions	getCloudMapOptions() (experimental) The options for configuring an Amazon ECS service to use service discovery.
ICluster	getCluster() (experimental) The name of the cluster that hosts the service.
DeploymentController	getDeploymentController() (experimental) Specifies which deployment controller to use for the service.
Number	getDesiredCount() (experimental) The desired number of instantiations of the task definition to keep running on the service.
Boolean	getEnableECSManagedTags() (experimental) Specifies whether to enable Amazon ECS managed tags for the tasks within the service.
Boolean	getEnableExecuteCommand() (experimental) Whether to enable the ability to execute into a container.
Duration	getHealthCheckGracePeriod() (experimental) The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started.
LaunchType	getLaunchType() (experimental) The launch type on which to run your service.
Number	getMaxHealthyPercent() (experimental) The maximum number of tasks, specified as a percentage of the Amazon ECS service's DesiredCount value, that can run in a service during a deployment.
Number	getMinHealthyPercent() (experimental) The minimum number of tasks, specified as a percentage of the Amazon ECS service's DesiredCount value, that must continue to run and remain healthy during a deployment.
PropagatedTagSource	getPropagateTags() (experimental) Specifies whether to propagate the tags from the task definition or the service to the tasks in the service.
String	getServiceName() (experimental) The name of the service.
int	hashCode()

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, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.services.ecs.BaseServiceProps

builder

Constructor Detail

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(LaunchType launchType,
                     ICluster cluster,
                     List<? extends CapacityProviderStrategy> capacityProviderStrategies,
                     DeploymentCircuitBreaker circuitBreaker,
                     CloudMapOptions cloudMapOptions,
                     DeploymentController deploymentController,
                     Number desiredCount,
                     Boolean enableEcsManagedTags,
                     Boolean enableExecuteCommand,
                     Duration healthCheckGracePeriod,
                     Number maxHealthyPercent,
                     Number minHealthyPercent,
                     PropagatedTagSource propagateTags,
                     String serviceName)

Constructor that initializes the object based on literal property values passed by the BaseServiceProps.Builder.

Method Detail

getLaunchType

public final LaunchType getLaunchType()

Description copied from interface: BaseServiceProps

(experimental) The launch type on which to run your service.

LaunchType will be omitted if capacity provider strategies are specified on the service.

Specified by:

getLaunchType in interface BaseServiceProps

See Also:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-service.html#cfn-ecs-service-capacityproviderstrategy Valid values are: LaunchType.ECS or LaunchType.FARGATE or LaunchType.EXTERNAL

getCluster

public final ICluster getCluster()

Description copied from interface: BaseServiceOptions

(experimental) The name of the cluster that hosts the service.

Specified by:

getCluster in interface BaseServiceOptions

getCapacityProviderStrategies

public final List<CapacityProviderStrategy> getCapacityProviderStrategies()

Description copied from interface: BaseServiceOptions

(experimental) A list of Capacity Provider strategies used to place a service.

Default: - undefined

Specified by:

getCapacityProviderStrategies in interface BaseServiceOptions

getCircuitBreaker

public final DeploymentCircuitBreaker getCircuitBreaker()

Description copied from interface: BaseServiceOptions

(experimental) Whether to enable the deployment circuit breaker.

If this property is defined, circuit breaker will be implicitly enabled.

Default: - disabled

Specified by:

getCircuitBreaker in interface BaseServiceOptions

getCloudMapOptions

public final CloudMapOptions getCloudMapOptions()

Description copied from interface: BaseServiceOptions

(experimental) The options for configuring an Amazon ECS service to use service discovery.

Default: - AWS Cloud Map service discovery is not enabled.

Specified by:

getCloudMapOptions in interface BaseServiceOptions

getDeploymentController

public final DeploymentController getDeploymentController()

Description copied from interface: BaseServiceOptions

(experimental) Specifies which deployment controller to use for the service.

For more information, see Amazon ECS Deployment Types

Default: - Rolling update (ECS)

Specified by:

getDeploymentController in interface BaseServiceOptions

getDesiredCount

public final Number getDesiredCount()

Description copied from interface: BaseServiceOptions

(experimental) The desired number of instantiations of the task definition to keep running on the service.

Default: - When creating the service, default is 1; when updating the service, default uses the current task number.

Specified by:

getDesiredCount in interface BaseServiceOptions

getEnableECSManagedTags

public final Boolean getEnableECSManagedTags()

Description copied from interface: BaseServiceOptions

(experimental) Specifies whether to enable Amazon ECS managed tags for the tasks within the service.

For more information, see Tagging Your Amazon ECS Resources

Default: false

Specified by:

getEnableECSManagedTags in interface BaseServiceOptions

getEnableExecuteCommand

public final Boolean getEnableExecuteCommand()

Description copied from interface: BaseServiceOptions

(experimental) Whether to enable the ability to execute into a container.

Default: - undefined

Specified by:

getEnableExecuteCommand in interface BaseServiceOptions

getHealthCheckGracePeriod

public final Duration getHealthCheckGracePeriod()

Description copied from interface: BaseServiceOptions

(experimental) The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started.

Default: - defaults to 60 seconds if at least one load balancer is in-use and it is not already set

Specified by:

getHealthCheckGracePeriod in interface BaseServiceOptions

getMaxHealthyPercent

public final Number getMaxHealthyPercent()

Description copied from interface: BaseServiceOptions

(experimental) The maximum number of tasks, specified as a percentage of the Amazon ECS service's DesiredCount value, that can run in a service during a deployment.

Default: - 100 if daemon, otherwise 200

Specified by:

getMaxHealthyPercent in interface BaseServiceOptions

getMinHealthyPercent

public final Number getMinHealthyPercent()

Description copied from interface: BaseServiceOptions

(experimental) The minimum number of tasks, specified as a percentage of the Amazon ECS service's DesiredCount value, that must continue to run and remain healthy during a deployment.

Default: - 0 if daemon, otherwise 50

Specified by:

getMinHealthyPercent in interface BaseServiceOptions

getPropagateTags

public final PropagatedTagSource getPropagateTags()

Description copied from interface: BaseServiceOptions

(experimental) Specifies whether to propagate the tags from the task definition or the service to the tasks in the service.

Valid values are: PropagatedTagSource.SERVICE, PropagatedTagSource.TASK_DEFINITION or PropagatedTagSource.NONE

Default: PropagatedTagSource.NONE

Specified by:

getPropagateTags in interface BaseServiceOptions

getServiceName

public final String getServiceName()

Description copied from interface: BaseServiceOptions

(experimental) The name of the service.

Default: - CloudFormation-generated name.

Specified by:

getServiceName in interface BaseServiceOptions

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object