@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
275 lines • 11.1 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Hostgroups define the hosts (aka initiators) that can access the specific Google Cloud Netapp Volumes.
* Hostgroup is a regional resource and independent of the volumes or any other resource
*
* To get more information about HostGroup, see:
*
* * [API documentation](https://docs.cloud.google.com/netapp/volumes/docs/reference/rest/v1/projects.locations.hostGroups)
* * How-to Guides
* * [Documentation](https://docs.cloud.google.com/netapp/volumes/docs/configure-and-use/host-groups/overview)
*
* ## Example Usage
*
* ### Netapp Host Group
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const testHostGroup = new gcp.netapp.HostGroup("test_host_group", {
* name: "test-host-group",
* location: "us-central1",
* osType: "LINUX",
* type: "ISCSI_INITIATOR",
* hosts: ["iqn.1994-05.com.redhat:8518f79d5366"],
* });
* ```
*
* ## Import
*
* HostGroup can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/hostGroups/{{name}}`
* * `{{project}}/{{location}}/{{name}}`
* * `{{location}}/{{name}}`
*
* When using the `pulumi import` command, HostGroup can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:netapp/hostGroup:HostGroup default projects/{{project}}/locations/{{location}}/hostGroups/{{name}}
* $ pulumi import gcp:netapp/hostGroup:HostGroup default {{project}}/{{location}}/{{name}}
* $ pulumi import gcp:netapp/hostGroup:HostGroup default {{location}}/{{name}}
* ```
*/
export declare class HostGroup extends pulumi.CustomResource {
/**
* Get an existing HostGroup 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?: HostGroupState, opts?: pulumi.CustomResourceOptions): HostGroup;
/**
* Returns true if the given object is an instance of HostGroup. 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 HostGroup;
/**
* Create time of the host group. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z".
*/
readonly createTime: 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>;
/**
* An optional description of this resource.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
*/
readonly effectiveLabels: pulumi.Output<{
[key: string]: string;
}>;
/**
* The list of hosts associated with the host group
*/
readonly hosts: pulumi.Output<string[]>;
/**
* Labels as key value pairs. Example: `{ "owner": "Bob", "department": "finance", "purpose": "testing" }`.
*
* **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
* Please refer to the field `effectiveLabels` for all of the labels present on the resource.
*/
readonly labels: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* Location (region) of the Host Group.
*/
readonly location: pulumi.Output<string>;
/**
* The resource name of the Host Group. Needs to be unique per location.
*/
readonly name: pulumi.Output<string>;
/**
* The OS type of the host group. It indicates the type of operating system
* used by all of the hosts in the HostGroup. All hosts in a HostGroup must be
* of the same OS type. This can be set only when creating a HostGroup.
* Possible values are: `LINUX`, `WINDOWS`, `ESXI`.
*/
readonly osType: pulumi.Output<string>;
/**
* 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 combination of labels configured directly on the resource
* and default labels configured on the provider.
*/
readonly pulumiLabels: pulumi.Output<{
[key: string]: string;
}>;
/**
* The state of the Host Group.
*/
readonly state: pulumi.Output<string>;
/**
* Type of the host group.
* Possible values are: `ISCSI_INITIATOR`.
*/
readonly type: pulumi.Output<string>;
/**
* Create a HostGroup 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: HostGroupArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering HostGroup resources.
*/
export interface HostGroupState {
/**
* Create time of the host group. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z".
*/
createTime?: 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>;
/**
* An optional description of this resource.
*/
description?: pulumi.Input<string | undefined>;
/**
* All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
*/
effectiveLabels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
} | undefined>;
/**
* The list of hosts associated with the host group
*/
hosts?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* Labels as key value pairs. Example: `{ "owner": "Bob", "department": "finance", "purpose": "testing" }`.
*
* **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
* Please refer to the field `effectiveLabels` for all of the labels present on the resource.
*/
labels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
} | undefined>;
/**
* Location (region) of the Host Group.
*/
location?: pulumi.Input<string | undefined>;
/**
* The resource name of the Host Group. Needs to be unique per location.
*/
name?: pulumi.Input<string | undefined>;
/**
* The OS type of the host group. It indicates the type of operating system
* used by all of the hosts in the HostGroup. All hosts in a HostGroup must be
* of the same OS type. This can be set only when creating a HostGroup.
* Possible values are: `LINUX`, `WINDOWS`, `ESXI`.
*/
osType?: 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 combination of labels configured directly on the resource
* and default labels configured on the provider.
*/
pulumiLabels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
} | undefined>;
/**
* The state of the Host Group.
*/
state?: pulumi.Input<string | undefined>;
/**
* Type of the host group.
* Possible values are: `ISCSI_INITIATOR`.
*/
type?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a HostGroup resource.
*/
export interface HostGroupArgs {
/**
* 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>;
/**
* An optional description of this resource.
*/
description?: pulumi.Input<string | undefined>;
/**
* The list of hosts associated with the host group
*/
hosts: pulumi.Input<pulumi.Input<string>[]>;
/**
* Labels as key value pairs. Example: `{ "owner": "Bob", "department": "finance", "purpose": "testing" }`.
*
* **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
* Please refer to the field `effectiveLabels` for all of the labels present on the resource.
*/
labels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
} | undefined>;
/**
* Location (region) of the Host Group.
*/
location: pulumi.Input<string>;
/**
* The resource name of the Host Group. Needs to be unique per location.
*/
name?: pulumi.Input<string | undefined>;
/**
* The OS type of the host group. It indicates the type of operating system
* used by all of the hosts in the HostGroup. All hosts in a HostGroup must be
* of the same OS type. This can be set only when creating a HostGroup.
* Possible values are: `LINUX`, `WINDOWS`, `ESXI`.
*/
osType: pulumi.Input<string>;
/**
* 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>;
/**
* Type of the host group.
* Possible values are: `ISCSI_INITIATOR`.
*/
type: pulumi.Input<string>;
}
//# sourceMappingURL=hostGroup.d.ts.map