CfnServiceProps.Jsii$Proxy (software.amazon.awscdk:aws-cdk-lib 2.42.1 API)

java.lang.Object
- software.amazon.jsii.JsiiObject
- - software.amazon.awscdk.services.ecs.CfnServiceProps.Jsii$Proxy

All Implemented Interfaces:: CfnServiceProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:: CfnServiceProps

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

An implementation for CfnServiceProps

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.CfnServiceProps
  CfnServiceProps.Builder, CfnServiceProps.Jsii$Proxy

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.fasterxml.jackson.databind.JsonNode`	`$jsii$toJson()`
`boolean`	`equals(Object o)`
`Object`	`getCapacityProviderStrategy()` The capacity provider strategy to use for the service.
`String`	`getCluster()` The short name or full Amazon Resource Name (ARN) of the cluster that you run your service on.
`Object`	`getDeploymentConfiguration()` Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
`Object`	`getDeploymentController()` The deployment controller to use for the service.
`Number`	`getDesiredCount()` The number of instantiations of the specified task definition to place and keep running on your cluster.
`Object`	`getEnableEcsManagedTags()` Specifies whether to turn on Amazon ECS managed tags for the tasks within the service.
`Object`	`getEnableExecuteCommand()` Determines whether the execute command functionality is enabled for the service.
`Number`	`getHealthCheckGracePeriodSeconds()` 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.
`String`	`getLaunchType()` The launch type on which to run your service.
`Object`	`getLoadBalancers()` A list of load balancer objects to associate with the service.
`Object`	`getNetworkConfiguration()` The network configuration for the service.
`Object`	`getPlacementConstraints()` An array of placement constraint objects to use for tasks in your service.
`Object`	`getPlacementStrategies()` The placement strategy objects to use for tasks in your service.
`String`	`getPlatformVersion()` The platform version that your tasks in the service are running on.
`String`	`getPropagateTags()` Specifies whether to propagate the tags from the task definition or the service to the tasks in the service.
`String`	`getRole()` The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf.
`String`	`getSchedulingStrategy()` The scheduling strategy to use for the service.
`String`	`getServiceName()` The name of your service.
`Object`	`getServiceRegistries()` The details of the service discovery registry to associate with this service.
`List<CfnTag>`	`getTags()` The metadata that you apply to the service to help you categorize and organize them.
`String`	`getTaskDefinition()` The `family` and `revision` ( `family:revision` ) or full ARN of the task definition to run in your 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.CfnServiceProps
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(CfnServiceProps.Builder builder)
```
    Constructor that initializes the object based on literal property values passed by the CfnServiceProps.Builder.
- Method Detail
  - getCapacityProviderStrategy
```
public final Object getCapacityProviderStrategy()
```
    Description copied from interface: CfnServiceProps
    
    The capacity provider strategy to use for the service.
    A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.
    Review the Capacity provider considerations in the Amazon Elastic Container Service Developer Guide.
    If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.
    If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
    To use an AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.
    The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.
    
    Specified by:
    
    getCapacityProviderStrategy in interface CfnServiceProps
  - getCluster
```
public final String getCluster()
```
    Description copied from interface: CfnServiceProps
    
    The short name or full Amazon Resource Name (ARN) of the cluster that you run your service on.
    If you do not specify a cluster, the default cluster is assumed.
    
    Specified by:
    
    getCluster in interface CfnServiceProps
  - getDeploymentConfiguration
```
public final Object getDeploymentConfiguration()
```
    Description copied from interface: CfnServiceProps
    
    Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
    
    Specified by:
    
    getDeploymentConfiguration in interface CfnServiceProps
  - getDeploymentController
```
public final Object getDeploymentController()
```
    Description copied from interface: CfnServiceProps
    
    The deployment controller to use for the service.
    If no deployment controller is specified, the default value of ECS is used.
    
    Specified by:
    
    getDeploymentController in interface CfnServiceProps
  - getDesiredCount
