1. Docs
2. Reference
3. API
4. @pulumi/gcp
5. endpoints

Module endpoints

Resources

• Service
• ServiceIamBinding
• ServiceIamMember
• ServiceIamPolicy

Others

• ServiceArgs
• ServiceIamBindingArgs
• ServiceIamBindingState
• ServiceIamMemberArgs
• ServiceIamMemberState
• ServiceIamPolicyArgs
• ServiceIamPolicyState
• ServiceState

Resources

Resource Service

class Service extends CustomResource

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

constructor

new Service(name: string, args: ServiceArgs, opts?: pulumi.CustomResourceOptions)

Create a Service resource with the given unique name, arguments, and options.

• name The unique name of the resource.
• args The arguments to use to populate this resource's properties.
• opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ServiceState, opts?: pulumi.CustomResourceOptions): Service

Get an existing Service resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Service

Returns true if the given object is an instance of Service. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property apis

public apis: pulumi.Output<ServiceApi[]>;

property configId

public configId: pulumi.Output<string>;

property dnsAddress

public dnsAddress: pulumi.Output<string>;

property endpoints

public endpoints: pulumi.Output<ServiceEndpoint[]>;

property grpcConfig

public grpcConfig: pulumi.Output<string | undefined>;

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property openapiConfig

public openapiConfig: pulumi.Output<string | undefined>;

property project

public project: pulumi.Output<string>;

property protocOutputBase64

public protocOutputBase64: pulumi.Output<string | undefined>;

property serviceName

public serviceName: pulumi.Output<string>;

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource ServiceIamBinding

class ServiceIamBinding extends CustomResource

Three different resources help you manage your IAM policy for Cloud Endpoints Service. Each of these resources serves a different use case:

• gcp.endpoints.ServiceIamPolicy: Authoritative. Sets the IAM policy for the service and replaces any existing policy already attached.
• gcp.endpoints.ServiceIamBinding: Authoritative for a given role. Updates the IAM policy to grant a role to a list of members. Other roles within the IAM policy for the service are preserved.
• gcp.endpoints.ServiceIamMember: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the service are preserved.

Note: gcp.endpoints.ServiceIamPolicy cannot be used in conjunction with gcp.endpoints.ServiceIamBinding and gcp.endpoints.ServiceIamMember or they will fight over what your policy should be.

Note: gcp.endpoints.ServiceIamBinding resources can be used in conjunction with gcp.endpoints.ServiceIamMember resources only if they do not grant privilege to the same role.

google_endpoints_service_iam_policy

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

const admin = gcp.organizations.getIAMPolicy({
    binding: [{
        role: "roles/viewer",
        members: ["user:jane@example.com"],
    }],
});
const policy = new gcp.endpoints.ServiceIamPolicy("policy", {
    serviceName: google_endpoints_service.endpoints_service.service_name,
    policyData: admin.then(admin => admin.policyData),
});

google_endpoints_service_iam_binding

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

const binding = new gcp.endpoints.ServiceIamBinding("binding", {
    serviceName: google_endpoints_service.endpoints_service.service_name,
    role: "roles/viewer",
    members: ["user:jane@example.com"],
});

google_endpoints_service_iam_member

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

const member = new gcp.endpoints.ServiceIamMember("member", {
    serviceName: google_endpoints_service.endpoints_service.service_name,
    role: "roles/viewer",
    member: "user:jane@example.com",
});

constructor

new ServiceIamBinding(name: string, args: ServiceIamBindingArgs, opts?: pulumi.CustomResourceOptions)

Create a ServiceIamBinding resource with the given unique name, arguments, and options.

• name The unique name of the resource.
• args The arguments to use to populate this resource's properties.
• opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ServiceIamBindingState, opts?: pulumi.CustomResourceOptions): ServiceIamBinding

Get an existing ServiceIamBinding resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ServiceIamBinding

Returns true if the given object is an instance of ServiceIamBinding. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property condition

public condition: pulumi.Output<ServiceIamBindingCondition | undefined>;

property etag

public etag: pulumi.Output<string>;

(Computed) The etag of the IAM policy.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property members

public members: pulumi.Output<string[]>;

property role

public role: pulumi.Output<string>;

The role that should be applied. Only one gcp.endpoints.ServiceIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

property serviceName

public serviceName: pulumi.Output<string>;

The name of the service. Used to find the parent resource to bind the IAM policy to

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource ServiceIamMember

class ServiceIamMember extends CustomResource

Three different resources help you manage your IAM policy for Cloud Endpoints Service. Each of these resources serves a different use case:

