Google Cloud Native v0.32.0, Nov 29 23

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

google-native.servicedirectory/v1beta1.Endpoint

Explore with Pulumi AI

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

Create Endpoint Resource

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

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,
             namespace_id: Optional[str] = None,
             service_id: Optional[str] = None,
             address: Optional[str] = None,
             location: Optional[str] = None,
             metadata: Optional[Mapping[str, str]] = None,
             name: Optional[str] = None,
             network: Optional[str] = None,
             port: Optional[int] = None,
             project: Optional[str] = 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/v1beta1: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.

Constructor example

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

TypeScript
Python
Go
C#
Java
YAML

var exampleendpointResourceResourceFromServicedirectoryv1beta1 = new GoogleNative.ServiceDirectory.V1Beta1.Endpoint("exampleendpointResourceResourceFromServicedirectoryv1beta1", new()
{
    EndpointId = "string",
    NamespaceId = "string",
    ServiceId = "string",
    Address = "string",
    Location = "string",
    Metadata = 
    {
        { "string", "string" },
    },
    Name = "string",
    Network = "string",
    Port = 0,
    Project = "string",
});

example, err := servicedirectoryv1beta1.NewEndpoint(ctx, "exampleendpointResourceResourceFromServicedirectoryv1beta1", &servicedirectoryv1beta1.EndpointArgs{
	EndpointId:  pulumi.String("string"),
	NamespaceId: pulumi.String("string"),
	ServiceId:   pulumi.String("string"),
	Address:     pulumi.String("string"),
	Location:    pulumi.String("string"),
	Metadata: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Name:    pulumi.String("string"),
	Network: pulumi.String("string"),
	Port:    pulumi.Int(0),
	Project: pulumi.String("string"),
})

var exampleendpointResourceResourceFromServicedirectoryv1beta1 = new Endpoint("exampleendpointResourceResourceFromServicedirectoryv1beta1", EndpointArgs.builder()
    .endpointId("string")
    .namespaceId("string")
    .serviceId("string")
    .address("string")
    .location("string")
    .metadata(Map.of("string", "string"))
    .name("string")
    .network("string")
    .port(0)
    .project("string")
    .build());

exampleendpoint_resource_resource_from_servicedirectoryv1beta1 = google_native.servicedirectory.v1beta1.Endpoint("exampleendpointResourceResourceFromServicedirectoryv1beta1",
    endpoint_id="string",
    namespace_id="string",
    service_id="string",
    address="string",
    location="string",
    metadata={
        "string": "string",
    },
    name="string",
    network="string",
    port=0,
    project="string")

const exampleendpointResourceResourceFromServicedirectoryv1beta1 = new google_native.servicedirectory.v1beta1.Endpoint("exampleendpointResourceResourceFromServicedirectoryv1beta1", {
    endpointId: "string",
    namespaceId: "string",
    serviceId: "string",
    address: "string",
    location: "string",
    metadata: {
        string: "string",
    },
    name: "string",
    network: "string",
    port: 0,
    project: "string",
});

type: google-native:servicedirectory/v1beta1:Endpoint
properties:
    address: string
    endpointId: string
    location: string
    metadata:
        string: string
    name: string
    namespaceId: string
    network: string
    port: 0
    project: string
    serviceId: 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

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Endpoint resource accepts the following input properties:

EndpointId 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.
NamespaceId string
ServiceId 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.
Location string
Metadata Dictionary<string, string>: Optional. Metadata for the endpoint. This data can be consumed by service clients. Restrictions: * The entire metadata dictionary may contain up to 512 characters, spread accoss all key-value pairs. Metadata that goes beyond this limit are rejected * Valid metadata 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 (/). Metadata that fails to meet these requirements are rejected Note: This field is equivalent to the annotations field in the v1 API. They have the same syntax and read/write to the same location in Service Directory.
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, but no other validation is performed on this field (ex. network or project existence, reachability, or permissions).
Port int: Optional. Service Directory rejects values outside of [0, 65535].
Project string

EndpointId 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.
NamespaceId string
ServiceId 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.
Location string
Metadata map[string]string: Optional. Metadata for the endpoint. This data can be consumed by service clients. Restrictions: * The entire metadata dictionary may contain up to 512 characters, spread accoss all key-value pairs. Metadata that goes beyond this limit are rejected * Valid metadata 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 (/). Metadata that fails to meet these requirements are rejected Note: This field is equivalent to the annotations field in the v1 API. They have the same syntax and read/write to the same location in Service Directory.
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, but no other validation is performed on this field (ex. network or project existence, reachability, or permissions).
Port int: Optional. Service Directory rejects values outside of [0, 65535].
Project string

