1. Docs
  2. Reference
  3. API
  4. @pulumi/aws
  5. docdb

Module docdb

This page documents the language specification for the aws package. If you're looking for help working with the inputs, outputs, or functions of aws resources in a Pulumi program, please see the resource documentation for examples and API reference.

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-aws repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-aws repo.

Resources

Others

Resources

Resource Cluster

class Cluster extends CustomResource

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 applyImmediately flag to instruct the service to apply the change immediately (see documentation below).

Note: using applyImmediately 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.

Example Usage

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

const docdb = new aws.docdb.Cluster("docdb", {
    backupRetentionPeriod: 5,
    clusterIdentifier: "my-docdb-cluster",
    engine: "docdb",
    masterPassword: "mustbeeightchars",
    masterUsername: "foo",
    preferredBackupWindow: "07:00-09:00",
    skipFinalSnapshot: true,
});

constructor

new Cluster(name: string, args?: ClusterArgs, opts?: pulumi.CustomResourceOptions)

Create a Cluster resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ClusterState, opts?: pulumi.CustomResourceOptions): Cluster

Get an existing Cluster resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Cluster

Returns true if the given object is an instance of Cluster. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property applyImmediately

public applyImmediately: pulumi.Output<boolean>;

Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false.

property arn

public arn: pulumi.Output<string>;

Amazon Resource Name (ARN) of cluster

property availabilityZones

public availabilityZones: pulumi.Output<string[]>;

A list of EC2 Availability Zones that instances in the DB cluster can be created in.

property backupRetentionPeriod

public backupRetentionPeriod: pulumi.Output<number | undefined>;

The days to retain backups for. Default 1

property clusterIdentifier

public clusterIdentifier: pulumi.Output<string>;

The cluster identifier. If omitted, this provider will assign a random, unique identifier.

property clusterIdentifierPrefix

public clusterIdentifierPrefix: pulumi.Output<string>;

Creates a unique cluster identifier beginning with the specified prefix. Conflicts with clusterIdentifer.

property clusterMembers

public clusterMembers: pulumi.Output<string[]>;

List of DocDB Instances that are a part of this cluster

property clusterResourceId

public clusterResourceId: pulumi.Output<string>;

The DocDB Cluster Resource ID

property dbClusterParameterGroupName

public dbClusterParameterGroupName: pulumi.Output<string>;

A cluster parameter group to associate with the cluster.

property dbSubnetGroupName

public dbSubnetGroupName: pulumi.Output<string>;

A DB subnet group to associate with this DB instance.

property deletionProtection

public deletionProtection: pulumi.Output<boolean | undefined>;

A value that indicates whether the DB cluster has deletion protection enabled. The database can’t be deleted when deletion protection is enabled. By default, deletion protection is disabled.

property enabledCloudwatchLogsExports

public enabledCloudwatchLogsExports: pulumi.Output<string[] | undefined>;

List of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: audit, profiler.

property endpoint

public endpoint: pulumi.Output<string>;

The DNS address of the DocDB instance

property engine

public engine: pulumi.Output<string | undefined>;

The name of the database engine to be used for this DB cluster. Defaults to docdb. Valid Values: docdb

property engineVersion

public engineVersion: pulumi.Output<string>;

The database engine version. Updating this argument results in an outage.

property finalSnapshotIdentifier

public finalSnapshotIdentifier: pulumi.Output<string | undefined>;

The name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.

property hostedZoneId

public hostedZoneId: pulumi.Output<string>;

The Route53 Hosted Zone ID of the endpoint

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property kmsKeyId

public kmsKeyId: pulumi.Output<string>;

The ARN for the KMS encryption key. When specifying kmsKeyId, storageEncrypted needs to be set to true.

property masterPassword

public masterPassword: pulumi.Output<string | undefined>;

Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Please refer to the DocDB Naming Constraints.

property masterUsername

public masterUsername: pulumi.Output<string>;

Username for the master DB user.

property port

public port: pulumi.Output<number | undefined>;

The port on which the DB accepts connections

property preferredBackupWindow

public preferredBackupWindow: pulumi.Output<string>;

The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.Time in UTC Default: A 30-minute window selected at random from an 8-hour block of time per region. e.g. 04:00-09:00

