Class CfnServiceProps.Jsii$Proxy
- All Implemented Interfaces:
CfnServiceProps,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
CfnServiceProps
CfnServiceProps-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationModeNested classes/interfaces inherited from interface software.amazon.awscdk.services.ecs.CfnServiceProps
CfnServiceProps.Builder, CfnServiceProps.Jsii$Proxy -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedJsii$Proxy(CfnServiceProps.Builder builder) Constructor that initializes the object based on literal property values passed by theCfnServiceProps.Builder.protectedJsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject. -
Method Summary
Modifier and TypeMethodDescriptioncom.fasterxml.jackson.databind.JsonNodefinal booleanfinal StringIndicates whether to use Availability Zone rebalancing for the service.final ObjectThe capacity provider strategy to use for the service.final ObjectThe short name or full Amazon Resource Name (ARN) of the cluster that you run your service on.final ObjectOptional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.final ObjectThe deployment controller to use for the service.final NumberThe number of instantiations of the specified task definition to place and keep running in your service.final ObjectSpecifies whether to turn on Amazon ECS managed tags for the tasks within the service.final ObjectDetermines whether the execute command functionality is turned on for the service.final ObjectDetermines whether to force a new deployment of the service.final NumberThe period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing, VPC Lattice, and container health checks after a task has first started.final StringThe launch type on which to run your service.final ObjectA list of load balancer objects to associate with the service.final ObjectThe network configuration for the service.final ObjectAn array of placement constraint objects to use for tasks in your service.final ObjectThe placement strategy objects to use for tasks in your service.final StringThe platform version that your tasks in the service are running on.final StringSpecifies whether to propagate the tags from the task definition to the task.final ObjectgetRole()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.final StringThe scheduling strategy to use for the service.final ObjectThe configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.final StringThe name of your service.final ObjectThe details of the service discovery registry to associate with this service.getTags()The metadata that you apply to the service to help you categorize and organize them.final ObjectThefamilyandrevision(family:revision) or full ARN of the task definition to run in your service.final ObjectThe configuration for a volume specified in the task definition as a volume that is configured at launch time.final ObjectThe VPC Lattice configuration for the service being created.final inthashCode()Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
-
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
Constructor that initializes the object based on literal property values passed by theCfnServiceProps.Builder.
-
-
Method Details
-
getAvailabilityZoneRebalancing
Description copied from interface:CfnServicePropsIndicates whether to use Availability Zone rebalancing for the service.For more information, see Balancing an Amazon ECS service across Availability Zones in the Amazon Elastic Container Service Developer Guide .
The default behavior of
AvailabilityZoneRebalancingdiffers between create and update requests:- For create service requests, when no value is specified for
AvailabilityZoneRebalancing, Amazon ECS defaults the value toENABLED. - For update service requests, when no value is specified for
AvailabilityZoneRebalancing, Amazon ECS defaults to the existing service’sAvailabilityZoneRebalancingvalue. If the service never had anAvailabilityZoneRebalancingvalue set, Amazon ECS treats this asDISABLED.
Default: - "ENABLED"
- Specified by:
getAvailabilityZoneRebalancingin interfaceCfnServiceProps- See Also:
- For create service requests, when no value is specified for
-
getCapacityProviderStrategy
Description copied from interface:CfnServicePropsThe capacity provider strategy to use for the service.If a
capacityProviderStrategyis specified, thelaunchTypeparameter must be omitted. If nocapacityProviderStrategyorlaunchTypeis specified, thedefaultCapacityProviderStrategyfor the cluster is used.A capacity provider strategy can contain a maximum of 20 capacity providers.
To remove this property from your service resource, specify an empty
CapacityProviderStrategyItemarray.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnService.CapacityProviderStrategyItemProperty>- Specified by:
getCapacityProviderStrategyin interfaceCfnServiceProps- See Also:
-
getCluster
Description copied from interface:CfnServicePropsThe 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.
Returns union: either
StringorIClusterRef- Specified by:
getClusterin interfaceCfnServiceProps- See Also:
-
getDeploymentConfiguration
Description copied from interface:CfnServicePropsOptional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.Returns union: either
IResolvableorCfnService.DeploymentConfigurationProperty- Specified by:
getDeploymentConfigurationin interfaceCfnServiceProps- See Also:
-
getDeploymentController
Description copied from interface:CfnServicePropsThe deployment controller to use for the service.Returns union: either
IResolvableorCfnService.DeploymentControllerProperty- Specified by:
getDeploymentControllerin interfaceCfnServiceProps- See Also:
-
getDesiredCount
Description copied from interface:CfnServicePropsThe number of instantiations of the specified task definition to place and keep running in your service.For new services, if a desired count is not specified, a default value of
1is used. When using theDAEMONscheduling 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:
getDesiredCountin interfaceCfnServiceProps- See Also:
-
getEnableEcsManagedTags
Description copied from interface:CfnServicePropsSpecifies 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 .
When you use Amazon ECS managed tags, you must set the
propagateTagsrequest parameter.Returns union: either
BooleanorIResolvable- Specified by:
getEnableEcsManagedTagsin interfaceCfnServiceProps- See Also:
-
getEnableExecuteCommand
Description copied from interface:CfnServicePropsDetermines whether the execute command functionality is turned on for the service.If
true, the execute command functionality is turned on for all containers in tasks as part of the service.Returns union: either
BooleanorIResolvable- Specified by:
getEnableExecuteCommandin interfaceCfnServiceProps- See Also:
-
getForceNewDeployment
Description copied from interface:CfnServicePropsDetermines whether to force a new deployment of the service.By default, deployments aren't forced. You can use this option to start a new deployment with no service definition changes. For example, you can update a service's tasks to use a newer Docker image with the same image/tag combination (
my_image:latest) or to roll Fargate tasks onto a newer platform version.Returns union: either
IResolvableorCfnService.ForceNewDeploymentProperty- Specified by:
getForceNewDeploymentin interfaceCfnServiceProps- See Also:
-
getHealthCheckGracePeriodSeconds
Description copied from interface:CfnServicePropsThe period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing, VPC Lattice, and container health checks after a task has first started.If you do not specify a health check grace period value, the default value of 0 is used. If you do not use any of the health checks, then
healthCheckGracePeriodSecondsis unused.If your service has more running tasks than desired, unhealthy tasks in the grace period might be stopped to reach the desired count.
- Specified by:
getHealthCheckGracePeriodSecondsin interfaceCfnServiceProps- See Also:
-
getLaunchType
Description copied from interface:CfnServicePropsThe launch type on which to run your service.For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide .
If you want to use Managed Instances, you must use the
capacityProviderStrategyrequest parameter- Specified by:
getLaunchTypein interfaceCfnServiceProps- See Also:
-
getLoadBalancers
Description copied from interface:CfnServicePropsA list of load balancer objects to associate with the service.If you specify the
Roleproperty,LoadBalancersmust 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 .To remove this property from your service resource, specify an empty
LoadBalancerarray.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnService.LoadBalancerProperty>- Specified by:
getLoadBalancersin interfaceCfnServiceProps- See Also:
-
getNetworkConfiguration
Description copied from interface:CfnServicePropsThe network configuration for the service.This parameter is required for task definitions that use the
awsvpcnetwork 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 .Returns union: either
IResolvableorCfnService.NetworkConfigurationProperty- Specified by:
getNetworkConfigurationin interfaceCfnServiceProps- See Also:
-
getPlacementConstraints
Description copied from interface:CfnServicePropsAn 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.
To remove this property from your service resource, specify an empty
PlacementConstraintarray.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnService.PlacementConstraintProperty>- Specified by:
getPlacementConstraintsin interfaceCfnServiceProps- See Also:
-
getPlacementStrategies
Description copied from interface:CfnServicePropsThe placement strategy objects to use for tasks in your service.You can specify a maximum of 5 strategy rules for each service.
To remove this property from your service resource, specify an empty
PlacementStrategyarray.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnService.PlacementStrategyProperty>- Specified by:
getPlacementStrategiesin interfaceCfnServiceProps- See Also:
-
getPlatformVersion
Description copied from interface:CfnServicePropsThe 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
LATESTplatform version is used. For more information, see AWS Fargate platform versions in the Amazon Elastic Container Service Developer Guide .Default: - "LATEST"
- Specified by:
getPlatformVersionin interfaceCfnServiceProps- See Also:
-
getPropagateTags
Description copied from interface:CfnServicePropsSpecifies whether to propagate the tags from the task definition to the task.If no value is specified, the tags aren't propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.
You must set this to a value other than
NONEwhen you use Cost Explorer. For more information, see Amazon ECS usage reports in the Amazon Elastic Container Service Developer Guide .The default is
NONE.- Specified by:
getPropagateTagsin interfaceCfnServiceProps- See Also:
-
getRole
Description copied from interface:CfnServicePropsThe 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
awsvpcnetwork mode. If you specify theroleparameter, you must also specify a load balancer object with theloadBalancersparameter.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
awsvpcnetwork 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 namebarhas a path of/foo/then you would specify/foo/baras the role name. For more information, see Friendly names and paths in the IAM User Guide .- Specified by:
getRolein interfaceCfnServiceProps- See Also:
-
getSchedulingStrategy
Description copied from interface:CfnServicePropsThe scheduling strategy to use for the service. For more information, see Services .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 theCODE_DEPLOYorEXTERNALdeployment 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_DEPLOYorEXTERNALdeployment controller types don't support theDAEMONscheduling strategy.- Specified by:
getSchedulingStrategyin interfaceCfnServiceProps- See Also:
-
getServiceConnectConfiguration
Description copied from interface:CfnServicePropsThe configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide .
Returns union: either
IResolvableorCfnService.ServiceConnectConfigurationProperty- Specified by:
getServiceConnectConfigurationin interfaceCfnServiceProps- See Also:
-
getServiceName
Description copied from interface:CfnServicePropsThe 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.
The stack update fails if you change any properties that require replacement and the
ServiceNameis configured. This is because AWS CloudFormation creates the replacement service first, but eachServiceNamemust be unique in the cluster.- Specified by:
getServiceNamein interfaceCfnServiceProps- See Also:
-
getServiceRegistries
Description copied from interface:CfnServicePropsThe details of the service discovery registry to associate with this service. For more information, see Service discovery .Each service may be associated with one service registry. Multiple service registries for each service isn't supported. > To remove this property from your service resource, specify an empty
ServiceRegistryarray.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnService.ServiceRegistryProperty>- Specified by:
getServiceRegistriesin interfaceCfnServiceProps- See Also:
-
getTags
Description copied from interface:CfnServicePropsThe 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: + - = . _ : /
- Specified by:
getTagsin interfaceCfnServiceProps- See Also:
-
getTaskDefinition
Description copied from interface:CfnServicePropsThefamilyandrevision(family:revision) or full ARN of the task definition to run in your service.If a
revisionisn't specified, the latestACTIVErevision is used.A task definition must be specified if the service uses either the
ECSorCODE_DEPLOYdeployment controllers.For more information about deployment types, see Amazon ECS deployment types .
Returns union: either
StringorITaskDefinitionRef- Specified by:
getTaskDefinitionin interfaceCfnServiceProps- See Also:
-
getVolumeConfigurations
Description copied from interface:CfnServicePropsThe configuration for a volume specified in the task definition as a volume that is configured at launch time.Currently, the only supported volume type is an Amazon EBS volume.
To remove this property from your service resource, specify an empty
ServiceVolumeConfigurationarray.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnService.ServiceVolumeConfigurationProperty>- Specified by:
getVolumeConfigurationsin interfaceCfnServiceProps- See Also:
-
getVpcLatticeConfigurations
Description copied from interface:CfnServicePropsThe VPC Lattice configuration for the service being created.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnService.VpcLatticeConfigurationProperty>- Specified by:
getVpcLatticeConfigurationsin interfaceCfnServiceProps- See Also:
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()- Specified by:
$jsii$toJsonin interfacesoftware.amazon.jsii.JsiiSerializable
-
equals
-
hashCode
public final int hashCode()
-