PreviewFeature class

Represents a single Google Compute Engine preview feature such as Alpha API access, which can be enabled or unspecified for a project.

To get more information about PreviewFeature, see:

• API documentation
• How-to Guides
• Use the Compute Engine alpha API

Example Usage

Preview Feature Basic

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: "ACTIVATION_STATE_UNSPECIFIED",
    rolloutOperation: {
        rolloutInput: {
            predefinedRolloutPlan: "ROLLOUT_PLAN_FAST_ROLLOUT",
        },
    },
});

import pulumi
import pulumi_gcp as gcp

gce_preview_feature = gcp.compute.PreviewFeature("gce_preview_feature",
    name="alpha-api-access",
    activation_status="ACTIVATION_STATE_UNSPECIFIED",
    rollout_operation={
        "rollout_input": {
            "predefined_rollout_plan": "ROLLOUT_PLAN_FAST_ROLLOUT",
        },
    })

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var gcePreviewFeature = new Gcp.Compute.PreviewFeature("gce_preview_feature", new()
    {
        Name = "alpha-api-access",
        ActivationStatus = "ACTIVATION_STATE_UNSPECIFIED",
        RolloutOperation = new Gcp.Compute.Inputs.PreviewFeatureRolloutOperationArgs
        {
            RolloutInput = new Gcp.Compute.Inputs.PreviewFeatureRolloutOperationRolloutInputArgs
            {
                PredefinedRolloutPlan = "ROLLOUT_PLAN_FAST_ROLLOUT",
            },
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/compute"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := compute.NewPreviewFeature(ctx, "gce_preview_feature", &compute.PreviewFeatureArgs{
			Name:             pulumi.String("alpha-api-access"),
			ActivationStatus: pulumi.String("ACTIVATION_STATE_UNSPECIFIED"),
			RolloutOperation: &compute.PreviewFeatureRolloutOperationArgs{
				RolloutInput: &compute.PreviewFeatureRolloutOperationRolloutInputArgs{
					PredefinedRolloutPlan: pulumi.String("ROLLOUT_PLAN_FAST_ROLLOUT"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_compute_previewfeature" "gce_preview_feature" {
  name              = "alpha-api-access"
  activation_status = "ACTIVATION_STATE_UNSPECIFIED"
  rollout_operation = {
    rollout_input = {
      predefined_rollout_plan = "ROLLOUT_PLAN_FAST_ROLLOUT"
    }
  }
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.PreviewFeature;
import com.pulumi.gcp.compute.PreviewFeatureArgs;
import com.pulumi.gcp.compute.inputs.PreviewFeatureRolloutOperationArgs;
import com.pulumi.gcp.compute.inputs.PreviewFeatureRolloutOperationRolloutInputArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var gcePreviewFeature = new PreviewFeature("gcePreviewFeature", PreviewFeatureArgs.builder()
            .name("alpha-api-access")
            .activationStatus("ACTIVATION_STATE_UNSPECIFIED")
            .rolloutOperation(PreviewFeatureRolloutOperationArgs.builder()
                .rolloutInput(PreviewFeatureRolloutOperationRolloutInputArgs.builder()
                    .predefinedRolloutPlan("ROLLOUT_PLAN_FAST_ROLLOUT")
                    .build())
                .build())
            .build());

    }
}

resources:
  gcePreviewFeature:
    type: gcp:compute:PreviewFeature
    name: gce_preview_feature
    properties:
      name: alpha-api-access
      activationStatus: ACTIVATION_STATE_UNSPECIFIED
      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:

$ pulumi import gcp:compute/previewFeature:PreviewFeature default projects/{{project}}/global/previewFeatures/{{name}}
$ pulumi import gcp:compute/previewFeature:PreviewFeature default {{project}}/{{name}}
$ pulumi import gcp:compute/previewFeature:PreviewFeature default {{name}}

Constructors

PreviewFeature(String name, {PreviewFeatureArgs? args, CustomResourceOptions? options})

Creates a new PreviewFeature. name The Pulumi resource name. args Arguments used to configure this PreviewFeature. The set of arguments for PreviewFeature. options Resource options controlling this resource's behavior.

PreviewFeature.reference(String urn)

Creates a typed reference to an existing PreviewFeature resource.

Properties

activationStatus ↔ Output<String>

The activation status of the preview feature. Possible values are: ENABLED, ACTIVATION_STATE_UNSPECIFIED.

late, final

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

name ↔ Output<String>

The name of the preview feature.

late, final

project ↔ Output<String>

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

rolloutOperation ↔ Output<PreviewFeatureRolloutOperation?>

The rollout operation of the feature. Structure is documented below.

late, final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

urn ↔ Output<String>

late, final, inherited

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

get(String name, Input<String> id, {PreviewFeatureState? state, CustomResourceOptions? options}) → PreviewFeature

Gets an existing PreviewFeature resource's state with the given name and id.