property preferredMaintenanceWindow

public preferredMaintenanceWindow: pulumi.Output<string>;

property readerEndpoint

public readerEndpoint: pulumi.Output<string>;

A read-only endpoint for the DocDB cluster, automatically load-balanced across replicas

property skipFinalSnapshot

public skipFinalSnapshot: pulumi.Output<boolean | undefined>;

Determines whether a final DB snapshot is created before the DB cluster is deleted. If true is specified, no DB snapshot is created. If false is specified, a DB snapshot is created before the DB cluster is deleted, using the value from finalSnapshotIdentifier. Default is false.

property snapshotIdentifier

public snapshotIdentifier: pulumi.Output<string | undefined>;

Specifies whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a DB cluster snapshot, or the ARN when specifying a DB snapshot.

property storageEncrypted

public storageEncrypted: pulumi.Output<boolean | undefined>;

Specifies whether the DB cluster is encrypted. The default is false.

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

A map of tags to assign to the DB cluster.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property vpcSecurityGroupIds

public vpcSecurityGroupIds: pulumi.Output<string[]>;

List of VPC security groups to associate with the Cluster

Resource ClusterInstance

class ClusterInstance extends CustomResource

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 instanceClass sizes.

Example Usage

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

const defaultCluster = new aws.docdb.Cluster("default", {
    availabilityZones: [
        "us-west-2a",
        "us-west-2b",
        "us-west-2c",
    ],
    clusterIdentifier: "docdb-cluster-demo",
    masterPassword: "barbut8chars",
    masterUsername: "foo",
});
const clusterInstances: aws.docdb.ClusterInstance[] = [];
for (let i = 0; i < 2; i++) {
    clusterInstances.push(new aws.docdb.ClusterInstance(`cluster_instances-${i}`, {
        clusterIdentifier: defaultCluster.id,
        identifier: `docdb-cluster-demo-${i}`,
        instanceClass: "db.r5.large",
    }));
}

constructor

new ClusterInstance(name: string, args: ClusterInstanceArgs, opts?: pulumi.CustomResourceOptions)

Create a ClusterInstance resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ClusterInstanceState, opts?: pulumi.CustomResourceOptions): ClusterInstance

Get an existing ClusterInstance resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ClusterInstance

Returns true if the given object is an instance of ClusterInstance. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property applyImmediately

public applyImmediately: pulumi.Output<boolean>;

Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default isfalse.

property arn

public arn: pulumi.Output<string>;

Amazon Resource Name (ARN) of cluster instance

property autoMinorVersionUpgrade

public autoMinorVersionUpgrade: pulumi.Output<boolean | undefined>;

Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Default true.

property availabilityZone

public availabilityZone: pulumi.Output<string>;

The EC2 Availability Zone that the DB instance is created in. See docs about the details.

property caCertIdentifier

public caCertIdentifier: pulumi.Output<string>;

(Optional) The identifier of the CA certificate for the DB instance.

property clusterIdentifier

public clusterIdentifier: pulumi.Output<string>;

The identifier of the aws.docdb.Cluster in which to launch this instance.

property dbSubnetGroupName

public dbSubnetGroupName: pulumi.Output<string>;

The DB subnet group to associate with this DB instance.

property dbiResourceId

public dbiResourceId: pulumi.Output<string>;

The region-unique, immutable identifier for the DB instance.

property endpoint

public endpoint: pulumi.Output<string>;

The DNS address for this instance. May not be writable

property engine

public engine: pulumi.Output<string | undefined>;

The name of the database engine to be used for the DocDB instance. Defaults to docdb. Valid Values: docdb.

property engineVersion

public engineVersion: pulumi.Output<string>;

The database engine version

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property identifier

public identifier: pulumi.Output<string>;

The indentifier for the DocDB instance, if omitted, this provider will assign a random, unique identifier.

property identifierPrefix

public identifierPrefix: pulumi.Output<string>;

Creates a unique identifier beginning with the specified prefix. Conflicts with identifer.

property instanceClass

public instanceClass: pulumi.Output<string>;

