Package software.amazon.awssdk.services.batch.model

Interface EksContainerDetail.Builder

    • Method Detail

      • name

        EksContainerDetail.Builder name​(String name)

        The name of the container. If the name isn't specified, the default name "Default" is used. Each container in a pod must have a unique name.

        Parameters:
        name - The name of the container. If the name isn't specified, the default name "Default" is used. Each container in a pod must have a unique name.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • image

        EksContainerDetail.Builder image​(String image)

        The Docker image used to start the container.

        Parameters:
        image - The Docker image used to start the container.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • imagePullPolicy

        EksContainerDetail.Builder imagePullPolicy​(String imagePullPolicy)

        The image pull policy for the container. Supported values are Always, IfNotPresent, and Never. This parameter defaults to Always if the :latest tag is specified, IfNotPresent otherwise. For more information, see Updating images in the Kubernetes documentation.

        Parameters:
        imagePullPolicy - The image pull policy for the container. Supported values are Always, IfNotPresent, and Never. This parameter defaults to Always if the :latest tag is specified, IfNotPresent otherwise. For more information, see Updating images in the Kubernetes documentation.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • command

        EksContainerDetail.Builder command​(Collection<String> command)

        The entrypoint for the container. For more information, see Entrypoint in the Kubernetes documentation.

        Parameters:
        command - The entrypoint for the container. For more information, see Entrypoint in the Kubernetes documentation.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • command

        EksContainerDetail.Builder command​(String... command)

        The entrypoint for the container. For more information, see Entrypoint in the Kubernetes documentation.

        Parameters:
        command - The entrypoint for the container. For more information, see Entrypoint in the Kubernetes documentation.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • args

        EksContainerDetail.Builder args​(Collection<String> args)

        An array of arguments to the entrypoint. If this isn't specified, the CMD of the container image is used. This corresponds to the args member in the Entrypoint portion of the Pod in Kubernetes. Environment variable references are expanded using the container's environment.

        If the referenced environment variable doesn't exist, the reference in the command isn't changed. For example, if the reference is to "$(NAME1)" and the NAME1 environment variable doesn't exist, the command string will remain "$(NAME1)". $$ is replaced with $ and the resulting string isn't expanded. For example, $$(VAR_NAME) is passed as $(VAR_NAME) whether or not the VAR_NAME environment variable exists. For more information, see Dockerfile reference: CMD and Define a command and arguments for a pod in the Kubernetes documentation.

        Parameters:
        args - An array of arguments to the entrypoint. If this isn't specified, the CMD of the container image is used. This corresponds to the args member in the Entrypoint portion of the Pod in Kubernetes. Environment variable references are expanded using the container's environment.

        If the referenced environment variable doesn't exist, the reference in the command isn't changed. For example, if the reference is to "$(NAME1)" and the NAME1 environment variable doesn't exist, the command string will remain "$(NAME1)". $$ is replaced with $ and the resulting string isn't expanded. For example, $$(VAR_NAME) is passed as $(VAR_NAME) whether or not the VAR_NAME environment variable exists. For more information, see Dockerfile reference: CMD and Define a command and arguments for a pod in the Kubernetes documentation.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • args

        EksContainerDetail.Builder args​(String... args)

        An array of arguments to the entrypoint. If this isn't specified, the CMD of the container image is used. This corresponds to the args member in the Entrypoint portion of the Pod in Kubernetes. Environment variable references are expanded using the container's environment.

        If the referenced environment variable doesn't exist, the reference in the command isn't changed. For example, if the reference is to "$(NAME1)" and the NAME1 environment variable doesn't exist, the command string will remain "$(NAME1)". $$ is replaced with $ and the resulting string isn't expanded. For example, $$(VAR_NAME) is passed as $(VAR_NAME) whether or not the VAR_NAME environment variable exists. For more information, see Dockerfile reference: CMD and Define a command and arguments for a pod in the Kubernetes documentation.

        Parameters:
        args - An array of arguments to the entrypoint. If this isn't specified, the CMD of the container image is used. This corresponds to the args member in the Entrypoint portion of the Pod in Kubernetes. Environment variable references are expanded using the container's environment.

        If the referenced environment variable doesn't exist, the reference in the command isn't changed. For example, if the reference is to "$(NAME1)" and the NAME1 environment variable doesn't exist, the command string will remain "$(NAME1)". $$ is replaced with $ and the resulting string isn't expanded. For example, $$(VAR_NAME) is passed as $(VAR_NAME) whether or not the VAR_NAME environment variable exists. For more information, see Dockerfile reference: CMD and Define a command and arguments for a pod in the Kubernetes documentation.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • env

        EksContainerDetail.Builder env​(Collection<EksContainerEnvironmentVariable> env)

        The environment variables to pass to a container.

        Environment variables cannot start with "AWS_BATCH". This naming convention is reserved for variables that Batch sets.

        Parameters:
        env - The environment variables to pass to a container.

        Environment variables cannot start with "AWS_BATCH". This naming convention is reserved for variables that Batch sets.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • env

        EksContainerDetail.Builder env​(EksContainerEnvironmentVariable... env)

        The environment variables to pass to a container.

        Environment variables cannot start with "AWS_BATCH". This naming convention is reserved for variables that Batch sets.

        Parameters:
        env - The environment variables to pass to a container.

        Environment variables cannot start with "AWS_BATCH". This naming convention is reserved for variables that Batch sets.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • exitCode

        EksContainerDetail.Builder exitCode​(Integer exitCode)

        The exit code returned for the job attempt. A non-zero exit code is considered failed.

        Parameters:
        exitCode - The exit code returned for the job attempt. A non-zero exit code is considered failed.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • reason

        EksContainerDetail.Builder reason​(String reason)

        A short human-readable string to provide additional details for a running or stopped container. It can be up to 255 characters long.

        Parameters:
        reason - A short human-readable string to provide additional details for a running or stopped container. It can be up to 255 characters long.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • volumeMounts

        EksContainerDetail.Builder volumeMounts​(Collection<EksContainerVolumeMount> volumeMounts)

        The volume mounts for the container. Batch supports emptyDir, hostPath, and secret volume types. For more information about volumes and volume mounts in Kubernetes, see Volumes in the Kubernetes documentation.

        Parameters:
        volumeMounts - The volume mounts for the container. Batch supports emptyDir, hostPath, and secret volume types. For more information about volumes and volume mounts in Kubernetes, see Volumes in the Kubernetes documentation.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • volumeMounts

        EksContainerDetail.Builder volumeMounts​(EksContainerVolumeMount... volumeMounts)

        The volume mounts for the container. Batch supports emptyDir, hostPath, and secret volume types. For more information about volumes and volume mounts in Kubernetes, see Volumes in the Kubernetes documentation.

        Parameters:
        volumeMounts - The volume mounts for the container. Batch supports emptyDir, hostPath, and secret volume types. For more information about volumes and volume mounts in Kubernetes, see Volumes in the Kubernetes documentation.
        Returns:
        Returns a reference to this object so that method calls can be chained together.