ServiceIdentity class

> Warning: These resources are in beta, and should be used with the terraform-provider-google-beta provider. See Provider Versions for more details on beta resources.

Generate service identity for a service.

> Note: Once created, this resource cannot be updated or destroyed. These actions are a no-op.

> Note: This resource can be used to retrieve the emails of the Google-managed service accounts of the APIs that Google has configured with a Service Identity. You can run gcloud beta services identity create --service SERVICE_NAME.googleapis.com to verify if an API supports this.

To get more information about Service Identity, see:

• API documentation

Example Usage

Service Identity Basic

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

const project = gcp.organizations.getProject({});
const hcSa = new gcp.projects.ServiceIdentity("hc_sa", {
    project: project.then(project => project.projectId),
    service: "healthcare.googleapis.com",
});
const hcSaBqJobuser = new gcp.projects.IAMMember("hc_sa_bq_jobuser", {
    project: project.then(project => project.projectId),
    role: "roles/bigquery.jobUser",
    member: hcSa.member,
});

import pulumi
import pulumi_gcp as gcp

project = gcp.organizations.get_project()
hc_sa = gcp.projects.ServiceIdentity("hc_sa",
    project=project.project_id,
    service="healthcare.googleapis.com")
hc_sa_bq_jobuser = gcp.projects.IAMMember("hc_sa_bq_jobuser",
    project=project.project_id,
    role="roles/bigquery.jobUser",
    member=hc_sa.member)

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

return await Deployment.RunAsync(() =>
{
    var project = Gcp.Organizations.GetProject.Invoke();

    var hcSa = new Gcp.Projects.ServiceIdentity("hc_sa", new()
    {
        Project = project.Apply(getProjectResult => getProjectResult.ProjectId),
        Service = "healthcare.googleapis.com",
    });

    var hcSaBqJobuser = new Gcp.Projects.IAMMember("hc_sa_bq_jobuser", new()
    {
        Project = project.Apply(getProjectResult => getProjectResult.ProjectId),
        Role = "roles/bigquery.jobUser",
        Member = hcSa.Member,
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/organizations"
	"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 {
		project, err := organizations.LookupProject(ctx, &organizations.LookupProjectArgs{}, nil)
		if err != nil {
			return err
		}
		hcSa, err := projects.NewServiceIdentity(ctx, "hc_sa", &projects.ServiceIdentityArgs{
			Project: pulumi.String(project.ProjectId),
			Service: pulumi.String("healthcare.googleapis.com"),
		})
		if err != nil {
			return err
		}
		_, err = projects.NewIAMMember(ctx, "hc_sa_bq_jobuser", &projects.IAMMemberArgs{
			Project: pulumi.String(project.ProjectId),
			Role:    pulumi.String("roles/bigquery.jobUser"),
			Member:  hcSa.Member,
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

data "gcp_organizations_getproject" "project" {
}

resource "gcp_projects_serviceidentity" "hc_sa" {
  project = data.gcp_organizations_getproject.project.project_id
  service = "healthcare.googleapis.com"
}
resource "gcp_projects_iammember" "hc_sa_bq_jobuser" {
  project = data.gcp_organizations_getproject.project.project_id
  role    = "roles/bigquery.jobUser"
  member  = gcp_projects_serviceidentity.hc_sa.member
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.organizations.OrganizationsFunctions;
import com.pulumi.gcp.organizations.inputs.GetProjectArgs;
import com.pulumi.gcp.projects.ServiceIdentity;
import com.pulumi.gcp.projects.ServiceIdentityArgs;
import com.pulumi.gcp.projects.IAMMember;
import com.pulumi.gcp.projects.IAMMemberArgs;
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) {
        final var project = OrganizationsFunctions.getProject(GetProjectArgs.builder()
            .build());

        var hcSa = new ServiceIdentity("hcSa", ServiceIdentityArgs.builder()
            .project(project.projectId())
            .service("healthcare.googleapis.com")
            .build());

        var hcSaBqJobuser = new IAMMember("hcSaBqJobuser", IAMMemberArgs.builder()
            .project(project.projectId())
            .role("roles/bigquery.jobUser")
            .member(hcSa.member())
            .build());

    }
}

resources:
  hcSa:
    type: gcp:projects:ServiceIdentity
    name: hc_sa
    properties:
      project: ${project.projectId}
      service: healthcare.googleapis.com
  hcSaBqJobuser:
    type: gcp:projects:IAMMember
    name: hc_sa_bq_jobuser
    properties:
      project: ${project.projectId}
      role: roles/bigquery.jobUser
      member: ${hcSa.member}
variables:
  project:
    fn::invoke:
      function: gcp:organizations:getProject
      arguments: {}

Import

This resource does not support import.

Constructors

ServiceIdentity(String name, {ServiceIdentityArgs? args, CustomResourceOptions? options})

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

ServiceIdentity.reference(String urn)

Creates a typed reference to an existing ServiceIdentity resource.

Properties

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

email ↔ Output<String>

The email address of the Google managed service account.

late, final

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

member ↔ Output<String>

The Identity of the Google managed service account in the form 'serviceAccount:{email}'. This value is often used to refer to the service account in order to grant IAM permissions.

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

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

service ↔ Output<String>

The service to generate identity for.

late, final

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, {ServiceIdentityState? state, CustomResourceOptions? options}) → ServiceIdentity

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