The instance class to use. For details on CPU and memory, see Scaling for DocDB Instances. DocDB currently supports the below instance classes. Please see AWS Documentation for complete details. - db.r4.large - db.r4.xlarge - db.r4.2xlarge - db.r4.4xlarge - db.r4.8xlarge - db.r4.16xlarge

property kmsKeyId

public kmsKeyId: pulumi.Output<string>;

The ARN for the KMS encryption key if one is set to the cluster.

property port

public port: pulumi.Output<number>;

The database port

property preferredBackupWindow

public preferredBackupWindow: pulumi.Output<string>;

The daily time range during which automated backups are created if automated backups are enabled.

property preferredMaintenanceWindow

public preferredMaintenanceWindow: pulumi.Output<string>;

The window to perform maintenance in. Syntax: “ddd:hh24:mi-ddd:hh24:mi”. Eg: “Mon:00:00-Mon:03:00”.

property promotionTier

public promotionTier: pulumi.Output<number | undefined>;

Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoter to writer.

property publiclyAccessible

public publiclyAccessible: pulumi.Output<boolean>;

property storageEncrypted

public storageEncrypted: pulumi.Output<boolean>;

Specifies whether the DB cluster is encrypted.

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

A map of tags to assign to the instance.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property writer

public writer: pulumi.Output<boolean>;

Boolean indicating if this instance is writable. False indicates this instance is a read replica.

Resource ClusterParameterGroup

class ClusterParameterGroup extends CustomResource

Manages a DocumentDB Cluster Parameter Group

Example Usage

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

const example = new aws.docdb.ClusterParameterGroup("example", {
    description: "docdb cluster parameter group",
    family: "docdb3.6",
    parameters: [{
        name: "tls",
        value: "enabled",
    }],
});

constructor

new ClusterParameterGroup(name: string, args: ClusterParameterGroupArgs, opts?: pulumi.CustomResourceOptions)

Create a ClusterParameterGroup resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ClusterParameterGroupState, opts?: pulumi.CustomResourceOptions): ClusterParameterGroup

Get an existing ClusterParameterGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ClusterParameterGroup

Returns true if the given object is an instance of ClusterParameterGroup. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

The ARN of the documentDB cluster parameter group.

property description

public description: pulumi.Output<string | undefined>;

The description of the documentDB cluster parameter group. Defaults to “Managed by Pulumi”.

property family

public family: pulumi.Output<string>;

The family of the documentDB cluster parameter group.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the documentDB parameter.

property namePrefix

public namePrefix: pulumi.Output<string>;

Creates a unique name beginning with the specified prefix. Conflicts with name.

property parameters

public parameters: pulumi.Output<ClusterParameterGroupParameter[] | undefined>;

A list of documentDB parameters to apply.

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

A map of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource ClusterSnapshot

class ClusterSnapshot extends CustomResource

Manages a DocDB database cluster snapshot for DocDB clusters.

Example Usage

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

const example = new aws.docdb.ClusterSnapshot("example", {
    dbClusterIdentifier: aws_docdb_cluster_example.id,
    dbClusterSnapshotIdentifier: "resourcetestsnapshot1234",
});

constructor

new ClusterSnapshot(name: string, args: ClusterSnapshotArgs, opts?: pulumi.CustomResourceOptions)

Create a ClusterSnapshot resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ClusterSnapshotState, opts?: pulumi.CustomResourceOptions): ClusterSnapshot

Get an existing ClusterSnapshot resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ClusterSnapshot

Returns true if the given object is an instance of ClusterSnapshot. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property availabilityZones

public availabilityZones: pulumi.Output<string[]>;

List of EC2 Availability Zones that instances in the DocDB cluster snapshot can be restored in.

property dbClusterIdentifier

public dbClusterIdentifier: pulumi.Output<string>;

The DocDB Cluster Identifier from which to take the snapshot.

property dbClusterSnapshotArn

public dbClusterSnapshotArn: pulumi.Output<string>;

The Amazon Resource Name (ARN) for the DocDB Cluster Snapshot.

property dbClusterSnapshotIdentifier

public dbClusterSnapshotIdentifier: pulumi.Output<string>;

The Identifier for the snapshot.

property engine

public engine: pulumi.Output<string>;

Specifies the name of the database engine.

