@pulumi/aws-native
Version:
The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)
85 lines (84 loc) • 3.07 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* Definition of AWS::Deadline::Fleet Resource Type
*/
export declare function getFleet(args: GetFleetArgs, opts?: pulumi.InvokeOptions): Promise<GetFleetResult>;
export interface GetFleetArgs {
/**
* The Amazon Resource Name (ARN) assigned to the fleet.
*/
arn: string;
}
export interface GetFleetResult {
/**
* The Amazon Resource Name (ARN) assigned to the fleet.
*/
readonly arn?: string;
readonly capabilities?: outputs.deadline.FleetCapabilities;
/**
* The configuration details for the fleet.
*/
readonly configuration?: outputs.deadline.FleetConfiguration0Properties | outputs.deadline.FleetConfiguration1Properties;
/**
* A description that helps identify what the fleet is used for.
*
* > 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.
*/
readonly description?: string;
/**
* The display name of the fleet summary to update.
*
* > 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.
*/
readonly displayName?: string;
/**
* The fleet ID.
*/
readonly fleetId?: string;
/**
* Provides a script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet.
*
* To remove a script from a fleet, use the [UpdateFleet](https://docs.aws.amazon.com/deadline-cloud/latest/APIReference/API_UpdateFleet.html) operation with the `hostConfiguration` `scriptBody` parameter set to an empty string ("").
*/
readonly hostConfiguration?: outputs.deadline.FleetHostConfiguration;
/**
* The maximum number of workers specified in the fleet.
*/
readonly maxWorkerCount?: number;
/**
* The minimum number of workers in the fleet.
*/
readonly minWorkerCount?: number;
/**
* The IAM role that workers in the fleet use when processing jobs.
*/
readonly roleArn?: string;
/**
* The status of the fleet.
*/
readonly status?: enums.deadline.FleetStatus;
/**
* A message that communicates a suspended status of the fleet.
*/
readonly statusMessage?: string;
/**
* An array of key-value pairs to apply to this resource.
*/
readonly tags?: outputs.Tag[];
/**
* The number of workers in the fleet summary.
*/
readonly workerCount?: number;
}
/**
* Definition of AWS::Deadline::Fleet Resource Type
*/
export declare function getFleetOutput(args: GetFleetOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetFleetResult>;
export interface GetFleetOutputArgs {
/**
* The Amazon Resource Name (ARN) assigned to the fleet.
*/
arn: pulumi.Input<string>;
}