Class: Aws::CodeBuild::Types::Fleet

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-codebuild/types.rb

Overview

A set of dedicated instances for your build environment.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

The ARN of the compute fleet.

Returns:

  • (String) 


2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
 
# File 'lib/aws-sdk-codebuild/types.rb', line 2774

class Fleet < Struct.new(
  :arn,
  :name,
  :id,
  :created,
  :last_modified,
  :status,
  :base_capacity,
  :environment_type,
  :compute_type,
  :compute_configuration,
  :scaling_configuration,
  :overflow_behavior,
  :vpc_config,
  :proxy_configuration,
  :image_id,
  :fleet_service_role,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#base_capacity ⇒ Integer

The initial number of machines allocated to the compute fleet, which defines the number of builds that can run in parallel.

Returns:

  • (Integer) 


2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
 
# File 'lib/aws-sdk-codebuild/types.rb', line 2774

class Fleet < Struct.new(
  :arn,
  :name,
  :id,
  :created,
  :last_modified,
  :status,
  :base_capacity,
  :environment_type,
  :compute_type,
  :compute_configuration,
  :scaling_configuration,
  :overflow_behavior,
  :vpc_config,
  :proxy_configuration,
  :image_id,
  :fleet_service_role,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#compute_configuration ⇒ Types::ComputeConfiguration

The compute configuration of the compute fleet. This is only required if ‘computeType` is set to `ATTRIBUTE_BASED_COMPUTE`.

Returns:



2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
 
# File 'lib/aws-sdk-codebuild/types.rb', line 2774

class Fleet < Struct.new(
  :arn,
  :name,
  :id,
  :created,
  :last_modified,
  :status,
  :base_capacity,
  :environment_type,
  :compute_type,
  :compute_configuration,
  :scaling_configuration,
  :overflow_behavior,
  :vpc_config,
  :proxy_configuration,
  :image_id,
  :fleet_service_role,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#compute_type ⇒ String

Information about the compute resources the compute fleet uses. Available values include:

  • ‘ATTRIBUTE_BASED_COMPUTE`: Specify the amount of vCPUs, memory, disk space, and the type of machine.

    <note markdown=“1”> If you use ‘ATTRIBUTE_BASED_COMPUTE`, you must define your attributes by using `computeConfiguration`. CodeBuild will select the cheapest instance that satisfies your specified attributes. For more information, see [Reserved capacity environment types] in the *CodeBuild User Guide*.

    </note>

  • ‘BUILD_GENERAL1_SMALL`: Use up to 4 GiB memory and 2 vCPUs for builds.

  • ‘BUILD_GENERAL1_MEDIUM`: Use up to 8 GiB memory and 4 vCPUs for builds.

  • ‘BUILD_GENERAL1_LARGE`: Use up to 16 GiB memory and 8 vCPUs for builds, depending on your environment type.

  • ‘BUILD_GENERAL1_XLARGE`: Use up to 72 GiB memory and 36 vCPUs for builds, depending on your environment type.

  • ‘BUILD_GENERAL1_2XLARGE`: Use up to 144 GiB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed.

  • ‘BUILD_LAMBDA_1GB`: Use up to 1 GiB memory for builds. Only available for environment type `LINUX_LAMBDA_CONTAINER` and `ARM_LAMBDA_CONTAINER`.

  • ‘BUILD_LAMBDA_2GB`: Use up to 2 GiB memory for builds. Only available for environment type `LINUX_LAMBDA_CONTAINER` and `ARM_LAMBDA_CONTAINER`.

  • ‘BUILD_LAMBDA_4GB`: Use up to 4 GiB memory for builds. Only available for environment type `LINUX_LAMBDA_CONTAINER` and `ARM_LAMBDA_CONTAINER`.

  • ‘BUILD_LAMBDA_8GB`: Use up to 8 GiB memory for builds. Only available for environment type `LINUX_LAMBDA_CONTAINER` and `ARM_LAMBDA_CONTAINER`.

  • ‘BUILD_LAMBDA_10GB`: Use up to 10 GiB memory for builds. Only available for environment type `LINUX_LAMBDA_CONTAINER` and `ARM_LAMBDA_CONTAINER`.

If you use ‘BUILD_GENERAL1_SMALL`:

  • For environment type ‘LINUX_CONTAINER`, you can use up to 4 GiB memory and 2 vCPUs for builds.

  • For environment type ‘LINUX_GPU_CONTAINER`, you can use up to 16 GiB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds.

  • For environment type ‘ARM_CONTAINER`, you can use up to 4 GiB memory and 2 vCPUs on ARM-based processors for builds.

If you use ‘BUILD_GENERAL1_LARGE`:

  • For environment type ‘LINUX_CONTAINER`, you can use up to 16 GiB memory and 8 vCPUs for builds.

  • For environment type ‘LINUX_GPU_CONTAINER`, you can use up to 255 GiB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.

  • For environment type ‘ARM_CONTAINER`, you can use up to 16 GiB memory and 8 vCPUs on ARM-based processors for builds.

For more information, see [On-demand environment types] in the *CodeBuild User Guide.*

[1]: docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html#environment-reserved-capacity.types [2]: docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html#environment.types

Returns:

  • (String) 


2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
 
# File 'lib/aws-sdk-codebuild/types.rb', line 2774

class Fleet < Struct.new(
  :arn,
  :name,
  :id,
  :created,
  :last_modified,
  :status,
  :base_capacity,
  :environment_type,
  :compute_type,
  :compute_configuration,
  :scaling_configuration,
  :overflow_behavior,
  :vpc_config,
  :proxy_configuration,
  :image_id,
  :fleet_service_role,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#created ⇒ Time

The time at which the compute fleet was created.

Returns:

  • (Time) 


2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
 
# File 'lib/aws-sdk-codebuild/types.rb', line 2774

class Fleet < Struct.new(
  :arn,
  :name,
  :id,
  :created,
  :last_modified,
  :status,
  :base_capacity,
  :environment_type,
  :compute_type,
  :compute_configuration,
  :scaling_configuration,
  :overflow_behavior,
  :vpc_config,
  :proxy_configuration,
  :image_id,
  :fleet_service_role,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#environment_type ⇒ String

The environment type of the compute fleet.

  • The environment type ‘ARM_CONTAINER` is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), Asia Pacific (Mumbai), Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), EU (Frankfurt), and South America (São Paulo).

  • The environment type ‘ARM_EC2` is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), South America (São Paulo), and Asia Pacific (Mumbai).

  • The environment type ‘LINUX_CONTAINER` is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), South America (São Paulo), and Asia Pacific (Mumbai).

  • The environment type ‘LINUX_EC2` is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), South America (São Paulo), and Asia Pacific (Mumbai).

  • The environment type ‘LINUX_GPU_CONTAINER` is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Tokyo), and Asia Pacific (Sydney).

  • The environment type ‘MAC_ARM` is available for Medium fleets only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Asia Pacific (Sydney), and EU (Frankfurt)

  • The environment type ‘MAC_ARM` is available for Large fleets only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), and Asia Pacific (Sydney).

  • The environment type ‘WINDOWS_EC2` is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), South America (São Paulo), and Asia Pacific (Mumbai).

  • The environment type ‘WINDOWS_SERVER_2019_CONTAINER` is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Asia Pacific (Sydney), Asia Pacific (Tokyo), Asia Pacific (Mumbai) and EU (Ireland).

  • The environment type ‘WINDOWS_SERVER_2022_CONTAINER` is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Sydney), Asia Pacific (Singapore), Asia Pacific (Tokyo), South America (São Paulo) and Asia Pacific (Mumbai).

For more information, see [Build environment compute types] in the *CodeBuild user guide*.

[1]: docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html

Returns:

  • (String) 


2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
 
# File 'lib/aws-sdk-codebuild/types.rb', line 2774

class Fleet < Struct.new(
  :arn,
  :name,
  :id,
  :created,
  :last_modified,
  :status,
  :base_capacity,
  :environment_type,
  :compute_type,
  :compute_configuration,
  :scaling_configuration,
  :overflow_behavior,
  :vpc_config,
  :proxy_configuration,
  :image_id,
  :fleet_service_role,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#fleet_service_role ⇒ String

The service role associated with the compute fleet. For more information, see [ Allow a user to add a permission policy for a fleet service role] in the *CodeBuild User Guide*.

[1]: docs.aws.amazon.com/codebuild/latest/userguide/auth-and-access-control-iam-identity-based-access-control.html#customer-managed-policies-example-permission-policy-fleet-service-role.html

Returns:

  • (String) 


2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
 
# File 'lib/aws-sdk-codebuild/types.rb', line 2774

class Fleet < Struct.new(
  :arn,
  :name,
  :id,
  :created,
  :last_modified,
  :status,
  :base_capacity,
  :environment_type,
  :compute_type,
  :compute_configuration,
  :scaling_configuration,
  :overflow_behavior,
  :vpc_config,
  :proxy_configuration,
  :image_id,
  :fleet_service_role,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

The ID of the compute fleet.

Returns:

  • (String) 


2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
 
# File 'lib/aws-sdk-codebuild/types.rb', line 2774

class Fleet < Struct.new(
  :arn,
  :name,
  :id,
  :created,
  :last_modified,
  :status,
  :base_capacity,
  :environment_type,
  :compute_type,
  :compute_configuration,
  :scaling_configuration,
  :overflow_behavior,
  :vpc_config,
  :proxy_configuration,
  :image_id,
  :fleet_service_role,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#image_id ⇒ String

The Amazon Machine Image (AMI) of the compute fleet.

Returns:

  • (String) 


2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
 
# File 'lib/aws-sdk-codebuild/types.rb', line 2774

class Fleet < Struct.new(
  :arn,
  :name,
  :id,
  :created,
  :last_modified,
  :status,
  :base_capacity,
  :environment_type,
  :compute_type,
  :compute_configuration,
  :scaling_configuration,
  :overflow_behavior,
  :vpc_config,
  :proxy_configuration,
  :image_id,
  :fleet_service_role,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified ⇒ Time

The time at which the compute fleet was last modified.

Returns:

  • (Time) 


2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
 
# File 'lib/aws-sdk-codebuild/types.rb', line 2774

class Fleet < Struct.new(
  :arn,
  :name,
  :id,
  :created,
  :last_modified,
  :status,
  :base_capacity,
  :environment_type,
  :compute_type,
  :compute_configuration,
  :scaling_configuration,
  :overflow_behavior,
  :vpc_config,
  :proxy_configuration,
  :image_id,
  :fleet_service_role,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the compute fleet.

Returns:

  • (String) 


2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
 
# File 'lib/aws-sdk-codebuild/types.rb', line 2774

class Fleet < Struct.new(
  :arn,
  :name,
  :id,
  :created,
  :last_modified,
  :status,
  :base_capacity,
  :environment_type,
  :compute_type,
  :compute_configuration,
  :scaling_configuration,
  :overflow_behavior,
  :vpc_config,
  :proxy_configuration,
  :image_id,
  :fleet_service_role,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#overflow_behavior ⇒ String

The compute fleet overflow behavior.

  • For overflow behavior ‘QUEUE`, your overflow builds need to wait on the existing fleet instance to become available.

  • For overflow behavior ‘ON_DEMAND`, your overflow builds run on CodeBuild on-demand.

    <note markdown=“1”> If you choose to set your overflow behavior to on-demand while creating a VPC-connected fleet, make sure that you add the required VPC permissions to your project service role. For more information, see [Example policy statement to allow CodeBuild access to Amazon Web Services services required to create a VPC network interface].

    </note>

[1]: docs.aws.amazon.com/codebuild/latest/userguide/auth-and-access-control-iam-identity-based-access-control.html#customer-managed-policies-example-create-vpc-network-interface

Returns:

  • (String) 


2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
 
# File 'lib/aws-sdk-codebuild/types.rb', line 2774

class Fleet < Struct.new(
  :arn,
  :name,
  :id,
  :created,
  :last_modified,
  :status,
  :base_capacity,
  :environment_type,
  :compute_type,
  :compute_configuration,
  :scaling_configuration,
  :overflow_behavior,
  :vpc_config,
  :proxy_configuration,
  :image_id,
  :fleet_service_role,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#proxy_configuration ⇒ Types::ProxyConfiguration

The proxy configuration of the compute fleet.

Returns:



2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
 
# File 'lib/aws-sdk-codebuild/types.rb', line 2774

class Fleet < Struct.new(
  :arn,
  :name,
  :id,
  :created,
  :last_modified,
  :status,
  :base_capacity,
  :environment_type,
  :compute_type,
  :compute_configuration,
  :scaling_configuration,
  :overflow_behavior,
  :vpc_config,
  :proxy_configuration,
  :image_id,
  :fleet_service_role,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#scaling_configuration ⇒ Types::ScalingConfigurationOutput

The scaling configuration of the compute fleet.

Returns:



2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
 
# File 'lib/aws-sdk-codebuild/types.rb', line 2774

class Fleet < Struct.new(
  :arn,
  :name,
  :id,
  :created,
  :last_modified,
  :status,
  :base_capacity,
  :environment_type,
  :compute_type,
  :compute_configuration,
  :scaling_configuration,
  :overflow_behavior,
  :vpc_config,
  :proxy_configuration,
  :image_id,
  :fleet_service_role,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ Types::FleetStatus

The status of the compute fleet.

Returns:



2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
 
# File 'lib/aws-sdk-codebuild/types.rb', line 2774

class Fleet < Struct.new(
  :arn,
  :name,
  :id,
  :created,
  :last_modified,
  :status,
  :base_capacity,
  :environment_type,
  :compute_type,
  :compute_configuration,
  :scaling_configuration,
  :overflow_behavior,
  :vpc_config,
  :proxy_configuration,
  :image_id,
  :fleet_service_role,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

A list of tag key and value pairs associated with this compute fleet.

These tags are available for use by Amazon Web Services services that support CodeBuild build project tags.

Returns:



2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
 
# File 'lib/aws-sdk-codebuild/types.rb', line 2774

class Fleet < Struct.new(
  :arn,
  :name,
  :id,
  :created,
  :last_modified,
  :status,
  :base_capacity,
  :environment_type,
  :compute_type,
  :compute_configuration,
  :scaling_configuration,
  :overflow_behavior,
  :vpc_config,
  :proxy_configuration,
  :image_id,
  :fleet_service_role,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_config ⇒ Types::VpcConfig

Information about the VPC configuration that CodeBuild accesses.

Returns:



2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
 
# File 'lib/aws-sdk-codebuild/types.rb', line 2774

class Fleet < Struct.new(
  :arn,
  :name,
  :id,
  :created,
  :last_modified,
  :status,
  :base_capacity,
  :environment_type,
  :compute_type,
  :compute_configuration,
  :scaling_configuration,
  :overflow_behavior,
  :vpc_config,
  :proxy_configuration,
  :image_id,
  :fleet_service_role,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end