property engineVersion

public engineVersion: pulumi.Output<string>;

Version of the database engine for this DocDB cluster snapshot.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property kmsKeyId

public kmsKeyId: pulumi.Output<string>;

If storageEncrypted is true, the AWS KMS key identifier for the encrypted DocDB cluster snapshot.

property port

public port: pulumi.Output<number>;

Port that the DocDB cluster was listening on at the time of the snapshot.

property snapshotType

public snapshotType: pulumi.Output<string>;

property sourceDbClusterSnapshotArn

public sourceDbClusterSnapshotArn: pulumi.Output<string>;

property status

public status: pulumi.Output<string>;

The status of this DocDB Cluster Snapshot.

property storageEncrypted

public storageEncrypted: pulumi.Output<boolean>;

Specifies whether the DocDB cluster snapshot is encrypted.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property vpcId

public vpcId: pulumi.Output<string>;

The VPC ID associated with the DocDB cluster snapshot.

Resource SubnetGroup

class SubnetGroup extends CustomResource

Provides an DocumentDB subnet group resource.

Example Usage

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

const defaultSubnetGroup = new aws.docdb.SubnetGroup("default", {
    subnetIds: [
        aws_subnet_frontend.id,
        aws_subnet_backend.id,
    ],
    tags: {
        Name: "My docdb subnet group",
    },
});

constructor

new SubnetGroup(name: string, args: SubnetGroupArgs, opts?: pulumi.CustomResourceOptions)

Create a SubnetGroup resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: SubnetGroupState, opts?: pulumi.CustomResourceOptions): SubnetGroup

Get an existing SubnetGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is SubnetGroup

Returns true if the given object is an instance of SubnetGroup. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

The ARN of the docDB subnet group.

property description

public description: pulumi.Output<string>;

The description of the docDB subnet group. Defaults to “Managed by Pulumi”.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the docDB subnet group. If omitted, this provider will assign a random, unique name.

property namePrefix

public namePrefix: pulumi.Output<string>;

Creates a unique name beginning with the specified prefix. Conflicts with name.

property subnetIds

public subnetIds: pulumi.Output<string[]>;

A list of VPC subnet IDs.

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

A map of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Others

interface ClusterArgs

interface ClusterArgs

The set of arguments for constructing a Cluster resource.

property applyImmediately

applyImmediately?: pulumi.Input<boolean>;

Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false.

property availabilityZones

availabilityZones?: pulumi.Input<pulumi.Input<string>[]>;

A list of EC2 Availability Zones that instances in the DB cluster can be created in.

property backupRetentionPeriod

backupRetentionPeriod?: pulumi.Input<number>;

The days to retain backups for. Default 1

property clusterIdentifier

clusterIdentifier?: pulumi.Input<string>;

The cluster identifier. If omitted, this provider will assign a random, unique identifier.

property clusterIdentifierPrefix

clusterIdentifierPrefix?: pulumi.Input<string>;

Creates a unique cluster identifier beginning with the specified prefix. Conflicts with clusterIdentifer.

property clusterMembers

clusterMembers?: pulumi.Input<pulumi.Input<string>[]>;

List of DocDB Instances that are a part of this cluster

property dbClusterParameterGroupName

dbClusterParameterGroupName?: pulumi.Input<string>;

A cluster parameter group to associate with the cluster.

property dbSubnetGroupName

dbSubnetGroupName?: pulumi.Input<string>;

A DB subnet group to associate with this DB instance.

property deletionProtection

deletionProtection?: pulumi.Input<boolean>;

A value that indicates whether the DB cluster has deletion protection enabled. The database can’t be deleted when deletion protection is enabled. By default, deletion protection is disabled.

property enabledCloudwatchLogsExports

enabledCloudwatchLogsExports?: pulumi.Input<pulumi.Input<string>[]>;

List of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: audit, profiler.

property engine

engine?: pulumi.Input<string>;

The name of the database engine to be used for this DB cluster. Defaults to docdb. Valid Values: docdb

property engineVersion

engineVersion?: pulumi.Input<string>;

The database engine version. Updating this argument results in an outage.

property finalSnapshotIdentifier

finalSnapshotIdentifier?: pulumi.Input<string>;

