google-native.servicedirectory/v1.Endpoint
Explore with Pulumi AI
Creates an endpoint, and returns the new endpoint.
Create Endpoint Resource
new Endpoint(name: string, args: EndpointArgs, opts?: CustomResourceOptions);
@overload
def Endpoint(resource_name: str,
opts: Optional[ResourceOptions] = None,
address: Optional[str] = None,
annotations: Optional[Mapping[str, str]] = None,
endpoint_id: Optional[str] = None,
location: Optional[str] = None,
name: Optional[str] = None,
namespace_id: Optional[str] = None,
network: Optional[str] = None,
port: Optional[int] = None,
project: Optional[str] = None,
service_id: Optional[str] = None)
@overload
def Endpoint(resource_name: str,
args: EndpointArgs,
opts: Optional[ResourceOptions] = 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: google-native:servicedirectory/v1:Endpoint
properties: # The arguments to resource properties.
options: # 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.
- 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.
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:
- Endpoint
Id string Required. The Resource ID must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression
[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.- Namespace
Id string - Service
Id string - Address string
Optional. An IPv4 or IPv6 address. Service Directory rejects bad addresses like: *
8.8.8
*8.8.8.8:53
*test:bad:address
*[::1]
*[::1]:8080
Limited to 45 characters.- Annotations Dictionary<string, string>
Optional. Annotations for the endpoint. This data can be consumed by service clients. Restrictions: * The entire annotations dictionary may contain up to 512 characters, spread accoss all key-value pairs. Annotations that go beyond this limit are rejected * Valid annotation keys have two segments: an optional prefix and name, separated by a slash (/). The name segment is required and must be 63 characters or less, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between. The prefix is optional. If specified, the prefix must be a DNS subdomain: a series of DNS labels separated by dots (.), not longer than 253 characters in total, followed by a slash (/) Annotations that fails to meet these requirements are rejected. Note: This field is equivalent to the
metadata
field in the v1beta1 API. They have the same syntax and read/write to the same location in Service Directory.- Location string
- Name string
Immutable. The resource name for the endpoint in the format
projects/*/locations/*/namespaces/*/services/*/endpoints/*
.- Network string
Immutable. The Google Compute Engine network (VPC) of the endpoint in the format
projects//locations/global/networks/*
. The project must be specified by project number (project id is rejected). Incorrectly formatted networks are rejected, we also check to make sure that you have the servicedirectory.networks.attach permission on the project specified.- Port int
Optional. Service Directory rejects values outside of
[0, 65535]
.- Project string
- Endpoint
Id string Required. The Resource ID must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression
[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.- Namespace
Id string - Service
Id string - Address string
Optional. An IPv4 or IPv6 address. Service Directory rejects bad addresses like: *
8.8.8
*8.8.8.8:53
*test:bad:address
*[::1]
*[::1]:8080
Limited to 45 characters.- Annotations map[string]string
Optional. Annotations for the endpoint. This data can be consumed by service clients. Restrictions: * The entire annotations dictionary may contain up to 512 characters, spread accoss all key-value pairs. Annotations that go beyond this limit are rejected * Valid annotation keys have two segments: an optional prefix and name, separated by a slash (/). The name segment is required and must be 63 characters or less, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between. The prefix is optional. If specified, the prefix must be a DNS subdomain: a series of DNS labels separated by dots (.), not longer than 253 characters in total, followed by a slash (/) Annotations that fails to meet these requirements are rejected. Note: This field is equivalent to the
metadata
field in the v1beta1 API. They have the same syntax and read/write to the same location in Service Directory.- Location string
- Name string
Immutable. The resource name for the endpoint in the format
projects/*/locations/*/namespaces/*/services/*/endpoints/*
.- Network string
Immutable. The Google Compute Engine network (VPC) of the endpoint in the format
projects//locations/global/networks/*
. The project must be specified by project number (project id is rejected). Incorrectly formatted networks are rejected, we also check to make sure that you have the servicedirectory.networks.attach permission on the project specified.- Port int
Optional. Service Directory rejects values outside of
[0, 65535]
.- Project string
- endpoint
Id String Required. The Resource ID must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression
[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.- namespace
Id String - service
Id String - address String
Optional. An IPv4 or IPv6 address. Service Directory rejects bad addresses like: *
8.8.8
*8.8.8.8:53
*test:bad:address
*[::1]
*[::1]:8080
Limited to 45 characters.- annotations Map<String,String>
Optional. Annotations for the endpoint. This data can be consumed by service clients. Restrictions: * The entire annotations dictionary may contain up to 512 characters, spread accoss all key-value pairs. Annotations that go beyond this limit are rejected * Valid annotation keys have two segments: an optional prefix and name, separated by a slash (/). The name segment is required and must be 63 characters or less, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between. The prefix is optional. If specified, the prefix must be a DNS subdomain: a series of DNS labels separated by dots (.), not longer than 253 characters in total, followed by a slash (/) Annotations that fails to meet these requirements are rejected. Note: This field is equivalent to the
metadata
field in the v1beta1 API. They have the same syntax and read/write to the same location in Service Directory.- location String
- name String
Immutable. The resource name for the endpoint in the format
projects/*/locations/*/namespaces/*/services/*/endpoints/*
.- network String
Immutable. The Google Compute Engine network (VPC) of the endpoint in the format
projects//locations/global/networks/*
. The project must be specified by project number (project id is rejected). Incorrectly formatted networks are rejected, we also check to make sure that you have the servicedirectory.networks.attach permission on the project specified.- port Integer
Optional. Service Directory rejects values outside of
[0, 65535]
.- project String
- endpoint
Id string Required. The Resource ID must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression
[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.- namespace
Id string - service
Id string - address string
Optional. An IPv4 or IPv6 address. Service Directory rejects bad addresses like: *
8.8.8
*8.8.8.8:53
*test:bad:address
*[::1]
*[::1]:8080
Limited to 45 characters.- annotations {[key: string]: string}
Optional. Annotations for the endpoint. This data can be consumed by service clients. Restrictions: * The entire annotations dictionary may contain up to 512 characters, spread accoss all key-value pairs. Annotations that go beyond this limit are rejected * Valid annotation keys have two segments: an optional prefix and name, separated by a slash (/). The name segment is required and must be 63 characters or less, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between. The prefix is optional. If specified, the prefix must be a DNS subdomain: a series of DNS labels separated by dots (.), not longer than 253 characters in total, followed by a slash (/) Annotations that fails to meet these requirements are rejected. Note: This field is equivalent to the
metadata
field in the v1beta1 API. They have the same syntax and read/write to the same location in Service Directory.- location string
- name string
Immutable. The resource name for the endpoint in the format
projects/*/locations/*/namespaces/*/services/*/endpoints/*
.- network string
Immutable. The Google Compute Engine network (VPC) of the endpoint in the format
projects//locations/global/networks/*
. The project must be specified by project number (project id is rejected). Incorrectly formatted networks are rejected, we also check to make sure that you have the servicedirectory.networks.attach permission on the project specified.- port number
Optional. Service Directory rejects values outside of
[0, 65535]
.- project string
- endpoint_
id str Required. The Resource ID must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression
[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.- namespace_
id str - service_
id str - address str
Optional. An IPv4 or IPv6 address. Service Directory rejects bad addresses like: *
8.8.8
*8.8.8.8:53
*test:bad:address
*[::1]
*[::1]:8080
Limited to 45 characters.- annotations Mapping[str, str]
Optional. Annotations for the endpoint. This data can be consumed by service clients. Restrictions: * The entire annotations dictionary may contain up to 512 characters, spread accoss all key-value pairs. Annotations that go beyond this limit are rejected * Valid annotation keys have two segments: an optional prefix and name, separated by a slash (/). The name segment is required and must be 63 characters or less, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between. The prefix is optional. If specified, the prefix must be a DNS subdomain: a series of DNS labels separated by dots (.), not longer than 253 characters in total, followed by a slash (/) Annotations that fails to meet these requirements are rejected. Note: This field is equivalent to the
metadata
field in the v1beta1 API. They have the same syntax and read/write to the same location in Service Directory.- location str
- name str
Immutable. The resource name for the endpoint in the format
projects/*/locations/*/namespaces/*/services/*/endpoints/*
.- network str
Immutable. The Google Compute Engine network (VPC) of the endpoint in the format
projects//locations/global/networks/*
. The project must be specified by project number (project id is rejected). Incorrectly formatted networks are rejected, we also check to make sure that you have the servicedirectory.networks.attach permission on the project specified.- port int
Optional. Service Directory rejects values outside of
[0, 65535]
.- project str
- endpoint
Id String Required. The Resource ID must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression
[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?
which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.- namespace
Id String - service
Id String - address String
Optional. An IPv4 or IPv6 address. Service Directory rejects bad addresses like: *
8.8.8
*8.8.8.8:53
*test:bad:address
*[::1]
*[::1]:8080
Limited to 45 characters.- annotations Map<String>
Optional. Annotations for the endpoint. This data can be consumed by service clients. Restrictions: * The entire annotations dictionary may contain up to 512 characters, spread accoss all key-value pairs. Annotations that go beyond this limit are rejected * Valid annotation keys have two segments: an optional prefix and name, separated by a slash (/). The name segment is required and must be 63 characters or less, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between. The prefix is optional. If specified, the prefix must be a DNS subdomain: a series of DNS labels separated by dots (.), not longer than 253 characters in total, followed by a slash (/) Annotations that fails to meet these requirements are rejected. Note: This field is equivalent to the
metadata
field in the v1beta1 API. They have the same syntax and read/write to the same location in Service Directory.- location String
- name String
Immutable. The resource name for the endpoint in the format
projects/*/locations/*/namespaces/*/services/*/endpoints/*
.- network String
Immutable. The Google Compute Engine network (VPC) of the endpoint in the format
projects//locations/global/networks/*
. The project must be specified by project number (project id is rejected). Incorrectly formatted networks are rejected, we also check to make sure that you have the servicedirectory.networks.attach permission on the project specified.- port Number
Optional. Service Directory rejects values outside of
[0, 65535]
.- project String
Outputs
All input properties are implicitly available as output properties. Additionally, the Endpoint resource produces the following output properties:
Package Details
- Repository
- Google Cloud Native pulumi/pulumi-google-native
- License
- Apache-2.0