1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. servicedirectory
  5. Endpoint
Google Cloud Classic v7.18.0 published on Wednesday, Apr 10, 2024 by Pulumi

gcp.servicedirectory.Endpoint

Explore with Pulumi AI

gcp logo
Google Cloud Classic v7.18.0 published on Wednesday, Apr 10, 2024 by Pulumi

    An individual endpoint that provides a service.

    To get more information about Endpoint, see:

    Example Usage

    Service Directory Endpoint Basic

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const example = new gcp.servicedirectory.Namespace("example", {
        namespaceId: "example-namespace",
        location: "us-central1",
    });
    const exampleService = new gcp.servicedirectory.Service("example", {
        serviceId: "example-service",
        namespace: example.id,
    });
    const exampleEndpoint = new gcp.servicedirectory.Endpoint("example", {
        endpointId: "example-endpoint",
        service: exampleService.id,
        metadata: {
            stage: "prod",
            region: "us-central1",
        },
        address: "1.2.3.4",
        port: 5353,
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    example = gcp.servicedirectory.Namespace("example",
        namespace_id="example-namespace",
        location="us-central1")
    example_service = gcp.servicedirectory.Service("example",
        service_id="example-service",
        namespace=example.id)
    example_endpoint = gcp.servicedirectory.Endpoint("example",
        endpoint_id="example-endpoint",
        service=example_service.id,
        metadata={
            "stage": "prod",
            "region": "us-central1",
        },
        address="1.2.3.4",
        port=5353)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/servicedirectory"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := servicedirectory.NewNamespace(ctx, "example", &servicedirectory.NamespaceArgs{
    			NamespaceId: pulumi.String("example-namespace"),
    			Location:    pulumi.String("us-central1"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleService, err := servicedirectory.NewService(ctx, "example", &servicedirectory.ServiceArgs{
    			ServiceId: pulumi.String("example-service"),
    			Namespace: example.ID(),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = servicedirectory.NewEndpoint(ctx, "example", &servicedirectory.EndpointArgs{
    			EndpointId: pulumi.String("example-endpoint"),
    			Service:    exampleService.ID(),
    			Metadata: pulumi.StringMap{
    				"stage":  pulumi.String("prod"),
    				"region": pulumi.String("us-central1"),
    			},
    			Address: pulumi.String("1.2.3.4"),
    			Port:    pulumi.Int(5353),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Gcp = Pulumi.Gcp;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Gcp.ServiceDirectory.Namespace("example", new()
        {
            NamespaceId = "example-namespace",
            Location = "us-central1",
        });
    
        var exampleService = new Gcp.ServiceDirectory.Service("example", new()
        {
            ServiceId = "example-service",
            Namespace = example.Id,
        });
    
        var exampleEndpoint = new Gcp.ServiceDirectory.Endpoint("example", new()
        {
            EndpointId = "example-endpoint",
            Service = exampleService.Id,
            Metadata = 
            {
                { "stage", "prod" },
                { "region", "us-central1" },
            },
            Address = "1.2.3.4",
            Port = 5353,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcp.servicedirectory.Namespace;
    import com.pulumi.gcp.servicedirectory.NamespaceArgs;
    import com.pulumi.gcp.servicedirectory.Service;
    import com.pulumi.gcp.servicedirectory.ServiceArgs;
    import com.pulumi.gcp.servicedirectory.Endpoint;
    import com.pulumi.gcp.servicedirectory.EndpointArgs;
    import java.util.List;
    import java.util.ArrayList;
    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 example = new Namespace("example", NamespaceArgs.builder()        
                .namespaceId("example-namespace")
                .location("us-central1")
                .build());
    
            var exampleService = new Service("exampleService", ServiceArgs.builder()        
                .serviceId("example-service")
                .namespace(example.id())
                .build());
    
            var exampleEndpoint = new Endpoint("exampleEndpoint", EndpointArgs.builder()        
                .endpointId("example-endpoint")
                .service(exampleService.id())
                .metadata(Map.ofEntries(
                    Map.entry("stage", "prod"),
                    Map.entry("region", "us-central1")
                ))
                .address("1.2.3.4")
                .port(5353)
                .build());
    
        }
    }
    
    resources:
      example:
        type: gcp:servicedirectory:Namespace
        properties:
          namespaceId: example-namespace
          location: us-central1
      exampleService:
        type: gcp:servicedirectory:Service
        name: example
        properties:
          serviceId: example-service
          namespace: ${example.id}
      exampleEndpoint:
        type: gcp:servicedirectory:Endpoint
        name: example
        properties:
          endpointId: example-endpoint
          service: ${exampleService.id}
          metadata:
            stage: prod
            region: us-central1
          address: 1.2.3.4
          port: 5353
    

    Service Directory Endpoint With Network

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const project = gcp.organizations.getProject({});
    const example = new gcp.compute.Network("example", {name: "example-network"});
    const exampleNamespace = new gcp.servicedirectory.Namespace("example", {
        namespaceId: "example-namespace",
        location: "us-central1",
    });
    const exampleService = new gcp.servicedirectory.Service("example", {
        serviceId: "example-service",
        namespace: exampleNamespace.id,
    });
    const exampleEndpoint = new gcp.servicedirectory.Endpoint("example", {
        endpointId: "example-endpoint",
        service: exampleService.id,
        metadata: {
            stage: "prod",
            region: "us-central1",
        },
        network: pulumi.all([project, example.name]).apply(([project, name]) => `projects/${project.number}/locations/global/networks/${name}`),
        address: "1.2.3.4",
        port: 5353,
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    project = gcp.organizations.get_project()
    example = gcp.compute.Network("example", name="example-network")
    example_namespace = gcp.servicedirectory.Namespace("example",
        namespace_id="example-namespace",
        location="us-central1")
    example_service = gcp.servicedirectory.Service("example",
        service_id="example-service",
        namespace=example_namespace.id)
    example_endpoint = gcp.servicedirectory.Endpoint("example",
        endpoint_id="example-endpoint",
        service=example_service.id,
        metadata={
            "stage": "prod",
            "region": "us-central1",
        },
        network=example.name.apply(lambda name: f"projects/{project.number}/locations/global/networks/{name}"),
        address="1.2.3.4",
        port=5353)
    
    package main
    
    import (
    	"fmt"
    
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/compute"
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/organizations"
    	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/servicedirectory"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		project, err := organizations.LookupProject(ctx, nil, nil)
    		if err != nil {
    			return err
    		}
    		example, err := compute.NewNetwork(ctx, "example", &compute.NetworkArgs{
    			Name: pulumi.String("example-network"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleNamespace, err := servicedirectory.NewNamespace(ctx, "example", &servicedirectory.NamespaceArgs{
    			NamespaceId: pulumi.String("example-namespace"),
    			Location:    pulumi.String("us-central1"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleService, err := servicedirectory.NewService(ctx, "example", &servicedirectory.ServiceArgs{
    			ServiceId: pulumi.String("example-service"),
    			Namespace: exampleNamespace.ID(),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = servicedirectory.NewEndpoint(ctx, "example", &servicedirectory.EndpointArgs{
    			EndpointId: pulumi.String("example-endpoint"),
    			Service:    exampleService.ID(),
    			Metadata: pulumi.StringMap{
    				"stage":  pulumi.String("prod"),
    				"region": pulumi.String("us-central1"),
    			},
    			Network: example.Name.ApplyT(func(name string) (string, error) {
    				return fmt.Sprintf("projects/%v/locations/global/networks/%v", project.Number, name), nil
    			}).(pulumi.StringOutput),
    			Address: pulumi.String("1.2.3.4"),
    			Port:    pulumi.Int(5353),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Gcp = Pulumi.Gcp;
    
    return await Deployment.RunAsync(() => 
    {
        var project = Gcp.Organizations.GetProject.Invoke();
    
        var example = new Gcp.Compute.Network("example", new()
        {
            Name = "example-network",
        });
    
        var exampleNamespace = new Gcp.ServiceDirectory.Namespace("example", new()
        {
            NamespaceId = "example-namespace",
            Location = "us-central1",
        });
    
        var exampleService = new Gcp.ServiceDirectory.Service("example", new()
        {
            ServiceId = "example-service",
            Namespace = exampleNamespace.Id,
        });
    
        var exampleEndpoint = new Gcp.ServiceDirectory.Endpoint("example", new()
        {
            EndpointId = "example-endpoint",
            Service = exampleService.Id,
            Metadata = 
            {
                { "stage", "prod" },
                { "region", "us-central1" },
            },
            Network = Output.Tuple(project, example.Name).Apply(values =>
            {
                var project = values.Item1;
                var name = values.Item2;
                return $"projects/{project.Apply(getProjectResult => getProjectResult.Number)}/locations/global/networks/{name}";
            }),
            Address = "1.2.3.4",
            Port = 5353,
        });
    
    });
    
    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.compute.Network;
    import com.pulumi.gcp.compute.NetworkArgs;
    import com.pulumi.gcp.servicedirectory.Namespace;
    import com.pulumi.gcp.servicedirectory.NamespaceArgs;
    import com.pulumi.gcp.servicedirectory.Service;
    import com.pulumi.gcp.servicedirectory.ServiceArgs;
    import com.pulumi.gcp.servicedirectory.Endpoint;
    import com.pulumi.gcp.servicedirectory.EndpointArgs;
    import java.util.List;
    import java.util.ArrayList;
    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();
    
            var example = new Network("example", NetworkArgs.builder()        
                .name("example-network")
                .build());
    
            var exampleNamespace = new Namespace("exampleNamespace", NamespaceArgs.builder()        
                .namespaceId("example-namespace")
                .location("us-central1")
                .build());
    
            var exampleService = new Service("exampleService", ServiceArgs.builder()        
                .serviceId("example-service")
                .namespace(exampleNamespace.id())
                .build());
    
            var exampleEndpoint = new Endpoint("exampleEndpoint", EndpointArgs.builder()        
                .endpointId("example-endpoint")
                .service(exampleService.id())
                .metadata(Map.ofEntries(
                    Map.entry("stage", "prod"),
                    Map.entry("region", "us-central1")
                ))
                .network(example.name().applyValue(name -> String.format("projects/%s/locations/global/networks/%s", project.applyValue(getProjectResult -> getProjectResult.number()),name)))
                .address("1.2.3.4")
                .port(5353)
                .build());
    
        }
    }
    
    resources:
      example:
        type: gcp:compute:Network
        properties:
          name: example-network
      exampleNamespace:
        type: gcp:servicedirectory:Namespace
        name: example
        properties:
          namespaceId: example-namespace
          location: us-central1
      exampleService:
        type: gcp:servicedirectory:Service
        name: example
        properties:
          serviceId: example-service
          namespace: ${exampleNamespace.id}
      exampleEndpoint:
        type: gcp:servicedirectory:Endpoint
        name: example
        properties:
          endpointId: example-endpoint
          service: ${exampleService.id}
          metadata:
            stage: prod
            region: us-central1
          network: projects/${project.number}/locations/global/networks/${example.name}
          address: 1.2.3.4
          port: 5353
    variables:
      project:
        fn::invoke:
          Function: gcp:organizations:getProject
          Arguments: {}
    

    Create Endpoint Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Endpoint(name: string, args: EndpointArgs, opts?: CustomResourceOptions);
    @overload
    def Endpoint(resource_name: str,
                 args: EndpointArgs,
                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def Endpoint(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 endpoint_id: Optional[str] = None,
                 service: Optional[str] = None,
                 address: Optional[str] = None,
                 metadata: Optional[Mapping[str, str]] = None,
                 network: Optional[str] = None,
                 port: Optional[int] = None)
    func NewEndpoint(ctx *Context, name string, args EndpointArgs, opts ...ResourceOption) (*Endpoint, error)
    public Endpoint(string name, EndpointArgs args, CustomResourceOptions? opts = null)
    public Endpoint(String name, EndpointArgs args)
    public Endpoint(String name, EndpointArgs args, CustomResourceOptions options)
    
    type: gcp:servicedirectory:Endpoint
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args EndpointArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args EndpointArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args EndpointArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EndpointArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EndpointArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var gcpEndpointResource = new Gcp.ServiceDirectory.Endpoint("gcpEndpointResource", new()
    {
        EndpointId = "string",
        Service = "string",
        Address = "string",
        Metadata = 
        {
            { "string", "string" },
        },
        Network = "string",
        Port = 0,
    });
    
    example, err := servicedirectory.NewEndpoint(ctx, "gcpEndpointResource", &servicedirectory.EndpointArgs{
    	EndpointId: pulumi.String("string"),
    	Service:    pulumi.String("string"),
    	Address:    pulumi.String("string"),
    	Metadata: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Network: pulumi.String("string"),
    	Port:    pulumi.Int(0),
    })
    
    var gcpEndpointResource = new Endpoint("gcpEndpointResource", EndpointArgs.builder()        
        .endpointId("string")
        .service("string")
        .address("string")
        .metadata(Map.of("string", "string"))
        .network("string")
        .port(0)
        .build());
    
    gcp_endpoint_resource = gcp.servicedirectory.Endpoint("gcpEndpointResource",
        endpoint_id="string",
        service="string",
        address="string",
        metadata={
            "string": "string",
        },
        network="string",
        port=0)
    
    const gcpEndpointResource = new gcp.servicedirectory.Endpoint("gcpEndpointResource", {
        endpointId: "string",
        service: "string",
        address: "string",
        metadata: {
            string: "string",
        },
        network: "string",
        port: 0,
    });
    
    type: gcp:servicedirectory:Endpoint
    properties:
        address: string
        endpointId: string
        metadata:
            string: string
        network: string
        port: 0
        service: string
    

    Endpoint Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Endpoint resource accepts the following input properties:

    EndpointId string
    The Resource ID must be 1-63 characters long, including digits, lowercase letters or the hyphen character.


    Service string
    The resource name of the service that this endpoint provides.
    Address string
    IPv4 or IPv6 address of the endpoint.
    Metadata Dictionary<string, string>
    Metadata for the endpoint. This data can be consumed by service clients. The entire metadata dictionary may contain up to 512 characters, spread across all key-value pairs. Metadata that goes beyond any these limits will be rejected.
    Network string
    The URL to the network, such as projects/PROJECT_NUMBER/locations/global/networks/NETWORK_NAME.
    Port int
    Port that the endpoint is running on, must be in the range of [0, 65535]. If unspecified, the default is 0.
    EndpointId string
    The Resource ID must be 1-63 characters long, including digits, lowercase letters or the hyphen character.


    Service string
    The resource name of the service that this endpoint provides.
    Address string
    IPv4 or IPv6 address of the endpoint.
    Metadata map[string]string
    Metadata for the endpoint. This data can be consumed by service clients. The entire metadata dictionary may contain up to 512 characters, spread across all key-value pairs. Metadata that goes beyond any these limits will be rejected.
    Network string
    The URL to the network, such as projects/PROJECT_NUMBER/locations/global/networks/NETWORK_NAME.
    Port int
    Port that the endpoint is running on, must be in the range of [0, 65535]. If unspecified, the default is 0.
    endpointId String
    The Resource ID must be 1-63 characters long, including digits, lowercase letters or the hyphen character.


    service String
    The resource name of the service that this endpoint provides.
    address String
    IPv4 or IPv6 address of the endpoint.
    metadata Map<String,String>
    Metadata for the endpoint. This data can be consumed by service clients. The entire metadata dictionary may contain up to 512 characters, spread across all key-value pairs. Metadata that goes beyond any these limits will be rejected.
    network String
    The URL to the network, such as projects/PROJECT_NUMBER/locations/global/networks/NETWORK_NAME.
    port Integer
    Port that the endpoint is running on, must be in the range of [0, 65535]. If unspecified, the default is 0.
    endpointId string
    The Resource ID must be 1-63 characters long, including digits, lowercase letters or the hyphen character.


    service string
    The resource name of the service that this endpoint provides.
    address string
    IPv4 or IPv6 address of the endpoint.
    metadata {[key: string]: string}
    Metadata for the endpoint. This data can be consumed by service clients. The entire metadata dictionary may contain up to 512 characters, spread across all key-value pairs. Metadata that goes beyond any these limits will be rejected.
    network string
    The URL to the network, such as projects/PROJECT_NUMBER/locations/global/networks/NETWORK_NAME.
    port number
    Port that the endpoint is running on, must be in the range of [0, 65535]. If unspecified, the default is 0.
    endpoint_id str
    The Resource ID must be 1-63 characters long, including digits, lowercase letters or the hyphen character.


    service str
    The resource name of the service that this endpoint provides.
    address str
    IPv4 or IPv6 address of the endpoint.
    metadata Mapping[str, str]
    Metadata for the endpoint. This data can be consumed by service clients. The entire metadata dictionary may contain up to 512 characters, spread across all key-value pairs. Metadata that goes beyond any these limits will be rejected.
    network str
    The URL to the network, such as projects/PROJECT_NUMBER/locations/global/networks/NETWORK_NAME.
    port int
    Port that the endpoint is running on, must be in the range of [0, 65535]. If unspecified, the default is 0.
    endpointId String
    The Resource ID must be 1-63 characters long, including digits, lowercase letters or the hyphen character.


    service String
    The resource name of the service that this endpoint provides.
    address String
    IPv4 or IPv6 address of the endpoint.
    metadata Map<String>
    Metadata for the endpoint. This data can be consumed by service clients. The entire metadata dictionary may contain up to 512 characters, spread across all key-value pairs. Metadata that goes beyond any these limits will be rejected.
    network String
    The URL to the network, such as projects/PROJECT_NUMBER/locations/global/networks/NETWORK_NAME.
    port Number
    Port that the endpoint is running on, must be in the range of [0, 65535]. If unspecified, the default is 0.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Endpoint resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The resource name for the endpoint in the format projects/*/locations/*/namespaces/*/services/*/endpoints/*.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The resource name for the endpoint in the format projects/*/locations/*/namespaces/*/services/*/endpoints/*.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The resource name for the endpoint in the format projects/*/locations/*/namespaces/*/services/*/endpoints/*.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The resource name for the endpoint in the format projects/*/locations/*/namespaces/*/services/*/endpoints/*.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The resource name for the endpoint in the format projects/*/locations/*/namespaces/*/services/*/endpoints/*.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The resource name for the endpoint in the format projects/*/locations/*/namespaces/*/services/*/endpoints/*.

    Look up Existing Endpoint Resource

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

    public static get(name: string, id: Input<ID>, state?: EndpointState, opts?: CustomResourceOptions): Endpoint
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            address: Optional[str] = None,
            endpoint_id: Optional[str] = None,
            metadata: Optional[Mapping[str, str]] = None,
            name: Optional[str] = None,
            network: Optional[str] = None,
            port: Optional[int] = None,
            service: Optional[str] = None) -> Endpoint
    func GetEndpoint(ctx *Context, name string, id IDInput, state *EndpointState, opts ...ResourceOption) (*Endpoint, error)
    public static Endpoint Get(string name, Input<string> id, EndpointState? state, CustomResourceOptions? opts = null)
    public static Endpoint get(String name, Output<String> id, EndpointState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Address string
    IPv4 or IPv6 address of the endpoint.
    EndpointId string
    The Resource ID must be 1-63 characters long, including digits, lowercase letters or the hyphen character.


    Metadata Dictionary<string, string>
    Metadata for the endpoint. This data can be consumed by service clients. The entire metadata dictionary may contain up to 512 characters, spread across all key-value pairs. Metadata that goes beyond any these limits will be rejected.
    Name string
    The resource name for the endpoint in the format projects/*/locations/*/namespaces/*/services/*/endpoints/*.
    Network string
    The URL to the network, such as projects/PROJECT_NUMBER/locations/global/networks/NETWORK_NAME.
    Port int
    Port that the endpoint is running on, must be in the range of [0, 65535]. If unspecified, the default is 0.
    Service string
    The resource name of the service that this endpoint provides.
    Address string
    IPv4 or IPv6 address of the endpoint.
    EndpointId string
    The Resource ID must be 1-63 characters long, including digits, lowercase letters or the hyphen character.


    Metadata map[string]string
    Metadata for the endpoint. This data can be consumed by service clients. The entire metadata dictionary may contain up to 512 characters, spread across all key-value pairs. Metadata that goes beyond any these limits will be rejected.
    Name string
    The resource name for the endpoint in the format projects/*/locations/*/namespaces/*/services/*/endpoints/*.
    Network string
    The URL to the network, such as projects/PROJECT_NUMBER/locations/global/networks/NETWORK_NAME.
    Port int
    Port that the endpoint is running on, must be in the range of [0, 65535]. If unspecified, the default is 0.
    Service string
    The resource name of the service that this endpoint provides.
    address String
    IPv4 or IPv6 address of the endpoint.
    endpointId String
    The Resource ID must be 1-63 characters long, including digits, lowercase letters or the hyphen character.


    metadata Map<String,String>
    Metadata for the endpoint. This data can be consumed by service clients. The entire metadata dictionary may contain up to 512 characters, spread across all key-value pairs. Metadata that goes beyond any these limits will be rejected.
    name String
    The resource name for the endpoint in the format projects/*/locations/*/namespaces/*/services/*/endpoints/*.
    network String
    The URL to the network, such as projects/PROJECT_NUMBER/locations/global/networks/NETWORK_NAME.
    port Integer
    Port that the endpoint is running on, must be in the range of [0, 65535]. If unspecified, the default is 0.
    service String
    The resource name of the service that this endpoint provides.
    address string
    IPv4 or IPv6 address of the endpoint.
    endpointId string
    The Resource ID must be 1-63 characters long, including digits, lowercase letters or the hyphen character.


    metadata {[key: string]: string}
    Metadata for the endpoint. This data can be consumed by service clients. The entire metadata dictionary may contain up to 512 characters, spread across all key-value pairs. Metadata that goes beyond any these limits will be rejected.
    name string
    The resource name for the endpoint in the format projects/*/locations/*/namespaces/*/services/*/endpoints/*.
    network string
    The URL to the network, such as projects/PROJECT_NUMBER/locations/global/networks/NETWORK_NAME.
    port number
    Port that the endpoint is running on, must be in the range of [0, 65535]. If unspecified, the default is 0.
    service string
    The resource name of the service that this endpoint provides.
    address str
    IPv4 or IPv6 address of the endpoint.
    endpoint_id str
    The Resource ID must be 1-63 characters long, including digits, lowercase letters or the hyphen character.


    metadata Mapping[str, str]
    Metadata for the endpoint. This data can be consumed by service clients. The entire metadata dictionary may contain up to 512 characters, spread across all key-value pairs. Metadata that goes beyond any these limits will be rejected.
    name str
    The resource name for the endpoint in the format projects/*/locations/*/namespaces/*/services/*/endpoints/*.
    network str
    The URL to the network, such as projects/PROJECT_NUMBER/locations/global/networks/NETWORK_NAME.
    port int
    Port that the endpoint is running on, must be in the range of [0, 65535]. If unspecified, the default is 0.
    service str
    The resource name of the service that this endpoint provides.
    address String
    IPv4 or IPv6 address of the endpoint.
    endpointId String
    The Resource ID must be 1-63 characters long, including digits, lowercase letters or the hyphen character.


    metadata Map<String>
    Metadata for the endpoint. This data can be consumed by service clients. The entire metadata dictionary may contain up to 512 characters, spread across all key-value pairs. Metadata that goes beyond any these limits will be rejected.
    name String
    The resource name for the endpoint in the format projects/*/locations/*/namespaces/*/services/*/endpoints/*.
    network String
    The URL to the network, such as projects/PROJECT_NUMBER/locations/global/networks/NETWORK_NAME.
    port Number
    Port that the endpoint is running on, must be in the range of [0, 65535]. If unspecified, the default is 0.
    service String
    The resource name of the service that this endpoint provides.

    Import

    Endpoint can be imported using any of these accepted formats:

    • projects/{{project}}/locations/{{location}}/namespaces/{{namespace_id}}/services/{{service_id}}/endpoints/{{endpoint_id}}

    • {{project}}/{{location}}/{{namespace_id}}/{{service_id}}/{{endpoint_id}}

    • {{location}}/{{namespace_id}}/{{service_id}}/{{endpoint_id}}

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

    $ pulumi import gcp:servicedirectory/endpoint:Endpoint default projects/{{project}}/locations/{{location}}/namespaces/{{namespace_id}}/services/{{service_id}}/endpoints/{{endpoint_id}}
    
    $ pulumi import gcp:servicedirectory/endpoint:Endpoint default {{project}}/{{location}}/{{namespace_id}}/{{service_id}}/{{endpoint_id}}
    
    $ pulumi import gcp:servicedirectory/endpoint:Endpoint default {{location}}/{{namespace_id}}/{{service_id}}/{{endpoint_id}}
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the google-beta Terraform Provider.
    gcp logo
    Google Cloud Classic v7.18.0 published on Wednesday, Apr 10, 2024 by Pulumi