Package software.amazon.awssdk.services.ecs.model

Interface HealthCheck.Builder

    • Method Detail

      • command

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

        A string array representing the command that the container runs to determine if it is healthy. The string array must start with CMD to run the command arguments directly, or CMD-SHELL to run the command with the container's default shell.

        When you use the Amazon Web Services Management Console JSON panel, the Command Line Interface, or the APIs, enclose the list of commands in double quotes and brackets.

        [ "CMD-SHELL", "curl -f http://localhost/ || exit 1" ]

        You don't include the double quotes and brackets when you use the Amazon Web Services Management Console.

        CMD-SHELL, curl -f http://localhost/ || exit 1

        An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, see HealthCheck in the Create a container section of the Docker Remote API.

        Parameters:
        command - A string array representing the command that the container runs to determine if it is healthy. The string array must start with CMD to run the command arguments directly, or CMD-SHELL to run the command with the container's default shell.

        When you use the Amazon Web Services Management Console JSON panel, the Command Line Interface, or the APIs, enclose the list of commands in double quotes and brackets.

        [ "CMD-SHELL", "curl -f http://localhost/ || exit 1" ]

        You don't include the double quotes and brackets when you use the Amazon Web Services Management Console.

        CMD-SHELL, curl -f http://localhost/ || exit 1

        An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, see HealthCheck in the Create a container section of the Docker Remote API.

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

      • command

        HealthCheck.Builder command​(String... command)

        A string array representing the command that the container runs to determine if it is healthy. The string array must start with CMD to run the command arguments directly, or CMD-SHELL to run the command with the container's default shell.

        When you use the Amazon Web Services Management Console JSON panel, the Command Line Interface, or the APIs, enclose the list of commands in double quotes and brackets.

        [ "CMD-SHELL", "curl -f http://localhost/ || exit 1" ]

        You don't include the double quotes and brackets when you use the Amazon Web Services Management Console.

        CMD-SHELL, curl -f http://localhost/ || exit 1

        An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, see HealthCheck in the Create a container section of the Docker Remote API.

        Parameters:
        command - A string array representing the command that the container runs to determine if it is healthy. The string array must start with CMD to run the command arguments directly, or CMD-SHELL to run the command with the container's default shell.

        When you use the Amazon Web Services Management Console JSON panel, the Command Line Interface, or the APIs, enclose the list of commands in double quotes and brackets.

        [ "CMD-SHELL", "curl -f http://localhost/ || exit 1" ]

        You don't include the double quotes and brackets when you use the Amazon Web Services Management Console.

        CMD-SHELL, curl -f http://localhost/ || exit 1

        An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, see HealthCheck in the Create a container section of the Docker Remote API.

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

      • interval

        HealthCheck.Builder interval​(Integer interval)

        The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds.

        Parameters:
        interval - The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • timeout

        HealthCheck.Builder timeout​(Integer timeout)

        The time period in seconds to wait for a health check to succeed before it is considered a failure. You may specify between 2 and 60 seconds. The default value is 5.

        Parameters:
        timeout - The time period in seconds to wait for a health check to succeed before it is considered a failure. You may specify between 2 and 60 seconds. The default value is 5.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • retries

        HealthCheck.Builder retries​(Integer retries)

        The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is 3.

        Parameters:
        retries - The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is 3.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • startPeriod

        HealthCheck.Builder startPeriod​(Integer startPeriod)

        The optional grace period to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. You can specify between 0 and 300 seconds. By default, the startPeriod is off.

        If a health check succeeds within the startPeriod, then the container is considered healthy and any subsequent failures count toward the maximum number of retries.

        Parameters:
        startPeriod - The optional grace period to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. You can specify between 0 and 300 seconds. By default, the startPeriod is off.

        If a health check succeeds within the startPeriod, then the container is considered healthy and any subsequent failures count toward the maximum number of retries.

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