ElasticCluster class
Manages an AWS DocDB (DocumentDB) Elastic Cluster.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.docdb.ElasticCluster("example", {
name: "my-docdb-cluster",
adminUserName: "foo",
adminUserPassword: "mustbeeightchars",
authType: "PLAIN_TEXT",
shardCapacity: 2,
shardCount: 1,
});
import pulumi
import pulumi_aws as aws
example = aws.docdb.ElasticCluster("example",
name="my-docdb-cluster",
admin_user_name="foo",
admin_user_password="mustbeeightchars",
auth_type="PLAIN_TEXT",
shard_capacity=2,
shard_count=1)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.DocDB.ElasticCluster("example", new()
{
Name = "my-docdb-cluster",
AdminUserName = "foo",
AdminUserPassword = "mustbeeightchars",
AuthType = "PLAIN_TEXT",
ShardCapacity = 2,
ShardCount = 1,
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/docdb"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := docdb.NewElasticCluster(ctx, "example", &docdb.ElasticClusterArgs{
Name: pulumi.String("my-docdb-cluster"),
AdminUserName: pulumi.String("foo"),
AdminUserPassword: pulumi.String("mustbeeightchars"),
AuthType: pulumi.String("PLAIN_TEXT"),
ShardCapacity: pulumi.Int(2),
ShardCount: pulumi.Int(1),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_docdb_elasticcluster" "example" {
name = "my-docdb-cluster"
admin_user_name = "foo"
admin_user_password = "mustbeeightchars"
auth_type = "PLAIN_TEXT"
shard_capacity = 2
shard_count = 1
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.docdb.ElasticCluster;
import com.pulumi.aws.docdb.ElasticClusterArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 ElasticCluster("example", ElasticClusterArgs.builder()
.name("my-docdb-cluster")
.adminUserName("foo")
.adminUserPassword("mustbeeightchars")
.authType("PLAIN_TEXT")
.shardCapacity(2)
.shardCount(1)
.build());
}
}
resources:
example:
type: aws:docdb:ElasticCluster
properties:
name: my-docdb-cluster
adminUserName: foo
adminUserPassword: mustbeeightchars
authType: PLAIN_TEXT
shardCapacity: 2
shardCount: 1
Import
Identity Schema
Required
arn(String) ARN of the DocDB Elastic cluster.
Using pulumi import, import DocDB (DocumentDB) Elastic Cluster using the arn argument. For example,
$ pulumi import aws:docdb/elasticCluster:ElasticCluster example arn:aws:docdb-elastic:us-east-1:000011112222:cluster/12345678-7abc-def0-1234-56789abcdef
Constructors
- ElasticCluster(String name, {ElasticClusterArgs? args, CustomResourceOptions? options})
-
Creates a new ElasticCluster.
nameThe Pulumi resource name.argsArguments used to configure this ElasticCluster. The set of arguments for ElasticCluster.optionsResource options controlling this resource's behavior. - ElasticCluster.reference(String urn)
- Creates a typed reference to an existing ElasticCluster resource.
Properties
-
adminUserName
↔ Output<
String> -
Name of the Elastic DocumentDB cluster administrator
latefinal
-
adminUserPassword
↔ Output<
String> -
Password for the Elastic DocumentDB cluster administrator. Can contain any printable ASCII characters. Must be at least 8 characters
latefinal
-
arn
↔ Output<
String> -
ARN of the DocumentDB Elastic Cluster
latefinal
-
authType
↔ Output<
String> -
Authentication type for the Elastic DocumentDB cluster. Valid values are
PLAIN_TEXTandSECRET_ARNlatefinal -
backupRetentionPeriod
↔ Output<
int> -
The number of days for which automatic snapshots are retained. It should be in between 1 and 35. If not specified, the default value of 1 is set.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
endpoint
↔ Output<
String> -
The DNS address of the DocDB instance
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
kmsKeyId
↔ Output<
String> -
ARN of a KMS key that is used to encrypt the Elastic DocumentDB cluster. If not specified, the default encryption key that KMS creates for your account is used.
latefinal
-
name
↔ Output<
String> -
Name of the Elastic DocumentDB cluster
latefinal
-
preferredBackupWindow
↔ Output<
String> -
The daily time range during which automated backups are created if automated backups are enabled, as determined by the
backupRetentionPeriod.latefinal -
preferredMaintenanceWindow
↔ Output<
String> -
Weekly time range during which system maintenance can occur in UTC. Format:
ddd:hh24:mi-ddd:hh24:mi. If not specified, AWS will choose a random 30-minute window on a random day of the week.latefinal -
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
Number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64
latefinal
-
Number of shards assigned to the elastic cluster. Maximum is 32
latefinal
-
Number of replica instances applying to all shards in the elastic cluster. If not specified, the default value of 2 is set.
latefinal
-
subnetIds
↔ Output<
List< String> > -
IDs of subnets in which the Elastic DocumentDB Cluster operates.
latefinal
-
A map of tags to assign to the collection. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
latefinal
-
timeouts
↔ Output<
ElasticClusterTimeouts?> -
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
-
vpcSecurityGroupIds
↔ Output<
List< String> > -
List of VPC security groups to associate with the Elastic DocumentDB Cluster
latefinal
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {ElasticClusterState? state, CustomResourceOptions? options}) → ElasticCluster -
Gets an existing ElasticCluster resource's state with the given
nameandid.