@pulumiverse/scaleway
Version:
A Pulumi package for creating and managing Scaleway cloud resources.
150 lines (149 loc) • 6.26 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Creates and manages Compute Instance Placement Groups. For more information, see the [API documentation](https://www.scaleway.com/en/developers/api/instance/#path-placement-groups-list-placement-groups).
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const availabilityGroup = new scaleway.instance.PlacementGroup("availability_group", {});
* ```
*
* ## Import
*
* Placement groups can be imported using the `{zone}/{id}`, e.g.
*
* bash
*
* ```sh
* $ pulumi import scaleway:index/instancePlacementGroup:InstancePlacementGroup availability_group fr-par-1/11111111-1111-1111-1111-111111111111
* ```
*
* @deprecated scaleway.index/instanceplacementgroup.InstancePlacementGroup has been deprecated in favor of scaleway.instance/placementgroup.PlacementGroup
*/
export declare class InstancePlacementGroup extends pulumi.CustomResource {
/**
* Get an existing InstancePlacementGroup 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?: InstancePlacementGroupState, opts?: pulumi.CustomResourceOptions): InstancePlacementGroup;
/**
* Returns true if the given object is an instance of InstancePlacementGroup. 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 InstancePlacementGroup;
/**
* The name of the placement group.
*/
readonly name: pulumi.Output<string>;
/**
* The organization ID the placement group is associated with.
*/
readonly organizationId: pulumi.Output<string>;
/**
* The [policy mode](https://www.scaleway.com/en/developers/api/instance/#path-placement-groups-create-a-placement-group) of the placement group. Possible values are: `optional` or `enforced`.
*/
readonly policyMode: pulumi.Output<string | undefined>;
/**
* Is true when the policy is respected.
*/
readonly policyRespected: pulumi.Output<boolean>;
/**
* The [policy type](https://www.scaleway.com/en/developers/api/instance/#path-placement-groups-create-a-placement-grou) of the placement group. Possible values are: `lowLatency` or `maxAvailability`.
*/
readonly policyType: pulumi.Output<string | undefined>;
/**
* `projectId`) The ID of the project the placement group is associated with.
*/
readonly projectId: pulumi.Output<string>;
/**
* A list of tags to apply to the placement group.
*/
readonly tags: pulumi.Output<string[] | undefined>;
/**
* `zone`) The zone in which the placement group should be created.
*/
readonly zone: pulumi.Output<string>;
/**
* Create a InstancePlacementGroup 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.
*/
/** @deprecated scaleway.index/instanceplacementgroup.InstancePlacementGroup has been deprecated in favor of scaleway.instance/placementgroup.PlacementGroup */
constructor(name: string, args?: InstancePlacementGroupArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering InstancePlacementGroup resources.
*/
export interface InstancePlacementGroupState {
/**
* The name of the placement group.
*/
name?: pulumi.Input<string>;
/**
* The organization ID the placement group is associated with.
*/
organizationId?: pulumi.Input<string>;
/**
* The [policy mode](https://www.scaleway.com/en/developers/api/instance/#path-placement-groups-create-a-placement-group) of the placement group. Possible values are: `optional` or `enforced`.
*/
policyMode?: pulumi.Input<string>;
/**
* Is true when the policy is respected.
*/
policyRespected?: pulumi.Input<boolean>;
/**
* The [policy type](https://www.scaleway.com/en/developers/api/instance/#path-placement-groups-create-a-placement-grou) of the placement group. Possible values are: `lowLatency` or `maxAvailability`.
*/
policyType?: pulumi.Input<string>;
/**
* `projectId`) The ID of the project the placement group is associated with.
*/
projectId?: pulumi.Input<string>;
/**
* A list of tags to apply to the placement group.
*/
tags?: pulumi.Input<pulumi.Input<string>[]>;
/**
* `zone`) The zone in which the placement group should be created.
*/
zone?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a InstancePlacementGroup resource.
*/
export interface InstancePlacementGroupArgs {
/**
* The name of the placement group.
*/
name?: pulumi.Input<string>;
/**
* The [policy mode](https://www.scaleway.com/en/developers/api/instance/#path-placement-groups-create-a-placement-group) of the placement group. Possible values are: `optional` or `enforced`.
*/
policyMode?: pulumi.Input<string>;
/**
* The [policy type](https://www.scaleway.com/en/developers/api/instance/#path-placement-groups-create-a-placement-grou) of the placement group. Possible values are: `lowLatency` or `maxAvailability`.
*/
policyType?: pulumi.Input<string>;
/**
* `projectId`) The ID of the project the placement group is associated with.
*/
projectId?: pulumi.Input<string>;
/**
* A list of tags to apply to the placement group.
*/
tags?: pulumi.Input<pulumi.Input<string>[]>;
/**
* `zone`) The zone in which the placement group should be created.
*/
zone?: pulumi.Input<string>;
}