Class CfnDaemonTaskDefinition.DaemonContainerDefinitionProperty.Jsii$Proxy
- All Implemented Interfaces:
CfnDaemonTaskDefinition.DaemonContainerDefinitionProperty,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
CfnDaemonTaskDefinition.DaemonContainerDefinitionProperty
CfnDaemonTaskDefinition.DaemonContainerDefinitionProperty-
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.CfnDaemonTaskDefinition.DaemonContainerDefinitionProperty
CfnDaemonTaskDefinition.DaemonContainerDefinitionProperty.Builder, CfnDaemonTaskDefinition.DaemonContainerDefinitionProperty.Jsii$Proxy -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedConstructor that initializes the object based on literal property values passed by theCfnDaemonTaskDefinition.DaemonContainerDefinitionProperty.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 booleanThe command that's passed to the container.final NumbergetCpu()The number ofcpuunits reserved for the container.final ObjectThe dependencies defined for container startup and shutdown.The entry point that's passed to the container.final ObjectThe environment variables to pass to a container.final ObjectA list of files containing the environment variables to pass to a container.final ObjectIf theessentialparameter of a container is marked astrue, and that container fails or stops for any reason, all other containers that are part of the task are stopped.final ObjectThe FireLens configuration for the container.final ObjectAn object representing a container health check.final StringgetImage()The image used to start the container.final ObjectWhen this parameter istrue, you can deploy containerized applications that requirestdinor attyto be allocated.final ObjectThe Linux-specific options that are applied to the container, such as Linux KernelCapabilities.final ObjectThe log configuration for the container.final NumberThe amount (in MiB) of memory to present to the container.final NumberThe soft limit (in MiB) of memory to reserve for the container.final ObjectThe mount points for data volumes in your container.final StringgetName()The name of the container.final ObjectWhen this parameter is true, the container is given elevated privileges on the host container instance (similar to therootuser).final ObjectWhen this parameter istrue, a TTY is allocated.final ObjectWhen this parameter is true, the container is given read-only access to its root file system.final ObjectThe repository credentials for private registry authentication.final ObjectReturns union: eitherIResolvableorCfnDaemonTaskDefinition.RestartPolicyPropertyfinal ObjectThe secrets to pass to the container.final NumberTime duration (in seconds) to wait before giving up on resolving dependencies for a container.final NumberTime duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own.final ObjectA list of namespaced kernel parameters to set in the container.final ObjectA list ofulimitsto set in the container.final StringgetUser()The user to use inside the container.final StringThe working directory to run commands inside the container in.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 theCfnDaemonTaskDefinition.DaemonContainerDefinitionProperty.Builder.
-
-
Method Details
-
getImage
Description copied from interface:CfnDaemonTaskDefinition.DaemonContainerDefinitionPropertyThe image used to start the container.This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with either
repository-url/image:tagorrepository-url/image@digest.- Specified by:
getImagein interfaceCfnDaemonTaskDefinition.DaemonContainerDefinitionProperty- See Also:
-
getName
Description copied from interface:CfnDaemonTaskDefinition.DaemonContainerDefinitionPropertyThe name of the container.Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.
- Specified by:
getNamein interfaceCfnDaemonTaskDefinition.DaemonContainerDefinitionProperty- See Also:
-
getCommand
Description copied from interface:CfnDaemonTaskDefinition.DaemonContainerDefinitionPropertyThe command that's passed to the container.- Specified by:
getCommandin interfaceCfnDaemonTaskDefinition.DaemonContainerDefinitionProperty- See Also:
-
getCpu
Description copied from interface:CfnDaemonTaskDefinition.DaemonContainerDefinitionPropertyThe number ofcpuunits reserved for the container.- Specified by:
getCpuin interfaceCfnDaemonTaskDefinition.DaemonContainerDefinitionProperty- See Also:
-
getDependsOn
Description copied from interface:CfnDaemonTaskDefinition.DaemonContainerDefinitionPropertyThe dependencies defined for container startup and shutdown.A container can contain multiple dependencies on other containers in a task definition.
Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnDaemonTaskDefinition.ContainerDependencyProperty>- Specified by:
getDependsOnin interfaceCfnDaemonTaskDefinition.DaemonContainerDefinitionProperty- See Also:
-
getEntryPoint
Description copied from interface:CfnDaemonTaskDefinition.DaemonContainerDefinitionPropertyThe entry point that's passed to the container.- Specified by:
getEntryPointin interfaceCfnDaemonTaskDefinition.DaemonContainerDefinitionProperty- See Also:
-
getEnvironment
Description copied from interface:CfnDaemonTaskDefinition.DaemonContainerDefinitionPropertyThe environment variables to pass to a container.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnDaemonTaskDefinition.KeyValuePairProperty>- Specified by:
getEnvironmentin interfaceCfnDaemonTaskDefinition.DaemonContainerDefinitionProperty- See Also:
-
getEnvironmentFiles
Description copied from interface:CfnDaemonTaskDefinition.DaemonContainerDefinitionPropertyA list of files containing the environment variables to pass to a container.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnDaemonTaskDefinition.EnvironmentFileProperty>- Specified by:
getEnvironmentFilesin interfaceCfnDaemonTaskDefinition.DaemonContainerDefinitionProperty- See Also:
-
getEssential
Description copied from interface:CfnDaemonTaskDefinition.DaemonContainerDefinitionPropertyIf theessentialparameter of a container is marked astrue, and that container fails or stops for any reason, all other containers that are part of the task are stopped.Returns union: either
BooleanorIResolvable- Specified by:
getEssentialin interfaceCfnDaemonTaskDefinition.DaemonContainerDefinitionProperty- See Also:
-
getFirelensConfiguration
Description copied from interface:CfnDaemonTaskDefinition.DaemonContainerDefinitionPropertyThe FireLens configuration for the container.This is used to specify and configure a log router for container logs. For more information, see Custom log routing in the Amazon Elastic Container Service Developer Guide.
Returns union: either
IResolvableorCfnDaemonTaskDefinition.FirelensConfigurationProperty- Specified by:
getFirelensConfigurationin interfaceCfnDaemonTaskDefinition.DaemonContainerDefinitionProperty- See Also:
-
getHealthCheck
Description copied from interface:CfnDaemonTaskDefinition.DaemonContainerDefinitionPropertyAn object representing a container health check.Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image (such as those specified in a parent image or from the image's Dockerfile). This configuration maps to the
HEALTHCHECKparameter of docker run. The Amazon ECS container agent only monitors and reports on the health checks specified in the task definition. Amazon ECS does not monitor Docker health checks that are embedded in a container image and not specified in the container definition. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image. You can view the health status of both individual containers and a task with the DescribeTasks API operation or when viewing the task details in the console. The health check is designed to make sure that your containers survive agent restarts, upgrades, or temporary unavailability. Amazon ECS performs health checks on containers with the default that launched the container instance or the task. The following describes the possiblehealthStatusvalues for a container:HEALTHY-The container health check has passed successfully.UNHEALTHY-The container health check has failed.UNKNOWN-The container health check is being evaluated, there's no container health check defined, or Amazon ECS doesn't have the health status of the container.
The following describes the possible
healthStatusvalues based on the container health checker status of essential containers in the task with the following priority order (high to low):UNHEALTHY-One or more essential containers have failed their health check.UNKNOWN-Any essential container running within the task is in anUNKNOWNstate and no other essential containers have anUNHEALTHYstate.HEALTHY-All essential containers within the task have passed their health checks.
Consider the following task health example with 2 containers.
- If Container1 is
UNHEALTHYand Container2 isUNKNOWN, the task health isUNHEALTHY. - If Container1 is
UNHEALTHYand Container2 isHEALTHY, the task health isUNHEALTHY. - If Container1 is
HEALTHYand Container2 isUNKNOWN, the task health isUNKNOWN. - If Container1 is
HEALTHYand Container2 isHEALTHY, the task health isHEALTHY.
Consider the following task health example with 3 containers.
- If Container1 is
UNHEALTHYand Container2 isUNKNOWN, and Container3 isUNKNOWN, the task health isUNHEALTHY. - If Container1 is
UNHEALTHYand Container2 isUNKNOWN, and Container3 isHEALTHY, the task health isUNHEALTHY. - If Container1 is
UNHEALTHYand Container2 isHEALTHY, and Container3 isHEALTHY, the task health isUNHEALTHY. - If Container1 is
HEALTHYand Container2 isUNKNOWN, and Container3 isHEALTHY, the task health isUNKNOWN. - If Container1 is
HEALTHYand Container2 isUNKNOWN, and Container3 isUNKNOWN, the task health isUNKNOWN. - If Container1 is
HEALTHYand Container2 isHEALTHY, and Container3 isHEALTHY, the task health isHEALTHY.
If a task is run manually, and not as part of a service, the task will continue its lifecycle regardless of its health status. For tasks that are part of a service, if the task reports as unhealthy then the task will be stopped and the service scheduler will replace it. When a container health check fails for a task that is part of a service, the following process occurs:
- The task is marked as
UNHEALTHY. - The unhealthy task will be stopped, and during the stopping process, it will go through the following states:
DEACTIVATING- In this state, Amazon ECS performs additional steps before stopping the task. For example, for tasks that are part of services configured to use Elastic Load Balancing target groups, target groups will be deregistered in this state.STOPPING- The task is in the process of being stopped.DEPROVISIONING- Resources associated with the task are being cleaned up.STOPPED- The task has been completely stopped.
- After the old task stops, a new task will be launched to ensure service operation, and the new task will go through the following lifecycle:
PROVISIONING- Resources required for the task are being provisioned.PENDING- The task is waiting to be placed on a container instance.ACTIVATING- In this state, Amazon ECS pulls container images, creates containers, configures task networking, registers load balancer target groups, and configures service discovery status.RUNNING- The task is running and performing its work.
For more detailed information about task lifecycle states, see Task lifecycle in the Amazon Elastic Container Service Developer Guide. The following are notes about container health check support:
- If the Amazon ECS container agent becomes disconnected from the Amazon ECS service, this won't cause a container to transition to an
UNHEALTHYstatus. This is by design, to ensure that containers remain running during agent restarts or temporary unavailability. The health check status is the "last heard from" response from the Amazon ECS agent, so if the container was consideredHEALTHYprior to the disconnect, that status will remain until the agent reconnects and another health check occurs. There are no assumptions made about the status of the container health checks. - Container health checks require version
1.17.0or greater of the Amazon ECS container agent. For more information, see Updating the Amazon ECS container agent. - Container health checks are supported for Fargate tasks if you're using platform version
1.1.0or greater. For more information, see platform versions. - Container health checks aren't supported for tasks that are part of a service that's configured to use a Classic Load Balancer.
For an example of how to specify a task definition with multiple containers where container dependency is specified, see Container dependency in the Amazon Elastic Container Service Developer Guide.
Returns union: either
IResolvableorCfnDaemonTaskDefinition.HealthCheckProperty- Specified by:
getHealthCheckin interfaceCfnDaemonTaskDefinition.DaemonContainerDefinitionProperty- See Also:
-
getInteractive
Description copied from interface:CfnDaemonTaskDefinition.DaemonContainerDefinitionPropertyWhen this parameter istrue, you can deploy containerized applications that requirestdinor attyto be allocated.Returns union: either
BooleanorIResolvable- Specified by:
getInteractivein interfaceCfnDaemonTaskDefinition.DaemonContainerDefinitionProperty- See Also:
-
getLinuxParameters
Description copied from interface:CfnDaemonTaskDefinition.DaemonContainerDefinitionPropertyThe Linux-specific options that are applied to the container, such as Linux KernelCapabilities.Returns union: either
IResolvableorCfnDaemonTaskDefinition.LinuxParametersProperty- Specified by:
getLinuxParametersin interfaceCfnDaemonTaskDefinition.DaemonContainerDefinitionProperty- See Also:
-
getLogConfiguration
Description copied from interface:CfnDaemonTaskDefinition.DaemonContainerDefinitionPropertyThe log configuration for the container.This parameter maps to
LogConfigin the docker container create command and the--log-driveroption to docker run. By default, containers use the same logging driver that the Docker daemon uses. However, the container might use a different logging driver than the Docker daemon by specifying a log driver configuration in the container definition. Understand the following when specifying a log configuration for your containers.- Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon. Additional log drivers may be available in future releases of the Amazon ECS container agent.
For tasks on FARGATElong, the supported log drivers are
awslogs,splunk, andawsfirelens. For tasks hosted on Amazon EC2 instances, the supported log drivers areawslogs,fluentd,gelf,json-file,journald,syslog,splunk, andawsfirelens. - This parameter requires version 1.18 of the Docker Remote API or greater on your container instance.
- For tasks that are hosted on Amazon EC2 instances, the Amazon ECS container agent must register the available logging drivers with the
ECS_AVAILABLE_LOGGING_DRIVERSenvironment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS container agent configuration in the Amazon Elastic Container Service Developer Guide. - For tasks that are on FARGATElong, because you don't have access to the underlying infrastructure your tasks are hosted on, any additional software needed must be installed outside of the task. For example, the Fluentd output aggregators or a remote host running Logstash to send Gelf logs to.
Returns union: either
IResolvableorCfnDaemonTaskDefinition.LogConfigurationProperty- Specified by:
getLogConfigurationin interfaceCfnDaemonTaskDefinition.DaemonContainerDefinitionProperty- See Also:
- Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon. Additional log drivers may be available in future releases of the Amazon ECS container agent.
For tasks on FARGATElong, the supported log drivers are
-
getMemory
Description copied from interface:CfnDaemonTaskDefinition.DaemonContainerDefinitionPropertyThe amount (in MiB) of memory to present to the container.If the container attempts to exceed the memory specified here, the container is killed.
- Specified by:
getMemoryin interfaceCfnDaemonTaskDefinition.DaemonContainerDefinitionProperty- See Also:
-
getMemoryReservation
Description copied from interface:CfnDaemonTaskDefinition.DaemonContainerDefinitionPropertyThe soft limit (in MiB) of memory to reserve for the container.- Specified by:
getMemoryReservationin interfaceCfnDaemonTaskDefinition.DaemonContainerDefinitionProperty- See Also:
-
getMountPoints
Description copied from interface:CfnDaemonTaskDefinition.DaemonContainerDefinitionPropertyThe mount points for data volumes in your container.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnDaemonTaskDefinition.MountPointProperty>- Specified by:
getMountPointsin interfaceCfnDaemonTaskDefinition.DaemonContainerDefinitionProperty- See Also:
-
getPrivileged
Description copied from interface:CfnDaemonTaskDefinition.DaemonContainerDefinitionPropertyWhen this parameter is true, the container is given elevated privileges on the host container instance (similar to therootuser).Returns union: either
BooleanorIResolvable- Specified by:
getPrivilegedin interfaceCfnDaemonTaskDefinition.DaemonContainerDefinitionProperty- See Also:
-
getPseudoTerminal
Description copied from interface:CfnDaemonTaskDefinition.DaemonContainerDefinitionPropertyWhen this parameter istrue, a TTY is allocated.Returns union: either
BooleanorIResolvable- Specified by:
getPseudoTerminalin interfaceCfnDaemonTaskDefinition.DaemonContainerDefinitionProperty- See Also:
-
getReadonlyRootFilesystem
Description copied from interface:CfnDaemonTaskDefinition.DaemonContainerDefinitionPropertyWhen this parameter is true, the container is given read-only access to its root file system.Returns union: either
BooleanorIResolvable- Specified by:
getReadonlyRootFilesystemin interfaceCfnDaemonTaskDefinition.DaemonContainerDefinitionProperty- See Also:
-
getRepositoryCredentials
Description copied from interface:CfnDaemonTaskDefinition.DaemonContainerDefinitionPropertyThe repository credentials for private registry authentication.Returns union: either
IResolvableorCfnDaemonTaskDefinition.RepositoryCredentialsProperty- Specified by:
getRepositoryCredentialsin interfaceCfnDaemonTaskDefinition.DaemonContainerDefinitionProperty- See Also:
-
getRestartPolicy
Description copied from interface:CfnDaemonTaskDefinition.DaemonContainerDefinitionPropertyReturns union: eitherIResolvableorCfnDaemonTaskDefinition.RestartPolicyProperty- Specified by:
getRestartPolicyin interfaceCfnDaemonTaskDefinition.DaemonContainerDefinitionProperty- See Also:
-
getSecrets
Description copied from interface:CfnDaemonTaskDefinition.DaemonContainerDefinitionPropertyThe secrets to pass to the container.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnDaemonTaskDefinition.SecretProperty>- Specified by:
getSecretsin interfaceCfnDaemonTaskDefinition.DaemonContainerDefinitionProperty- See Also:
-
getStartTimeout
Description copied from interface:CfnDaemonTaskDefinition.DaemonContainerDefinitionPropertyTime duration (in seconds) to wait before giving up on resolving dependencies for a container.- Specified by:
getStartTimeoutin interfaceCfnDaemonTaskDefinition.DaemonContainerDefinitionProperty- See Also:
-
getStopTimeout
Description copied from interface:CfnDaemonTaskDefinition.DaemonContainerDefinitionPropertyTime duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own.- Specified by:
getStopTimeoutin interfaceCfnDaemonTaskDefinition.DaemonContainerDefinitionProperty- See Also:
-
getSystemControls
Description copied from interface:CfnDaemonTaskDefinition.DaemonContainerDefinitionPropertyA list of namespaced kernel parameters to set in the container.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnDaemonTaskDefinition.SystemControlProperty>- Specified by:
getSystemControlsin interfaceCfnDaemonTaskDefinition.DaemonContainerDefinitionProperty- See Also:
-
getUlimits
Description copied from interface:CfnDaemonTaskDefinition.DaemonContainerDefinitionPropertyA list ofulimitsto set in the container.Returns union: either
IResolvableor Listinvalid input: '<'eitherIResolvableorCfnDaemonTaskDefinition.UlimitProperty>- Specified by:
getUlimitsin interfaceCfnDaemonTaskDefinition.DaemonContainerDefinitionProperty- See Also:
-
getUser
Description copied from interface:CfnDaemonTaskDefinition.DaemonContainerDefinitionPropertyThe user to use inside the container.- Specified by:
getUserin interfaceCfnDaemonTaskDefinition.DaemonContainerDefinitionProperty- See Also:
-
getWorkingDirectory
Description copied from interface:CfnDaemonTaskDefinition.DaemonContainerDefinitionPropertyThe working directory to run commands inside the container in.- Specified by:
getWorkingDirectoryin interfaceCfnDaemonTaskDefinition.DaemonContainerDefinitionProperty- See Also:
-
$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()
-