Scaleway v1.14.0, Jun 6 24

Scaleway v1.14.0 published on Thursday, Jun 6, 2024 by pulumiverse

scaleway.DocumentdbPrivateNetworkEndpoint

Explore with Pulumi AI

Scaleway v1.14.0 published on Thursday, Jun 6, 2024 by pulumiverse

pulumiverse/pulumi-scaleway

Example Usage

Example Basic

Coming soon!

Coming soon!

Coming soon!

Coming soon!

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scaleway.VpcPrivateNetwork;
import com.pulumi.scaleway.DocumentdbPrivateNetworkEndpoint;
import com.pulumi.scaleway.DocumentdbPrivateNetworkEndpointArgs;
import com.pulumi.resources.CustomResourceOptions;
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 pn = new VpcPrivateNetwork("pn");

        var main = new DocumentdbPrivateNetworkEndpoint("main", DocumentdbPrivateNetworkEndpointArgs.builder()        
            .instanceId("11111111-1111-1111-1111-111111111111")
            .privateNetwork(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
            .build(), CustomResourceOptions.builder()
                .dependsOn(pn)
                .build());

    }
}

resources:
  pn:
    type: scaleway:VpcPrivateNetwork
  main:
    type: scaleway:DocumentdbPrivateNetworkEndpoint
    properties:
      instanceId: 11111111-1111-1111-1111-111111111111
      privateNetwork:
        - ipNet: 172.16.32.3/22
          id: ${pn.id}
    options:
      dependson:
        - ${pn}

Private Network

Important: Updates to private_network_id will recreate the attachment Instance.

NOTE: Please calculate your host IP. using cirhost. Otherwise, lets IPAM service handle the host IP on the network.

Create DocumentdbPrivateNetworkEndpoint Resource

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

Constructor syntax

new DocumentdbPrivateNetworkEndpoint(name: string, args: DocumentdbPrivateNetworkEndpointArgs, opts?: CustomResourceOptions);

@overload
def DocumentdbPrivateNetworkEndpoint(resource_name: str,
                                     args: DocumentdbPrivateNetworkEndpointArgs,
                                     opts: Optional[ResourceOptions] = None)

@overload
def DocumentdbPrivateNetworkEndpoint(resource_name: str,
                                     opts: Optional[ResourceOptions] = None,
                                     instance_id: Optional[str] = None,
                                     private_network_id: Optional[str] = None,
                                     ip_net: Optional[str] = None,
                                     port: Optional[int] = None,
                                     region: Optional[str] = None,
                                     zone: Optional[str] = None)

func NewDocumentdbPrivateNetworkEndpoint(ctx *Context, name string, args DocumentdbPrivateNetworkEndpointArgs, opts ...ResourceOption) (*DocumentdbPrivateNetworkEndpoint, error)

public DocumentdbPrivateNetworkEndpoint(string name, DocumentdbPrivateNetworkEndpointArgs args, CustomResourceOptions? opts = null)

public DocumentdbPrivateNetworkEndpoint(String name, DocumentdbPrivateNetworkEndpointArgs args)
public DocumentdbPrivateNetworkEndpoint(String name, DocumentdbPrivateNetworkEndpointArgs args, CustomResourceOptions options)

type: scaleway:DocumentdbPrivateNetworkEndpoint
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 DocumentdbPrivateNetworkEndpointArgs: 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 DocumentdbPrivateNetworkEndpointArgs: 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 DocumentdbPrivateNetworkEndpointArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args DocumentdbPrivateNetworkEndpointArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args DocumentdbPrivateNetworkEndpointArgs: 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.

var documentdbPrivateNetworkEndpointResource = new Scaleway.DocumentdbPrivateNetworkEndpoint("documentdbPrivateNetworkEndpointResource", new()
{
    InstanceId = "string",
    PrivateNetworkId = "string",
    IpNet = "string",
    Port = 0,
    Region = "string",
    Zone = "string",
});

example, err := scaleway.NewDocumentdbPrivateNetworkEndpoint(ctx, "documentdbPrivateNetworkEndpointResource", &scaleway.DocumentdbPrivateNetworkEndpointArgs{
	InstanceId:       pulumi.String("string"),
	PrivateNetworkId: pulumi.String("string"),
	IpNet:            pulumi.String("string"),
	Port:             pulumi.Int(0),
	Region:           pulumi.String("string"),
	Zone:             pulumi.String("string"),
})

var documentdbPrivateNetworkEndpointResource = new DocumentdbPrivateNetworkEndpoint("documentdbPrivateNetworkEndpointResource", DocumentdbPrivateNetworkEndpointArgs.builder()
    .instanceId("string")
    .privateNetworkId("string")
    .ipNet("string")
    .port(0)
    .region("string")
    .zone("string")
    .build());

