Endpoint

An individual endpoint that provides a service.

To get more information about Endpoint, see:

API documentation
How-to Guides
- Configuring an endpoint

Create a Endpoint Resource

new Endpoint(name: string, args: EndpointArgs, opts?: CustomResourceOptions);

def Endpoint(resource_name, opts=None, address=None, endpoint_id=None, metadata=None, port=None, service=None, __props__=None);

func NewEndpoint(ctx *Context, name string, args EndpointArgs, opts ...ResourceOption) (*Endpoint, error)

public Endpoint(string name, EndpointArgs args, CustomResourceOptions? opts = null)

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.
opts ResourceOptions: A bag of options that control this 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.

Endpoint Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model 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.
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.
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 {[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.
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 Dict[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.
port float: 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 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/*‘.

Look up an 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

static get(resource_name, id, opts=None, address=None, endpoint_id=None, metadata=None, name=None, port=None, service=None, __props__=None);

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)

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.

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/*‘.
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/*‘.
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 {[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/*‘.
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 Dict[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/*‘.
port float: 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.

Package Details

Repository: https://github.com/pulumi/pulumi-gcp
License: Apache-2.0
Notes: This Pulumi package is based on the google-beta Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud