Class NetworkLoadBalancedFargateServiceProps.Jsii$Proxy
- All Implemented Interfaces:
FargateServiceBaseProps
,NetworkLoadBalancedFargateServiceProps
,NetworkLoadBalancedServiceBaseProps
,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
- NetworkLoadBalancedFargateServiceProps
NetworkLoadBalancedFargateServiceProps
-
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.patterns.NetworkLoadBalancedFargateServiceProps
NetworkLoadBalancedFargateServiceProps.Builder, NetworkLoadBalancedFargateServiceProps.Jsii$Proxy
-
Constructor Summary
ModifierConstructorDescriptionprotected
Constructor that initializes the object based on literal property values passed by theNetworkLoadBalancedFargateServiceProps.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 TypeMethodDescriptioncom.fasterxml.jackson.databind.JsonNode
final boolean
final Boolean
Determines whether the service will be assigned a public IP address.final List<CapacityProviderStrategy>
A list of Capacity Provider strategies used to place a service.final DeploymentCircuitBreaker
Whether to enable the deployment circuit breaker.final CloudMapOptions
The options for configuring an Amazon ECS service to use service discovery.final ICluster
The name of the cluster that hosts the service.final Number
getCpu()
The number of cpu units used by the task.final DeploymentController
Specifies which deployment controller to use for the service.final Number
The desired number of instantiations of the task definition to keep running on the service.final String
The domain name for the service, e.g.final IHostedZone
The Route53 hosted zone for the domain, e.g.final Boolean
Specifies whether to enable Amazon ECS managed tags for the tasks within the service.final Boolean
Whether ECS Exec should be enabled.final Number
The amount (in GiB) of ephemeral storage to be allocated to the task.final Duration
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 IpAddressType
The type of IP addresses to use.final IListenerCertificate
Listener certificate list of ACM cert ARNs.final Number
Listener port of the network load balancer that will serve traffic to the service.final INetworkLoadBalancer
The network load balancer that will serve traffic to the service.final Number
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
The amount (in MiB) of memory used by the task.final Number
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 FargatePlatformVersion
The platform version on which to run your service.final PropagatedTagSource
Specifies whether to propagate the tags from the task definition or the service to the tasks in the service.final Boolean
Determines whether the Load Balancer will be internet-facing.Specifies whether the Route53 record should be a CNAME, an A record using the Alias feature or no record at all.final RuntimePlatform
The runtime platform of the task definition.final List<ISecurityGroup>
The security groups to associate with the service.final String
The name of the service.final FargateTaskDefinition
The task definition to use for tasks in the service.The properties required to create a new task definition.final SubnetSelection
The subnets to associate with the service.final IVpc
getVpc()
The VPC where the container instances will be launched or the elastic network interfaces (ENIs) will be deployed.final int
hashCode()
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 theNetworkLoadBalancedFargateServiceProps.Builder
.
-
-
Method Details
-
getAssignPublicIp
Description copied from interface:NetworkLoadBalancedFargateServiceProps
Determines whether the service will be assigned a public IP address.Default: false
- Specified by:
getAssignPublicIp
in interfaceNetworkLoadBalancedFargateServiceProps
-
getSecurityGroups
Description copied from interface:NetworkLoadBalancedFargateServiceProps
The security groups to associate with the service.If you do not specify a security group, a new security group is created.
Default: - A new security group is created.
- Specified by:
getSecurityGroups
in interfaceNetworkLoadBalancedFargateServiceProps
-
getTaskSubnets
Description copied from interface:NetworkLoadBalancedFargateServiceProps
The subnets to associate with the service.Default: - Public subnets if `assignPublicIp` is set, otherwise the first available one of Private, Isolated, Public, in that order.
- Specified by:
getTaskSubnets
in interfaceNetworkLoadBalancedFargateServiceProps
-
getCapacityProviderStrategies
Description copied from interface:NetworkLoadBalancedServiceBaseProps
A list of Capacity Provider strategies used to place a service.Default: - undefined
- Specified by:
getCapacityProviderStrategies
in interfaceNetworkLoadBalancedServiceBaseProps
-
getCircuitBreaker
Description copied from interface:NetworkLoadBalancedServiceBaseProps
Whether to enable the deployment circuit breaker.If this property is defined, circuit breaker will be implicitly enabled.
Default: - disabled
- Specified by:
getCircuitBreaker
in interfaceNetworkLoadBalancedServiceBaseProps
-
getCloudMapOptions
Description copied from interface:NetworkLoadBalancedServiceBaseProps
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 interfaceNetworkLoadBalancedServiceBaseProps
-
getCluster
Description copied from interface:NetworkLoadBalancedServiceBaseProps
The name of the cluster that hosts the service.If a cluster is specified, the vpc construct should be omitted. Alternatively, you can omit both cluster and vpc.
Default: - create a new cluster; if both cluster and vpc are omitted, a new VPC will be created for you.
- Specified by:
getCluster
in interfaceNetworkLoadBalancedServiceBaseProps
-
getDeploymentController
Description copied from interface:NetworkLoadBalancedServiceBaseProps
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 interfaceNetworkLoadBalancedServiceBaseProps
-
getDesiredCount
Description copied from interface:NetworkLoadBalancedServiceBaseProps
The desired number of instantiations of the task definition to keep running on the service.The minimum value is 1
Default: - The default is 1 for all new services and uses the existing service's desired count when updating an existing service.
- Specified by:
getDesiredCount
in interfaceNetworkLoadBalancedServiceBaseProps
-
getDomainName
Description copied from interface:NetworkLoadBalancedServiceBaseProps
The domain name for the service, e.g. "api.example.com.".Default: - No domain name.
- Specified by:
getDomainName
in interfaceNetworkLoadBalancedServiceBaseProps
-
getDomainZone
Description copied from interface:NetworkLoadBalancedServiceBaseProps
The Route53 hosted zone for the domain, e.g. "example.com.".Default: - No Route53 hosted domain zone.
- Specified by:
getDomainZone
in interfaceNetworkLoadBalancedServiceBaseProps
-
getEnableECSManagedTags
Description copied from interface:NetworkLoadBalancedServiceBaseProps
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 interfaceNetworkLoadBalancedServiceBaseProps
-
getEnableExecuteCommand
Description copied from interface:NetworkLoadBalancedServiceBaseProps
Whether ECS Exec should be enabled.Default: - false
- Specified by:
getEnableExecuteCommand
in interfaceNetworkLoadBalancedServiceBaseProps
-
getHealthCheckGracePeriod
Description copied from interface:NetworkLoadBalancedServiceBaseProps
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 interfaceNetworkLoadBalancedServiceBaseProps
-
getIpAddressType
Description copied from interface:NetworkLoadBalancedServiceBaseProps
The type of IP addresses to use.If you want to add a UDP or TCP_UDP listener to the load balancer, you must choose IPv4.
Default: IpAddressType.IPV4
- Specified by:
getIpAddressType
in interfaceNetworkLoadBalancedServiceBaseProps
- See Also:
-
getListenerCertificate
Description copied from interface:NetworkLoadBalancedServiceBaseProps
Listener certificate list of ACM cert ARNs.If you provide a certificate, the listener's protocol will be TLS. If not, the listener's protocol will be TCP.
Default: - none
- Specified by:
getListenerCertificate
in interfaceNetworkLoadBalancedServiceBaseProps
-
getListenerPort
Description copied from interface:NetworkLoadBalancedServiceBaseProps
Listener port of the network load balancer that will serve traffic to the service.Default: 80 or 443 with listenerCertificate provided
- Specified by:
getListenerPort
in interfaceNetworkLoadBalancedServiceBaseProps
-
getLoadBalancer
Description copied from interface:NetworkLoadBalancedServiceBaseProps
The network load balancer that will serve traffic to the service.If the load balancer has been imported, the vpc attribute must be specified in the call to fromNetworkLoadBalancerAttributes().
[disable-awslint:ref-via-interface]
Default: - a new load balancer will be created.
- Specified by:
getLoadBalancer
in interfaceNetworkLoadBalancedServiceBaseProps
-
getMaxHealthyPercent
Description copied from interface:NetworkLoadBalancedServiceBaseProps
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 interfaceNetworkLoadBalancedServiceBaseProps
-
getMinHealthyPercent
Description copied from interface:NetworkLoadBalancedServiceBaseProps
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 interfaceNetworkLoadBalancedServiceBaseProps
-
getPropagateTags
Description copied from interface:NetworkLoadBalancedServiceBaseProps
Specifies whether to propagate the tags from the task definition or the service to the tasks in the service.Tags can only be propagated to the tasks within the service during service creation.
Default: - none
- Specified by:
getPropagateTags
in interfaceNetworkLoadBalancedServiceBaseProps
-
getPublicLoadBalancer
Description copied from interface:NetworkLoadBalancedServiceBaseProps
Determines whether the Load Balancer will be internet-facing.Default: true
- Specified by:
getPublicLoadBalancer
in interfaceNetworkLoadBalancedServiceBaseProps
-
getRecordType
Description copied from interface:NetworkLoadBalancedServiceBaseProps
Specifies whether the Route53 record should be a CNAME, an A record using the Alias feature or no record at all.This is useful if you need to work with DNS systems that do not support alias records.
Default: NetworkLoadBalancedServiceRecordType.ALIAS
- Specified by:
getRecordType
in interfaceNetworkLoadBalancedServiceBaseProps
-
getServiceName
Description copied from interface:NetworkLoadBalancedServiceBaseProps
The name of the service.Default: - CloudFormation-generated name.
- Specified by:
getServiceName
in interfaceNetworkLoadBalancedServiceBaseProps
-
getTaskImageOptions
Description copied from interface:NetworkLoadBalancedServiceBaseProps
The properties required to create a new task definition.One of taskImageOptions or taskDefinition must be specified.
Default: - none
- Specified by:
getTaskImageOptions
in interfaceNetworkLoadBalancedServiceBaseProps
-
getVpc
Description copied from interface:NetworkLoadBalancedServiceBaseProps
The VPC where the container instances will be launched or the elastic network interfaces (ENIs) will be deployed.If a vpc is specified, the cluster construct should be omitted. Alternatively, you can omit both vpc and cluster.
Default: - uses the VPC defined in the cluster or creates a new VPC.
- Specified by:
getVpc
in interfaceNetworkLoadBalancedServiceBaseProps
-
getCpu
Description copied from interface:FargateServiceBaseProps
The number of cpu units used by the task.Valid values, which determines your range of valid values for the memory parameter:
256 (.25 vCPU) - Available memory values: 0.5GB, 1GB, 2GB
512 (.5 vCPU) - Available memory values: 1GB, 2GB, 3GB, 4GB
1024 (1 vCPU) - Available memory values: 2GB, 3GB, 4GB, 5GB, 6GB, 7GB, 8GB
2048 (2 vCPU) - Available memory values: Between 4GB and 16GB in 1GB increments
4096 (4 vCPU) - Available memory values: Between 8GB and 30GB in 1GB increments
8192 (8 vCPU) - Available memory values: Between 16GB and 60GB in 4GB increments
16384 (16 vCPU) - Available memory values: Between 32GB and 120GB in 8GB increments
This default is set in the underlying FargateTaskDefinition construct.
Default: 256
- Specified by:
getCpu
in interfaceFargateServiceBaseProps
-
getEphemeralStorageGiB
Description copied from interface:FargateServiceBaseProps
The amount (in GiB) of ephemeral storage to be allocated to the task.The minimum supported value is
21
GiB and the maximum supported value is200
GiB.Only supported in Fargate platform version 1.4.0 or later.
Default: Undefined, in which case, the task will receive 20GiB ephemeral storage.
- Specified by:
getEphemeralStorageGiB
in interfaceFargateServiceBaseProps
-
getMemoryLimitMiB
Description copied from interface:FargateServiceBaseProps
The amount (in MiB) of memory used by the task.This field is required and you must use one of the following values, which determines your range of valid values for the cpu parameter:
512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)
1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)
2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)
Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)
Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)
Between 16384 (16 GB) and 61440 (60 GB) in increments of 4096 (4 GB) - Available cpu values: 8192 (8 vCPU)
Between 32768 (32 GB) and 122880 (120 GB) in increments of 8192 (8 GB) - Available cpu values: 16384 (16 vCPU)
This default is set in the underlying FargateTaskDefinition construct.
Default: 512
- Specified by:
getMemoryLimitMiB
in interfaceFargateServiceBaseProps
-
getPlatformVersion
Description copied from interface:FargateServiceBaseProps
The platform version on which to run your service.If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
Default: Latest
- Specified by:
getPlatformVersion
in interfaceFargateServiceBaseProps
-
getRuntimePlatform
Description copied from interface:FargateServiceBaseProps
The runtime platform of the task definition.Default: - If the property is undefined, `operatingSystemFamily` is LINUX and `cpuArchitecture` is X86_64
- Specified by:
getRuntimePlatform
in interfaceFargateServiceBaseProps
-
getTaskDefinition
Description copied from interface:FargateServiceBaseProps
The task definition to use for tasks in the service. TaskDefinition or TaskImageOptions must be specified, but not both.[disable-awslint:ref-via-interface]
Default: - none
- Specified by:
getTaskDefinition
in interfaceFargateServiceBaseProps
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()- Specified by:
$jsii$toJson
in interfacesoftware.amazon.jsii.JsiiSerializable
-
equals
-
hashCode
public final int hashCode()
-