Class: Aws::SecurityHub::Types::AwsEcsTaskDefinitionDetails

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb

Overview

Note:

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

{
  container_definitions: [
    {
      command: ["NonEmptyString"],
      cpu: 1,
      depends_on: [
        {
          condition: "NonEmptyString",
          container_name: "NonEmptyString",
        },
      ],
      disable_networking: false,
      dns_search_domains: ["NonEmptyString"],
      dns_servers: ["NonEmptyString"],
      docker_labels: {
        "NonEmptyString" => "NonEmptyString",
      },
      docker_security_options: ["NonEmptyString"],
      entry_point: ["NonEmptyString"],
      environment: [
        {
          name: "NonEmptyString",
          value: "NonEmptyString",
        },
      ],
      environment_files: [
        {
          type: "NonEmptyString",
          value: "NonEmptyString",
        },
      ],
      essential: false,
      extra_hosts: [
        {
          hostname: "NonEmptyString",
          ip_address: "NonEmptyString",
        },
      ],
      firelens_configuration: {
        options: {
          "NonEmptyString" => "NonEmptyString",
        },
        type: "NonEmptyString",
      },
      health_check: {
        command: ["NonEmptyString"],
        interval: 1,
        retries: 1,
        start_period: 1,
        timeout: 1,
      },
      hostname: "NonEmptyString",
      image: "NonEmptyString",
      interactive: false,
      links: ["NonEmptyString"],
      linux_parameters: {
        capabilities: {
          add: ["NonEmptyString"],
          drop: ["NonEmptyString"],
        },
        devices: [
          {
            container_path: "NonEmptyString",
            host_path: "NonEmptyString",
            permissions: ["NonEmptyString"],
          },
        ],
        init_process_enabled: false,
        max_swap: 1,
        shared_memory_size: 1,
        swappiness: 1,
        tmpfs: [
          {
            container_path: "NonEmptyString",
            mount_options: ["NonEmptyString"],
            size: 1,
          },
        ],
      },
      log_configuration: {
        log_driver: "NonEmptyString",
        options: {
          "NonEmptyString" => "NonEmptyString",
        },
        secret_options: [
          {
            name: "NonEmptyString",
            value_from: "NonEmptyString",
          },
        ],
      },
      memory: 1,
      memory_reservation: 1,
      mount_points: [
        {
          container_path: "NonEmptyString",
          read_only: false,
          source_volume: "NonEmptyString",
        },
      ],
      name: "NonEmptyString",
      port_mappings: [
        {
          container_port: 1,
          host_port: 1,
          protocol: "NonEmptyString",
        },
      ],
      privileged: false,
      pseudo_terminal: false,
      readonly_root_filesystem: false,
      repository_credentials: {
        credentials_parameter: "NonEmptyString",
      },
      resource_requirements: [
        {
          type: "NonEmptyString",
          value: "NonEmptyString",
        },
      ],
      secrets: [
        {
          name: "NonEmptyString",
          value_from: "NonEmptyString",
        },
      ],
      start_timeout: 1,
      stop_timeout: 1,
      system_controls: [
        {
          namespace: "NonEmptyString",
          value: "NonEmptyString",
        },
      ],
      ulimits: [
        {
          hard_limit: 1,
          name: "NonEmptyString",
          soft_limit: 1,
        },
      ],
      user: "NonEmptyString",
      volumes_from: [
        {
          read_only: false,
          source_container: "NonEmptyString",
        },
      ],
      working_directory: "NonEmptyString",
    },
  ],
  cpu: "NonEmptyString",
  execution_role_arn: "NonEmptyString",
  family: "NonEmptyString",
  inference_accelerators: [
    {
      device_name: "NonEmptyString",
      device_type: "NonEmptyString",
    },
  ],
  ipc_mode: "NonEmptyString",
  memory: "NonEmptyString",
  network_mode: "NonEmptyString",
  pid_mode: "NonEmptyString",
  placement_constraints: [
    {
      expression: "NonEmptyString",
      type: "NonEmptyString",
    },
  ],
  proxy_configuration: {
    container_name: "NonEmptyString",
    proxy_configuration_properties: [
      {
        name: "NonEmptyString",
        value: "NonEmptyString",
      },
    ],
    type: "NonEmptyString",
  },
  requires_compatibilities: ["NonEmptyString"],
  task_role_arn: "NonEmptyString",
  volumes: [
    {
      docker_volume_configuration: {
        autoprovision: false,
        driver: "NonEmptyString",
        driver_opts: {
          "NonEmptyString" => "NonEmptyString",
        },
        labels: {
          "NonEmptyString" => "NonEmptyString",
        },
        scope: "NonEmptyString",
      },
      efs_volume_configuration: {
        authorization_config: {
          access_point_id: "NonEmptyString",
          iam: "NonEmptyString",
        },
        filesystem_id: "NonEmptyString",
        root_directory: "NonEmptyString",
        transit_encryption: "NonEmptyString",
        transit_encryption_port: 1,
      },
      host: {
        source_path: "NonEmptyString",
      },
      name: "NonEmptyString",
    },
  ],
}

