Class: Aws::SecurityHub::Types::AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails

Inherits:

Struct

• Object
• Struct
• Aws::SecurityHub::Types::AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails

Defined in:

gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb

Overview

Note:

When making an API call, you may pass AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails data as a hash:

{
  command: ["NonEmptyString"],
  interval: 1,
  retries: 1,
  start_period: 1,
  timeout: 1,
}

The container health check command and associated configuration parameters for the container.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #command ⇒ Array<String>

  The command that the container runs to determine whether it is healthy.

• #interval ⇒ Integer

  The time period in seconds between each health check execution.

• #retries ⇒ Integer

  The number of times to retry a failed health check before the container is considered unhealthy.

• #start_period ⇒ Integer

  The optional grace period in seconds that allows containers time to bootstrap before failed health checks count towards the maximum number of retries.

• #timeout ⇒ Integer

  The time period in seconds to wait for a health check to succeed before it is considered a failure.

Instance Attribute Details

#command ⇒ Array<String>

The command that the container runs to determine whether it is healthy.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 8067

class AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails < Struct.new(
  :command,
  :interval,
  :retries,
  :start_period,
  :timeout)
  SENSITIVE = []
  include Aws::Structure
end

#interval ⇒ Integer

The time period in seconds between each health check execution. The default value is 30 seconds.

Returns:

• (Integer)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 8067

class AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails < Struct.new(
  :command,
  :interval,
  :retries,
  :start_period,
  :timeout)
  SENSITIVE = []
  include Aws::Structure
end

#retries ⇒ Integer

The number of times to retry a failed health check before the container is considered unhealthy. The default value is 3.

Returns:

• (Integer)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 8067

class AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails < Struct.new(
  :command,
  :interval,
  :retries,
  :start_period,
  :timeout)
  SENSITIVE = []
  include Aws::Structure
end

#start_period ⇒ Integer

The optional grace period in seconds that allows containers time to bootstrap before failed health checks count towards the maximum number of retries.

Returns:

• (Integer)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 8067

class AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails < Struct.new(
  :command,
  :interval,
  :retries,
  :start_period,
  :timeout)
  SENSITIVE = []
  include Aws::Structure
end

#timeout ⇒ Integer

The time period in seconds to wait for a health check to succeed before it is considered a failure. The default value is 5.

Returns:

• (Integer)

# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 8067

class AwsEcsTaskDefinitionContainerDefinitionsHealthCheckDetails < Struct.new(
  :command,
  :interval,
  :retries,
  :start_period,
  :timeout)
  SENSITIVE = []
  include Aws::Structure
end