mongodbatlas.PrivateEndpointRegionalMode

# Resource: private_endpoint_regional_mode

mongodbatlas.PrivateEndpointRegionalMode provides a Private Endpoint Regional Mode resource. This represents a regionalized private endpoint setting for a Project. Enable it to allow region specific private endpoints.

**IMPORTANT:**You must have one of the following roles to successfully handle the resource:

• Organization Owner
• Project Owner

NOTE: Groups and projects are synonymous terms. You may find group_id in the official documentation.

**WARNING:**Your connection strings to existing multi-region and global sharded clusters change when you enable this setting. You must update your applications to use the new connection strings. This might cause downtime.

Create PrivateEndpointRegionalMode Resource

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

Constructor syntax

new PrivateEndpointRegionalMode(name: string, args: PrivateEndpointRegionalModeArgs, opts?: CustomResourceOptions);

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

@overload
def PrivateEndpointRegionalMode(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                project_id: Optional[str] = None,
                                enabled: Optional[bool] = None)

func NewPrivateEndpointRegionalMode(ctx *Context, name string, args PrivateEndpointRegionalModeArgs, opts ...ResourceOption) (*PrivateEndpointRegionalMode, error)

public PrivateEndpointRegionalMode(string name, PrivateEndpointRegionalModeArgs args, CustomResourceOptions? opts = null)

public PrivateEndpointRegionalMode(String name, PrivateEndpointRegionalModeArgs args)
public PrivateEndpointRegionalMode(String name, PrivateEndpointRegionalModeArgs args, CustomResourceOptions options)

type: mongodbatlas:PrivateEndpointRegionalMode
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

Constructor example

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

var privateEndpointRegionalModeResource = new Mongodbatlas.PrivateEndpointRegionalMode("privateEndpointRegionalModeResource", new()
{
    ProjectId = "string",
    Enabled = false,
});

example, err := mongodbatlas.NewPrivateEndpointRegionalMode(ctx, "privateEndpointRegionalModeResource", &mongodbatlas.PrivateEndpointRegionalModeArgs{
	ProjectId: pulumi.String("string"),
	Enabled:   pulumi.Bool(false),
})

var privateEndpointRegionalModeResource = new PrivateEndpointRegionalMode("privateEndpointRegionalModeResource", PrivateEndpointRegionalModeArgs.builder()
    .projectId("string")
    .enabled(false)
    .build());

private_endpoint_regional_mode_resource = mongodbatlas.PrivateEndpointRegionalMode("privateEndpointRegionalModeResource",
    project_id="string",
    enabled=False)

const privateEndpointRegionalModeResource = new mongodbatlas.PrivateEndpointRegionalMode("privateEndpointRegionalModeResource", {
    projectId: "string",
    enabled: false,
});

type: mongodbatlas:PrivateEndpointRegionalMode
properties:
    enabled: false
    projectId: string

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

Outputs

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

Look up Existing PrivateEndpointRegionalMode Resource

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        enabled: Optional[bool] = None,
        project_id: Optional[str] = None) -> PrivateEndpointRegionalMode

func GetPrivateEndpointRegionalMode(ctx *Context, name string, id IDInput, state *PrivateEndpointRegionalModeState, opts ...ResourceOption) (*PrivateEndpointRegionalMode, error)

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

public static PrivateEndpointRegionalMode get(String name, Output<String> id, PrivateEndpointRegionalModeState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

Import

Private Endpoint Regional Mode can be imported using project id in format {project_id}, e.g.

$ pulumi import mongodbatlas:index/privateEndpointRegionalMode:PrivateEndpointRegionalMode test 1112222b3bf99403840e8934

See detailed information for arguments and attributes: Private Endpoints Get Regional Mode | Update Regional Mode

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

Package Details

Repository

MongoDB Atlas pulumi/pulumi-mongodbatlas

License

Apache-2.0

Notes

This Pulumi package is based on the mongodbatlas Terraform Provider.