```
public final Number getDesiredCount()
```
    Description copied from interface: CfnServiceProps
    
    The number of instantiations of the specified task definition to place and keep running on your cluster.
    For new services, if a desired count is not specified, a default value of 1 is used. When using the DAEMON scheduling strategy, the desired count is not required.
    For existing services, if a desired count is not specified, it is omitted from the operation.
    
    Specified by:
    
    getDesiredCount in interface CfnServiceProps
  - getEnableEcsManagedTags
```
public final Object getEnableEcsManagedTags()
```
    Description copied from interface: CfnServiceProps
    
    Specifies whether to turn on Amazon ECS managed tags for the tasks within the service.
    For more information, see Tagging your Amazon ECS resources in the Amazon Elastic Container Service Developer Guide .
    
    Specified by:
    
    getEnableEcsManagedTags in interface CfnServiceProps
  - getEnableExecuteCommand
```
public final Object getEnableExecuteCommand()
```
    Description copied from interface: CfnServiceProps
    
    Determines whether the execute command functionality is enabled for the service.
    If true , the execute command functionality is enabled for all containers in tasks as part of the service.
    
    Specified by:
    
    getEnableExecuteCommand in interface CfnServiceProps
  - getHealthCheckGracePeriodSeconds
```
public final Number getHealthCheckGracePeriodSeconds()
```
    Description copied from interface: CfnServiceProps
    
    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.
    This is only used when your service is configured to use a load balancer. If your service has a load balancer defined and you don't specify a health check grace period value, the default value of 0 is used.
    If you do not use an Elastic Load Balancing, we recomend that you use the startPeriod in the task definition healtch check parameters. For more information, see Health check .
    If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds (about 69 years). During that time, the Amazon ECS service scheduler ignores health check status. This grace period can prevent the service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.
    
    Specified by:
    
    getHealthCheckGracePeriodSeconds in interface CfnServiceProps
  - getLaunchType
```
public final String getLaunchType()
```
    Description copied from interface: CfnServiceProps
    
    The launch type on which to run your service.
    For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide .
    
    Specified by:
    
    getLaunchType in interface CfnServiceProps
  - getLoadBalancers
```
public final Object getLoadBalancers()
```
    Description copied from interface: CfnServiceProps
    
    A list of load balancer objects to associate with the service.
    If you specify the Role property, LoadBalancers must be specified as well. For information about the number of load balancers that you can specify per service, see Service Load Balancing in the Amazon Elastic Container Service Developer Guide .
    
    Specified by:
    
    getLoadBalancers in interface CfnServiceProps
  - getNetworkConfiguration
```
public final Object getNetworkConfiguration()
```
    Description copied from interface: CfnServiceProps
    
    The network configuration for the service.
    This parameter is required for task definitions that use the awsvpc network mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide .
    
    Specified by:
    
    getNetworkConfiguration in interface CfnServiceProps
  - getPlacementConstraints
```
public final Object getPlacementConstraints()
```
    Description copied from interface: CfnServiceProps
    
    An array of placement constraint objects to use for tasks in your service.
    You can specify a maximum of 10 constraints for each task. This limit includes constraints in the task definition and those specified at runtime.
    
    Specified by:
    
    getPlacementConstraints in interface CfnServiceProps
  - getPlacementStrategies
```
public final Object getPlacementStrategies()
```
    Description copied from interface: CfnServiceProps
    
    The placement strategy objects to use for tasks in your service.
    You can specify a maximum of five strategy rules per service. For more information, see Task Placement Strategies in the Amazon Elastic Container Service Developer Guide .
    
    Specified by:
    
    getPlacementStrategies in interface CfnServiceProps
  - getPlatformVersion
```
public final String getPlatformVersion()
```
    Description copied from interface: CfnServiceProps
    
    The platform version that your tasks in the service are running on.
    A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used. For more information, see AWS Fargate platform versions in the Amazon Elastic Container Service Developer Guide .
    
    Specified by:
    
    getPlatformVersion in interface CfnServiceProps
  - getPropagateTags
```
public final String getPropagateTags()
```
    Description copied from interface: CfnServiceProps
    
    Specifies whether to propagate the tags from the task definition or the service to the tasks in the service.
    If no value is specified, the tags are not propagated. Tags can only be propagated to the tasks within the service during service creation. To add tags to a task after service creation, use the TagResource API action.
    
    Specified by:
    
    getPropagateTags in interface CfnServiceProps
  - getRole