details about a task definition. A task definition describes the container and volume definitions of an Amazon Elastic Container Service task.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#container_definitionsArray<Types::AwsEcsTaskDefinitionContainerDefinitionsDetails>

The container definitions that describe the containers that make up the task.



8537
8538
8539
8540
8541
8542
8543
8544
8545
8546
8547
8548
8549
8550
8551
8552
8553
8554
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 8537

class AwsEcsTaskDefinitionDetails < Struct.new(
  :container_definitions,
  :cpu,
  :execution_role_arn,
  :family,
  :inference_accelerators,
  :ipc_mode,
  :memory,
  :network_mode,
  :pid_mode,
  :placement_constraints,
  :proxy_configuration,
  :requires_compatibilities,
  :task_role_arn,
  :volumes)
  SENSITIVE = []
  include Aws::Structure
end

#cpuString

The number of CPU units used by the task.

Returns:

  • (String)


8537
8538
8539
8540
8541
8542
8543
8544
8545
8546
8547
8548
8549
8550
8551
8552
8553
8554
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 8537

class AwsEcsTaskDefinitionDetails < Struct.new(
  :container_definitions,
  :cpu,
  :execution_role_arn,
  :family,
  :inference_accelerators,
  :ipc_mode,
  :memory,
  :network_mode,
  :pid_mode,
  :placement_constraints,
  :proxy_configuration,
  :requires_compatibilities,
  :task_role_arn,
  :volumes)
  SENSITIVE = []
  include Aws::Structure
end

#execution_role_arnString

The ARN of the task execution role that grants the container agent permission to make API calls on behalf of the container user.

Returns:

  • (String)


8537
8538
8539
8540
8541
8542
8543
8544
8545
8546
8547
8548
8549
8550
8551
8552
8553
8554
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 8537

class AwsEcsTaskDefinitionDetails < Struct.new(
  :container_definitions,
  :cpu,
  :execution_role_arn,
  :family,
  :inference_accelerators,
  :ipc_mode,
  :memory,
  :network_mode,
  :pid_mode,
  :placement_constraints,
  :proxy_configuration,
  :requires_compatibilities,
  :task_role_arn,
  :volumes)
  SENSITIVE = []
  include Aws::Structure
end

#familyString

The name of a family that this task definition is registered to.

Returns:

  • (String)


8537
8538
8539
8540
8541
8542
8543
8544
8545
8546
8547
8548
8549
8550
8551
8552
8553
8554
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 8537

class AwsEcsTaskDefinitionDetails < Struct.new(
  :container_definitions,
  :cpu,
  :execution_role_arn,
  :family,
  :inference_accelerators,
  :ipc_mode,
  :memory,
  :network_mode,
  :pid_mode,
  :placement_constraints,
  :proxy_configuration,
  :requires_compatibilities,
  :task_role_arn,
  :volumes)
  SENSITIVE = []
  include Aws::Structure
end

#inference_acceleratorsArray<Types::AwsEcsTaskDefinitionInferenceAcceleratorsDetails>

The Elastic Inference accelerators to use for the containers in the task.



8537
8538
8539
8540
8541
8542
8543
8544
8545
8546
8547
8548
8549
8550
8551
8552
8553
8554
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 8537

class AwsEcsTaskDefinitionDetails < Struct.new(
  :container_definitions,
  :cpu,
  :execution_role_arn,
  :family,
  :inference_accelerators,
  :ipc_mode,
  :memory,
  :network_mode,
  :pid_mode,
  :placement_constraints,
  :proxy_configuration,
  :requires_compatibilities,
  :task_role_arn,
  :volumes)
  SENSITIVE = []
  include Aws::Structure
end

#ipc_modeString

The IPC resource namespace to use for the containers in the task.

Returns:

  • (String)


8537
8538
8539
8540
8541
8542
8543
8544
8545
8546
8547
8548
8549
8550
8551
8552
8553
8554
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 8537

class AwsEcsTaskDefinitionDetails < Struct.new(
  :container_definitions,
  :cpu,
  :execution_role_arn,
  :family,
  :inference_accelerators,
  :ipc_mode,
  :memory,
  :network_mode,
  :pid_mode,
  :placement_constraints,
  :proxy_configuration,
  :requires_compatibilities,
  :task_role_arn,
  :volumes)
  SENSITIVE = []
  include Aws::Structure
end

#memoryString

The amount (in MiB) of memory used by the task.

Returns:

  • (String)


8537
8538
8539
8540
8541
8542
8543
8544
8545
8546
8547
8548
8549
8550
8551
8552
8553
8554
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 8537

class AwsEcsTaskDefinitionDetails < Struct.new(
  :container_definitions,
  :cpu,
  :execution_role_arn,
  :family,
  :inference_accelerators,
  :ipc_mode,
  :memory,
  :network_mode,
  :pid_mode,
  :placement_constraints,
  :proxy_configuration,
  :requires_compatibilities,
  :task_role_arn,
  :volumes)
  SENSITIVE = []
  include Aws::Structure