The name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.

property kmsKeyId

kmsKeyId?: pulumi.Input<string>;

The ARN for the KMS encryption key. When specifying kmsKeyId, storageEncrypted needs to be set to true.

property masterPassword

masterPassword?: pulumi.Input<string>;

Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Please refer to the DocDB Naming Constraints.

property masterUsername

masterUsername?: pulumi.Input<string>;

Username for the master DB user.

property port

port?: pulumi.Input<number>;

The port on which the DB accepts connections

property preferredBackupWindow

preferredBackupWindow?: pulumi.Input<string>;

The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.Time in UTC Default: A 30-minute window selected at random from an 8-hour block of time per region. e.g. 04:00-09:00

property preferredMaintenanceWindow

preferredMaintenanceWindow?: pulumi.Input<string>;

property skipFinalSnapshot

skipFinalSnapshot?: pulumi.Input<boolean>;

Determines whether a final DB snapshot is created before the DB cluster is deleted. If true is specified, no DB snapshot is created. If false is specified, a DB snapshot is created before the DB cluster is deleted, using the value from finalSnapshotIdentifier. Default is false.

property snapshotIdentifier

snapshotIdentifier?: pulumi.Input<string>;

Specifies whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a DB cluster snapshot, or the ARN when specifying a DB snapshot.

property storageEncrypted

storageEncrypted?: pulumi.Input<boolean>;

Specifies whether the DB cluster is encrypted. The default is false.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A map of tags to assign to the DB cluster.

property vpcSecurityGroupIds

vpcSecurityGroupIds?: pulumi.Input<pulumi.Input<string>[]>;

List of VPC security groups to associate with the Cluster

interface ClusterInstanceArgs

interface ClusterInstanceArgs

The set of arguments for constructing a ClusterInstance resource.

property applyImmediately

applyImmediately?: pulumi.Input<boolean>;

Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default isfalse.

property autoMinorVersionUpgrade

autoMinorVersionUpgrade?: pulumi.Input<boolean>;

Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Default true.

property availabilityZone

availabilityZone?: pulumi.Input<string>;

The EC2 Availability Zone that the DB instance is created in. See docs about the details.

property caCertIdentifier

caCertIdentifier?: pulumi.Input<string>;

(Optional) The identifier of the CA certificate for the DB instance.

property clusterIdentifier

clusterIdentifier: pulumi.Input<string>;

The identifier of the aws.docdb.Cluster in which to launch this instance.

property engine

engine?: pulumi.Input<string>;

The name of the database engine to be used for the DocDB instance. Defaults to docdb. Valid Values: docdb.

property identifier

identifier?: pulumi.Input<string>;

The indentifier for the DocDB instance, if omitted, this provider will assign a random, unique identifier.

property identifierPrefix

identifierPrefix?: pulumi.Input<string>;

Creates a unique identifier beginning with the specified prefix. Conflicts with identifer.

property instanceClass

instanceClass: pulumi.Input<string>;

The instance class to use. For details on CPU and memory, see Scaling for DocDB Instances. DocDB currently supports the below instance classes. Please see AWS Documentation for complete details. - db.r4.large - db.r4.xlarge - db.r4.2xlarge - db.r4.4xlarge - db.r4.8xlarge - db.r4.16xlarge

property preferredMaintenanceWindow

preferredMaintenanceWindow?: pulumi.Input<string>;

The window to perform maintenance in. Syntax: “ddd:hh24:mi-ddd:hh24:mi”. Eg: “Mon:00:00-Mon:03:00”.

property promotionTier

promotionTier?: pulumi.Input<number>;

Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoter to writer.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A map of tags to assign to the instance.

interface ClusterInstanceState

interface ClusterInstanceState

Input properties used for looking up and filtering ClusterInstance resources.

property applyImmediately

applyImmediately?: pulumi.Input<boolean>;

Specifies whether any database modifications are applied immediately, or during the next maintenance window. Default isfalse.

property arn

arn?: pulumi.Input<string>;

Amazon Resource Name (ARN) of cluster instance

property autoMinorVersionUpgrade

autoMinorVersionUpgrade?: pulumi.Input<boolean>;

Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Default true.

