Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Mongodbatlas Provider
  3. API Docs
  4. CustomDnsConfigurationClusterAws
MongoDB Atlas v3.20.4 published on Wednesday, Oct 30, 2024 by Pulumi
pulumi/pulumi-mongodbatlas

mongodbatlas.CustomDnsConfigurationClusterAws

Explore with Pulumi AI

mongodbatlas logo
MongoDB Atlas v3.20.4 published on Wednesday, Oct 30, 2024 by Pulumi
pulumi/pulumi-mongodbatlas

    # Resource: mongodbatlas.CustomDnsConfigurationClusterAws

    mongodbatlas.CustomDnsConfigurationClusterAws provides a Custom DNS Configuration for Atlas Clusters on AWS resource. This represents a Custom DNS Configuration for Atlas Clusters on AWS that can be updated in an Atlas project.

    **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.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as mongodbatlas from "@pulumi/mongodbatlas";

const test = new mongodbatlas.CustomDnsConfigurationClusterAws("test", {
    projectId: "<PROJECT-ID>",
    enabled: true,
});

    import pulumi
import pulumi_mongodbatlas as mongodbatlas

test = mongodbatlas.CustomDnsConfigurationClusterAws("test",
    project_id="<PROJECT-ID>",
    enabled=True)

    package main

import (
	"github.com/pulumi/pulumi-mongodbatlas/sdk/v3/go/mongodbatlas"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := mongodbatlas.NewCustomDnsConfigurationClusterAws(ctx, "test", &mongodbatlas.CustomDnsConfigurationClusterAwsArgs{
			ProjectId: pulumi.String("<PROJECT-ID>"),
			Enabled:   pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Mongodbatlas = Pulumi.Mongodbatlas;

return await Deployment.RunAsync(() => 
{
    var test = new Mongodbatlas.CustomDnsConfigurationClusterAws("test", new()
    {
        ProjectId = "<PROJECT-ID>",
        Enabled = true,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.CustomDnsConfigurationClusterAws;
import com.pulumi.mongodbatlas.CustomDnsConfigurationClusterAwsArgs;
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 test = new CustomDnsConfigurationClusterAws("test", CustomDnsConfigurationClusterAwsArgs.builder()
            .projectId("<PROJECT-ID>")
            .enabled(true)
            .build());

    }
}

    resources:
  test:
    type: mongodbatlas:CustomDnsConfigurationClusterAws
    properties:
      projectId: <PROJECT-ID>
      enabled: true

    Create CustomDnsConfigurationClusterAws Resource

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

    Constructor syntax

    new CustomDnsConfigurationClusterAws(name: string, args: CustomDnsConfigurationClusterAwsArgs, opts?: CustomResourceOptions);
    @overload
def CustomDnsConfigurationClusterAws(resource_name: str,
                                     args: CustomDnsConfigurationClusterAwsArgs,
                                     opts: Optional[ResourceOptions] = None)

@overload
def CustomDnsConfigurationClusterAws(resource_name: str,
                                     opts: Optional[ResourceOptions] = None,
                                     enabled: Optional[bool] = None,
                                     project_id: Optional[str] = None)
    func NewCustomDnsConfigurationClusterAws(ctx *Context, name string, args CustomDnsConfigurationClusterAwsArgs, opts ...ResourceOption) (*CustomDnsConfigurationClusterAws, error)
    public CustomDnsConfigurationClusterAws(string name, CustomDnsConfigurationClusterAwsArgs args, CustomResourceOptions? opts = null)
    public CustomDnsConfigurationClusterAws(String name, CustomDnsConfigurationClusterAwsArgs args)
public CustomDnsConfigurationClusterAws(String name, CustomDnsConfigurationClusterAwsArgs args, CustomResourceOptions options)

    type: mongodbatlas:CustomDnsConfigurationClusterAws
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 CustomDnsConfigurationClusterAwsArgs
    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 CustomDnsConfigurationClusterAwsArgs
    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 CustomDnsConfigurationClusterAwsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CustomDnsConfigurationClusterAwsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CustomDnsConfigurationClusterAwsArgs
    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 customDnsConfigurationClusterAwsResource = new Mongodbatlas.CustomDnsConfigurationClusterAws("customDnsConfigurationClusterAwsResource", new()
{
    Enabled = false,
    ProjectId = "string",
});

    example, err := mongodbatlas.NewCustomDnsConfigurationClusterAws(ctx, "customDnsConfigurationClusterAwsResource", &mongodbatlas.CustomDnsConfigurationClusterAwsArgs{
	Enabled:   pulumi.Bool(false),
	ProjectId: pulumi.String("string"),
})

    var customDnsConfigurationClusterAwsResource = new CustomDnsConfigurationClusterAws("customDnsConfigurationClusterAwsResource", CustomDnsConfigurationClusterAwsArgs.builder()
    .enabled(false)
    .projectId("string")
    .build());

    custom_dns_configuration_cluster_aws_resource = mongodbatlas.CustomDnsConfigurationClusterAws("customDnsConfigurationClusterAwsResource",
    enabled=False,
    project_id="string")

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

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

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

    Enabled bool
    Indicates whether the project's clusters deployed to AWS use custom DNS. If true, the Get All Clusters and Get One Cluster endpoints return the connectionStrings.private and connectionStrings.privateSrv fields for clusters deployed to AWS .
    ProjectId string
    Required Unique identifier for the project.
    Enabled bool
    Indicates whether the project's clusters deployed to AWS use custom DNS. If true, the Get All Clusters and Get One Cluster endpoints return the connectionStrings.private and connectionStrings.privateSrv fields for clusters deployed to AWS .
    ProjectId string
    Required Unique identifier for the project.
    enabled Boolean
    Indicates whether the project's clusters deployed to AWS use custom DNS. If true, the Get All Clusters and Get One Cluster endpoints return the connectionStrings.private and connectionStrings.privateSrv fields for clusters deployed to AWS .
    projectId String
    Required Unique identifier for the project.
    enabled boolean
    Indicates whether the project's clusters deployed to AWS use custom DNS. If true, the Get All Clusters and Get One Cluster endpoints return the connectionStrings.private and connectionStrings.privateSrv fields for clusters deployed to AWS .
    projectId string
    Required Unique identifier for the project.
    enabled bool
    Indicates whether the project's clusters deployed to AWS use custom DNS. If true, the Get All Clusters and Get One Cluster endpoints return the connectionStrings.private and connectionStrings.privateSrv fields for clusters deployed to AWS .
    project_id str
    Required Unique identifier for the project.
    enabled Boolean
    Indicates whether the project's clusters deployed to AWS use custom DNS. If true, the Get All Clusters and Get One Cluster endpoints return the connectionStrings.private and connectionStrings.privateSrv fields for clusters deployed to AWS .
    projectId String
    Required Unique identifier for the project.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing CustomDnsConfigurationClusterAws Resource

    Get an existing CustomDnsConfigurationClusterAws 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?: CustomDnsConfigurationClusterAwsState, opts?: CustomResourceOptions): CustomDnsConfigurationClusterAws
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        enabled: Optional[bool] = None,
        project_id: Optional[str] = None) -> CustomDnsConfigurationClusterAws
    func GetCustomDnsConfigurationClusterAws(ctx *Context, name string, id IDInput, state *CustomDnsConfigurationClusterAwsState, opts ...ResourceOption) (*CustomDnsConfigurationClusterAws, error)
    public static CustomDnsConfigurationClusterAws Get(string name, Input<string> id, CustomDnsConfigurationClusterAwsState? state, CustomResourceOptions? opts = null)
    public static CustomDnsConfigurationClusterAws get(String name, Output<String> id, CustomDnsConfigurationClusterAwsState 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:
    Enabled bool
    Indicates whether the project's clusters deployed to AWS use custom DNS. If true, the Get All Clusters and Get One Cluster endpoints return the connectionStrings.private and connectionStrings.privateSrv fields for clusters deployed to AWS .
    ProjectId string
    Required Unique identifier for the project.
    Enabled bool
    Indicates whether the project's clusters deployed to AWS use custom DNS. If true, the Get All Clusters and Get One Cluster endpoints return the connectionStrings.private and connectionStrings.privateSrv fields for clusters deployed to AWS .
    ProjectId string
    Required Unique identifier for the project.
    enabled Boolean
    Indicates whether the project's clusters deployed to AWS use custom DNS. If true, the Get All Clusters and Get One Cluster endpoints return the connectionStrings.private and connectionStrings.privateSrv fields for clusters deployed to AWS .
    projectId String
    Required Unique identifier for the project.
    enabled boolean
    Indicates whether the project's clusters deployed to AWS use custom DNS. If true, the Get All Clusters and Get One Cluster endpoints return the connectionStrings.private and connectionStrings.privateSrv fields for clusters deployed to AWS .
    projectId string
    Required Unique identifier for the project.
    enabled bool
    Indicates whether the project's clusters deployed to AWS use custom DNS. If true, the Get All Clusters and Get One Cluster endpoints return the connectionStrings.private and connectionStrings.privateSrv fields for clusters deployed to AWS .
    project_id str
    Required Unique identifier for the project.
    enabled Boolean
    Indicates whether the project's clusters deployed to AWS use custom DNS. If true, the Get All Clusters and Get One Cluster endpoints return the connectionStrings.private and connectionStrings.privateSrv fields for clusters deployed to AWS .
    projectId String
    Required Unique identifier for the project.

    Import

    Custom DNS Configuration for Atlas Clusters on AWS must be imported using Project ID, e.g.

    $ pulumi import mongodbatlas:index/customDnsConfigurationClusterAws:CustomDnsConfigurationClusterAws test 1112222b3bf99403840e8934

    See detailed information for arguments and attributes: MongoDB API Custom DNS Configuration for Atlas Clusters on AWS.

    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.
    mongodbatlas logo
    MongoDB Atlas v3.20.4 published on Wednesday, Oct 30, 2024 by Pulumi
    pulumi/pulumi-mongodbatlas