Docs Packages
  1. Packages
  2. AWS Classic
  3. API Docs
  4. docdb
  5. ClusterInstance

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.13.1 published on Tuesday, Dec 5, 2023 by Pulumi
pulumi/pulumi-aws

aws.docdb.ClusterInstance

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.13.1 published on Tuesday, Dec 5, 2023 by Pulumi
pulumi/pulumi-aws

    Provides an DocumentDB Cluster Resource Instance. A Cluster Instance Resource defines attributes that are specific to a single instance in a [DocumentDB Cluster][1].

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

    Example Usage

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

return await Deployment.RunAsync(() => 
{
    var @default = new Aws.DocDB.Cluster("default", new()
    {
        ClusterIdentifier = "docdb-cluster-demo",
        AvailabilityZones = new[]
        {
            "us-west-2a",
            "us-west-2b",
            "us-west-2c",
        },
        MasterUsername = "foo",
        MasterPassword = "barbut8chars",
    });

    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()
        {
            Identifier = $"docdb-cluster-demo-{range.Value}",
            ClusterIdentifier = @default.Id,
            InstanceClass = "db.r5.large",
        }));
    }
});

    package main

import (
	"fmt"

	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/docdb"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := docdb.NewCluster(ctx, "default", &docdb.ClusterArgs{
			ClusterIdentifier: pulumi.String("docdb-cluster-demo"),
			AvailabilityZones: pulumi.StringArray{
				pulumi.String("us-west-2a"),
				pulumi.String("us-west-2b"),
				pulumi.String("us-west-2c"),
			},
			MasterUsername: pulumi.String("foo"),
			MasterPassword: pulumi.String("barbut8chars"),
		})
		if err != nil {
			return err
		}
		var clusterInstances []*docdb.ClusterInstance
		for index := 0; index < 2; index++ {
			key0 := index
			val0 := index
			__res, err := docdb.NewClusterInstance(ctx, fmt.Sprintf("clusterInstances-%v", key0), &docdb.ClusterInstanceArgs{
				Identifier:        pulumi.String(fmt.Sprintf("docdb-cluster-demo-%v", val0)),
				ClusterIdentifier: _default.ID(),
				InstanceClass:     pulumi.String("db.r5.large"),
			})
			if err != nil {
				return err
			}
			clusterInstances = append(clusterInstances, __res)
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.docdb.Cluster;
import com.pulumi.aws.docdb.ClusterArgs;
import com.pulumi.aws.docdb.ClusterInstance;
import com.pulumi.aws.docdb.ClusterInstanceArgs;
import com.pulumi.codegen.internal.KeyedValue;
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 default_ = new Cluster("default", ClusterArgs.builder()        
            .clusterIdentifier("docdb-cluster-demo")
            .availabilityZones(            
                "us-west-2a",
                "us-west-2b",
                "us-west-2c")
            .masterUsername("foo")
            .masterPassword("barbut8chars")
            .build());

        for (var i = 0; i < 2; i++) {
            new ClusterInstance("clusterInstances-" + i, ClusterInstanceArgs.builder()            
                .identifier(String.format("docdb-cluster-demo-%s", range.value()))
                .clusterIdentifier(default_.id())
                .instanceClass("db.r5.large")
                .build());

        
}
    }
}

    import pulumi
import pulumi_aws as aws

default = aws.docdb.Cluster("default",
    cluster_identifier="docdb-cluster-demo",
    availability_zones=[
        "us-west-2a",
        "us-west-2b",
        "us-west-2c",
    ],
    master_username="foo",
    master_password="barbut8chars")
cluster_instances = []
for range in [{"value": i} for i in range(0, 2)]:
    cluster_instances.append(aws.docdb.ClusterInstance(f"clusterInstances-{range['value']}",
        identifier=f"docdb-cluster-demo-{range['value']}",
        cluster_identifier=default.id,
        instance_class="db.r5.large"))

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

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

    resources:
  clusterInstances:
    type: aws:docdb:ClusterInstance
    properties:
      identifier: docdb-cluster-demo-${range.value}
      clusterIdentifier: ${default.id}
      instanceClass: db.r5.large
    options: {}
  default:
    type: aws:docdb:Cluster
    properties:
      clusterIdentifier: docdb-cluster-demo
      availabilityZones:
        - us-west-2a
        - us-west-2b
        - us-west-2c
      masterUsername: foo
      masterPassword: barbut8chars

    Create ClusterInstance Resource

    new ClusterInstance(name: string, args: ClusterInstanceArgs, opts?: CustomResourceOptions);
    @overload