end

#network_modeString

The Docker networking mode to use for the containers in the task.

Returns:

  • (String)


8537
8538
8539
8540
8541
8542
8543
8544
8545
8546
8547
8548
8549
8550
8551
8552
8553
8554
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 8537

class AwsEcsTaskDefinitionDetails < Struct.new(
  :container_definitions,
  :cpu,
  :execution_role_arn,
  :family,
  :inference_accelerators,
  :ipc_mode,
  :memory,
  :network_mode,
  :pid_mode,
  :placement_constraints,
  :proxy_configuration,
  :requires_compatibilities,
  :task_role_arn,
  :volumes)
  SENSITIVE = []
  include Aws::Structure
end

#pid_modeString

The process namespace to use for the containers in the task.

Returns:

  • (String)


8537
8538
8539
8540
8541
8542
8543
8544
8545
8546
8547
8548
8549
8550
8551
8552
8553
8554
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 8537

class AwsEcsTaskDefinitionDetails < Struct.new(
  :container_definitions,
  :cpu,
  :execution_role_arn,
  :family,
  :inference_accelerators,
  :ipc_mode,
  :memory,
  :network_mode,
  :pid_mode,
  :placement_constraints,
  :proxy_configuration,
  :requires_compatibilities,
  :task_role_arn,
  :volumes)
  SENSITIVE = []
  include Aws::Structure
end

#placement_constraintsArray<Types::AwsEcsTaskDefinitionPlacementConstraintsDetails>

The placement constraint objects to use for tasks.



8537
8538
8539
8540
8541
8542
8543
8544
8545
8546
8547
8548
8549
8550
8551
8552
8553
8554
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 8537

class AwsEcsTaskDefinitionDetails < Struct.new(
  :container_definitions,
  :cpu,
  :execution_role_arn,
  :family,
  :inference_accelerators,
  :ipc_mode,
  :memory,
  :network_mode,
  :pid_mode,
  :placement_constraints,
  :proxy_configuration,
  :requires_compatibilities,
  :task_role_arn,
  :volumes)
  SENSITIVE = []
  include Aws::Structure
end

#proxy_configurationTypes::AwsEcsTaskDefinitionProxyConfigurationDetails

The configuration details for the App Mesh proxy.



8537
8538
8539
8540
8541
8542
8543
8544
8545
8546
8547
8548
8549
8550
8551
8552
8553
8554
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 8537

class AwsEcsTaskDefinitionDetails < Struct.new(
  :container_definitions,
  :cpu,
  :execution_role_arn,
  :family,
  :inference_accelerators,
  :ipc_mode,
  :memory,
  :network_mode,
  :pid_mode,
  :placement_constraints,
  :proxy_configuration,
  :requires_compatibilities,
  :task_role_arn,
  :volumes)
  SENSITIVE = []
  include Aws::Structure
end

#requires_compatibilitiesArray<String>

The task launch types that the task definition was validated against.

Returns:

  • (Array<String>)


8537
8538
8539
8540
8541
8542
8543
8544
8545
8546
8547
8548
8549
8550
8551
8552
8553
8554
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 8537

class AwsEcsTaskDefinitionDetails < Struct.new(
  :container_definitions,
  :cpu,
  :execution_role_arn,
  :family,
  :inference_accelerators,
  :ipc_mode,
  :memory,
  :network_mode,
  :pid_mode,
  :placement_constraints,
  :proxy_configuration,
  :requires_compatibilities,
  :task_role_arn,
  :volumes)
  SENSITIVE = []
  include Aws::Structure
end

#task_role_arnString

The short name or ARN of the IAM role that grants containers in the task permission to call Amazon Web Services API operations on your behalf.

Returns:

  • (String)


8537
8538
8539
8540
8541
8542
8543
8544
8545
8546
8547
8548
8549
8550
8551
8552
8553
8554
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 8537

class AwsEcsTaskDefinitionDetails < Struct.new(
  :container_definitions,
  :cpu,
  :execution_role_arn,
  :family,
  :inference_accelerators,
  :ipc_mode,
  :memory,
  :network_mode,
  :pid_mode,
  :placement_constraints,
  :proxy_configuration,
  :requires_compatibilities,
  :task_role_arn,
  :volumes)
  SENSITIVE = []
  include Aws::Structure
end

#volumesArray<Types::AwsEcsTaskDefinitionVolumesDetails>

The data volume definitions for the task.



8537
8538
8539
8540
8541
8542
8543
8544
8545
8546
8547
8548
8549
8550
8551
8552
8553
8554
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 8537

class AwsEcsTaskDefinitionDetails < Struct.new(
  :container_definitions,
  :cpu,
  :execution_role_arn,
  :family,
  :inference_accelerators,
  :ipc_mode,
  :memory,
  :network_mode,
  :pid_mode,
  :placement_constraints,
  :proxy_configuration,
  :requires_compatibilities,
  :task_role_arn,
  :volumes)
  SENSITIVE = []
  include Aws::Structure
end