Package software.amazon.awscdk.services.ecs.patterns

Class ApplicationLoadBalancedTaskImageOptions.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.ecs.patterns.ApplicationLoadBalancedTaskImageOptions.Jsii$Proxy

All Implemented Interfaces:

ApplicationLoadBalancedTaskImageOptions, software.amazon.jsii.JsiiSerializable

Enclosing interface:

ApplicationLoadBalancedTaskImageOptions

@Stability(Stable)
@Internal
public static final class ApplicationLoadBalancedTaskImageOptions.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements ApplicationLoadBalancedTaskImageOptions

An implementation for ApplicationLoadBalancedTaskImageOptions

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.ApplicationLoadBalancedTaskImageOptions

ApplicationLoadBalancedTaskImageOptions.Builder, ApplicationLoadBalancedTaskImageOptions.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(ApplicationLoadBalancedTaskImageOptions.Builder builder)	Constructor that initializes the object based on literal property values passed by the ApplicationLoadBalancedTaskImageOptions.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 Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final List<String>	getCommand()	The command that's passed to the container.
final String	getContainerName()	The container name value to be specified in the task definition.
final Number	getContainerPort()	The port number on the container that is bound to the user-specified or automatically assigned host port.
final Map<String,String>	getDockerLabels()	A key/value map of labels to add to the container.
final Boolean	getEnableLogging()	Flag to indicate whether to enable logging.
final List<String>	getEntryPoint()	The entry point that's passed to the container.
final Map<String,String>	getEnvironment()	The environment variables to pass to the container.
final 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.
final String	getFamily()	The name of a family that this task definition is registered to.
final ContainerImage	getImage()	The image used to start a container.
final LogDriver	getLogDriver()	The log driver to use.
final Map<String,Secret>	getSecrets()	The secret to expose to the container as an environment variable.
final IRole	getTaskRole()	The name of the task IAM role that grants containers in the task permission to call AWS APIs on your behalf.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

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

protected Jsii$Proxy(ApplicationLoadBalancedTaskImageOptions.Builder builder)

Constructor that initializes the object based on literal property values passed by the ApplicationLoadBalancedTaskImageOptions.Builder.

Method Details

getImage

public final ContainerImage getImage()

Description copied from interface: ApplicationLoadBalancedTaskImageOptions

The image used to start a container.

Image or taskDefinition must be specified, not both.

Default: - none

Specified by:

getImage in interface ApplicationLoadBalancedTaskImageOptions

getCommand

public final List<String> getCommand()

Description copied from interface: ApplicationLoadBalancedTaskImageOptions

The command that's passed to the container.

If there are multiple arguments, make sure that each argument is a separated string in the array.

This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run.

For more information about the Docker CMD parameter, see https://docs.docker.com/engine/reference/builder/#cmd.

Default: none

Specified by:

getCommand in interface ApplicationLoadBalancedTaskImageOptions

getContainerName

public final String getContainerName()

Description copied from interface: ApplicationLoadBalancedTaskImageOptions

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

Default: - none

Specified by:

getContainerName in interface ApplicationLoadBalancedTaskImageOptions

getContainerPort

public final Number getContainerPort()

Description copied from interface: ApplicationLoadBalancedTaskImageOptions

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

Specified by:

getContainerPort in interface ApplicationLoadBalancedTaskImageOptions

getDockerLabels

public final Map<String,String> getDockerLabels()

Description copied from interface: ApplicationLoadBalancedTaskImageOptions

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

Default: - No labels.

Specified by:

getDockerLabels in interface ApplicationLoadBalancedTaskImageOptions

getEnableLogging

public final Boolean getEnableLogging()

Description copied from interface: ApplicationLoadBalancedTaskImageOptions

Flag to indicate whether to enable logging.

Default: true

Specified by:

getEnableLogging in interface ApplicationLoadBalancedTaskImageOptions

getEntryPoint

public final List<String> getEntryPoint()

Description copied from interface: ApplicationLoadBalancedTaskImageOptions

The entry point that's passed to the container.

This parameter maps to Entrypoint in the Create a container section of the Docker Remote API and the --entrypoint option to docker run.

For more information about the Docker ENTRYPOINT parameter, see https://docs.docker.com/engine/reference/builder/#entrypoint.

Default: none

Specified by:

getEntryPoint in interface ApplicationLoadBalancedTaskImageOptions

getEnvironment

public final Map<String,String> getEnvironment()

Description copied from interface: ApplicationLoadBalancedTaskImageOptions

The environment variables to pass to the container.

Default: - No environment variables.

Specified by:

getEnvironment in interface ApplicationLoadBalancedTaskImageOptions

getExecutionRole

public final IRole getExecutionRole()

Description copied from interface: ApplicationLoadBalancedTaskImageOptions

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

Specified by:

getExecutionRole in interface ApplicationLoadBalancedTaskImageOptions

getFamily

public final String getFamily()

Description copied from interface: ApplicationLoadBalancedTaskImageOptions

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.

Specified by:

getFamily in interface ApplicationLoadBalancedTaskImageOptions

getLogDriver

public final LogDriver getLogDriver()

Description copied from interface: ApplicationLoadBalancedTaskImageOptions

The log driver to use.

Default: - AwsLogDriver if enableLogging is true

Specified by:

getLogDriver in interface ApplicationLoadBalancedTaskImageOptions

getSecrets

public final Map<String,Secret> getSecrets()

Description copied from interface: ApplicationLoadBalancedTaskImageOptions

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

Default: - No secret environment variables.

Specified by:

getSecrets in interface ApplicationLoadBalancedTaskImageOptions

getTaskRole

public final IRole getTaskRole()

Description copied from interface: ApplicationLoadBalancedTaskImageOptions

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.

Specified by:

getTaskRole in interface ApplicationLoadBalancedTaskImageOptions

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object