Class NetworkMultipleTargetGroupsFargateServiceProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<NetworkMultipleTargetGroupsFargateServiceProps>
- Enclosing interface:
NetworkMultipleTargetGroupsFargateServiceProps
NetworkMultipleTargetGroupsFargateServiceProps
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionassignPublicIp
(Boolean assignPublicIp) Sets the value ofNetworkMultipleTargetGroupsFargateServiceProps.getAssignPublicIp()
build()
Builds the configured instance.cloudMapOptions
(CloudMapOptions cloudMapOptions) Sets the value ofNetworkMultipleTargetGroupsServiceBaseProps.getCloudMapOptions()
Sets the value ofNetworkMultipleTargetGroupsServiceBaseProps.getCluster()
Sets the value ofFargateServiceBaseProps.getCpu()
desiredCount
(Number desiredCount) Sets the value ofNetworkMultipleTargetGroupsServiceBaseProps.getDesiredCount()
enableEcsManagedTags
(Boolean enableEcsManagedTags) Sets the value ofinvalid @link
NetworkMultipleTargetGroupsFargateServiceProps#getEnableEcsManagedTags
enableExecuteCommand
(Boolean enableExecuteCommand) Sets the value ofNetworkMultipleTargetGroupsServiceBaseProps.getEnableExecuteCommand()
ephemeralStorageGiB
(Number ephemeralStorageGiB) Sets the value ofFargateServiceBaseProps.getEphemeralStorageGiB()
healthCheckGracePeriod
(Duration healthCheckGracePeriod) Sets the value ofNetworkMultipleTargetGroupsServiceBaseProps.getHealthCheckGracePeriod()
loadBalancers
(List<? extends NetworkLoadBalancerProps> loadBalancers) Sets the value ofNetworkMultipleTargetGroupsServiceBaseProps.getLoadBalancers()
memoryLimitMiB
(Number memoryLimitMiB) Sets the value ofFargateServiceBaseProps.getMemoryLimitMiB()
platformVersion
(FargatePlatformVersion platformVersion) Sets the value ofFargateServiceBaseProps.getPlatformVersion()
propagateTags
(PropagatedTagSource propagateTags) Sets the value ofNetworkMultipleTargetGroupsServiceBaseProps.getPropagateTags()
runtimePlatform
(RuntimePlatform runtimePlatform) Sets the value ofFargateServiceBaseProps.getRuntimePlatform()
serviceName
(String serviceName) Sets the value ofNetworkMultipleTargetGroupsServiceBaseProps.getServiceName()
targetGroups
(List<? extends NetworkTargetProps> targetGroups) Sets the value ofNetworkMultipleTargetGroupsServiceBaseProps.getTargetGroups()
taskDefinition
(FargateTaskDefinition taskDefinition) Sets the value ofFargateServiceBaseProps.getTaskDefinition()
taskImageOptions
(NetworkLoadBalancedTaskImageProps taskImageOptions) Sets the value ofNetworkMultipleTargetGroupsServiceBaseProps.getTaskImageOptions()
Sets the value ofNetworkMultipleTargetGroupsServiceBaseProps.getVpc()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
assignPublicIp
@Stability(Stable) public NetworkMultipleTargetGroupsFargateServiceProps.Builder assignPublicIp(Boolean assignPublicIp) Sets the value ofNetworkMultipleTargetGroupsFargateServiceProps.getAssignPublicIp()
- Parameters:
assignPublicIp
- Determines whether the service will be assigned a public IP address.- Returns:
this
-
cloudMapOptions
@Stability(Stable) public NetworkMultipleTargetGroupsFargateServiceProps.Builder cloudMapOptions(CloudMapOptions cloudMapOptions) Sets the value ofNetworkMultipleTargetGroupsServiceBaseProps.getCloudMapOptions()
- Parameters:
cloudMapOptions
- The options for configuring an Amazon ECS service to use service discovery.- Returns:
this
-
cluster
@Stability(Stable) public NetworkMultipleTargetGroupsFargateServiceProps.Builder cluster(ICluster cluster) Sets the value ofNetworkMultipleTargetGroupsServiceBaseProps.getCluster()
- Parameters:
cluster
- 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.- Returns:
this
-
desiredCount
@Stability(Stable) public NetworkMultipleTargetGroupsFargateServiceProps.Builder desiredCount(Number desiredCount) Sets the value ofNetworkMultipleTargetGroupsServiceBaseProps.getDesiredCount()
- Parameters:
desiredCount
- The desired number of instantiations of the task definition to keep running on the service. The minimum value is 1- Returns:
this
-
enableEcsManagedTags
@Stability(Stable) public NetworkMultipleTargetGroupsFargateServiceProps.Builder enableEcsManagedTags(Boolean enableEcsManagedTags) Sets the value ofinvalid @link
NetworkMultipleTargetGroupsFargateServiceProps#getEnableEcsManagedTags
- Parameters:
enableEcsManagedTags
- Specifies whether to enable Amazon ECS managed tags for the tasks within the service. For more information, see Tagging Your Amazon ECS Resources- Returns:
this
-
enableExecuteCommand
@Stability(Stable) public NetworkMultipleTargetGroupsFargateServiceProps.Builder enableExecuteCommand(Boolean enableExecuteCommand) Sets the value ofNetworkMultipleTargetGroupsServiceBaseProps.getEnableExecuteCommand()
- Parameters:
enableExecuteCommand
- Whether ECS Exec should be enabled.- Returns:
this
-
healthCheckGracePeriod
@Stability(Stable) public NetworkMultipleTargetGroupsFargateServiceProps.Builder healthCheckGracePeriod(Duration healthCheckGracePeriod) Sets the value ofNetworkMultipleTargetGroupsServiceBaseProps.getHealthCheckGracePeriod()
- Parameters:
healthCheckGracePeriod
- 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.- Returns:
this
-
loadBalancers
@Stability(Stable) public NetworkMultipleTargetGroupsFargateServiceProps.Builder loadBalancers(List<? extends NetworkLoadBalancerProps> loadBalancers) Sets the value ofNetworkMultipleTargetGroupsServiceBaseProps.getLoadBalancers()
- Parameters:
loadBalancers
- The network load balancer that will serve traffic to the service.- Returns:
this
-
propagateTags
@Stability(Stable) public NetworkMultipleTargetGroupsFargateServiceProps.Builder propagateTags(PropagatedTagSource propagateTags) Sets the value ofNetworkMultipleTargetGroupsServiceBaseProps.getPropagateTags()
- Parameters:
propagateTags
- 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.- Returns:
this
-
serviceName
@Stability(Stable) public NetworkMultipleTargetGroupsFargateServiceProps.Builder serviceName(String serviceName) Sets the value ofNetworkMultipleTargetGroupsServiceBaseProps.getServiceName()
- Parameters:
serviceName
- Name of the service.- Returns:
this
-
targetGroups
@Stability(Stable) public NetworkMultipleTargetGroupsFargateServiceProps.Builder targetGroups(List<? extends NetworkTargetProps> targetGroups) Sets the value ofNetworkMultipleTargetGroupsServiceBaseProps.getTargetGroups()
- Parameters:
targetGroups
- Properties to specify NLB target groups.- Returns:
this
-
taskImageOptions
@Stability(Stable) public NetworkMultipleTargetGroupsFargateServiceProps.Builder taskImageOptions(NetworkLoadBalancedTaskImageProps taskImageOptions) Sets the value ofNetworkMultipleTargetGroupsServiceBaseProps.getTaskImageOptions()
- Parameters:
taskImageOptions
- The properties required to create a new task definition. Only one of TaskDefinition or TaskImageOptions must be specified.- Returns:
this
-
vpc
Sets the value ofNetworkMultipleTargetGroupsServiceBaseProps.getVpc()
- Parameters:
vpc
- 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.- Returns:
this
-
cpu
Sets the value ofFargateServiceBaseProps.getCpu()
- Parameters:
cpu
- 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.
- Returns:
this
-
ephemeralStorageGiB
@Stability(Stable) public NetworkMultipleTargetGroupsFargateServiceProps.Builder ephemeralStorageGiB(Number ephemeralStorageGiB) Sets the value ofFargateServiceBaseProps.getEphemeralStorageGiB()
- Parameters:
ephemeralStorageGiB
- The amount (in GiB) of ephemeral storage to be allocated to the task. The minimum supported value is21
GiB and the maximum supported value is200
GiB.Only supported in Fargate platform version 1.4.0 or later.
- Returns:
this
-
memoryLimitMiB
@Stability(Stable) public NetworkMultipleTargetGroupsFargateServiceProps.Builder memoryLimitMiB(Number memoryLimitMiB) Sets the value ofFargateServiceBaseProps.getMemoryLimitMiB()
- Parameters:
memoryLimitMiB
- 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.
- Returns:
this
-
platformVersion
@Stability(Stable) public NetworkMultipleTargetGroupsFargateServiceProps.Builder platformVersion(FargatePlatformVersion platformVersion) Sets the value ofFargateServiceBaseProps.getPlatformVersion()
- Parameters:
platformVersion
- 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.- Returns:
this
-
runtimePlatform
@Stability(Stable) public NetworkMultipleTargetGroupsFargateServiceProps.Builder runtimePlatform(RuntimePlatform runtimePlatform) Sets the value ofFargateServiceBaseProps.getRuntimePlatform()
- Parameters:
runtimePlatform
- The runtime platform of the task definition.- Returns:
this
-
taskDefinition
@Stability(Stable) public NetworkMultipleTargetGroupsFargateServiceProps.Builder taskDefinition(FargateTaskDefinition taskDefinition) Sets the value ofFargateServiceBaseProps.getTaskDefinition()
- Parameters:
taskDefinition
- The task definition to use for tasks in the service. TaskDefinition or TaskImageOptions must be specified, but not both. [disable-awslint:ref-via-interface]- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<NetworkMultipleTargetGroupsFargateServiceProps>
- Returns:
- a new instance of
NetworkMultipleTargetGroupsFargateServiceProps
- Throws:
NullPointerException
- if any required attribute was not provided
-