@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
148 lines (147 loc) • 5.16 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Represents a single Google Compute Engine preview feature such as Alpha API access, which can be enabled or disabled for a project.
*
* To get more information about PreviewFeature, see:
*
* * [API documentation](https://cloud.google.com/compute/docs/reference/rest/beta/PreviewFeatures)
* * How-to Guides
* * [Use the Compute Engine alpha API](https://cloud.google.com/compute/docs/reference/rest/alpha)
*
* ## Example Usage
*
* ### Preview Feature Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const gcePreviewFeature = new gcp.compute.PreviewFeature("gce_preview_feature", {
* name: "alpha-api-access",
* activationStatus: "DISABLED",
* rolloutOperation: {
* rolloutInput: {
* predefinedRolloutPlan: "ROLLOUT_PLAN_FAST_ROLLOUT",
* },
* },
* });
* ```
*
* ## Import
*
* PreviewFeature can be imported using any of these accepted formats:
*
* * `projects/{{project}}/global/previewFeatures/{{name}}`
*
* * `{{project}}/{{name}}`
*
* * `{{name}}`
*
* When using the `pulumi import` command, PreviewFeature can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:compute/previewFeature:PreviewFeature default projects/{{project}}/global/previewFeatures/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:compute/previewFeature:PreviewFeature default {{project}}/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:compute/previewFeature:PreviewFeature default {{name}}
* ```
*/
export declare class PreviewFeature extends pulumi.CustomResource {
/**
* Get an existing PreviewFeature 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?: PreviewFeatureState, opts?: pulumi.CustomResourceOptions): PreviewFeature;
/**
* Returns true if the given object is an instance of PreviewFeature. 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 PreviewFeature;
/**
* The activation status of the preview feature.
* Possible values are: `ENABLED`, `DISABLED`.
*/
readonly activationStatus: pulumi.Output<string>;
/**
* The name of the preview feature.
*/
readonly name: 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 rollout operation of the feature.
* Structure is documented below.
*/
readonly rolloutOperation: pulumi.Output<outputs.compute.PreviewFeatureRolloutOperation | undefined>;
/**
* Create a PreviewFeature 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: PreviewFeatureArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering PreviewFeature resources.
*/
export interface PreviewFeatureState {
/**
* The activation status of the preview feature.
* Possible values are: `ENABLED`, `DISABLED`.
*/
activationStatus?: pulumi.Input<string>;
/**
* The name of the preview feature.
*/
name?: 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>;
/**
* The rollout operation of the feature.
* Structure is documented below.
*/
rolloutOperation?: pulumi.Input<inputs.compute.PreviewFeatureRolloutOperation>;
}
/**
* The set of arguments for constructing a PreviewFeature resource.
*/
export interface PreviewFeatureArgs {
/**
* The activation status of the preview feature.
* Possible values are: `ENABLED`, `DISABLED`.
*/
activationStatus: pulumi.Input<string>;
/**
* The name of the preview feature.
*/
name?: 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>;
/**
* The rollout operation of the feature.
* Structure is documented below.
*/
rolloutOperation?: pulumi.Input<inputs.compute.PreviewFeatureRolloutOperation>;
}