property availabilityZone

availabilityZone?: pulumi.Input<string>;

The EC2 Availability Zone that the DB instance is created in. See docs about the details.

property caCertIdentifier

caCertIdentifier?: pulumi.Input<string>;

(Optional) The identifier of the CA certificate for the DB instance.

property clusterIdentifier

clusterIdentifier?: pulumi.Input<string>;

The identifier of the aws.docdb.Cluster in which to launch this instance.

property dbSubnetGroupName

dbSubnetGroupName?: pulumi.Input<string>;

The DB subnet group to associate with this DB instance.

property dbiResourceId

dbiResourceId?: pulumi.Input<string>;

The region-unique, immutable identifier for the DB instance.

property endpoint

endpoint?: pulumi.Input<string>;

The DNS address for this instance. May not be writable

property engine

engine?: pulumi.Input<string>;

The name of the database engine to be used for the DocDB instance. Defaults to docdb. Valid Values: docdb.

property engineVersion

engineVersion?: pulumi.Input<string>;

The database engine version

property identifier

identifier?: pulumi.Input<string>;

The indentifier for the DocDB instance, if omitted, this provider will assign a random, unique identifier.

property identifierPrefix

identifierPrefix?: pulumi.Input<string>;

Creates a unique identifier beginning with the specified prefix. Conflicts with identifer.

property instanceClass

instanceClass?: pulumi.Input<string>;

The instance class to use. For details on CPU and memory, see Scaling for DocDB Instances. DocDB currently supports the below instance classes. Please see AWS Documentation for complete details. - db.r4.large - db.r4.xlarge - db.r4.2xlarge - db.r4.4xlarge - db.r4.8xlarge - db.r4.16xlarge

property kmsKeyId

kmsKeyId?: pulumi.Input<string>;

The ARN for the KMS encryption key if one is set to the cluster.

property port

port?: pulumi.Input<number>;

The database port

property preferredBackupWindow

preferredBackupWindow?: pulumi.Input<string>;

The daily time range during which automated backups are created if automated backups are enabled.

property preferredMaintenanceWindow

preferredMaintenanceWindow?: pulumi.Input<string>;

The window to perform maintenance in. Syntax: “ddd:hh24:mi-ddd:hh24:mi”. Eg: “Mon:00:00-Mon:03:00”.

property promotionTier

promotionTier?: pulumi.Input<number>;

Default 0. Failover Priority setting on instance level. The reader who has lower tier has higher priority to get promoter to writer.

property publiclyAccessible

publiclyAccessible?: pulumi.Input<boolean>;

property storageEncrypted

storageEncrypted?: pulumi.Input<boolean>;

Specifies whether the DB cluster is encrypted.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A map of tags to assign to the instance.

property writer

writer?: pulumi.Input<boolean>;

Boolean indicating if this instance is writable. False indicates this instance is a read replica.

interface ClusterParameterGroupArgs

interface ClusterParameterGroupArgs

The set of arguments for constructing a ClusterParameterGroup resource.

property description

description?: pulumi.Input<string>;

The description of the documentDB cluster parameter group. Defaults to “Managed by Pulumi”.

property family

family: pulumi.Input<string>;

The family of the documentDB cluster parameter group.

property name

name?: pulumi.Input<string>;

The name of the documentDB parameter.

property namePrefix

namePrefix?: pulumi.Input<string>;

Creates a unique name beginning with the specified prefix. Conflicts with name.

property parameters

parameters?: pulumi.Input<pulumi.Input<ClusterParameterGroupParameter>[]>;

A list of documentDB parameters to apply.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A map of tags to assign to the resource.

interface ClusterParameterGroupState

interface ClusterParameterGroupState

Input properties used for looking up and filtering ClusterParameterGroup resources.

property arn

arn?: pulumi.Input<string>;

The ARN of the documentDB cluster parameter group.

property description

description?: pulumi.Input<string>;

The description of the documentDB cluster parameter group. Defaults to “Managed by Pulumi”.

property family

family?: pulumi.Input<string>;

The family of the documentDB cluster parameter group.

property name

name?: pulumi.Input<string>;

The name of the documentDB parameter.

property namePrefix

namePrefix?: pulumi.Input<string>;

