CfnJobDefinition.ContainerPropertiesProperty.Jsii$Proxy (software.amazon.awscdk:aws-cdk-lib 2.42.1 API)

java.lang.Object
- software.amazon.jsii.JsiiObject
- - software.amazon.awscdk.services.batch.CfnJobDefinition.ContainerPropertiesProperty.Jsii$Proxy

All Implemented Interfaces:

CfnJobDefinition.ContainerPropertiesProperty, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnJobDefinition.ContainerPropertiesProperty
```
@Stability(value=Stable)
 @Internal
public static final class CfnJobDefinition.ContainerPropertiesProperty.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnJobDefinition.ContainerPropertiesProperty
```
An implementation for CfnJobDefinition.ContainerPropertiesProperty

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.batch.CfnJobDefinition.ContainerPropertiesProperty
  CfnJobDefinition.ContainerPropertiesProperty.Builder, CfnJobDefinition.ContainerPropertiesProperty.Jsii$Proxy

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Jsii$Proxy(CfnJobDefinition.ContainerPropertiesProperty.Builder builder)` Constructor that initializes the object based on literal property values passed by the `CfnJobDefinition.AuthorizationConfigProperty.Builder`.
`protected`	`Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)` Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.fasterxml.jackson.databind.JsonNode`	`$jsii$toJson()`
`boolean`	`equals(Object o)`
`List<String>`	`getCommand()` The command that's passed to the container.
`Object`	`getEnvironment()` The environment variables to pass to a container.
`String`	`getExecutionRoleArn()` The Amazon Resource Name (ARN) of the execution role that AWS Batch can assume.
`Object`	`getFargatePlatformConfiguration()` The platform configuration for jobs that are running on Fargate resources.
`String`	`getImage()` The image used to start a container.
`String`	`getInstanceType()` The instance type to use for a multi-node parallel job.
`String`	`getJobRoleArn()` The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions.
`Object`	`getLinuxParameters()` Linux-specific modifications that are applied to the container, such as details for device mappings.
`Object`	`getLogConfiguration()` The log configuration specification for the container.
`Number`	`getMemory()` This parameter is deprecated, use `resourceRequirements` to specify the memory requirements for the job definition.
`Object`	`getMountPoints()` The mount points for data volumes in your container.
`Object`	`getNetworkConfiguration()` The network configuration for jobs that are running on Fargate resources.
`Object`	`getPrivileged()` When this parameter is true, the container is given elevated permissions on the host container instance (similar to the `root` user).
`Object`	`getReadonlyRootFilesystem()` When this parameter is true, the container is given read-only access to its root file system.
`Object`	`getResourceRequirements()` The type and amount of resources to assign to a container.
`Object`	`getSecrets()` The secrets for the container.
`Object`	`getUlimits()` A list of `ulimits` to set in the container.
`String`	`getUser()` The user name to use inside the container.
`Number`	`getVcpus()` This parameter is deprecated, use `resourceRequirements` to specify the vCPU requirements for the job definition.
`Object`	`getVolumes()` A list of data volumes used in a job.
`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

Methods inherited from interface software.amazon.awscdk.services.batch.CfnJobDefinition.ContainerPropertiesProperty
builder

- Constructor Detail
  - 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(CfnJobDefinition.ContainerPropertiesProperty.Builder builder)
```
    Constructor that initializes the object based on literal property values passed by the CfnJobDefinition.AuthorizationConfigProperty.Builder.
- Method Detail
  - getImage
```
public final String getImage()
```
    Description copied from interface: CfnJobDefinition.ContainerPropertiesProperty
    The image used to start a 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 *repository-url* / *image* : *tag* . Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run .
    
    Docker image architecture must match the processor architecture of the compute resources that they're scheduled on. For example, ARM-based Docker images can only run on ARM-based compute resources.
    - Images in Amazon ECR Public repositories use the full registry/repository[:tag] or registry/repository[@digest] naming conventions. For example, public.ecr.aws/ *registry_alias* / *my-web-app* : *latest* .
    - Images in Amazon ECR repositories use the full registry and repository URI (for example, 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name> ).
    - Images in official repositories on Docker Hub use a single name (for example, ubuntu or mongo ).
    - Images in other repositories on Docker Hub are qualified with an organization name (for example, amazon/amazon-ecs-agent ).
    - Images in other online repositories are qualified further by a domain name (for example, quay.io/assemblyline/ubuntu ).
    Specified by:
    
    getImage in interface CfnJobDefinition.ContainerPropertiesProperty
  - getCommand