```
public final String getRole()
```
    Description copied from interface: CfnServiceProps
    
    The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf.
    This parameter is only permitted if you are using a load balancer with your service and your task definition doesn't use the awsvpc network mode. If you specify the role parameter, you must also specify a load balancer object with the loadBalancers parameter.
    
    If your account has already created the Amazon ECS service-linked role, that role is used for your service unless you specify a role here. The service-linked role is required if your task definition uses the awsvpc network mode or if the service is configured to use service discovery, an external deployment controller, multiple target groups, or Elastic Inference accelerators in which case you don't specify a role here. For more information, see Using service-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide .
    
    If your specified role has a path other than / , then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. For example, if a role with the name bar has a path of /foo/ then you would specify /foo/bar as the role name. For more information, see Friendly names and paths in the IAM User Guide .
    
    Specified by:
    
    getRole in interface CfnServiceProps
  - getSchedulingStrategy
```
public final String getSchedulingStrategy()
```
    Description copied from interface: CfnServiceProps
    The scheduling strategy to use for the service. For more information, see [Services](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html) .
    There are two service scheduler strategies available:
    - REPLICA -The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. This scheduler strategy is required if the service uses the CODE_DEPLOY or EXTERNAL deployment controller types.
    - DAEMON -The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks and will stop tasks that don't meet the placement constraints. When you're using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies.
    Tasks using the Fargate launch type or the CODE_DEPLOY or EXTERNAL deployment controller types don't support the DAEMON scheduling strategy.
    Specified by:
    
    getSchedulingStrategy in interface CfnServiceProps
  - getServiceName
```
public final String getServiceName()
```
    Description copied from interface: CfnServiceProps
    
    The name of your service.
    Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions.
    
    Specified by:
    
    getServiceName in interface CfnServiceProps
  - getServiceRegistries
```
public final Object getServiceRegistries()
```
    Description copied from interface: CfnServiceProps
    
    The details of the service discovery registry to associate with this service. For more information, see [Service discovery](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html) .
    
    Each service may be associated with one service registry. Multiple service registries for each service isn't supported.
    
    Specified by:
    
    getServiceRegistries in interface CfnServiceProps
  - getTags
```
public final List<CfnTag> getTags()
```
    Description copied from interface: CfnServiceProps
    The metadata that you apply to the service to help you categorize and organize them.
    Each tag consists of a key and an optional value, both of which you define. When a service is deleted, the tags are deleted as well.
    The following basic restrictions apply to tags:
    - Maximum number of tags per resource - 50
    - For each resource, each tag key must be unique, and each tag key can have only one value.
    - Maximum key length - 128 Unicode characters in UTF-8
    - Maximum value length - 256 Unicode characters in UTF-8
    - If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
    - Tag keys and values are case-sensitive.
    - Do not use aws: , AWS: , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
    Specified by:
    
    getTags in interface CfnServiceProps
  - getTaskDefinition
```
public final String getTaskDefinition()
```
    Description copied from interface: CfnServiceProps
    
    The `family` and `revision` ( `family:revision` ) or full ARN of the task definition to run in your service.
    The revision is required in order for the resource to stabilize.
    A task definition must be specified if the service is using either the ECS or CODE_DEPLOY deployment controllers.
    
    Specified by:
    
    getTaskDefinition in interface CfnServiceProps
  - $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

Class CfnServiceProps.Jsii$Proxy

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

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

Constructor Summary

Method Summary

Methods inherited from class software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

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

Constructor Detail

Jsii$Proxy

Jsii$Proxy

Method Detail

getCapacityProviderStrategy

getCluster

getDeploymentConfiguration

getDeploymentController

getDesiredCount

getEnableEcsManagedTags

getEnableExecuteCommand

getHealthCheckGracePeriodSeconds

getLaunchType

getLoadBalancers

getNetworkConfiguration

getPlacementConstraints

getPlacementStrategies

getPlatformVersion

getPropagateTags

getRole

getSchedulingStrategy

getServiceName

getServiceRegistries

getTags

getTaskDefinition

$jsii$toJson

equals

hashCode