Package software.amazon.awscdk.services.ecs

Class Ec2ServiceProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

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

All Implemented Interfaces:

BaseServiceOptions, Ec2ServiceProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

Ec2ServiceProps

@Stability(Stable)
@Internal
public static final class Ec2ServiceProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements Ec2ServiceProps

An implementation for Ec2ServiceProps

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

Ec2ServiceProps.Builder, Ec2ServiceProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(Ec2ServiceProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the Ec2ServiceProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final Boolean	getAssignPublicIp()	Specifies whether the task's elastic network interface receives a public IP address.
final AvailabilityZoneRebalancing	getAvailabilityZoneRebalancing()	Whether to use Availability Zone rebalancing for the service.
final Duration	getBakeTime()	bake time minutes for service.
final List<CapacityProviderStrategy>	getCapacityProviderStrategies()	A list of Capacity Provider strategies used to place a service.
final DeploymentCircuitBreaker	getCircuitBreaker()	Whether to enable the deployment circuit breaker.
final CloudMapOptions	getCloudMapOptions()	The options for configuring an Amazon ECS service to use service discovery.
final ICluster	getCluster()	The name of the cluster that hosts the service.
final Boolean	getDaemon()	Specifies whether the service will use the daemon scheduling strategy.
final DeploymentAlarmConfig	getDeploymentAlarms()	The alarm(s) to monitor during deployment, and behavior to apply if at least one enters a state of alarm during the deployment or bake time.
final DeploymentController	getDeploymentController()	Specifies which deployment controller to use for the service.
final DeploymentStrategy	getDeploymentStrategy()	The deployment strategy to use for the service.
final Number	getDesiredCount()	The desired number of instantiations of the task definition to keep running on the service.
final Boolean	getEnableECSManagedTags()	Specifies whether to enable Amazon ECS managed tags for the tasks within the service.
final Boolean	getEnableExecuteCommand()	Whether to enable the ability to execute into a container.
final Duration	getHealthCheckGracePeriod()	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.
final List<IDeploymentLifecycleHookTarget>	getLifecycleHooks()	The lifecycle hooks to execute during deployment stages.
final Number	getMaxHealthyPercent()	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.
final Number	getMinHealthyPercent()	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.
final List<PlacementConstraint>	getPlacementConstraints()	The placement constraints to use for tasks in the service.
final List<PlacementStrategy>	getPlacementStrategies()	The placement strategies to use for tasks in the service.
final PropagatedTagSource	getPropagateTags()	Specifies whether to propagate the tags from the task definition or the service to the tasks in the service.
final List<ISecurityGroup>	getSecurityGroups()	The security groups to associate with the service.
final ServiceConnectProps	getServiceConnectConfiguration()	Configuration for Service Connect.
final String	getServiceName()	The name of the service.
final TaskDefinition	getTaskDefinition()	The task definition to use for tasks in the service.
final TaskDefinitionRevision	getTaskDefinitionRevision()	Revision number for the task definition or latest to use the latest active task revision.
final List<ServiceManagedVolume>	getVolumeConfigurations()	Configuration details for a volume used by the service.
final SubnetSelection	getVpcSubnets()	The subnets to associate with the service.
final 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

Constructor Details

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(Ec2ServiceProps.Builder builder)

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

Method Details

getTaskDefinition

public final TaskDefinition getTaskDefinition()

Description copied from interface: Ec2ServiceProps

The task definition to use for tasks in the service.

[disable-awslint:ref-via-interface]

Specified by:

getTaskDefinition in interface Ec2ServiceProps

getAssignPublicIp

public final Boolean getAssignPublicIp()

Description copied from interface: Ec2ServiceProps

Specifies whether the task's elastic network interface receives a public IP address.

If true, each task will receive a public IP address.

This property is only used for tasks that use the awsvpc network mode.

Default: false

Specified by:

getAssignPublicIp in interface Ec2ServiceProps

getAvailabilityZoneRebalancing

public final AvailabilityZoneRebalancing getAvailabilityZoneRebalancing()

Description copied from interface: Ec2ServiceProps

Whether to use Availability Zone rebalancing for the service.

If enabled: maxHealthyPercent must be greater than 100; daemon must be false; if there are any placementStrategies, the first must be "spread across Availability Zones"; there must be no placementConstraints using attribute:ecs.availability-zone, and the service must not be a target of a Classic Load Balancer.

Default: AvailabilityZoneRebalancing.ENABLED

Specified by:

getAvailabilityZoneRebalancing in interface Ec2ServiceProps

See Also:

• https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-rebalancing.html

getDaemon

public final Boolean getDaemon()

Description copied from interface: Ec2ServiceProps

Specifies whether the service will use the daemon scheduling strategy.

If true, the service scheduler deploys exactly one task on each container instance in your cluster.

When you are using this strategy, do not specify a desired number of tasks or any task placement strategies.

Default: false

Specified by:

getDaemon in interface Ec2ServiceProps

getPlacementConstraints

public final List<PlacementConstraint> getPlacementConstraints()

Description copied from interface: Ec2ServiceProps

The placement constraints to use for tasks in the service.

For more information, see Amazon ECS Task Placement Constraints.

Default: - No constraints.

Specified by:

getPlacementConstraints in interface Ec2ServiceProps

getPlacementStrategies

public final List<PlacementStrategy> getPlacementStrategies()

Description copied from interface: Ec2ServiceProps

The placement strategies to use for tasks in the service.

For more information, see Amazon ECS Task Placement Strategies.

Default: - No strategies.

Specified by:

getPlacementStrategies in interface Ec2ServiceProps

getSecurityGroups

public final List<ISecurityGroup> getSecurityGroups()

Description copied from interface: Ec2ServiceProps

The security groups to associate with the service.

If you do not specify a security group, a new security group is created.

This property is only used for tasks that use the awsvpc network mode.

Default: - A new security group is created.

Specified by:

getSecurityGroups in interface Ec2ServiceProps

getVpcSubnets

public final SubnetSelection getVpcSubnets()

Description copied from interface: Ec2ServiceProps

The subnets to associate with the service.

This property is only used for tasks that use the awsvpc network mode.

Default: - Public subnets if `assignPublicIp` is set, otherwise the first available one of Private, Isolated, Public, in that order.

Specified by:

getVpcSubnets in interface Ec2ServiceProps

getCluster

public final ICluster getCluster()

Description copied from interface: BaseServiceOptions

The name of the cluster that hosts the service.

Specified by:

getCluster in interface BaseServiceOptions

getBakeTime

public final Duration getBakeTime()

Description copied from interface: BaseServiceOptions

bake time minutes for service.

Default: - none

Specified by:

getBakeTime in interface BaseServiceOptions

getCapacityProviderStrategies

public final List<CapacityProviderStrategy> getCapacityProviderStrategies()

Description copied from interface: BaseServiceOptions

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

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

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

getDeploymentAlarms

public final DeploymentAlarmConfig getDeploymentAlarms()

Description copied from interface: BaseServiceOptions

The alarm(s) to monitor during deployment, and behavior to apply if at least one enters a state of alarm during the deployment or bake time.

Default: - No alarms will be monitored during deployment.

Specified by:

getDeploymentAlarms in interface BaseServiceOptions

getDeploymentController

public final DeploymentController getDeploymentController()

Description copied from interface: BaseServiceOptions

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

getDeploymentStrategy

public final DeploymentStrategy getDeploymentStrategy()

Description copied from interface: BaseServiceOptions

The deployment strategy to use for the service.

Default: ROLLING

Specified by:

getDeploymentStrategy in interface BaseServiceOptions

getDesiredCount

public final Number getDesiredCount()

Description copied from interface: BaseServiceOptions

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

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

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

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

getLifecycleHooks

public final List<IDeploymentLifecycleHookTarget> getLifecycleHooks()

Description copied from interface: BaseServiceOptions

The lifecycle hooks to execute during deployment stages.

Default: - none;

Specified by:

getLifecycleHooks in interface BaseServiceOptions

getMaxHealthyPercent

public final Number getMaxHealthyPercent()

Description copied from interface: BaseServiceOptions

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

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

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

getServiceConnectConfiguration

public final ServiceConnectProps getServiceConnectConfiguration()

Description copied from interface: BaseServiceOptions

Configuration for Service Connect.

Default: No ports are advertised via Service Connect on this service, and the service cannot make requests to other services via Service Connect.

Specified by:

getServiceConnectConfiguration in interface BaseServiceOptions

getServiceName

public final String getServiceName()

Description copied from interface: BaseServiceOptions

The name of the service.

Default: - CloudFormation-generated name.

Specified by:

getServiceName in interface BaseServiceOptions

getTaskDefinitionRevision

public final TaskDefinitionRevision getTaskDefinitionRevision()

Description copied from interface: BaseServiceOptions

Revision number for the task definition or latest to use the latest active task revision.

Default: - Uses the revision of the passed task definition deployed by CloudFormation

Specified by:

getTaskDefinitionRevision in interface BaseServiceOptions

getVolumeConfigurations

public final List<ServiceManagedVolume> getVolumeConfigurations()

Description copied from interface: BaseServiceOptions

Configuration details for a volume used by the service.

This allows you to specify details about the EBS volume that can be attched to ECS tasks.

Default: - undefined

Specified by:

getVolumeConfigurations 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