documentdb_private_network_endpoint_resource = scaleway.DocumentdbPrivateNetworkEndpoint("documentdbPrivateNetworkEndpointResource",
    instance_id="string",
    private_network_id="string",
    ip_net="string",
    port=0,
    region="string",
    zone="string")

const documentdbPrivateNetworkEndpointResource = new scaleway.DocumentdbPrivateNetworkEndpoint("documentdbPrivateNetworkEndpointResource", {
    instanceId: "string",
    privateNetworkId: "string",
    ipNet: "string",
    port: 0,
    region: "string",
    zone: "string",
});

type: scaleway:DocumentdbPrivateNetworkEndpoint
properties:
    instanceId: string
    ipNet: string
    port: 0
    privateNetworkId: string
    region: string
    zone: string

DocumentdbPrivateNetworkEndpoint 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 DocumentdbPrivateNetworkEndpoint resource accepts the following input properties:

InstanceId string: UUID of the documentdb instance.
PrivateNetworkId string: The ID of the private network.
IpNet string: The IP network address within the private subnet. This must be an IPv4 address with a CIDR notation. The IP network address within the private subnet is determined by the IP Address Management (IPAM) service if not set.
Port int: Port in the Private Network.
Region string: The region you want to attach the resource to
Zone string: The zone you want to attach the resource to

InstanceId string: UUID of the documentdb instance.
PrivateNetworkId string: The ID of the private network.
IpNet string: The IP network address within the private subnet. This must be an IPv4 address with a CIDR notation. The IP network address within the private subnet is determined by the IP Address Management (IPAM) service if not set.
Port int: Port in the Private Network.
Region string: The region you want to attach the resource to
Zone string: The zone you want to attach the resource to

instanceId String: UUID of the documentdb instance.
privateNetworkId String: The ID of the private network.
ipNet String: The IP network address within the private subnet. This must be an IPv4 address with a CIDR notation. The IP network address within the private subnet is determined by the IP Address Management (IPAM) service if not set.
port Integer: Port in the Private Network.
region String: The region you want to attach the resource to
zone String: The zone you want to attach the resource to

instanceId string: UUID of the documentdb instance.
privateNetworkId string: The ID of the private network.
ipNet string: The IP network address within the private subnet. This must be an IPv4 address with a CIDR notation. The IP network address within the private subnet is determined by the IP Address Management (IPAM) service if not set.
port number: Port in the Private Network.
region string: The region you want to attach the resource to
zone string: The zone you want to attach the resource to

instance_id str: UUID of the documentdb instance.
private_network_id str: The ID of the private network.
ip_net str: The IP network address within the private subnet. This must be an IPv4 address with a CIDR notation. The IP network address within the private subnet is determined by the IP Address Management (IPAM) service if not set.
port int: Port in the Private Network.
region str: The region you want to attach the resource to
zone str: The zone you want to attach the resource to

instanceId String: UUID of the documentdb instance.
privateNetworkId String: The ID of the private network.
ipNet String: The IP network address within the private subnet. This must be an IPv4 address with a CIDR notation. The IP network address within the private subnet is determined by the IP Address Management (IPAM) service if not set.
port Number: Port in the Private Network.
region String: The region you want to attach the resource to
zone String: The zone you want to attach the resource to

Outputs

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

Hostname string: Hostname of the endpoint.
Id string: The provider-assigned unique ID for this managed resource.
Ip string: IPv4 address on the network.
Name string: Name of the endpoint.

Hostname string: Hostname of the endpoint.
Id string: The provider-assigned unique ID for this managed resource.
Ip string: IPv4 address on the network.
Name string: Name of the endpoint.

hostname String: Hostname of the endpoint.
id String: The provider-assigned unique ID for this managed resource.
ip String: IPv4 address on the network.
name String: Name of the endpoint.

hostname string: Hostname of the endpoint.
id string: The provider-assigned unique ID for this managed resource.
ip string: IPv4 address on the network.
name string: Name of the endpoint.

hostname str: Hostname of the endpoint.
id str: The provider-assigned unique ID for this managed resource.
ip str: IPv4 address on the network.
name str: Name of the endpoint.

hostname String: Hostname of the endpoint.
id String: The provider-assigned unique ID for this managed resource.
ip String: IPv4 address on the network.
name String: Name of the endpoint.

Look up Existing DocumentdbPrivateNetworkEndpoint Resource

Get an existing DocumentdbPrivateNetworkEndpoint 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?: DocumentdbPrivateNetworkEndpointState, opts?: CustomResourceOptions): DocumentdbPrivateNetworkEndpoint

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        hostname: Optional[str] = None,
        instance_id: Optional[str] = None,
        ip: Optional[str] = None,
        ip_net: Optional[str] = None,
        name: Optional[str] = None,
        port: Optional[int] = None,
        private_network_id: Optional[str] = None,
        region: Optional[str] = None,
        zone: Optional[str] = None) -> DocumentdbPrivateNetworkEndpoint

