Interface CreateFleetRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateFleetRequest.Builder,CreateFleetRequest>, DeadlineRequest.Builder, SdkBuilder<CreateFleetRequest.Builder,CreateFleetRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateFleetRequest
@Mutable @NotThreadSafe public static interface CreateFleetRequest.Builder extends DeadlineRequest.Builder, SdkPojo, CopyableBuilder<CreateFleetRequest.Builder,CreateFleetRequest>

  • Method Details

    • clientToken

      CreateFleetRequest.Builder clientToken(String clientToken)

      The unique token which the server uses to recognize retries of the same request.

      Parameters:
      clientToken - The unique token which the server uses to recognize retries of the same request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • farmId

      CreateFleetRequest.Builder farmId(String farmId)

      The farm ID of the farm to connect to the fleet.

      Parameters:
      farmId - The farm ID of the farm to connect to the fleet.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • displayName

      CreateFleetRequest.Builder displayName(String displayName)

      The display name of the fleet.

      This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

      Parameters:
      displayName - The display name of the fleet.

      This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      CreateFleetRequest.Builder description(String description)

      The description of the fleet.

      This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

      Parameters:
      description - The description of the fleet.

      This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • roleArn

      CreateFleetRequest.Builder roleArn(String roleArn)

      The IAM role ARN for the role that the fleet's workers will use.

      Parameters:
      roleArn - The IAM role ARN for the role that the fleet's workers will use.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • minWorkerCount

      CreateFleetRequest.Builder minWorkerCount(Integer minWorkerCount)

      The minimum number of workers for the fleet.

      Parameters:
      minWorkerCount - The minimum number of workers for the fleet.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxWorkerCount

      CreateFleetRequest.Builder maxWorkerCount(Integer maxWorkerCount)

      The maximum number of workers for the fleet.

      Deadline Cloud limits the number of workers to less than or equal to the fleet's maximum worker count. The service maintains eventual consistency for the worker count. If you make multiple rapid calls to CreateWorker before the field updates, you might exceed your fleet's maximum worker count. For example, if your maxWorkerCount is 10 and you currently have 9 workers, making two quick CreateWorker calls might successfully create 2 workers instead of 1, resulting in 11 total workers.

      Parameters:
      maxWorkerCount - The maximum number of workers for the fleet.

      Deadline Cloud limits the number of workers to less than or equal to the fleet's maximum worker count. The service maintains eventual consistency for the worker count. If you make multiple rapid calls to CreateWorker before the field updates, you might exceed your fleet's maximum worker count. For example, if your maxWorkerCount is 10 and you currently have 9 workers, making two quick CreateWorker calls might successfully create 2 workers instead of 1, resulting in 11 total workers.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • configuration

      CreateFleetRequest.Builder configuration(FleetConfiguration configuration)

      The configuration settings for the fleet. Customer managed fleets are self-managed. Service managed Amazon EC2 fleets are managed by Deadline Cloud.

      Parameters:
      configuration - The configuration settings for the fleet. Customer managed fleets are self-managed. Service managed Amazon EC2 fleets are managed by Deadline Cloud.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • configuration

      default CreateFleetRequest.Builder configuration(Consumer<FleetConfiguration.Builder> configuration)

      The configuration settings for the fleet. Customer managed fleets are self-managed. Service managed Amazon EC2 fleets are managed by Deadline Cloud.

      This is a convenience method that creates an instance of the FleetConfiguration.Builder avoiding the need to create one manually via FleetConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to configuration(FleetConfiguration).

      Parameters:
      configuration - a consumer that will call methods on FleetConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tags

      CreateFleetRequest.Builder tags(Map<String,String> tags)

      Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.

      Parameters:
      tags - Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • hostConfiguration

      CreateFleetRequest.Builder hostConfiguration(HostConfiguration hostConfiguration)

      Provides a script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet.

      Parameters:
      hostConfiguration - Provides a script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • hostConfiguration

      default CreateFleetRequest.Builder hostConfiguration(Consumer<HostConfiguration.Builder> hostConfiguration)

      Provides a script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet.

      This is a convenience method that creates an instance of the HostConfiguration.Builder avoiding the need to create one manually via HostConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to hostConfiguration(HostConfiguration).

      Parameters:
      hostConfiguration - a consumer that will call methods on HostConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      CreateFleetRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateFleetRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.