Package software.amazon.awssdk.services.codebuild.model

Class CreateFleetRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.codebuild.model.CodeBuildRequest
software.amazon.awssdk.services.codebuild.model.CreateFleetRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateFleetRequest.Builder,CreateFleetRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateFleetRequest extends CodeBuildRequest implements ToCopyableBuilder<CreateFleetRequest.Builder,CreateFleetRequest>

  • Method Details

    • name

      public final String name()

      The name of the compute fleet.

      Returns:
      The name of the compute fleet.

    • baseCapacity

      public final Integer baseCapacity()

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

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

    • environmentType

      public final EnvironmentType 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 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.

      If the service returns an enum value that is not available in the current SDK version, environmentType will return EnvironmentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from environmentTypeAsString().

      Returns:
      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 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.

      See Also:

    • environmentTypeAsString

      public final String environmentTypeAsString()

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

      If the service returns an enum value that is not available in the current SDK version, environmentType will return EnvironmentType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from environmentTypeAsString().

      Returns:
      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 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.

      See Also:

    • computeType

      public final ComputeType 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.

      If the service returns an enum value that is not available in the current SDK version, computeType will return ComputeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from computeTypeAsString().

      Returns:
      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.

      See Also:

    • computeTypeAsString

      public final String computeTypeAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, computeType will return ComputeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from computeTypeAsString().

      Returns:
      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.

      See Also:

    • scalingConfiguration

      public final ScalingConfigurationInput scalingConfiguration()

      The scaling configuration of the compute fleet.

      Returns:
      The scaling configuration of the compute fleet.

    • overflowBehavior

      public final FleetOverflowBehavior 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 the service returns an enum value that is not available in the current SDK version, overflowBehavior will return FleetOverflowBehavior.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from overflowBehaviorAsString().

      Returns:
      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.

      See Also:

    • overflowBehaviorAsString

      public final String overflowBehaviorAsString()

      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 the service returns an enum value that is not available in the current SDK version, overflowBehavior will return FleetOverflowBehavior.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from overflowBehaviorAsString().

      Returns:
      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.

      See Also:

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final List<Tag> 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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      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.

    • toBuilder

      public CreateFleetRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateFleetRequest.Builder,CreateFleetRequest>
      Specified by:
      toBuilder in class CodeBuildRequest
      Returns:
      a builder for type T

    • builder

      public static CreateFleetRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateFleetRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.