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

  • 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

    • 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

    • 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

    • 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

    • 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