```
public final List<String> getCommand()
```
    Description copied from interface: CfnJobDefinition.ContainerPropertiesProperty
    
    The command that's passed to the container.
    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, see https://docs.docker.com/engine/reference/builder/#cmd .
    
    Specified by:
    
    getCommand in interface CfnJobDefinition.ContainerPropertiesProperty
  - getEnvironment
```
public final Object getEnvironment()
```
    Description copied from interface: CfnJobDefinition.ContainerPropertiesProperty
    
    The environment variables to pass to a container.
    This parameter maps to Env in the Create a container section of the Docker Remote API and the --env option to docker run .
    
    We don't recommend using plaintext environment variables for sensitive information, such as credential data. > Environment variables must not start with AWS_BATCH ; this naming convention is reserved for variables that are set by the AWS Batch service.
    
    Specified by:
    
    getEnvironment in interface CfnJobDefinition.ContainerPropertiesProperty
  - getExecutionRoleArn
```
public final String getExecutionRoleArn()
```
    Description copied from interface: CfnJobDefinition.ContainerPropertiesProperty
    
    The Amazon Resource Name (ARN) of the execution role that AWS Batch can assume.
    For jobs that run on Fargate resources, you must provide an execution role. For more information, see AWS Batch execution IAM role in the AWS Batch User Guide .
    
    Specified by:
    
    getExecutionRoleArn in interface CfnJobDefinition.ContainerPropertiesProperty
  - getFargatePlatformConfiguration
```
public final Object getFargatePlatformConfiguration()
```
    Description copied from interface: CfnJobDefinition.ContainerPropertiesProperty
    
    The platform configuration for jobs that are running on Fargate resources.
    Jobs that are running on EC2 resources must not specify this parameter.
    
    Specified by:
    
    getFargatePlatformConfiguration in interface CfnJobDefinition.ContainerPropertiesProperty
  - getInstanceType
```
public final String getInstanceType()
```
    Description copied from interface: CfnJobDefinition.ContainerPropertiesProperty
    
    The instance type to use for a multi-node parallel job.
    All node groups in a multi-node parallel job must use the same instance type.
    
    This parameter isn't applicable to single-node container jobs or jobs that run on Fargate resources, and shouldn't be provided.
    
    Specified by:
    
    getInstanceType in interface CfnJobDefinition.ContainerPropertiesProperty
  - getJobRoleArn
```
public final String getJobRoleArn()
```
    Description copied from interface: CfnJobDefinition.ContainerPropertiesProperty
    
    The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions.
    For more information, see IAM roles for tasks in the Amazon Elastic Container Service Developer Guide .
    
    Specified by:
    
    getJobRoleArn in interface CfnJobDefinition.ContainerPropertiesProperty
  - getLinuxParameters
```
public final Object getLinuxParameters()
```
    Description copied from interface: CfnJobDefinition.ContainerPropertiesProperty
    
    Linux-specific modifications that are applied to the container, such as details for device mappings.
    
    Specified by:
    
    getLinuxParameters in interface CfnJobDefinition.ContainerPropertiesProperty
  - getLogConfiguration
```
public final Object getLogConfiguration()
```
    Description copied from interface: CfnJobDefinition.ContainerPropertiesProperty
    
    The log configuration specification for the container.
    This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option 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 with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation.
    
    AWS Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type).
    
    This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: sudo docker version | grep "Server API version"
    
    The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment 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 .
    
    Specified by:
    
    getLogConfiguration in interface CfnJobDefinition.ContainerPropertiesProperty
  - getMemory
```
public final Number getMemory()
```
    Description copied from interface: CfnJobDefinition.ContainerPropertiesProperty
    
    This parameter is deprecated, use `resourceRequirements` to specify the memory requirements for the job definition.
    It's not supported for jobs running on Fargate resources. For jobs running on EC2 resources, it specifies the memory hard limit (in MiB) for a container. If your container attempts to exceed the specified number, it's terminated. You must specify at least 4 MiB of memory for a job using this parameter. The memory hard limit can be specified in several places. It must be specified for each node at least once.
    
    Specified by:
    
    getMemory in interface CfnJobDefinition.ContainerPropertiesProperty
  - getMountPoints
```
public final Object getMountPoints()
```
    Description copied from interface: CfnJobDefinition.ContainerPropertiesProperty
    
    The mount points for data volumes in your container.
    This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run .
    
    Specified by:
    
    getMountPoints in interface CfnJobDefinition.ContainerPropertiesProperty
  - getNetworkConfiguration
