com.pulumi.gcp.servicedirectory.kotlin.Endpoint.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-gcp-kotlin Show documentation
Show all versions of pulumi-gcp-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.gcp.servicedirectory.kotlin
import com.pulumi.core.Output
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.Int
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.Map
/**
* Builder for [Endpoint].
*/
@PulumiTagMarker
public class EndpointResourceBuilder internal constructor() {
public var name: String? = null
public var args: EndpointArgs = EndpointArgs()
public var opts: CustomResourceOptions = CustomResourceOptions()
/**
* @param name The _unique_ name of the resulting resource.
*/
public fun name(`value`: String) {
this.name = value
}
/**
* @param block The arguments to use to populate this resource's properties.
*/
public suspend fun args(block: suspend EndpointArgsBuilder.() -> Unit) {
val builder = EndpointArgsBuilder()
block(builder)
this.args = builder.build()
}
/**
* @param block A bag of options that control this resource's behavior.
*/
public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
}
internal fun build(): Endpoint {
val builtJavaResource = com.pulumi.gcp.servicedirectory.Endpoint(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return Endpoint(builtJavaResource)
}
}
/**
* An individual endpoint that provides a service.
* To get more information about Endpoint, see:
* * [API documentation](https://cloud.google.com/service-directory/docs/reference/rest/v1beta1/projects.locations.namespaces.services.endpoints)
* * How-to Guides
* * [Configuring an endpoint](https://cloud.google.com/service-directory/docs/configuring-service-directory#configuring_an_endpoint)
* ## Example Usage
* ### Service Directory Endpoint Basic
*
* ```typescript
* 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,
* });
* ```
* ```python
* 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)
* ```
* ```csharp
* 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,
* });
* });
* ```
* ```go
* 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
* })
* }
* ```
* ```java
* 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());
* }
* }
* ```
* ```yaml
* 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
*
* ```typescript
* 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,
* });
* ```
* ```python
* 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)
* ```
* ```csharp
* 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,
* });
* });
* ```
* ```go
* 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
* })
* }
* ```
* ```java
* 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());
* }
* }
* ```
* ```yaml
* 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: {}
* ```
*
* ## 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:
* ```sh
* $ pulumi import gcp:servicedirectory/endpoint:Endpoint default projects/{{project}}/locations/{{location}}/namespaces/{{namespace_id}}/services/{{service_id}}/endpoints/{{endpoint_id}}
* ```
* ```sh
* $ pulumi import gcp:servicedirectory/endpoint:Endpoint default {{project}}/{{location}}/{{namespace_id}}/{{service_id}}/{{endpoint_id}}
* ```
* ```sh
* $ pulumi import gcp:servicedirectory/endpoint:Endpoint default {{location}}/{{namespace_id}}/{{service_id}}/{{endpoint_id}}
* ```
*/
public class Endpoint internal constructor(
override val javaResource: com.pulumi.gcp.servicedirectory.Endpoint,
) : KotlinCustomResource(javaResource, EndpointMapper) {
/**
* IPv4 or IPv6 address of the endpoint.
*/
public val address: Output?
get() = javaResource.address().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* The Resource ID must be 1-63 characters long, including digits,
* lowercase letters or the hyphen character.
* - - -
*/
public val endpointId: Output
get() = javaResource.endpointId().applyValue({ args0 -> args0 })
/**
* 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.
*/
public val metadata: Output>?
get() = javaResource.metadata().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
}).orElse(null)
})
/**
* The resource name for the endpoint in the format
* `projects/*/locations/*/namespaces/*/services/*/endpoints/*`.
* */*/*/*/*/
*/
public val name: Output
get() = javaResource.name().applyValue({ args0 -> args0 })
/**
* The URL to the network, such as projects/PROJECT_NUMBER/locations/global/networks/NETWORK_NAME.
*/
public val network: Output?
get() = javaResource.network().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* Port that the endpoint is running on, must be in the
* range of [0, 65535]. If unspecified, the default is 0.
*/
public val port: Output?
get() = javaResource.port().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* The resource name of the service that this endpoint provides.
*/
public val service: Output
get() = javaResource.service().applyValue({ args0 -> args0 })
}
public object EndpointMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.gcp.servicedirectory.Endpoint::class == javaResource::class
override fun map(javaResource: Resource): Endpoint = Endpoint(
javaResource as
com.pulumi.gcp.servicedirectory.Endpoint,
)
}
/**
* @see [Endpoint].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [Endpoint].
*/
public suspend fun endpoint(name: String, block: suspend EndpointResourceBuilder.() -> Unit): Endpoint {
val builder = EndpointResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [Endpoint].
* @param name The _unique_ name of the resulting resource.
*/
public fun endpoint(name: String): Endpoint {
val builder = EndpointResourceBuilder()
builder.name(name)
return builder.build()
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy