Update Fleet

codebuild_update_fleet

R Documentation

Updates a compute fleet

Description

Updates a compute fleet.

Usage

codebuild_update_fleet(arn, baseCapacity, environmentType, computeType,
  scalingConfiguration, overflowBehavior, vpcConfig, imageId,
  fleetServiceRole, tags)

Arguments

arn

[required] The ARN of the compute fleet.

baseCapacity

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

environmentType

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 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_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_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.

computeType

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

• BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for builds.

• BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for builds.

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

• BUILD_GENERAL1_XLARGE: Use up to 70 GB memory and 36 vCPUs for builds, depending on your environment type.

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

If you use BUILD_GENERAL1_SMALL:

• For environment type LINUX_CONTAINER, you can use up to 3 GB memory and 2 vCPUs for builds.

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

• For environment type ARM_CONTAINER, you can use up to 4 GB 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 15 GB memory and 8 vCPUs for builds.

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

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

For more information, see Build environment compute types in the CodeBuild User Guide.

scalingConfiguration

The scaling configuration of the compute fleet.

overflowBehavior

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.

  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.

vpcConfig

imageId

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

fleetServiceRole

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.

tags

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.

Value

A list with the following syntax:

list(
  fleet = list(
    arn = "string",
    name = "string",
    id = "string",
    created = as.POSIXct(
      "2015-01-01"
    ),
    lastModified = as.POSIXct(
      "2015-01-01"
    ),
    status = list(
      statusCode = "CREATING"|"UPDATING"|"ROTATING"|"PENDING_DELETION"|"DELETING"|"CREATE_FAILED"|"UPDATE_ROLLBACK_FAILED"|"ACTIVE",
      context = "CREATE_FAILED"|"UPDATE_FAILED"|"ACTION_REQUIRED"|"PENDING_DELETION"|"INSUFFICIENT_CAPACITY",
      message = "string"
    ),
    baseCapacity = 123,
    environmentType = "WINDOWS_CONTAINER"|"LINUX_CONTAINER"|"LINUX_GPU_CONTAINER"|"ARM_CONTAINER"|"WINDOWS_SERVER_2019_CONTAINER"|"LINUX_LAMBDA_CONTAINER"|"ARM_LAMBDA_CONTAINER"|"MAC_ARM",
    computeType = "BUILD_GENERAL1_SMALL"|"BUILD_GENERAL1_MEDIUM"|"BUILD_GENERAL1_LARGE"|"BUILD_GENERAL1_XLARGE"|"BUILD_GENERAL1_2XLARGE"|"BUILD_LAMBDA_1GB"|"BUILD_LAMBDA_2GB"|"BUILD_LAMBDA_4GB"|"BUILD_LAMBDA_8GB"|"BUILD_LAMBDA_10GB",
    scalingConfiguration = list(
      scalingType = "TARGET_TRACKING_SCALING",
      targetTrackingScalingConfigs = list(
        list(
          metricType = "FLEET_UTILIZATION_RATE",
          targetValue = 123.0
        )
      ),
      maxCapacity = 123,
      desiredCapacity = 123
    ),
    overflowBehavior = "QUEUE"|"ON_DEMAND",
    vpcConfig = list(
      vpcId = "string",
      subnets = list(
        "string"
      ),
      securityGroupIds = list(
        "string"
      )
    ),
    imageId = "string",
    fleetServiceRole = "string",
    tags = list(
      list(
        key = "string",
        value = "string"
      )
    )
  )
)

Request syntax

svc$update_fleet(
  arn = "string",
  baseCapacity = 123,
  environmentType = "WINDOWS_CONTAINER"|"LINUX_CONTAINER"|"LINUX_GPU_CONTAINER"|"ARM_CONTAINER"|"WINDOWS_SERVER_2019_CONTAINER"|"LINUX_LAMBDA_CONTAINER"|"ARM_LAMBDA_CONTAINER"|"MAC_ARM",
  computeType = "BUILD_GENERAL1_SMALL"|"BUILD_GENERAL1_MEDIUM"|"BUILD_GENERAL1_LARGE"|"BUILD_GENERAL1_XLARGE"|"BUILD_GENERAL1_2XLARGE"|"BUILD_LAMBDA_1GB"|"BUILD_LAMBDA_2GB"|"BUILD_LAMBDA_4GB"|"BUILD_LAMBDA_8GB"|"BUILD_LAMBDA_10GB",
  scalingConfiguration = list(
    scalingType = "TARGET_TRACKING_SCALING",
    targetTrackingScalingConfigs = list(
      list(
        metricType = "FLEET_UTILIZATION_RATE",
        targetValue = 123.0
      )
    ),
    maxCapacity = 123
  ),
  overflowBehavior = "QUEUE"|"ON_DEMAND",
  vpcConfig = list(
    vpcId = "string",
    subnets = list(
      "string"
    ),
    securityGroupIds = list(
      "string"
    )
  ),
  imageId = "string",
  fleetServiceRole = "string",
  tags = list(
    list(
      key = "string",
      value = "string"
    )
  )
)