def ClusterInstance(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    apply_immediately: Optional[bool] = None,
                    auto_minor_version_upgrade: Optional[bool] = None,
                    availability_zone: Optional[str] = None,
                    ca_cert_identifier: Optional[str] = None,
                    cluster_identifier: Optional[str] = None,
                    copy_tags_to_snapshot: Optional[bool] = None,
                    enable_performance_insights: Optional[bool] = None,
                    engine: Optional[str] = None,
                    identifier: Optional[str] = None,
                    identifier_prefix: Optional[str] = None,
                    instance_class: Optional[str] = None,
                    performance_insights_kms_key_id: Optional[str] = None,
                    preferred_maintenance_window: Optional[str] = None,
                    promotion_tier: Optional[int] = None,
                    tags: Optional[Mapping[str, str]] = None)
@overload
def ClusterInstance(resource_name: str,
                    args: ClusterInstanceArgs,
                    opts: Optional[ResourceOptions] = None)
    func NewClusterInstance(ctx *Context, name string, args ClusterInstanceArgs, opts ...ResourceOption) (*ClusterInstance, error)
    public ClusterInstance(string name, ClusterInstanceArgs args, CustomResourceOptions? opts = null)
    public ClusterInstance(String name, ClusterInstanceArgs args)
public ClusterInstance(String name, ClusterInstanceArgs args, CustomResourceOptions options)

    type: aws:docdb:ClusterInstance
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ClusterInstanceArgs
    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 ClusterInstanceArgs
    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 ClusterInstanceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ClusterInstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ClusterInstanceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    ClusterIdentifier string

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

    InstanceClass string

    The instance class to use. For details on CPU and memory, see Scaling for DocumentDB Instances. DocumentDB currently supports the below instance classes. Please see AWS Documentation for complete details.

    • db.r6g.large
    • db.r6g.xlarge
    • db.r6g.2xlarge
    • db.r6g.4xlarge
    • db.r6g.8xlarge
    • db.r6g.12xlarge
    • db.r6g.16xlarge
    • db.r5.large
    • db.r5.xlarge
    • db.r5.2xlarge
    • db.r5.4xlarge
    • db.r5.12xlarge
    • db.r5.24xlarge
    • db.r4.large
    • db.r4.xlarge
    • db.r4.2xlarge
    • db.r4.4xlarge
    • db.r4.8xlarge
    • db.r4.16xlarge
    • db.t4g.medium
    • db.t3.medium
    ApplyImmediately bool

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

    AutoMinorVersionUpgrade bool

    This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set (see docs). Default true.

    AvailabilityZone string

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

    CaCertIdentifier string

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

    CopyTagsToSnapshot bool

    Copy all DB instance tags to snapshots. Default is false.

    EnablePerformanceInsights bool

    A value that indicates whether to enable Performance Insights for the DB Instance. Default false. See [docs] (https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html) about the details.

    Engine string

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

    Identifier string

    The identifier for the DocumentDB instance, if omitted, the provider will assign a random, unique identifier.

    IdentifierPrefix string

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

    PerformanceInsightsKmsKeyId string

    The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon DocumentDB uses your default KMS key.

    PreferredMaintenanceWindow string

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

    PromotionTier int

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

    Tags Dictionary<string, string>

    A map of tags to assign to the instance. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    ClusterIdentifier string

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

    InstanceClass string

    The instance class to use. For details on CPU and memory, see Scaling for DocumentDB Instances. DocumentDB currently supports the below instance classes. Please see AWS Documentation for complete details.

    • db.r6g.large
    • db.r6g.xlarge
    • db.r6g.2xlarge
    • db.r6g.4xlarge
    • db.r6g.8xlarge
    • db.r6g.12xlarge
    • db.r6g.16xlarge
    • db.r5.large
    • db.r5.xlarge
    • db.r5.2xlarge
    • db.r5.4xlarge
    • db.r5.12xlarge
    • db.r5.24xlarge
    • db.r4.large
    • db.r4.xlarge
    • db.r4.2xlarge
    • db.r4.4xlarge
    • db.r4.8xlarge
    • db.r4.16xlarge
    • db.t4g.medium
    • db.t3.medium
    ApplyImmediately bool

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

    AutoMinorVersionUpgrade bool

    This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set (see docs). Default true.

    AvailabilityZone string

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

    CaCertIdentifier string

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

    CopyTagsToSnapshot bool

    Copy all DB instance tags to snapshots. Default is false.

    EnablePerformanceInsights bool

    A value that indicates whether to enable Performance Insights for the DB Instance. Default false. See [docs] (https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html) about the details.

    Engine string

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

    Identifier string

    The identifier for the DocumentDB instance, if omitted, the provider will assign a random, unique identifier.

    IdentifierPrefix string

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

    PerformanceInsightsKmsKeyId string

    The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon DocumentDB uses your default KMS key.

    PreferredMaintenanceWindow string

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

    PromotionTier int

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

    Tags map[string]string

    A map of tags to assign to the instance. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    clusterIdentifier String

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

    instanceClass String

    The instance class to use. For details on CPU and memory, see Scaling for DocumentDB Instances. DocumentDB currently supports the below instance classes. Please see AWS Documentation for complete details.

    • db.r6g.large
    • db.r6g.xlarge
    • db.r6g.2xlarge
    • db.r6g.4xlarge
    • db.r6g.8xlarge
    • db.r6g.12xlarge
    • db.r6g.16xlarge
    • db.r5.large
    • db.r5.xlarge
    • db.r5.2xlarge
    • db.r5.4xlarge
    • db.r5.12xlarge
    • db.r5.24xlarge
    • db.r4.large
    • db.r4.xlarge
    • db.r4.2xlarge
    • db.r4.4xlarge
    • db.r4.8xlarge
    • db.r4.16xlarge
    • db.t4g.medium
    • db.t3.medium
    applyImmediately Boolean

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

    autoMinorVersionUpgrade Boolean

    This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set (see docs). Default true.

    availabilityZone String

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

    caCertIdentifier String

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

    copyTagsToSnapshot Boolean

    Copy all DB instance tags to snapshots. Default is false.

    enablePerformanceInsights Boolean

    A value that indicates whether to enable Performance Insights for the DB Instance. Default false. See [docs] (https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html) about the details.

    engine String

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

    identifier String

    The identifier for the DocumentDB instance, if omitted, the provider will assign a random, unique identifier.

    identifierPrefix String

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

    performanceInsightsKmsKeyId String

    The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon DocumentDB uses your default KMS key.

    preferredMaintenanceWindow String

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

    promotionTier Integer

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

    tags Map<String,String>

    A map of tags to assign to the instance. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    clusterIdentifier string

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

    instanceClass string

    The instance class to use. For details on CPU and memory, see Scaling for DocumentDB Instances. DocumentDB currently supports the below instance classes. Please see AWS Documentation for complete details.

    • db.r6g.large
    • db.r6g.xlarge
    • db.r6g.2xlarge
    • db.r6g.4xlarge
    • db.r6g.8xlarge
    • db.r6g.12xlarge
    • db.r6g.16xlarge
    • db.r5.large
    • db.r5.xlarge
    • db.r5.2xlarge
    • db.r5.4xlarge
    • db.r5.12xlarge
    • db.r5.24xlarge
    • db.r4.large
    • db.r4.xlarge
    • db.r4.2xlarge
    • db.r4.4xlarge
    • db.r4.8xlarge
    • db.r4.16xlarge
    • db.t4g.medium
    • db.t3.medium
    applyImmediately boolean

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

    autoMinorVersionUpgrade boolean

    This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set (see docs). Default true.

    availabilityZone string

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

    caCertIdentifier string

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

    copyTagsToSnapshot boolean

    Copy all DB instance tags to snapshots. Default is false.

    enablePerformanceInsights boolean

    A value that indicates whether to enable Performance Insights for the DB Instance. Default false. See [docs] (https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html) about the details.

    engine string

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

    identifier string

    The identifier for the DocumentDB instance, if omitted, the provider will assign a random, unique identifier.

    identifierPrefix string

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

    performanceInsightsKmsKeyId string

    The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon DocumentDB uses your default KMS key.

    preferredMaintenanceWindow string

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

    promotionTier number

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

    tags {[key: string]: string}

    A map of tags to assign to the instance. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    cluster_identifier str

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

    instance_class str

    The instance class to use. For details on CPU and memory, see Scaling for DocumentDB Instances. DocumentDB currently supports the below instance classes. Please see AWS Documentation for complete details.

    • db.r6g.large
    • db.r6g.xlarge
    • db.r6g.2xlarge
    • db.r6g.4xlarge
    • db.r6g.8xlarge
    • db.r6g.12xlarge
    • db.r6g.16xlarge
    • db.r5.large
    • db.r5.xlarge
    • db.r5.2xlarge
    • db.r5.4xlarge
    • db.r5.12xlarge
    • db.r5.24xlarge
    • db.r4.large
    • db.r4.xlarge
    • db.r4.2xlarge
    • db.r4.4xlarge
    • db.r4.8xlarge
    • db.r4.16xlarge
    • db.t4g.medium
    • db.t3.medium
    apply_immediately bool

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

    auto_minor_version_upgrade bool

    This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set (see docs). Default true.

    availability_zone str

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

    ca_cert_identifier str

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

    copy_tags_to_snapshot bool

    Copy all DB instance tags to snapshots. Default is false.

    enable_performance_insights bool

    A value that indicates whether to enable Performance Insights for the DB Instance. Default false. See [docs] (https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html) about the details.

    engine str

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

    identifier str

    The identifier for the DocumentDB instance, if omitted, the provider will assign a random, unique identifier.

    identifier_prefix str

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

    performance_insights_kms_key_id str

    The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon DocumentDB uses your default KMS key.

    preferred_maintenance_window str

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

    promotion_tier int

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

    tags Mapping[str, str]

    A map of tags to assign to the instance. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    clusterIdentifier String

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

    instanceClass String

    The instance class to use. For details on CPU and memory, see Scaling for DocumentDB Instances. DocumentDB currently supports the below instance classes. Please see AWS Documentation for complete details.

    • db.r6g.large
    • db.r6g.xlarge
    • db.r6g.2xlarge
    • db.r6g.4xlarge
    • db.r6g.8xlarge
    • db.r6g.12xlarge
    • db.r6g.16xlarge
    • db.r5.large
    • db.r5.xlarge
    • db.r5.2xlarge
    • db.r5.4xlarge
    • db.r5.12xlarge
    • db.r5.24xlarge
    • db.r4.large
    • db.r4.xlarge
    • db.r4.2xlarge
    • db.r4.4xlarge
    • db.r4.8xlarge
    • db.r4.16xlarge
    • db.t4g.medium
    • db.t3.medium
    applyImmediately Boolean

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

    autoMinorVersionUpgrade Boolean

    This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set (see docs). Default true.

    availabilityZone String

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

    caCertIdentifier String

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

    copyTagsToSnapshot Boolean

    Copy all DB instance tags to snapshots. Default is false.

    enablePerformanceInsights Boolean

    A value that indicates whether to enable Performance Insights for the DB Instance. Default false. See [docs] (https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html) about the details.

    engine String

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

    identifier String

    The identifier for the DocumentDB instance, if omitted, the provider will assign a random, unique identifier.

    identifierPrefix String

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

    performanceInsightsKmsKeyId String

    The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon DocumentDB uses your default KMS key.

    preferredMaintenanceWindow String

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

    promotionTier Number

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

    tags Map<String>

    A map of tags to assign to the instance. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

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

    Arn string

    Amazon Resource Name (ARN) of cluster instance

    DbSubnetGroupName string

    The DB subnet group to associate with this DB instance.

    DbiResourceId string

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

    Endpoint string

    The DNS address for this instance. May not be writable

    EngineVersion string

    The database engine version

    Id string

    The provider-assigned unique ID for this managed resource.

    KmsKeyId string

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

    Port int

    The database port

    PreferredBackupWindow string

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

    PubliclyAccessible bool
    StorageEncrypted bool

    Specifies whether the DB cluster is encrypted.

    TagsAll Dictionary<string, string>

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    Writer bool

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

    Arn string

    Amazon Resource Name (ARN) of cluster instance

    DbSubnetGroupName string

    The DB subnet group to associate with this DB instance.

    DbiResourceId string

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

    Endpoint string

    The DNS address for this instance. May not be writable

    EngineVersion string

    The database engine version

    Id string

    The provider-assigned unique ID for this managed resource.

    KmsKeyId string

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

    Port int

    The database port

    PreferredBackupWindow string

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

    PubliclyAccessible bool
    StorageEncrypted bool

    Specifies whether the DB cluster is encrypted.

    TagsAll map[string]string

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    Writer bool

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

    arn String

    Amazon Resource Name (ARN) of cluster instance

    dbSubnetGroupName String

    The DB subnet group to associate with this DB instance.

    dbiResourceId String

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

    endpoint String

    The DNS address for this instance. May not be writable

    engineVersion String

    The database engine version

    id String

    The provider-assigned unique ID for this managed resource.

    kmsKeyId String

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

    port Integer

    The database port

    preferredBackupWindow String

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

    publiclyAccessible Boolean
    storageEncrypted Boolean

    Specifies whether the DB cluster is encrypted.

    tagsAll Map<String,String>

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    writer Boolean

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

    arn string

    Amazon Resource Name (ARN) of cluster instance

    dbSubnetGroupName string

    The DB subnet group to associate with this DB instance.

    dbiResourceId string

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

    endpoint string

    The DNS address for this instance. May not be writable

    engineVersion string

    The database engine version

    id string

    The provider-assigned unique ID for this managed resource.

    kmsKeyId string

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

    port number

    The database port

    preferredBackupWindow string

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

    publiclyAccessible boolean
    storageEncrypted boolean

    Specifies whether the DB cluster is encrypted.

    tagsAll {[key: string]: string}

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    writer boolean

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

    arn str

    Amazon Resource Name (ARN) of cluster instance

    db_subnet_group_name str

    The DB subnet group to associate with this DB instance.

    dbi_resource_id str

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

    endpoint str

    The DNS address for this instance. May not be writable

    engine_version str

    The database engine version

    id str

    The provider-assigned unique ID for this managed resource.

    kms_key_id str

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

    port int

    The database port

    preferred_backup_window str

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

    publicly_accessible bool
    storage_encrypted bool

    Specifies whether the DB cluster is encrypted.

    tags_all Mapping[str, str]

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    writer bool

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

    arn String

    Amazon Resource Name (ARN) of cluster instance

    dbSubnetGroupName String

    The DB subnet group to associate with this DB instance.

    dbiResourceId String

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

    endpoint String

    The DNS address for this instance. May not be writable

    engineVersion String

    The database engine version

    id String

    The provider-assigned unique ID for this managed resource.

    kmsKeyId String

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

    port Number

    The database port

    preferredBackupWindow String

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

    publiclyAccessible Boolean
    storageEncrypted Boolean

    Specifies whether the DB cluster is encrypted.

    tagsAll Map<String>

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    writer Boolean

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

    Look up Existing ClusterInstance Resource

    Get an existing ClusterInstance 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?: ClusterInstanceState, opts?: CustomResourceOptions): ClusterInstance
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        apply_immediately: Optional[bool] = None,
        arn: Optional[str] = None,
        auto_minor_version_upgrade: Optional[bool] = None,
        availability_zone: Optional[str] = None,
        ca_cert_identifier: Optional[str] = None,
        cluster_identifier: Optional[str] = None,
        copy_tags_to_snapshot: Optional[bool] = None,
        db_subnet_group_name: Optional[str] = None,
        dbi_resource_id: Optional[str] = None,
        enable_performance_insights: Optional[bool] = None,
        endpoint: Optional[str] = None,
        engine: Optional[str] = None,
        engine_version: Optional[str] = None,
        identifier: Optional[str] = None,
        identifier_prefix: Optional[str] = None,
        instance_class: Optional[str] = None,
        kms_key_id: Optional[str] = None,
        performance_insights_kms_key_id: Optional[str] = None,
        port: Optional[int] = None,
        preferred_backup_window: Optional[str] = None,
        preferred_maintenance_window: Optional[str] = None,
        promotion_tier: Optional[int] = None,
        publicly_accessible: Optional[bool] = None,
        storage_encrypted: Optional[bool] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        writer: Optional[bool] = None) -> ClusterInstance
    func GetClusterInstance(ctx *Context, name string, id IDInput, state *ClusterInstanceState, opts ...ResourceOption) (*ClusterInstance, error)
    public static ClusterInstance Get(string name, Input<string> id, ClusterInstanceState? state, CustomResourceOptions? opts = null)
    public static ClusterInstance get(String name, Output<String> id, ClusterInstanceState 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:
    ApplyImmediately bool

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

    Arn string

    Amazon Resource Name (ARN) of cluster instance

    AutoMinorVersionUpgrade bool

    This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set (see docs). Default true.

    AvailabilityZone string

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

    CaCertIdentifier string

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

    ClusterIdentifier string

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

    CopyTagsToSnapshot bool

    Copy all DB instance tags to snapshots. Default is false.

    DbSubnetGroupName string

    The DB subnet group to associate with this DB instance.

    DbiResourceId string

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

    EnablePerformanceInsights bool

    A value that indicates whether to enable Performance Insights for the DB Instance. Default false. See [docs] (https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html) about the details.

    Endpoint string

    The DNS address for this instance. May not be writable

    Engine string

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

    EngineVersion string

    The database engine version

    Identifier string

    The identifier for the DocumentDB instance, if omitted, the provider will assign a random, unique identifier.

    IdentifierPrefix string

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

    InstanceClass string

    The instance class to use. For details on CPU and memory, see Scaling for DocumentDB Instances. DocumentDB currently supports the below instance classes. Please see AWS Documentation for complete details.

    • db.r6g.large
    • db.r6g.xlarge
    • db.r6g.2xlarge
    • db.r6g.4xlarge
    • db.r6g.8xlarge
    • db.r6g.12xlarge
    • db.r6g.16xlarge
    • db.r5.large
    • db.r5.xlarge
    • db.r5.2xlarge
    • db.r5.4xlarge
    • db.r5.12xlarge
    • db.r5.24xlarge
    • db.r4.large
    • db.r4.xlarge
    • db.r4.2xlarge
    • db.r4.4xlarge
    • db.r4.8xlarge
    • db.r4.16xlarge
    • db.t4g.medium
    • db.t3.medium
    KmsKeyId string

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

    PerformanceInsightsKmsKeyId string

    The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon DocumentDB uses your default KMS key.

    Port int

    The database port

    PreferredBackupWindow string

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

    PreferredMaintenanceWindow string

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

    PromotionTier int

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

    PubliclyAccessible bool
    StorageEncrypted bool

    Specifies whether the DB cluster is encrypted.

    Tags Dictionary<string, string>

    A map of tags to assign to the instance. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    TagsAll Dictionary<string, string>

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    Writer bool

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

    ApplyImmediately bool

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

    Arn string

    Amazon Resource Name (ARN) of cluster instance

    AutoMinorVersionUpgrade bool

    This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set (see docs). Default true.

    AvailabilityZone string

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

    CaCertIdentifier string

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

    ClusterIdentifier string

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

    CopyTagsToSnapshot bool

    Copy all DB instance tags to snapshots. Default is false.

    DbSubnetGroupName string

    The DB subnet group to associate with this DB instance.

    DbiResourceId string

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

    EnablePerformanceInsights bool

    A value that indicates whether to enable Performance Insights for the DB Instance. Default false. See [docs] (https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html) about the details.

    Endpoint string

    The DNS address for this instance. May not be writable

    Engine string

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

    EngineVersion string

    The database engine version

    Identifier string

    The identifier for the DocumentDB instance, if omitted, the provider will assign a random, unique identifier.

    IdentifierPrefix string

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

    InstanceClass string

    The instance class to use. For details on CPU and memory, see Scaling for DocumentDB Instances. DocumentDB currently supports the below instance classes. Please see AWS Documentation for complete details.

    • db.r6g.large
    • db.r6g.xlarge
    • db.r6g.2xlarge
    • db.r6g.4xlarge
    • db.r6g.8xlarge
    • db.r6g.12xlarge
    • db.r6g.16xlarge
    • db.r5.large
    • db.r5.xlarge
    • db.r5.2xlarge
    • db.r5.4xlarge
    • db.r5.12xlarge
    • db.r5.24xlarge
    • db.r4.large
    • db.r4.xlarge
    • db.r4.2xlarge
    • db.r4.4xlarge
    • db.r4.8xlarge
    • db.r4.16xlarge
    • db.t4g.medium
    • db.t3.medium
    KmsKeyId string

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

    PerformanceInsightsKmsKeyId string

    The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon DocumentDB uses your default KMS key.

    Port int

    The database port

    PreferredBackupWindow string

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

    PreferredMaintenanceWindow string

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

    PromotionTier int

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

    PubliclyAccessible bool
    StorageEncrypted bool

    Specifies whether the DB cluster is encrypted.

    Tags map[string]string

    A map of tags to assign to the instance. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    TagsAll map[string]string

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    Writer bool

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

    applyImmediately Boolean

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

    arn String

    Amazon Resource Name (ARN) of cluster instance

    autoMinorVersionUpgrade Boolean

    This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set (see docs). Default true.

    availabilityZone String

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

    caCertIdentifier String

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

    clusterIdentifier String

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

    copyTagsToSnapshot Boolean

    Copy all DB instance tags to snapshots. Default is false.

    dbSubnetGroupName String

    The DB subnet group to associate with this DB instance.

    dbiResourceId String

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

    enablePerformanceInsights Boolean

    A value that indicates whether to enable Performance Insights for the DB Instance. Default false. See [docs] (https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html) about the details.

    endpoint String

    The DNS address for this instance. May not be writable

    engine String

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

    engineVersion String

    The database engine version

    identifier String

    The identifier for the DocumentDB instance, if omitted, the provider will assign a random, unique identifier.

    identifierPrefix String

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

    instanceClass String

    The instance class to use. For details on CPU and memory, see Scaling for DocumentDB Instances. DocumentDB currently supports the below instance classes. Please see AWS Documentation for complete details.

    • db.r6g.large
    • db.r6g.xlarge
    • db.r6g.2xlarge
    • db.r6g.4xlarge
    • db.r6g.8xlarge
    • db.r6g.12xlarge
    • db.r6g.16xlarge
    • db.r5.large
    • db.r5.xlarge
    • db.r5.2xlarge
    • db.r5.4xlarge
    • db.r5.12xlarge
    • db.r5.24xlarge
    • db.r4.large
    • db.r4.xlarge
    • db.r4.2xlarge
    • db.r4.4xlarge
    • db.r4.8xlarge
    • db.r4.16xlarge
    • db.t4g.medium
    • db.t3.medium
    kmsKeyId String

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

    performanceInsightsKmsKeyId String

    The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon DocumentDB uses your default KMS key.

    port Integer

    The database port

    preferredBackupWindow String

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

    preferredMaintenanceWindow String

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

    promotionTier Integer

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

    publiclyAccessible Boolean
    storageEncrypted Boolean

    Specifies whether the DB cluster is encrypted.

    tags Map<String,String>

    A map of tags to assign to the instance. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    tagsAll Map<String,String>

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    writer Boolean

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

    applyImmediately boolean

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

    arn string

    Amazon Resource Name (ARN) of cluster instance

    autoMinorVersionUpgrade boolean

    This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set (see docs). Default true.

    availabilityZone string

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

    caCertIdentifier string

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

    clusterIdentifier string

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

    copyTagsToSnapshot boolean

    Copy all DB instance tags to snapshots. Default is false.

    dbSubnetGroupName string

    The DB subnet group to associate with this DB instance.

    dbiResourceId string

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

    enablePerformanceInsights boolean

    A value that indicates whether to enable Performance Insights for the DB Instance. Default false. See [docs] (https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html) about the details.

    endpoint string

    The DNS address for this instance. May not be writable

    engine string

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

    engineVersion string

    The database engine version

    identifier string

    The identifier for the DocumentDB instance, if omitted, the provider will assign a random, unique identifier.

    identifierPrefix string

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

    instanceClass string

    The instance class to use. For details on CPU and memory, see Scaling for DocumentDB Instances. DocumentDB currently supports the below instance classes. Please see AWS Documentation for complete details.

    • db.r6g.large
    • db.r6g.xlarge
    • db.r6g.2xlarge
    • db.r6g.4xlarge
    • db.r6g.8xlarge
    • db.r6g.12xlarge
    • db.r6g.16xlarge
    • db.r5.large
    • db.r5.xlarge
    • db.r5.2xlarge
    • db.r5.4xlarge
    • db.r5.12xlarge
    • db.r5.24xlarge
    • db.r4.large
    • db.r4.xlarge
    • db.r4.2xlarge
    • db.r4.4xlarge
    • db.r4.8xlarge
    • db.r4.16xlarge
    • db.t4g.medium
    • db.t3.medium
    kmsKeyId string

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

    performanceInsightsKmsKeyId string

    The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon DocumentDB uses your default KMS key.

    port number

    The database port

    preferredBackupWindow string

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

    preferredMaintenanceWindow string

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

    promotionTier number

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

    publiclyAccessible boolean
    storageEncrypted boolean

    Specifies whether the DB cluster is encrypted.

    tags {[key: string]: string}

    A map of tags to assign to the instance. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    tagsAll {[key: string]: string}

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    writer boolean

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

    apply_immediately bool

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

    arn str

    Amazon Resource Name (ARN) of cluster instance

    auto_minor_version_upgrade bool

    This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set (see docs). Default true.

    availability_zone str

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

    ca_cert_identifier str

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

    cluster_identifier str

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

    copy_tags_to_snapshot bool

    Copy all DB instance tags to snapshots. Default is false.

    db_subnet_group_name str

    The DB subnet group to associate with this DB instance.

    dbi_resource_id str

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

    enable_performance_insights bool

    A value that indicates whether to enable Performance Insights for the DB Instance. Default false. See [docs] (https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html) about the details.

    endpoint str

    The DNS address for this instance. May not be writable

    engine str

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

    engine_version str

    The database engine version

    identifier str

    The identifier for the DocumentDB instance, if omitted, the provider will assign a random, unique identifier.

    identifier_prefix str

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

    instance_class str

    The instance class to use. For details on CPU and memory, see Scaling for DocumentDB Instances. DocumentDB currently supports the below instance classes. Please see AWS Documentation for complete details.

    • db.r6g.large
    • db.r6g.xlarge
    • db.r6g.2xlarge
    • db.r6g.4xlarge
    • db.r6g.8xlarge
    • db.r6g.12xlarge
    • db.r6g.16xlarge
    • db.r5.large
    • db.r5.xlarge
    • db.r5.2xlarge
    • db.r5.4xlarge
    • db.r5.12xlarge
    • db.r5.24xlarge
    • db.r4.large
    • db.r4.xlarge
    • db.r4.2xlarge
    • db.r4.4xlarge
    • db.r4.8xlarge
    • db.r4.16xlarge
    • db.t4g.medium
    • db.t3.medium
    kms_key_id str

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

    performance_insights_kms_key_id str

    The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon DocumentDB uses your default KMS key.

    port int

    The database port

    preferred_backup_window str

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

    preferred_maintenance_window str

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

    promotion_tier int

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

    publicly_accessible bool
    storage_encrypted bool

    Specifies whether the DB cluster is encrypted.

    tags Mapping[str, str]

    A map of tags to assign to the instance. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    tags_all Mapping[str, str]

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    writer bool

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

    applyImmediately Boolean

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

    arn String

    Amazon Resource Name (ARN) of cluster instance

    autoMinorVersionUpgrade Boolean

    This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set (see docs). Default true.

    availabilityZone String

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

    caCertIdentifier String

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

    clusterIdentifier String

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

    copyTagsToSnapshot Boolean

    Copy all DB instance tags to snapshots. Default is false.

    dbSubnetGroupName String

    The DB subnet group to associate with this DB instance.

    dbiResourceId String

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

    enablePerformanceInsights Boolean

    A value that indicates whether to enable Performance Insights for the DB Instance. Default false. See [docs] (https://docs.aws.amazon.com/documentdb/latest/developerguide/performance-insights.html) about the details.

    endpoint String

    The DNS address for this instance. May not be writable

    engine String

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

    engineVersion String

    The database engine version

    identifier String

    The identifier for the DocumentDB instance, if omitted, the provider will assign a random, unique identifier.

    identifierPrefix String

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

    instanceClass String

    The instance class to use. For details on CPU and memory, see Scaling for DocumentDB Instances. DocumentDB currently supports the below instance classes. Please see AWS Documentation for complete details.

    • db.r6g.large
    • db.r6g.xlarge
    • db.r6g.2xlarge
    • db.r6g.4xlarge
    • db.r6g.8xlarge
    • db.r6g.12xlarge
    • db.r6g.16xlarge
    • db.r5.large
    • db.r5.xlarge
    • db.r5.2xlarge
    • db.r5.4xlarge
    • db.r5.12xlarge
    • db.r5.24xlarge
    • db.r4.large
    • db.r4.xlarge
    • db.r4.2xlarge
    • db.r4.4xlarge
    • db.r4.8xlarge
    • db.r4.16xlarge
    • db.t4g.medium
    • db.t3.medium
    kmsKeyId String

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

    performanceInsightsKmsKeyId String

    The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon DocumentDB uses your default KMS key.

    port Number

    The database port

    preferredBackupWindow String

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

    preferredMaintenanceWindow String

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

    promotionTier Number

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

    publiclyAccessible Boolean
    storageEncrypted Boolean

    Specifies whether the DB cluster is encrypted.

    tags Map<String>

    A map of tags to assign to the instance. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    tagsAll Map<String>

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated:

    Please use tags instead.

    writer Boolean

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

    Import

    Using pulumi import, import DocumentDB Cluster Instances using the identifier. For example:

     $ pulumi import aws:docdb/clusterInstance:ClusterInstance prod_instance_1 aurora-cluster-instance-1

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the aws Terraform Provider.

    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.13.1 published on Tuesday, Dec 5, 2023 by Pulumi
    pulumi/pulumi-aws