• gcp.endpoints.ServiceIamPolicy: Authoritative. Sets the IAM policy for the service and replaces any existing policy already attached.
• gcp.endpoints.ServiceIamBinding: Authoritative for a given role. Updates the IAM policy to grant a role to a list of members. Other roles within the IAM policy for the service are preserved.
• gcp.endpoints.ServiceIamMember: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the service are preserved.

Note: gcp.endpoints.ServiceIamPolicy cannot be used in conjunction with gcp.endpoints.ServiceIamBinding and gcp.endpoints.ServiceIamMember or they will fight over what your policy should be.

Note: gcp.endpoints.ServiceIamBinding resources can be used in conjunction with gcp.endpoints.ServiceIamMember resources only if they do not grant privilege to the same role.

google_endpoints_service_iam_policy

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

const admin = gcp.organizations.getIAMPolicy({
    binding: [{
        role: "roles/viewer",
        members: ["user:jane@example.com"],
    }],
});
const policy = new gcp.endpoints.ServiceIamPolicy("policy", {
    serviceName: google_endpoints_service.endpoints_service.service_name,
    policyData: admin.then(admin => admin.policyData),
});

google_endpoints_service_iam_binding

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

const binding = new gcp.endpoints.ServiceIamBinding("binding", {
    serviceName: google_endpoints_service.endpoints_service.service_name,
    role: "roles/viewer",
    members: ["user:jane@example.com"],
});

google_endpoints_service_iam_member

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

const member = new gcp.endpoints.ServiceIamMember("member", {
    serviceName: google_endpoints_service.endpoints_service.service_name,
    role: "roles/viewer",
    member: "user:jane@example.com",
});

constructor

new ServiceIamMember(name: string, args: ServiceIamMemberArgs, opts?: pulumi.CustomResourceOptions)

Create a ServiceIamMember resource with the given unique name, arguments, and options.

• name The unique name of the resource.
• args The arguments to use to populate this resource's properties.
• opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ServiceIamMemberState, opts?: pulumi.CustomResourceOptions): ServiceIamMember

Get an existing ServiceIamMember resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ServiceIamMember

Returns true if the given object is an instance of ServiceIamMember. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property condition

public condition: pulumi.Output<ServiceIamMemberCondition | undefined>;

property etag

public etag: pulumi.Output<string>;

(Computed) The etag of the IAM policy.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property member

public member: pulumi.Output<string>;

property role

public role: pulumi.Output<string>;

The role that should be applied. Only one gcp.endpoints.ServiceIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

property serviceName

public serviceName: pulumi.Output<string>;

The name of the service. Used to find the parent resource to bind the IAM policy to

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource ServiceIamPolicy

class ServiceIamPolicy extends CustomResource

Three different resources help you manage your IAM policy for Cloud Endpoints Service. Each of these resources serves a different use case:

• gcp.endpoints.ServiceIamPolicy: Authoritative. Sets the IAM policy for the service and replaces any existing policy already attached.
• gcp.endpoints.ServiceIamBinding: Authoritative for a given role. Updates the IAM policy to grant a role to a list of members. Other roles within the IAM policy for the service are preserved.
• gcp.endpoints.ServiceIamMember: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the service are preserved.

Note: gcp.endpoints.ServiceIamPolicy cannot be used in conjunction with gcp.endpoints.ServiceIamBinding and gcp.endpoints.ServiceIamMember or they will fight over what your policy should be.

Note: gcp.endpoints.ServiceIamBinding resources can be used in conjunction with gcp.endpoints.ServiceIamMember resources only if they do not grant privilege to the same role.

google_endpoints_service_iam_policy

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

const admin = gcp.organizations.getIAMPolicy({
    binding: [{
        role: "roles/viewer",
        members: ["user:jane@example.com"],
    }],
});
const policy = new gcp.endpoints.ServiceIamPolicy("policy", {
    serviceName: google_endpoints_service.endpoints_service.service_name,
    policyData: admin.then(admin => admin.policyData),
});

google_endpoints_service_iam_binding

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

const binding = new gcp.endpoints.ServiceIamBinding("binding", {
    serviceName: google_endpoints_service.endpoints_service.service_name,
    role: "roles/viewer",
    members: ["user:jane@example.com"],
});

google_endpoints_service_iam_member

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

const member = new gcp.endpoints.ServiceIamMember("member", {
    serviceName: google_endpoints_service.endpoints_service.service_name,
    role: "roles/viewer",
    member: "user:jane@example.com",
});

constructor

new ServiceIamPolicy(name: string, args: ServiceIamPolicyArgs, opts?: pulumi.CustomResourceOptions)

Create a ServiceIamPolicy resource with the given unique name, arguments, and options.

• name The unique name of the resource.
• args The arguments to use to populate this resource's properties.
• opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ServiceIamPolicyState, opts?: pulumi.CustomResourceOptions): ServiceIamPolicy

