software.amazon.awscdk.services.ecs.patterns

Interface NetworkLoadBalancedTaskImageOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

NetworkLoadBalancedTaskImageOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.812Z")
 @Stability(value=Stable)
public interface NetworkLoadBalancedTaskImageOptions
extends software.amazon.jsii.JsiiSerializable

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

Modifier and Type	Method and Description
static NetworkLoadBalancedTaskImageOptions.Builder	builder()
default String	getContainerName() The container name value to be specified in the task definition.
default Number	getContainerPort() The port number on the container that is bound to the user-specified or automatically assigned host port.
default Map<String,String>	getDockerLabels() A key/value map of labels to add to the container.
default Boolean	getEnableLogging() Flag to indicate whether to enable logging.
default Map<String,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 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 Map<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.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getImage

@Stability(value=Stable)
 @NotNull
ContainerImage getImage()

The image used to start a container.

Image or taskDefinition must be specified, but not both.

Default: - none

getContainerName

@Stability(value=Stable)
 @Nullable
default String getContainerName()

The container name value to be specified in the task definition.

Default: - none

getContainerPort

@Stability(value=Stable)
 @Nullable
default 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

@Stability(value=Stable)
 @Nullable
default Map<String,String> getDockerLabels()

A key/value map of labels to add to the container.

Default: - No labels.

getEnableLogging

@Stability(value=Stable)
 @Nullable
default Boolean getEnableLogging()

Flag to indicate whether to enable logging.

Default: true

getEnvironment

@Stability(value=Stable)
 @Nullable
default Map<String,String> getEnvironment()

The environment variables to pass to the container.

Default: - No environment variables.

getExecutionRole

@Stability(value=Stable)
 @Nullable
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

@Stability(value=Stable)
 @Nullable
default 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

@Stability(value=Stable)
 @Nullable
default LogDriver getLogDriver()

The log driver to use.

Default: - AwsLogDriver if enableLogging is true

getSecrets

@Stability(value=Stable)
 @Nullable
default Map<String,Secret> getSecrets()

The secret to expose to the container as an environment variable.

Default: - No secret environment variables.

getTaskRole

@Stability(value=Stable)
 @Nullable
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

@Stability(value=Stable)
static NetworkLoadBalancedTaskImageOptions.Builder builder()

Returns:

a NetworkLoadBalancedTaskImageOptions.Builder of NetworkLoadBalancedTaskImageOptions