Service class

This resource creates and rolls out a Cloud Endpoints service using OpenAPI or gRPC. View the relevant docs for OpenAPI and gRPC.

Example Usage

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

const openapiService = new gcp.endpoints.Service("openapi_service", {
    serviceName: "api-name.endpoints.project-id.cloud.goog",
    project: "project-id",
    openapiConfig: std.file({
        input: "openapi_spec.yml",
    }).then(invoke => invoke.result),
});
const grpcService = new gcp.endpoints.Service("grpc_service", {
    serviceName: "api-name.endpoints.project-id.cloud.goog",
    project: "project-id",
    grpcConfig: std.file({
        input: "service_spec.yml",
    }).then(invoke => invoke.result),
    protocOutputBase64: std.filebase64({
        input: "compiled_descriptor_file.pb",
    }).then(invoke => invoke.result),
});

import pulumi
import pulumi_gcp as gcp
import pulumi_std as std

openapi_service = gcp.endpoints.Service("openapi_service",
    service_name="api-name.endpoints.project-id.cloud.goog",
    project="project-id",
    openapi_config=std.file(input="openapi_spec.yml").result)
grpc_service = gcp.endpoints.Service("grpc_service",
    service_name="api-name.endpoints.project-id.cloud.goog",
    project="project-id",
    grpc_config=std.file(input="service_spec.yml").result,
    protoc_output_base64=std.filebase64(input="compiled_descriptor_file.pb").result)

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

return await Deployment.RunAsync(() =>
{
    var openapiService = new Gcp.Endpoints.Service("openapi_service", new()
    {
        ServiceName = "api-name.endpoints.project-id.cloud.goog",
        Project = "project-id",
        OpenapiConfig = Std.File.Invoke(new()
        {
            Input = "openapi_spec.yml",
        }).Apply(invoke => invoke.Result),
    });

    var grpcService = new Gcp.Endpoints.Service("grpc_service", new()
    {
        ServiceName = "api-name.endpoints.project-id.cloud.goog",
        Project = "project-id",
        GrpcConfig = Std.File.Invoke(new()
        {
            Input = "service_spec.yml",
        }).Apply(invoke => invoke.Result),
        ProtocOutputBase64 = Std.Filebase64.Invoke(new()
        {
            Input = "compiled_descriptor_file.pb",
        }).Apply(invoke => invoke.Result),
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		invokeFile, err := std.File(ctx, &std.FileArgs{
			Input: "openapi_spec.yml",
		}, nil)
		if err != nil {
			return err
		}
		_, err = endpoints.NewService(ctx, "openapi_service", &endpoints.ServiceArgs{
			ServiceName:   pulumi.String("api-name.endpoints.project-id.cloud.goog"),
			Project:       pulumi.String("project-id"),
			OpenapiConfig: pulumi.String(invokeFile.Result),
		})
		if err != nil {
			return err
		}
		invokeFile1, err := std.File(ctx, &std.FileArgs{
			Input: "service_spec.yml",
		}, nil)
		if err != nil {
			return err
		}
		invokeFilebase642, err := std.Filebase64(ctx, &std.Filebase64Args{
			Input: "compiled_descriptor_file.pb",
		}, nil)
		if err != nil {
			return err
		}
		_, err = endpoints.NewService(ctx, "grpc_service", &endpoints.ServiceArgs{
			ServiceName:        pulumi.String("api-name.endpoints.project-id.cloud.goog"),
			Project:            pulumi.String("project-id"),
			GrpcConfig:         pulumi.String(invokeFile1.Result),
			ProtocOutputBase64: pulumi.String(invokeFilebase642.Result),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

resource "gcp_endpoints_service" "openapi_service" {
  service_name   = "api-name.endpoints.project-id.cloud.goog"
  project        = "project-id"
  openapi_config = file("openapi_spec.yml")
}
resource "gcp_endpoints_service" "grpc_service" {
  service_name         = "api-name.endpoints.project-id.cloud.goog"
  project              = "project-id"
  grpc_config          = file("service_spec.yml")
  protoc_output_base64 = filebase64("compiled_descriptor_file.pb")
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.endpoints.Service;
import com.pulumi.gcp.endpoints.ServiceArgs;
import com.pulumi.std.StdFunctions;
import com.pulumi.std.inputs.FileArgs;
import com.pulumi.std.inputs.Filebase64Args;
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 openapiService = new Service("openapiService", ServiceArgs.builder()
            .serviceName("api-name.endpoints.project-id.cloud.goog")
            .project("project-id")
            .openapiConfig(StdFunctions.file(FileArgs.builder()
                .input("openapi_spec.yml")
                .build()).result())
            .build());

        var grpcService = new Service("grpcService", ServiceArgs.builder()
            .serviceName("api-name.endpoints.project-id.cloud.goog")
            .project("project-id")
            .grpcConfig(StdFunctions.file(FileArgs.builder()
                .input("service_spec.yml")
                .build()).result())
            .protocOutputBase64(StdFunctions.filebase64(Filebase64Args.builder()
                .input("compiled_descriptor_file.pb")
                .build()).result())
            .build());

    }
}

resources:
  openapiService:
    type: gcp:endpoints:Service
    name: openapi_service
    properties:
      serviceName: api-name.endpoints.project-id.cloud.goog
      project: project-id
      openapiConfig:
        fn::invoke:
          function: std:file
          arguments:
            input: openapi_spec.yml
          return: result
  grpcService:
    type: gcp:endpoints:Service
    name: grpc_service
    properties:
      serviceName: api-name.endpoints.project-id.cloud.goog
      project: project-id
      grpcConfig:
        fn::invoke:
          function: std:file
          arguments:
            input: service_spec.yml
          return: result
      protocOutputBase64:
        fn::invoke:
          function: std:filebase64
          arguments:
            input: compiled_descriptor_file.pb
          return: result

The example in examples/endpoints_on_compute_engine shows the API from the quickstart running on a Compute Engine VM and reachable through Cloud Endpoints, which may also be useful.

Import

This resource does not support import.

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

apis ↔ Output<List<ServiceApi>>

A list of API objects; structure is documented below.

late, final

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

configId ↔ Output<String>

The autogenerated ID for the configuration that is rolled out as part of the creation of this resource. Must be provided to compute engine instances as a tag.

late, final

deletionPolicy ↔ Output<String>

Whether Terraform will be prevented from destroying the instance. Defaults to "DELETE". When a 'terraform destroy' or 'terraform apply' would delete the instance, 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.

late, final

dnsAddress ↔ Output<String>

The address at which the service can be found - usually the same as the service name.

late, final

endpoints ↔ Output<List<ServiceEndpoint>>

A list of Endpoint objects; structure is documented below.

late, final

grpcConfig ↔ Output<String?>

The full text of the Service Config YAML file (Example located here). If provided, must also provide protocOutputBase64. openApi config must not be provided.

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

openapiConfig ↔ Output<String?>

The full text of the OpenAPI YAML configuration as described here. Either this, or both of grpcConfig and protocOutputBase64 must be specified.

late, final

project ↔ Output<String>

The project ID that the service belongs to. If not provided, provider project is used.

late, final

protocOutputBase64 ↔ Output<String?>

The full contents of the Service Descriptor File generated by protoc. This should be a compiled .pb file, base64-encoded.

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

serviceName ↔ Output<String>

The name of the service. Usually of the form $apiname.endpoints.$projectid.cloud.goog.

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

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