Namespace Pulumi.Aws.DocDB

Classes

Cluster

Manages a DocDB Cluster.

Changes to a DocDB Cluster can occur when you manually change a parameter, such as port, and are reflected in the next maintenance window. Because of this, this provider may report a difference in its planning phase because a modification has not yet taken place. You can use the apply_immediately flag to instruct the service to apply the change immediately (see documentation below).

Note: using apply_immediately can result in a brief downtime as the server reboots. Note: All arguments including the username and password will be stored in the raw state as plain-text. Read more about sensitive data in state.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
public MyStack()
{
    var docdb = new Aws.DocDB.Cluster("docdb", new Aws.DocDB.ClusterArgs
    {
        BackupRetentionPeriod = 5,
        ClusterIdentifier = "my-docdb-cluster",
        Engine = "docdb",
        MasterPassword = "mustbeeightchars",
        MasterUsername = "foo",
        PreferredBackupWindow = "07:00-09:00",
        SkipFinalSnapshot = true,
    });
}

}

ClusterArgs

ClusterInstance

Provides an DocDB Cluster Resource Instance. A Cluster Instance Resource defines attributes that are specific to a single instance in a DocDB Cluster.

You do not designate a primary and subsequent replicas. Instead, you simply add DocDB Instances and DocDB manages the replication. You can use the count meta-parameter to make multiple instances and join them all to the same DocDB Cluster, or you may specify different Cluster Instance resources with various instance_class sizes.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
public MyStack()
{
    var @default = new Aws.DocDB.Cluster("default", new Aws.DocDB.ClusterArgs
    {
        AvailabilityZones = 
        {
            "us-west-2a",
            "us-west-2b",
            "us-west-2c",
        },
        ClusterIdentifier = "docdb-cluster-demo",
        MasterPassword = "barbut8chars",
        MasterUsername = "foo",
    });
    var clusterInstances = new List<Aws.DocDB.ClusterInstance>();
    for (var rangeIndex = 0; rangeIndex < 2; rangeIndex++)
    {
        var range = new { Value = rangeIndex };
        clusterInstances.Add(new Aws.DocDB.ClusterInstance($"clusterInstances-{range.Value}", new Aws.DocDB.ClusterInstanceArgs
        {
            ClusterIdentifier = @default.Id,
            Identifier = $"docdb-cluster-demo-{range.Value}",
            InstanceClass = "db.r5.large",
        }));
    }
}

}

ClusterInstanceArgs

ClusterInstanceState

ClusterParameterGroup

Manages a DocumentDB Cluster Parameter Group

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
public MyStack()
{
    var example = new Aws.DocDB.ClusterParameterGroup("example", new Aws.DocDB.ClusterParameterGroupArgs
    {
        Description = "docdb cluster parameter group",
        Family = "docdb3.6",
        Parameters = 
        {
            new Aws.DocDB.Inputs.ClusterParameterGroupParameterArgs
            {
                Name = "tls",
                Value = "enabled",
            },
        },
    });
}

}

ClusterParameterGroupArgs

ClusterParameterGroupState

ClusterSnapshot

Manages a DocDB database cluster snapshot for DocDB clusters.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
public MyStack()
{
    var example = new Aws.DocDB.ClusterSnapshot("example", new Aws.DocDB.ClusterSnapshotArgs
    {
        DbClusterIdentifier = aws_docdb_cluster.Example.Id,
        DbClusterSnapshotIdentifier = "resourcetestsnapshot1234",
    });
}

}

ClusterSnapshotArgs

ClusterSnapshotState

ClusterState

SubnetGroup

Provides an DocumentDB subnet group resource.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
public MyStack()
{
    var @default = new Aws.DocDB.SubnetGroup("default", new Aws.DocDB.SubnetGroupArgs
    {
        SubnetIds = 
        {
            aws_subnet.Frontend.Id,
            aws_subnet.Backend.Id,
        },
        Tags = 
        {
            { "Name", "My docdb subnet group" },
        },
    });
}

}

SubnetGroupArgs

SubnetGroupState