NetworkLoadBalancedTaskImageOptions

All Known Implementing Classes:: NetworkLoadBalancedTaskImageOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-25T18:29:11.927Z")
public interface NetworkLoadBalancedTaskImageOptions

Example:

 Cluster cluster;
 NetworkLoadBalancedEc2Service loadBalancedEcsService = NetworkLoadBalancedEc2Service.Builder.create(this, "Service")
         .cluster(cluster)
         .memoryLimitMiB(1024)
         .taskImageOptions(NetworkLoadBalancedTaskImageOptions.builder()
                 .image(ContainerImage.fromRegistry("test"))
                 .environment(Map.of(
                         "TEST_ENVIRONMENT_VARIABLE1", "test environment variable 1 value",
                         "TEST_ENVIRONMENT_VARIABLE2", "test environment variable 2 value"))
                 .build())
         .desiredCount(2)
         .build();

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`NetworkLoadBalancedTaskImageOptions.Builder` A builder for `NetworkLoadBalancedTaskImageOptions`
`static class`	`NetworkLoadBalancedTaskImageOptions.Jsii$Proxy` An implementation for `NetworkLoadBalancedTaskImageOptions`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static NetworkLoadBalancedTaskImageOptions.Builder`	`builder()`
`default java.lang.String`	`getContainerName()` The container name value to be specified in the task definition.
`default java.lang.Number`	`getContainerPort()` The port number on the container that is bound to the user-specified or automatically assigned host port.
`default java.util.Map<java.lang.String,java.lang.String>`	`getDockerLabels()` A key/value map of labels to add to the container.
`default java.lang.Boolean`	`getEnableLogging()` Flag to indicate whether to enable logging.
`default java.util.Map<java.lang.String,java.lang.String>`	`getEnvironment()` The environment variables to pass to the container.
`default IRole`	`getExecutionRole()` The name of the task execution IAM role that grants the Amazon ECS container agent permission to call AWS APIs on your behalf.
`default java.lang.String`	`getFamily()` The name of a family that this task definition is registered to.
`ContainerImage`	`getImage()` The image used to start a container.
`default LogDriver`	`getLogDriver()` The log driver to use.
`default java.util.Map<java.lang.String,Secret>`	`getSecrets()` The secret to expose to the container as an environment variable.
`default IRole`	`getTaskRole()` The name of the task IAM role that grants containers in the task permission to call AWS APIs on your behalf.

- Method Detail
  - getImage
```
ContainerImage getImage()
```
    The image used to start a container.
    Image or taskDefinition must be specified, but not both.
    Default: - none
  - getContainerName
```
default java.lang.String getContainerName()
```
    The container name value to be specified in the task definition.
    Default: - none
  - getContainerPort
```
default java.lang.Number getContainerPort()
```
    The port number on the container that is bound to the user-specified or automatically assigned host port.
    If you are using containers in a task with the awsvpc or host network mode, exposed ports should be specified using containerPort. If you are using containers in a task with the bridge network mode and you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range.
    Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance.
    For more information, see hostPort.
    Default: 80
  - getDockerLabels
```
default java.util.Map<java.lang.String,java.lang.String> getDockerLabels()
```
    A key/value map of labels to add to the container.
    Default: - No labels.
  - getEnableLogging
```
default java.lang.Boolean getEnableLogging()
```
    Flag to indicate whether to enable logging.
    Default: true
  - getEnvironment
```
default java.util.Map<java.lang.String,java.lang.String> getEnvironment()
```
    The environment variables to pass to the container.
    Default: - No environment variables.
  - getExecutionRole
```
default IRole getExecutionRole()
```
    The name of the task execution IAM role that grants the Amazon ECS container agent permission to call AWS APIs on your behalf.
    Default: - No value
  - getFamily
```
default java.lang.String getFamily()
```
    The name of a family that this task definition is registered to.
    A family groups multiple versions of a task definition.
    Default: - Automatically generated name.
  - getLogDriver
```
default LogDriver getLogDriver()
```
    The log driver to use.
    Default: - AwsLogDriver if enableLogging is true
  - getSecrets
```
default java.util.Map<java.lang.String,Secret> getSecrets()
```
    The secret to expose to the container as an environment variable.
    Default: - No secret environment variables.
  - getTaskRole
```
default IRole getTaskRole()
```
    The name of the task IAM role that grants containers in the task permission to call AWS APIs on your behalf.
    Default: - A task role is automatically created for you.
  - builder
```
static NetworkLoadBalancedTaskImageOptions.Builder builder()
```
    Returns:
    
    a NetworkLoadBalancedTaskImageOptions.Builder of NetworkLoadBalancedTaskImageOptions

Interface NetworkLoadBalancedTaskImageOptions

Nested Class Summary

Method Summary

Method Detail

getImage

getContainerName

getContainerPort

getDockerLabels

getEnableLogging

getEnvironment

getExecutionRole

getFamily

getLogDriver

getSecrets

getTaskRole

builder