Creates a unique name beginning with the specified prefix. Conflicts with name.

property parameters

parameters?: pulumi.Input<pulumi.Input<ClusterParameterGroupParameter>[]>;

A list of documentDB parameters to apply.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A map of tags to assign to the resource.

interface ClusterSnapshotArgs

interface ClusterSnapshotArgs

The set of arguments for constructing a ClusterSnapshot resource.

property dbClusterIdentifier

dbClusterIdentifier: pulumi.Input<string>;

The DocDB Cluster Identifier from which to take the snapshot.

property dbClusterSnapshotIdentifier

dbClusterSnapshotIdentifier: pulumi.Input<string>;

The Identifier for the snapshot.

interface ClusterSnapshotState

interface ClusterSnapshotState

Input properties used for looking up and filtering ClusterSnapshot resources.

property availabilityZones

availabilityZones?: pulumi.Input<pulumi.Input<string>[]>;

List of EC2 Availability Zones that instances in the DocDB cluster snapshot can be restored in.

property dbClusterIdentifier

dbClusterIdentifier?: pulumi.Input<string>;

The DocDB Cluster Identifier from which to take the snapshot.

property dbClusterSnapshotArn

dbClusterSnapshotArn?: pulumi.Input<string>;

The Amazon Resource Name (ARN) for the DocDB Cluster Snapshot.

property dbClusterSnapshotIdentifier

dbClusterSnapshotIdentifier?: pulumi.Input<string>;

The Identifier for the snapshot.

property engine

engine?: pulumi.Input<string>;

Specifies the name of the database engine.

property engineVersion

engineVersion?: pulumi.Input<string>;

Version of the database engine for this DocDB cluster snapshot.

property kmsKeyId

kmsKeyId?: pulumi.Input<string>;

If storageEncrypted is true, the AWS KMS key identifier for the encrypted DocDB cluster snapshot.

property port

port?: pulumi.Input<number>;

Port that the DocDB cluster was listening on at the time of the snapshot.

property snapshotType

snapshotType?: pulumi.Input<string>;

property sourceDbClusterSnapshotArn

sourceDbClusterSnapshotArn?: pulumi.Input<string>;

property status

status?: pulumi.Input<string>;

The status of this DocDB Cluster Snapshot.

property storageEncrypted

storageEncrypted?: pulumi.Input<boolean>;

Specifies whether the DocDB cluster snapshot is encrypted.

property vpcId

vpcId?: pulumi.Input<string>;

The VPC ID associated with the DocDB cluster snapshot.

interface ClusterState

interface ClusterState

Input properties used for looking up and filtering Cluster resources.

property applyImmediately

applyImmediately?: pulumi.Input<boolean>;

Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false.

property arn

arn?: pulumi.Input<string>;

Amazon Resource Name (ARN) of cluster

property availabilityZones

availabilityZones?: pulumi.Input<pulumi.Input<string>[]>;

A list of EC2 Availability Zones that instances in the DB cluster can be created in.

property backupRetentionPeriod

backupRetentionPeriod?: pulumi.Input<number>;

The days to retain backups for. Default 1

property clusterIdentifier

clusterIdentifier?: pulumi.Input<string>;

The cluster identifier. If omitted, this provider will assign a random, unique identifier.

property clusterIdentifierPrefix

clusterIdentifierPrefix?: pulumi.Input<string>;

Creates a unique cluster identifier beginning with the specified prefix. Conflicts with clusterIdentifer.

property clusterMembers

clusterMembers?: pulumi.Input<pulumi.Input<string>[]>;

List of DocDB Instances that are a part of this cluster

property clusterResourceId

clusterResourceId?: pulumi.Input<string>;

The DocDB Cluster Resource ID

property dbClusterParameterGroupName

dbClusterParameterGroupName?: pulumi.Input<string>;

A cluster parameter group to associate with the cluster.

property dbSubnetGroupName

dbSubnetGroupName?: pulumi.Input<string>;

A DB subnet group to associate with this DB instance.

property deletionProtection

deletionProtection?: pulumi.Input<boolean>;

A value that indicates whether the DB cluster has deletion protection enabled. The database can’t be deleted when deletion protection is enabled. By default, deletion protection is disabled.