```
public final Object getNetworkConfiguration()
```
    Description copied from interface: CfnJobDefinition.ContainerPropertiesProperty
    
    The network configuration for jobs that are running on Fargate resources.
    Jobs that are running on EC2 resources must not specify this parameter.
    
    Specified by:
    
    getNetworkConfiguration in interface CfnJobDefinition.ContainerPropertiesProperty
  - getPrivileged
```
public final Object getPrivileged()
```
    Description copied from interface: CfnJobDefinition.ContainerPropertiesProperty
    
    When this parameter is true, the container is given elevated permissions on the host container instance (similar to the `root` user).
    This parameter maps to Privileged in the Create a container section of the Docker Remote API and the --privileged option to docker run . The default value is false.
    
    This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided, or specified as false.
    
    Specified by:
    
    getPrivileged in interface CfnJobDefinition.ContainerPropertiesProperty
  - getReadonlyRootFilesystem
```
public final Object getReadonlyRootFilesystem()
```
    Description copied from interface: CfnJobDefinition.ContainerPropertiesProperty
    
    When this parameter is true, the container is given read-only access to its root file system.
    This parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and the --read-only option to docker run .
    
    Specified by:
    
    getReadonlyRootFilesystem in interface CfnJobDefinition.ContainerPropertiesProperty
  - getResourceRequirements
```
public final Object getResourceRequirements()
```
    Description copied from interface: CfnJobDefinition.ContainerPropertiesProperty
    
    The type and amount of resources to assign to a container.
    The supported resources include GPU , MEMORY , and VCPU .
    
    Specified by:
    
    getResourceRequirements in interface CfnJobDefinition.ContainerPropertiesProperty
  - getSecrets
```
public final Object getSecrets()
```
    Description copied from interface: CfnJobDefinition.ContainerPropertiesProperty
    
    The secrets for the container.
    For more information, see Specifying sensitive data in the AWS Batch User Guide .
    
    Specified by:
    
    getSecrets in interface CfnJobDefinition.ContainerPropertiesProperty
  - getUlimits
```
public final Object getUlimits()
```
    Description copied from interface: CfnJobDefinition.ContainerPropertiesProperty
    
    A list of `ulimits` to set in the container.
    This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run .
    
    This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
    
    Specified by:
    
    getUlimits in interface CfnJobDefinition.ContainerPropertiesProperty
  - getUser
```
public final String getUser()
```
    Description copied from interface: CfnJobDefinition.ContainerPropertiesProperty
    
    The user name to use inside the container.
    This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run .
    
    Specified by:
    
    getUser in interface CfnJobDefinition.ContainerPropertiesProperty
  - getVcpus
```
public final Number getVcpus()
```
    Description copied from interface: CfnJobDefinition.ContainerPropertiesProperty
    
    This parameter is deprecated, use `resourceRequirements` to specify the vCPU requirements for the job definition.
    It's not supported for jobs running on Fargate resources. For jobs running on EC2 resources, it specifies the number of vCPUs reserved for the job.
    Each vCPU is equivalent to 1,024 CPU shares. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run . The number of vCPUs must be specified but can be specified in several places. You must specify it at least once for each node.
    
    Specified by:
    
    getVcpus in interface CfnJobDefinition.ContainerPropertiesProperty
  - getVolumes
```
public final Object getVolumes()
```
    Description copied from interface: CfnJobDefinition.ContainerPropertiesProperty
    
    A list of data volumes used in a job.
    
    Specified by:
    
    getVolumes in interface CfnJobDefinition.ContainerPropertiesProperty
  - $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

Class CfnJobDefinition.ContainerPropertiesProperty.Jsii$Proxy

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.batch.CfnJobDefinition.ContainerPropertiesProperty

Constructor Summary

Method Summary

Methods inherited from class software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awscdk.services.batch.CfnJobDefinition.ContainerPropertiesProperty

Constructor Detail

Jsii$Proxy

Jsii$Proxy

Method Detail

getImage

getCommand

getEnvironment

getExecutionRoleArn

getFargatePlatformConfiguration

getInstanceType

getJobRoleArn

getLinuxParameters

getLogConfiguration

getMemory

getMountPoints

getNetworkConfiguration

getPrivileged

getReadonlyRootFilesystem

getResourceRequirements

getSecrets

getUlimits

getUser

getVcpus

getVolumes

$jsii$toJson

equals

hashCode