Service class

Allows management of a single API service for a Google Cloud project.

For a list of services available, visit the API library page or run gcloud services list --available.

This resource requires the Service Usage API to use.

To get more information about gcp.projects.Service, see:

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const project = new gcp.projects.Service("project", {
    project: "your-project-id",
    service: "iam.googleapis.com",
});

import pulumi
import pulumi_gcp as gcp

project = gcp.projects.Service("project",
    project="your-project-id",
    service="iam.googleapis.com")

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

return await Deployment.RunAsync(() =>
{
    var project = new Gcp.Projects.Service("project", new()
    {
        Project = "your-project-id",
        ServiceName = "iam.googleapis.com",
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := projects.NewService(ctx, "project", &projects.ServiceArgs{
			Project: pulumi.String("your-project-id"),
			Service: pulumi.String("iam.googleapis.com"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

resource "gcp_projects_service" "project" {
  project = "your-project-id"
  service = "iam.googleapis.com"
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.projects.Service;
import com.pulumi.gcp.projects.ServiceArgs;
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 project = new Service("project", ServiceArgs.builder()
            .project("your-project-id")
            .service("iam.googleapis.com")
            .build());

    }
}

resources:
  project:
    type: gcp:projects:Service
    properties:
      project: your-project-id
      service: iam.googleapis.com

Import

Project services can be imported using the projectId and service, e.g.

{{project_id}}/{{service}}

When using the pulumi import command, project services can be imported using one of the formats above. For example:

$ pulumi import gcp:projects/service:Service default {{project_id}}/{{service}}

Note that unlike other resources that fail if they already exist, pulumi up can be successfully used to verify already enabled services. This means that when importing existing resources into Terraform, you can either import the gcp.projects.Service resources or treat them as new infrastructure and run pulumi up to add them to state.

Constructors

Service(String name, {ServiceArgs? args, CustomResourceOptions? options}): Creates a new Service. name The Pulumi resource name. args Arguments used to configure this Service. The set of arguments for Service. options Resource options controlling this resource's behavior.
Service.reference(String urn): Creates a typed reference to an existing Service resource.

Properties

checkIfServiceHasUsageOnDestroy ↔ Output<bool?>: Beta If true, the usage of the service to be disabled will be checked and an error will be returned if the service to be disabled has usage in last 30 days.
latefinal
childResources → Set<Resource>: finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>: latefinalinherited
deletionPolicy ↔ 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. If disableOnDestroy is set to false, the service will still be enabled when the Terraform resource is destroyed even if the deletionPolicy field is set to "DELETE".
latefinal
disableDependentServices ↔ Output<bool?>: If true, services that are enabled and which depend on this service should also be disabled when this service is destroyed. If false or unset, an error will be generated if any enabled services depend on this service when destroying it.
latefinal
disableOnDestroy ↔ Output<bool?>: If true, disable the service when the Terraform resource is destroyed. If false or unset, the service will be left enabled when the Terraform resource is destroyed. It should generally only be true in configurations that manage the gcp.organizations.Project resource itself.
latefinal
hashCode → int: The hash code for this object.
no setterinherited
id ↔ Output<String>: getter/setter pairinherited
isCustom → bool: Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool: Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool: Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool: Whether this instance represents a resource value returned over RPC.
finalinherited
project ↔ Output<String>: The project ID. If not provided, the provider project is used.
latefinal
resourceTransforms → List<ResourceTransform>: Inherited/explicit async transforms.
no setterinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
service ↔ Output<String>: The service to enable.
latefinal
transformations → List<ResourceTransformation>: Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>: latefinalinherited

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, {ServiceState? state, CustomResourceOptions? options}) → Service: Gets an existing Service resource's state with the given name and id.