property enabledCloudwatchLogsExports

enabledCloudwatchLogsExports?: pulumi.Input<pulumi.Input<string>[]>;

List of log types to export to cloudwatch. If omitted, no logs will be exported. The following log types are supported: audit, profiler.

property endpoint

endpoint?: pulumi.Input<string>;

The DNS address of the DocDB instance

property engine

engine?: pulumi.Input<string>;

The name of the database engine to be used for this DB cluster. Defaults to docdb. Valid Values: docdb

property engineVersion

engineVersion?: pulumi.Input<string>;

The database engine version. Updating this argument results in an outage.

property finalSnapshotIdentifier

finalSnapshotIdentifier?: pulumi.Input<string>;

The name of your final DB snapshot when this DB cluster is deleted. If omitted, no final snapshot will be made.

property hostedZoneId

hostedZoneId?: pulumi.Input<string>;

The Route53 Hosted Zone ID of the endpoint

property kmsKeyId

kmsKeyId?: pulumi.Input<string>;

The ARN for the KMS encryption key. When specifying kmsKeyId, storageEncrypted needs to be set to true.

property masterPassword

masterPassword?: pulumi.Input<string>;

Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Please refer to the DocDB Naming Constraints.

property masterUsername

masterUsername?: pulumi.Input<string>;

Username for the master DB user.

property port

port?: pulumi.Input<number>;

The port on which the DB accepts connections

property preferredBackupWindow

preferredBackupWindow?: pulumi.Input<string>;

The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.Time in UTC Default: A 30-minute window selected at random from an 8-hour block of time per region. e.g. 04:00-09:00

property preferredMaintenanceWindow

preferredMaintenanceWindow?: pulumi.Input<string>;

property readerEndpoint

readerEndpoint?: pulumi.Input<string>;

A read-only endpoint for the DocDB cluster, automatically load-balanced across replicas

property skipFinalSnapshot

skipFinalSnapshot?: pulumi.Input<boolean>;

Determines whether a final DB snapshot is created before the DB cluster is deleted. If true is specified, no DB snapshot is created. If false is specified, a DB snapshot is created before the DB cluster is deleted, using the value from finalSnapshotIdentifier. Default is false.

property snapshotIdentifier

snapshotIdentifier?: pulumi.Input<string>;

Specifies whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a DB cluster snapshot, or the ARN when specifying a DB snapshot.

property storageEncrypted

storageEncrypted?: pulumi.Input<boolean>;

Specifies whether the DB cluster is encrypted. The default is false.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A map of tags to assign to the DB cluster.

property vpcSecurityGroupIds

vpcSecurityGroupIds?: pulumi.Input<pulumi.Input<string>[]>;

List of VPC security groups to associate with the Cluster

interface SubnetGroupArgs

interface SubnetGroupArgs

The set of arguments for constructing a SubnetGroup resource.

property description

description?: pulumi.Input<string>;

The description of the docDB subnet group. Defaults to “Managed by Pulumi”.

property name

name?: pulumi.Input<string>;

The name of the docDB subnet group. If omitted, this provider will assign a random, unique name.

property namePrefix

namePrefix?: pulumi.Input<string>;

Creates a unique name beginning with the specified prefix. Conflicts with name.

property subnetIds

subnetIds: pulumi.Input<pulumi.Input<string>[]>;

A list of VPC subnet IDs.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A map of tags to assign to the resource.

interface SubnetGroupState

interface SubnetGroupState

Input properties used for looking up and filtering SubnetGroup resources.

property arn

arn?: pulumi.Input<string>;

The ARN of the docDB subnet group.

property description

description?: pulumi.Input<string>;

The description of the docDB subnet group. Defaults to “Managed by Pulumi”.

property name

name?: pulumi.Input<string>;

The name of the docDB subnet group. If omitted, this provider will assign a random, unique name.

property namePrefix

namePrefix?: pulumi.Input<string>;

Creates a unique name beginning with the specified prefix. Conflicts with name.

property subnetIds

subnetIds?: pulumi.Input<pulumi.Input<string>[]>;

A list of VPC subnet IDs.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A map of tags to assign to the resource.