Class ApplicationLoadBalancedFargateServiceProps.Jsii$Proxy
- All Implemented Interfaces:
ApplicationLoadBalancedFargateServiceProps,ApplicationLoadBalancedServiceBaseProps,FargateServiceBaseProps,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
ApplicationLoadBalancedFargateServiceProps
ApplicationLoadBalancedFargateServiceProps-
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.patterns.ApplicationLoadBalancedFargateServiceProps
ApplicationLoadBalancedFargateServiceProps.Builder, ApplicationLoadBalancedFargateServiceProps.Jsii$Proxy -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedConstructor that initializes the object based on literal property values passed by theApplicationLoadBalancedFargateServiceProps.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 BooleanDetermines 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 ICertificateCertificate Manager certificate to associate with the load balancer.final DeploymentCircuitBreakerWhether to enable the deployment circuit breaker.final CloudMapOptionsThe options for configuring an Amazon ECS service to use service discovery.final IClusterThe name of the cluster that hosts the service.final NumberThe minimum number of CPU units to reserve for the container.final NumberThe amount (in MiB) of memory to present to the container.final NumbergetCpu()The number of cpu units used by the task.final DeploymentControllerSpecifies which deployment controller to use for the service.final NumberThe desired number of instantiations of the task definition to keep running on the service.final StringThe domain name for the service, e.g.final IHostedZoneThe Route53 hosted zone for the domain, e.g.final BooleanSpecifies whether to enable Amazon ECS managed tags for the tasks within the service.final BooleanWhether ECS Exec should be enabled.final NumberThe amount (in GiB) of ephemeral storage to be allocated to the task.final HealthCheckThe health check command and associated configuration parameters for the container.final DurationThe 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 DurationThe load balancer idle timeout, in seconds.final IpAddressTypeThe type of IP address to use.final NumberListener port of the application load balancer that will serve traffic to the service.final IApplicationLoadBalancerThe application load balancer that will serve traffic to the service.final StringName of the load balancer.final NumberThe 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 NumberThe amount (in MiB) of memory used by the task.final NumberThe 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 BooleanDetermines whether or not the Security Group for the Load Balancer's Listener will be open to all traffic by default.final FargatePlatformVersionThe platform version on which to run your service.final PropagatedTagSourceSpecifies whether to propagate the tags from the task definition or the service to the tasks in the service.final ApplicationProtocolThe protocol for connections from clients to the load balancer.The protocol version to use.final BooleanDetermines 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 BooleanSpecifies whether the load balancer should redirect traffic on port 80 to theto support HTTP->HTTPS redirects.invalid reference
listenerPortfinal RuntimePlatformThe runtime platform of the task definition.final List<ISecurityGroup> The security groups to associate with the service.final StringThe name of the service.final SslPolicyThe security policy that defines which ciphers and protocols are supported by the ALB Listener.final ApplicationProtocolThe protocol for connections from the load balancer to the ECS tasks.final FargateTaskDefinitionThe task definition to use for tasks in the service.The properties required to create a new task definition.final SubnetSelectionThe subnets to associate with the service.final IVpcgetVpc()The VPC where the container instances will be launched or the elastic network interfaces (ENIs) will be deployed.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 theApplicationLoadBalancedFargateServiceProps.Builder.
-
-
Method Details
-
getAssignPublicIp
Description copied from interface:ApplicationLoadBalancedFargateServicePropsDetermines whether the service will be assigned a public IP address.Default: false
- Specified by:
getAssignPublicIpin interfaceApplicationLoadBalancedFargateServiceProps
-
getContainerCpu
Description copied from interface:ApplicationLoadBalancedFargateServicePropsThe minimum number of CPU units to reserve for the container.Default: - No minimum CPU units reserved.
- Specified by:
getContainerCpuin interfaceApplicationLoadBalancedFargateServiceProps
-
getContainerMemoryLimitMiB
Description copied from interface:ApplicationLoadBalancedFargateServicePropsThe amount (in MiB) of memory to present to the container.If your container attempts to exceed the allocated memory, the container is terminated.
Default: - No memory limit.
- Specified by:
getContainerMemoryLimitMiBin interfaceApplicationLoadBalancedFargateServiceProps
-
getHealthCheck
Description copied from interface:ApplicationLoadBalancedFargateServicePropsThe health check command and associated configuration parameters for the container.Default: - Health check configuration from container.
- Specified by:
getHealthCheckin interfaceApplicationLoadBalancedFargateServiceProps
-
getSecurityGroups
Description copied from interface:ApplicationLoadBalancedFargateServicePropsThe 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:
getSecurityGroupsin interfaceApplicationLoadBalancedFargateServiceProps
-
getTaskSubnets
Description copied from interface:ApplicationLoadBalancedFargateServicePropsThe 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:
getTaskSubnetsin interfaceApplicationLoadBalancedFargateServiceProps
-
getCapacityProviderStrategies
Description copied from interface:ApplicationLoadBalancedServiceBasePropsA list of Capacity Provider strategies used to place a service.Default: - undefined
- Specified by:
getCapacityProviderStrategiesin interfaceApplicationLoadBalancedServiceBaseProps
-
getCertificate
Description copied from interface:ApplicationLoadBalancedServiceBasePropsCertificate Manager certificate to associate with the load balancer.Setting this option will set the load balancer protocol to HTTPS.
Default: - No certificate associated with the load balancer, if using the HTTP protocol. For HTTPS, a DNS-validated certificate will be created for the load balancer's specified domain name if a domain name and domain zone are specified.
- Specified by:
getCertificatein interfaceApplicationLoadBalancedServiceBaseProps
-
getCircuitBreaker
Description copied from interface:ApplicationLoadBalancedServiceBasePropsWhether to enable the deployment circuit breaker.If this property is defined, circuit breaker will be implicitly enabled.
Default: - disabled
- Specified by:
getCircuitBreakerin interfaceApplicationLoadBalancedServiceBaseProps
-
getCloudMapOptions
Description copied from interface:ApplicationLoadBalancedServiceBasePropsThe options for configuring an Amazon ECS service to use service discovery.Default: - AWS Cloud Map service discovery is not enabled.
- Specified by:
getCloudMapOptionsin interfaceApplicationLoadBalancedServiceBaseProps
-
getCluster
Description copied from interface:ApplicationLoadBalancedServiceBasePropsThe 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:
getClusterin interfaceApplicationLoadBalancedServiceBaseProps
-
getDeploymentController
Description copied from interface:ApplicationLoadBalancedServiceBasePropsSpecifies which deployment controller to use for the service.For more information, see Amazon ECS Deployment Types
Default: - Rolling update (ECS)
- Specified by:
getDeploymentControllerin interfaceApplicationLoadBalancedServiceBaseProps
-
getDesiredCount
Description copied from interface:ApplicationLoadBalancedServiceBasePropsThe 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:
getDesiredCountin interfaceApplicationLoadBalancedServiceBaseProps
-
getDomainName
Description copied from interface:ApplicationLoadBalancedServiceBasePropsThe domain name for the service, e.g. "api.example.com.".Default: - No domain name.
- Specified by:
getDomainNamein interfaceApplicationLoadBalancedServiceBaseProps
-
getDomainZone
Description copied from interface:ApplicationLoadBalancedServiceBasePropsThe Route53 hosted zone for the domain, e.g. "example.com.".Default: - No Route53 hosted domain zone.
- Specified by:
getDomainZonein interfaceApplicationLoadBalancedServiceBaseProps
-
getEnableECSManagedTags
Description copied from interface:ApplicationLoadBalancedServiceBasePropsSpecifies 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:
getEnableECSManagedTagsin interfaceApplicationLoadBalancedServiceBaseProps
-
getEnableExecuteCommand
Description copied from interface:ApplicationLoadBalancedServiceBasePropsWhether ECS Exec should be enabled.Default: - false
- Specified by:
getEnableExecuteCommandin interfaceApplicationLoadBalancedServiceBaseProps
-
getHealthCheckGracePeriod
Description copied from interface:ApplicationLoadBalancedServiceBasePropsThe 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:
getHealthCheckGracePeriodin interfaceApplicationLoadBalancedServiceBaseProps
-
getIdleTimeout
Description copied from interface:ApplicationLoadBalancedServiceBasePropsThe load balancer idle timeout, in seconds.Can be between 1 and 4000 seconds
Default: - CloudFormation sets idle timeout to 60 seconds
- Specified by:
getIdleTimeoutin interfaceApplicationLoadBalancedServiceBaseProps
-
getIpAddressType
Description copied from interface:ApplicationLoadBalancedServiceBasePropsThe type of IP address to use.Default: - IpAddressType.IPV4
- Specified by:
getIpAddressTypein interfaceApplicationLoadBalancedServiceBaseProps
-
getListenerPort
Description copied from interface:ApplicationLoadBalancedServiceBasePropsListener port of the application load balancer that will serve traffic to the service.Default: - The default listener port is determined from the protocol (port 80 for HTTP, port 443 for HTTPS). A domain name and zone must be also be specified if using HTTPS.
- Specified by:
getListenerPortin interfaceApplicationLoadBalancedServiceBaseProps
-
getLoadBalancer
Description copied from interface:ApplicationLoadBalancedServiceBasePropsThe application load balancer that will serve traffic to the service.The VPC attribute of a load balancer must be specified for it to be used to create a new service with this pattern.
[disable-awslint:ref-via-interface]
Default: - a new load balancer will be created.
- Specified by:
getLoadBalancerin interfaceApplicationLoadBalancedServiceBaseProps
-
getLoadBalancerName
Description copied from interface:ApplicationLoadBalancedServiceBasePropsName of the load balancer.Default: - Automatically generated name.
- Specified by:
getLoadBalancerNamein interfaceApplicationLoadBalancedServiceBaseProps
-
getMaxHealthyPercent
Description copied from interface:ApplicationLoadBalancedServiceBasePropsThe 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:
getMaxHealthyPercentin interfaceApplicationLoadBalancedServiceBaseProps
-
getMinHealthyPercent
Description copied from interface:ApplicationLoadBalancedServiceBasePropsThe 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:
getMinHealthyPercentin interfaceApplicationLoadBalancedServiceBaseProps
-
getOpenListener
Description copied from interface:ApplicationLoadBalancedServiceBasePropsDetermines whether or not the Security Group for the Load Balancer's Listener will be open to all traffic by default.Default: true -- The security group allows ingress from all IP addresses.
- Specified by:
getOpenListenerin interfaceApplicationLoadBalancedServiceBaseProps
-
getPropagateTags
Description copied from interface:ApplicationLoadBalancedServiceBasePropsSpecifies 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:
getPropagateTagsin interfaceApplicationLoadBalancedServiceBaseProps
-
getProtocol
Description copied from interface:ApplicationLoadBalancedServiceBasePropsThe protocol for connections from clients to the load balancer.The load balancer port is determined from the protocol (port 80 for HTTP, port 443 for HTTPS). If HTTPS, either a certificate or domain name and domain zone must also be specified.
Default: HTTP. If a certificate is specified, the protocol will be set by default to HTTPS.
- Specified by:
getProtocolin interfaceApplicationLoadBalancedServiceBaseProps
-
getProtocolVersion
Description copied from interface:ApplicationLoadBalancedServiceBasePropsThe protocol version to use.Default: ApplicationProtocolVersion.HTTP1
- Specified by:
getProtocolVersionin interfaceApplicationLoadBalancedServiceBaseProps
-
getPublicLoadBalancer
Description copied from interface:ApplicationLoadBalancedServiceBasePropsDetermines whether the Load Balancer will be internet-facing.Default: true
- Specified by:
getPublicLoadBalancerin interfaceApplicationLoadBalancedServiceBaseProps
-
getRecordType
Description copied from interface:ApplicationLoadBalancedServiceBasePropsSpecifies 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: ApplicationLoadBalancedServiceRecordType.ALIAS
- Specified by:
getRecordTypein interfaceApplicationLoadBalancedServiceBaseProps
-
getRedirectHTTP
Description copied from interface:ApplicationLoadBalancedServiceBasePropsSpecifies whether the load balancer should redirect traffic on port 80 to theto support HTTP->HTTPS redirects.invalid reference
listenerPortThis is only valid if the protocol of the ALB is HTTPS.
Default: false
- Specified by:
getRedirectHTTPin interfaceApplicationLoadBalancedServiceBaseProps
-
getServiceName
Description copied from interface:ApplicationLoadBalancedServiceBasePropsThe name of the service.Default: - CloudFormation-generated name.
- Specified by:
getServiceNamein interfaceApplicationLoadBalancedServiceBaseProps
-
getSslPolicy
Description copied from interface:ApplicationLoadBalancedServiceBasePropsThe security policy that defines which ciphers and protocols are supported by the ALB Listener.Default: - The recommended elastic load balancing security policy
- Specified by:
getSslPolicyin interfaceApplicationLoadBalancedServiceBaseProps
-
getTargetProtocol
Description copied from interface:ApplicationLoadBalancedServiceBasePropsThe protocol for connections from the load balancer to the ECS tasks.The default target port is determined from the protocol (port 80 for HTTP, port 443 for HTTPS).
Default: HTTP.
- Specified by:
getTargetProtocolin interfaceApplicationLoadBalancedServiceBaseProps
-
getTaskImageOptions
Description copied from interface:ApplicationLoadBalancedServiceBasePropsThe properties required to create a new task definition.TaskDefinition or TaskImageOptions must be specified, but not both.
Default: none
- Specified by:
getTaskImageOptionsin interfaceApplicationLoadBalancedServiceBaseProps
-
getVpc
Description copied from interface:ApplicationLoadBalancedServiceBasePropsThe 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:
getVpcin interfaceApplicationLoadBalancedServiceBaseProps
-
getCpu
Description copied from interface:FargateServiceBasePropsThe 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:
getCpuin interfaceFargateServiceBaseProps
-
getEphemeralStorageGiB
Description copied from interface:FargateServiceBasePropsThe amount (in GiB) of ephemeral storage to be allocated to the task.The minimum supported value is
21GiB and the maximum supported value is200GiB.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:
getEphemeralStorageGiBin interfaceFargateServiceBaseProps
-
getMemoryLimitMiB
Description copied from interface:FargateServiceBasePropsThe 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:
getMemoryLimitMiBin interfaceFargateServiceBaseProps
-
getPlatformVersion
Description copied from interface:FargateServiceBasePropsThe 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:
getPlatformVersionin interfaceFargateServiceBaseProps
-
getRuntimePlatform
Description copied from interface:FargateServiceBasePropsThe runtime platform of the task definition.Default: - If the property is undefined, `operatingSystemFamily` is LINUX and `cpuArchitecture` is X86_64
- Specified by:
getRuntimePlatformin interfaceFargateServiceBaseProps
-
getTaskDefinition
Description copied from interface:FargateServiceBasePropsThe 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:
getTaskDefinitionin interfaceFargateServiceBaseProps
-
$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()
-