Get an existing ServiceIamPolicy resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ServiceIamPolicy

Returns true if the given object is an instance of ServiceIamPolicy. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property etag

public etag: pulumi.Output<string>;

(Computed) The etag of the IAM policy.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property policyData

public policyData: pulumi.Output<string>;

The policy data generated by a gcp.organizations.getIAMPolicy data source.

property serviceName

public serviceName: pulumi.Output<string>;

The name of the service. Used to find the parent resource to bind the IAM policy to

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Others

interface ServiceArgs

interface ServiceArgs

The set of arguments for constructing a Service resource.

property grpcConfig

grpcConfig?: pulumi.Input<string>;

property openapiConfig

openapiConfig?: pulumi.Input<string>;

property project

project?: pulumi.Input<string>;

property protocOutputBase64

protocOutputBase64?: pulumi.Input<string>;

property serviceName

serviceName: pulumi.Input<string>;

interface ServiceIamBindingArgs

interface ServiceIamBindingArgs

The set of arguments for constructing a ServiceIamBinding resource.

property condition

condition?: pulumi.Input<ServiceIamBindingCondition>;

property members

members: pulumi.Input<pulumi.Input<string>[]>;

property role

role: pulumi.Input<string>;

The role that should be applied. Only one gcp.endpoints.ServiceIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

property serviceName

serviceName: pulumi.Input<string>;

The name of the service. Used to find the parent resource to bind the IAM policy to

interface ServiceIamBindingState

interface ServiceIamBindingState

Input properties used for looking up and filtering ServiceIamBinding resources.

property condition

condition?: pulumi.Input<ServiceIamBindingCondition>;

property etag

etag?: pulumi.Input<string>;

(Computed) The etag of the IAM policy.

property members

members?: pulumi.Input<pulumi.Input<string>[]>;

property role

role?: pulumi.Input<string>;

The role that should be applied. Only one gcp.endpoints.ServiceIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

property serviceName

serviceName?: pulumi.Input<string>;

The name of the service. Used to find the parent resource to bind the IAM policy to

interface ServiceIamMemberArgs

interface ServiceIamMemberArgs

The set of arguments for constructing a ServiceIamMember resource.

property condition

condition?: pulumi.Input<ServiceIamMemberCondition>;

property member

member: pulumi.Input<string>;

property role

role: pulumi.Input<string>;

The role that should be applied. Only one gcp.endpoints.ServiceIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

property serviceName

serviceName: pulumi.Input<string>;

The name of the service. Used to find the parent resource to bind the IAM policy to

interface ServiceIamMemberState

interface ServiceIamMemberState

Input properties used for looking up and filtering ServiceIamMember resources.

property condition

condition?: pulumi.Input<ServiceIamMemberCondition>;

property etag

etag?: pulumi.Input<string>;

(Computed) The etag of the IAM policy.

property member

member?: pulumi.Input<string>;

property role

role?: pulumi.Input<string>;

The role that should be applied. Only one gcp.endpoints.ServiceIamBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

property serviceName

serviceName?: pulumi.Input<string>;

The name of the service. Used to find the parent resource to bind the IAM policy to

interface ServiceIamPolicyArgs

interface ServiceIamPolicyArgs

The set of arguments for constructing a ServiceIamPolicy resource.

property policyData

policyData: pulumi.Input<string>;

The policy data generated by a gcp.organizations.getIAMPolicy data source.

property serviceName

serviceName: pulumi.Input<string>;

The name of the service. Used to find the parent resource to bind the IAM policy to

interface ServiceIamPolicyState

interface ServiceIamPolicyState

Input properties used for looking up and filtering ServiceIamPolicy resources.

property etag

etag?: pulumi.Input<string>;

(Computed) The etag of the IAM policy.

property policyData

policyData?: pulumi.Input<string>;

The policy data generated by a gcp.organizations.getIAMPolicy data source.

property serviceName

serviceName?: pulumi.Input<string>;

The name of the service. Used to find the parent resource to bind the IAM policy to

interface ServiceState

interface ServiceState

Input properties used for looking up and filtering Service resources.

property apis

apis?: pulumi.Input<pulumi.Input<ServiceApi>[]>;

property configId

configId?: pulumi.Input<string>;

property dnsAddress

dnsAddress?: pulumi.Input<string>;

property endpoints

endpoints?: pulumi.Input<pulumi.Input<ServiceEndpoint>[]>;

property grpcConfig

grpcConfig?: pulumi.Input<string>;

property openapiConfig

openapiConfig?: pulumi.Input<string>;

property project

project?: pulumi.Input<string>;

property protocOutputBase64

protocOutputBase64?: pulumi.Input<string>;

property serviceName

serviceName?: pulumi.Input<string>;