func GetDocumentdbPrivateNetworkEndpoint(ctx *Context, name string, id IDInput, state *DocumentdbPrivateNetworkEndpointState, opts ...ResourceOption) (*DocumentdbPrivateNetworkEndpoint, error)

public static DocumentdbPrivateNetworkEndpoint Get(string name, Input<string> id, DocumentdbPrivateNetworkEndpointState? state, CustomResourceOptions? opts = null)

public static DocumentdbPrivateNetworkEndpoint get(String name, Output<String> id, DocumentdbPrivateNetworkEndpointState 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:

Hostname string: Hostname of the endpoint.
InstanceId string: UUID of the documentdb instance.
Ip string: IPv4 address on the network.
IpNet string: The IP network address within the private subnet. This must be an IPv4 address with a CIDR notation. The IP network address within the private subnet is determined by the IP Address Management (IPAM) service if not set.
Name string: Name of the endpoint.
Port int: Port in the Private Network.
PrivateNetworkId string: The ID of the private network.
Region string: The region you want to attach the resource to
Zone string: The zone you want to attach the resource to

Hostname string: Hostname of the endpoint.
InstanceId string: UUID of the documentdb instance.
Ip string: IPv4 address on the network.
IpNet string: The IP network address within the private subnet. This must be an IPv4 address with a CIDR notation. The IP network address within the private subnet is determined by the IP Address Management (IPAM) service if not set.
Name string: Name of the endpoint.
Port int: Port in the Private Network.
PrivateNetworkId string: The ID of the private network.
Region string: The region you want to attach the resource to
Zone string: The zone you want to attach the resource to

hostname String: Hostname of the endpoint.
instanceId String: UUID of the documentdb instance.
ip String: IPv4 address on the network.
ipNet String: The IP network address within the private subnet. This must be an IPv4 address with a CIDR notation. The IP network address within the private subnet is determined by the IP Address Management (IPAM) service if not set.
name String: Name of the endpoint.
port Integer: Port in the Private Network.
privateNetworkId String: The ID of the private network.
region String: The region you want to attach the resource to
zone String: The zone you want to attach the resource to

hostname string: Hostname of the endpoint.
instanceId string: UUID of the documentdb instance.
ip string: IPv4 address on the network.
ipNet string: The IP network address within the private subnet. This must be an IPv4 address with a CIDR notation. The IP network address within the private subnet is determined by the IP Address Management (IPAM) service if not set.
name string: Name of the endpoint.
port number: Port in the Private Network.
privateNetworkId string: The ID of the private network.
region string: The region you want to attach the resource to
zone string: The zone you want to attach the resource to

hostname str: Hostname of the endpoint.
instance_id str: UUID of the documentdb instance.
ip str: IPv4 address on the network.
ip_net str: The IP network address within the private subnet. This must be an IPv4 address with a CIDR notation. The IP network address within the private subnet is determined by the IP Address Management (IPAM) service if not set.
name str: Name of the endpoint.
port int: Port in the Private Network.
private_network_id str: The ID of the private network.
region str: The region you want to attach the resource to
zone str: The zone you want to attach the resource to

hostname String: Hostname of the endpoint.
instanceId String: UUID of the documentdb instance.
ip String: IPv4 address on the network.
ipNet String: The IP network address within the private subnet. This must be an IPv4 address with a CIDR notation. The IP network address within the private subnet is determined by the IP Address Management (IPAM) service if not set.
name String: Name of the endpoint.
port Number: Port in the Private Network.
privateNetworkId String: The ID of the private network.
region String: The region you want to attach the resource to
zone String: The zone you want to attach the resource to

Import

Database Instance Endpoint can be imported using the {region}/{endpoint_id}, e.g.

bash

$ pulumi import scaleway:index/documentdbPrivateNetworkEndpoint:DocumentdbPrivateNetworkEndpoint end fr-par/11111111-1111-1111-1111-111111111111

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

Package Details

Repository: scaleway pulumiverse/pulumi-scaleway
License: Apache-2.0
Notes: This Pulumi package is based on the scaleway Terraform Provider.

Scaleway v1.14.0 published on Thursday, Jun 6, 2024 by pulumiverse

pulumiverse/pulumi-scaleway

scaleway.DocumentdbPrivateNetworkEndpoint

On this page

On this page

Example Usage

Example Basic

Private Network

Create DocumentdbPrivateNetworkEndpoint Resource

Constructor syntax

Parameters

Constructor example

DocumentdbPrivateNetworkEndpoint Resource Properties

Inputs

Outputs

Look up Existing DocumentdbPrivateNetworkEndpoint Resource

Import

Package Details

On this page

On this page