endpointId 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.
namespaceId String
serviceId 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.
location String
metadata Map<String,String>: Optional. Metadata for the endpoint. This data can be consumed by service clients. Restrictions: * The entire metadata dictionary may contain up to 512 characters, spread accoss all key-value pairs. Metadata that goes beyond this limit are rejected * Valid metadata 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 (/). Metadata that fails to meet these requirements are rejected Note: This field is equivalent to the annotations field in the v1 API. They have the same syntax and read/write to the same location in Service Directory.
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, but no other validation is performed on this field (ex. network or project existence, reachability, or permissions).
port Integer: Optional. Service Directory rejects values outside of [0, 65535].
project String

endpointId 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.
namespaceId string
serviceId 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.
location string
metadata {[key: string]: string}: Optional. Metadata for the endpoint. This data can be consumed by service clients. Restrictions: * The entire metadata dictionary may contain up to 512 characters, spread accoss all key-value pairs. Metadata that goes beyond this limit are rejected * Valid metadata 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 (/). Metadata that fails to meet these requirements are rejected Note: This field is equivalent to the annotations field in the v1 API. They have the same syntax and read/write to the same location in Service Directory.
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, but no other validation is performed on this field (ex. network or project existence, reachability, or permissions).
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.
location str
metadata Mapping[str, str]: Optional. Metadata for the endpoint. This data can be consumed by service clients. Restrictions: * The entire metadata dictionary may contain up to 512 characters, spread accoss all key-value pairs. Metadata that goes beyond this limit are rejected * Valid metadata 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 (/). Metadata that fails to meet these requirements are rejected Note: This field is equivalent to the annotations field in the v1 API. They have the same syntax and read/write to the same location in Service Directory.
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, but no other validation is performed on this field (ex. network or project existence, reachability, or permissions).
port int: Optional. Service Directory rejects values outside of [0, 65535].
project str

endpointId 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.
namespaceId String
serviceId 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.
location String
metadata Map<String>: Optional. Metadata for the endpoint. This data can be consumed by service clients. Restrictions: * The entire metadata dictionary may contain up to 512 characters, spread accoss all key-value pairs. Metadata that goes beyond this limit are rejected * Valid metadata 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 (/). Metadata that fails to meet these requirements are rejected Note: This field is equivalent to the annotations field in the v1 API. They have the same syntax and read/write to the same location in Service Directory.
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, but no other validation is performed on this field (ex. network or project existence, reachability, or permissions).
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:

CreateTime string: The timestamp when the endpoint was created.
Id string: The provider-assigned unique ID for this managed resource.
Uid string: A globally unique identifier (in UUID4 format) for this endpoint.
UpdateTime string: The timestamp when the endpoint was last updated.

CreateTime string: The timestamp when the endpoint was created.
Id string: The provider-assigned unique ID for this managed resource.
Uid string: A globally unique identifier (in UUID4 format) for this endpoint.
UpdateTime string: The timestamp when the endpoint was last updated.

createTime String: The timestamp when the endpoint was created.
id String: The provider-assigned unique ID for this managed resource.
uid String: A globally unique identifier (in UUID4 format) for this endpoint.
updateTime String: The timestamp when the endpoint was last updated.

createTime string: The timestamp when the endpoint was created.
id string: The provider-assigned unique ID for this managed resource.
uid string: A globally unique identifier (in UUID4 format) for this endpoint.
updateTime string: The timestamp when the endpoint was last updated.

create_time str: The timestamp when the endpoint was created.
id str: The provider-assigned unique ID for this managed resource.
uid str: A globally unique identifier (in UUID4 format) for this endpoint.
update_time str: The timestamp when the endpoint was last updated.

createTime String: The timestamp when the endpoint was created.
id String: The provider-assigned unique ID for this managed resource.
uid String: A globally unique identifier (in UUID4 format) for this endpoint.
updateTime String: The timestamp when the endpoint was last updated.

Package Details

Repository: Google Cloud Native pulumi/pulumi-google-native
License: Apache-2.0

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

pulumi/pulumi-google-native

google-native.servicedirectory/v1beta1.Endpoint

On this page

On this page

Create Endpoint Resource

Constructor syntax

Parameters

Constructor example

Endpoint Resource Properties

Inputs

Outputs

Package Details

On this page

On this page