@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
199 lines • 8.39 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Fleet contains information about a group of clusters.
*
* To get more information about Fleet, see:
*
* * [API documentation](https://cloud.google.com/anthos/multicluster-management/reference/rest/v1/projects.locations.fleets)
* * How-to Guides
* * [Registering a Cluster to a Fleet](https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster#register_cluster)
*
* ## Example Usage
*
* ### Gkehub Fleet Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const _default = new gcp.gkehub.Fleet("default", {
* displayName: "my production fleet",
* defaultClusterConfig: {
* securityPostureConfig: {
* mode: "DISABLED",
* vulnerabilityMode: "VULNERABILITY_DISABLED",
* },
* },
* });
* ```
*
* ## Import
*
* Fleet can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/global/fleets/default`
* * `{{project}}`
*
* When using the `pulumi import` command, Fleet can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:gkehub/fleet:Fleet default projects/{{project}}/locations/global/fleets/default
* $ pulumi import gcp:gkehub/fleet:Fleet default {{project}}
* ```
*/
export declare class Fleet extends pulumi.CustomResource {
/**
* Get an existing Fleet resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: FleetState, opts?: pulumi.CustomResourceOptions): Fleet;
/**
* Returns true if the given object is an instance of Fleet. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Fleet;
/**
* The time the fleet was created, in RFC3339 text format.
*/
readonly createTime: pulumi.Output<string>;
/**
* The default cluster configurations to apply across the fleet.
* Structure is documented below.
*/
readonly defaultClusterConfig: pulumi.Output<outputs.gkehub.FleetDefaultClusterConfig | undefined>;
/**
* The time the fleet was deleted, in RFC3339 text format.
*/
readonly deleteTime: pulumi.Output<string>;
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
readonly deletionPolicy: pulumi.Output<string>;
/**
* A user-assigned display name of the Fleet. When present, it must be between 4 to 30 characters.
* Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point.
*/
readonly displayName: pulumi.Output<string | undefined>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
readonly project: pulumi.Output<string>;
/**
* The state of the fleet resource.
* Structure is documented below.
*/
readonly states: pulumi.Output<outputs.gkehub.FleetState[]>;
/**
* Google-generated UUID for this resource. This is unique across all
* Fleet resources. If a Fleet resource is deleted and another
* resource with the same name is created, it gets a different uid.
*/
readonly uid: pulumi.Output<string>;
/**
* The time the fleet was last updated, in RFC3339 text format.
*/
readonly updateTime: pulumi.Output<string>;
/**
* Create a Fleet resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args?: FleetArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Fleet resources.
*/
export interface FleetState {
/**
* The time the fleet was created, in RFC3339 text format.
*/
createTime?: pulumi.Input<string | undefined>;
/**
* The default cluster configurations to apply across the fleet.
* Structure is documented below.
*/
defaultClusterConfig?: pulumi.Input<inputs.gkehub.FleetDefaultClusterConfig | undefined>;
/**
* The time the fleet was deleted, in RFC3339 text format.
*/
deleteTime?: pulumi.Input<string | undefined>;
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
deletionPolicy?: pulumi.Input<string | undefined>;
/**
* A user-assigned display name of the Fleet. When present, it must be between 4 to 30 characters.
* Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point.
*/
displayName?: pulumi.Input<string | undefined>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string | undefined>;
/**
* The state of the fleet resource.
* Structure is documented below.
*/
states?: pulumi.Input<pulumi.Input<inputs.gkehub.FleetState>[] | undefined>;
/**
* Google-generated UUID for this resource. This is unique across all
* Fleet resources. If a Fleet resource is deleted and another
* resource with the same name is created, it gets a different uid.
*/
uid?: pulumi.Input<string | undefined>;
/**
* The time the fleet was last updated, in RFC3339 text format.
*/
updateTime?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a Fleet resource.
*/
export interface FleetArgs {
/**
* The default cluster configurations to apply across the fleet.
* Structure is documented below.
*/
defaultClusterConfig?: pulumi.Input<inputs.gkehub.FleetDefaultClusterConfig | undefined>;
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
deletionPolicy?: pulumi.Input<string | undefined>;
/**
* A user-assigned display name of the Fleet. When present, it must be between 4 to 30 characters.
* Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point.
*/
displayName?: pulumi.Input<string | undefined>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=fleet.d.ts.map