1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. docdb
  6. DbInstance

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.86.0
published on Wednesday, Nov 18, 2026 by Pulumi
aws-native logo aws-native logo AWS Cloud Control

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.86.0
published on Wednesday, Nov 18, 2026 by Pulumi

    Resource Type definition for AWS::DocDB::DBInstance

    Create DbInstance Resource

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

    Constructor syntax

    new DbInstance(name: string, args: DbInstanceArgs, opts?: CustomResourceOptions);
    @overload
    def DbInstance(resource_name: str,
                   args: DbInstanceArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def DbInstance(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   db_cluster_identifier: Optional[str] = None,
                   db_instance_class: Optional[str] = None,
                   auto_minor_version_upgrade: Optional[bool] = None,
                   availability_zone: Optional[str] = None,
                   ca_certificate_identifier: Optional[str] = None,
                   certificate_rotation_restart: Optional[bool] = None,
                   db_instance_identifier: Optional[str] = None,
                   enable_performance_insights: Optional[bool] = None,
                   preferred_maintenance_window: Optional[str] = None,
                   tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewDbInstance(ctx *Context, name string, args DbInstanceArgs, opts ...ResourceOption) (*DbInstance, error)
    public DbInstance(string name, DbInstanceArgs args, CustomResourceOptions? opts = null)
    public DbInstance(String name, DbInstanceArgs args)
    public DbInstance(String name, DbInstanceArgs args, CustomResourceOptions options)
    
    type: aws-native:docdb:DbInstance
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "aws-native_docdb_db_instance" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args DbInstanceArgs
    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 DbInstanceArgs
    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 DbInstanceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DbInstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DbInstanceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    DbInstance Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The DbInstance resource accepts the following input properties:

    DbClusterIdentifier string
    The identifier of the cluster that the instance will belong to.
    DbInstanceClass string
    The compute and memory capacity of the instance; for example, db.m4.large . If you change the class of an instance there can be some interruption in the cluster's service.
    AutoMinorVersionUpgrade bool

    This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

    Default: false

    AvailabilityZone string

    The Amazon EC2 Availability Zone that the instance is created in.

    Default: A random, system-chosen Availability Zone in the endpoint's AWS Region .

    Example: us-east-1d

    CaCertificateIdentifier string
    The identifier of the CA certificate for this DB instance.
    CertificateRotationRestart bool

    Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate.

    By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted.

    Set this parameter only if you are not using SSL/TLS to connect to the DB instance.

    If you are using SSL/TLS to connect to the DB instance, see Updating Your Amazon DocumentDB TLS Certificates and Encrypting Data in Transit in the Amazon DocumentDB Developer Guide .

    DbInstanceIdentifier string

    The instance identifier. This parameter is stored as a lowercase string.

    Constraints:

    • Must contain from 1 to 63 letters, numbers, or hyphens.
    • The first character must be a letter.
    • Cannot end with a hyphen or contain two consecutive hyphens.

    Example: mydbinstance

    EnablePerformanceInsights bool
    A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights .
    PreferredMaintenanceWindow string

    The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).

    Format: ddd:hh24:mi-ddd:hh24:mi

    The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region , occurring on a random day of the week.

    Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

    Constraints: Minimum 30-minute window.

    Tags List<Pulumi.AwsNative.Inputs.Tag>
    The tags to be assigned to the instance. You can assign up to 10 tags to an instance.
    DbClusterIdentifier string
    The identifier of the cluster that the instance will belong to.
    DbInstanceClass string
    The compute and memory capacity of the instance; for example, db.m4.large . If you change the class of an instance there can be some interruption in the cluster's service.
    AutoMinorVersionUpgrade bool

    This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

    Default: false

    AvailabilityZone string

    The Amazon EC2 Availability Zone that the instance is created in.

    Default: A random, system-chosen Availability Zone in the endpoint's AWS Region .

    Example: us-east-1d

    CaCertificateIdentifier string
    The identifier of the CA certificate for this DB instance.
    CertificateRotationRestart bool

    Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate.

    By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted.

    Set this parameter only if you are not using SSL/TLS to connect to the DB instance.

    If you are using SSL/TLS to connect to the DB instance, see Updating Your Amazon DocumentDB TLS Certificates and Encrypting Data in Transit in the Amazon DocumentDB Developer Guide .

    DbInstanceIdentifier string

    The instance identifier. This parameter is stored as a lowercase string.

    Constraints:

    • Must contain from 1 to 63 letters, numbers, or hyphens.
    • The first character must be a letter.
    • Cannot end with a hyphen or contain two consecutive hyphens.

    Example: mydbinstance

    EnablePerformanceInsights bool
    A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights .
    PreferredMaintenanceWindow string

    The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).

    Format: ddd:hh24:mi-ddd:hh24:mi

    The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region , occurring on a random day of the week.

    Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

    Constraints: Minimum 30-minute window.

    Tags TagArgs
    The tags to be assigned to the instance. You can assign up to 10 tags to an instance.
    db_cluster_identifier string
    The identifier of the cluster that the instance will belong to.
    db_instance_class string
    The compute and memory capacity of the instance; for example, db.m4.large . If you change the class of an instance there can be some interruption in the cluster's service.
    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.

    Default: false

    availability_zone string

    The Amazon EC2 Availability Zone that the instance is created in.

    Default: A random, system-chosen Availability Zone in the endpoint's AWS Region .

    Example: us-east-1d

    ca_certificate_identifier string
    The identifier of the CA certificate for this DB instance.
    certificate_rotation_restart bool

    Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate.

    By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted.

    Set this parameter only if you are not using SSL/TLS to connect to the DB instance.

    If you are using SSL/TLS to connect to the DB instance, see Updating Your Amazon DocumentDB TLS Certificates and Encrypting Data in Transit in the Amazon DocumentDB Developer Guide .

    db_instance_identifier string

    The instance identifier. This parameter is stored as a lowercase string.

    Constraints:

    • Must contain from 1 to 63 letters, numbers, or hyphens.
    • The first character must be a letter.
    • Cannot end with a hyphen or contain two consecutive hyphens.

    Example: mydbinstance

    enable_performance_insights bool
    A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights .
    preferred_maintenance_window string

    The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).

    Format: ddd:hh24:mi-ddd:hh24:mi

    The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region , occurring on a random day of the week.

    Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

    Constraints: Minimum 30-minute window.

    tags list(object)
    The tags to be assigned to the instance. You can assign up to 10 tags to an instance.
    dbClusterIdentifier String
    The identifier of the cluster that the instance will belong to.
    dbInstanceClass String
    The compute and memory capacity of the instance; for example, db.m4.large . If you change the class of an instance there can be some interruption in the cluster's service.
    autoMinorVersionUpgrade Boolean

    This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

    Default: false

    availabilityZone String

    The Amazon EC2 Availability Zone that the instance is created in.

    Default: A random, system-chosen Availability Zone in the endpoint's AWS Region .

    Example: us-east-1d

    caCertificateIdentifier String
    The identifier of the CA certificate for this DB instance.
    certificateRotationRestart Boolean

    Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate.

    By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted.

    Set this parameter only if you are not using SSL/TLS to connect to the DB instance.

    If you are using SSL/TLS to connect to the DB instance, see Updating Your Amazon DocumentDB TLS Certificates and Encrypting Data in Transit in the Amazon DocumentDB Developer Guide .

    dbInstanceIdentifier String

    The instance identifier. This parameter is stored as a lowercase string.

    Constraints:

    • Must contain from 1 to 63 letters, numbers, or hyphens.
    • The first character must be a letter.
    • Cannot end with a hyphen or contain two consecutive hyphens.

    Example: mydbinstance

    enablePerformanceInsights Boolean
    A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights .
    preferredMaintenanceWindow String

    The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).

    Format: ddd:hh24:mi-ddd:hh24:mi

    The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region , occurring on a random day of the week.

    Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

    Constraints: Minimum 30-minute window.

    tags List<Tag>
    The tags to be assigned to the instance. You can assign up to 10 tags to an instance.
    dbClusterIdentifier string
    The identifier of the cluster that the instance will belong to.
    dbInstanceClass string
    The compute and memory capacity of the instance; for example, db.m4.large . If you change the class of an instance there can be some interruption in the cluster's service.
    autoMinorVersionUpgrade boolean

    This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

    Default: false

    availabilityZone string

    The Amazon EC2 Availability Zone that the instance is created in.

    Default: A random, system-chosen Availability Zone in the endpoint's AWS Region .

    Example: us-east-1d

    caCertificateIdentifier string
    The identifier of the CA certificate for this DB instance.
    certificateRotationRestart boolean

    Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate.

    By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted.

    Set this parameter only if you are not using SSL/TLS to connect to the DB instance.

    If you are using SSL/TLS to connect to the DB instance, see Updating Your Amazon DocumentDB TLS Certificates and Encrypting Data in Transit in the Amazon DocumentDB Developer Guide .

    dbInstanceIdentifier string

    The instance identifier. This parameter is stored as a lowercase string.

    Constraints:

    • Must contain from 1 to 63 letters, numbers, or hyphens.
    • The first character must be a letter.
    • Cannot end with a hyphen or contain two consecutive hyphens.

    Example: mydbinstance

    enablePerformanceInsights boolean
    A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights .
    preferredMaintenanceWindow string

    The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).

    Format: ddd:hh24:mi-ddd:hh24:mi

    The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region , occurring on a random day of the week.

    Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

    Constraints: Minimum 30-minute window.

    tags Tag[]
    The tags to be assigned to the instance. You can assign up to 10 tags to an instance.
    db_cluster_identifier str
    The identifier of the cluster that the instance will belong to.
    db_instance_class str
    The compute and memory capacity of the instance; for example, db.m4.large . If you change the class of an instance there can be some interruption in the cluster's service.
    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.

    Default: false

    availability_zone str

    The Amazon EC2 Availability Zone that the instance is created in.

    Default: A random, system-chosen Availability Zone in the endpoint's AWS Region .

    Example: us-east-1d

    ca_certificate_identifier str
    The identifier of the CA certificate for this DB instance.
    certificate_rotation_restart bool

    Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate.

    By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted.

    Set this parameter only if you are not using SSL/TLS to connect to the DB instance.

    If you are using SSL/TLS to connect to the DB instance, see Updating Your Amazon DocumentDB TLS Certificates and Encrypting Data in Transit in the Amazon DocumentDB Developer Guide .

    db_instance_identifier str

    The instance identifier. This parameter is stored as a lowercase string.

    Constraints:

    • Must contain from 1 to 63 letters, numbers, or hyphens.
    • The first character must be a letter.
    • Cannot end with a hyphen or contain two consecutive hyphens.

    Example: mydbinstance

    enable_performance_insights bool
    A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights .
    preferred_maintenance_window str

    The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).

    Format: ddd:hh24:mi-ddd:hh24:mi

    The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region , occurring on a random day of the week.

    Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

    Constraints: Minimum 30-minute window.

    tags Sequence[TagArgs]
    The tags to be assigned to the instance. You can assign up to 10 tags to an instance.
    dbClusterIdentifier String
    The identifier of the cluster that the instance will belong to.
    dbInstanceClass String
    The compute and memory capacity of the instance; for example, db.m4.large . If you change the class of an instance there can be some interruption in the cluster's service.
    autoMinorVersionUpgrade Boolean

    This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

    Default: false

    availabilityZone String

    The Amazon EC2 Availability Zone that the instance is created in.

    Default: A random, system-chosen Availability Zone in the endpoint's AWS Region .

    Example: us-east-1d

    caCertificateIdentifier String
    The identifier of the CA certificate for this DB instance.
    certificateRotationRestart Boolean

    Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate.

    By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted.

    Set this parameter only if you are not using SSL/TLS to connect to the DB instance.

    If you are using SSL/TLS to connect to the DB instance, see Updating Your Amazon DocumentDB TLS Certificates and Encrypting Data in Transit in the Amazon DocumentDB Developer Guide .

    dbInstanceIdentifier String

    The instance identifier. This parameter is stored as a lowercase string.

    Constraints:

    • Must contain from 1 to 63 letters, numbers, or hyphens.
    • The first character must be a letter.
    • Cannot end with a hyphen or contain two consecutive hyphens.

    Example: mydbinstance

    enablePerformanceInsights Boolean
    A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights .
    preferredMaintenanceWindow String

    The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).

    Format: ddd:hh24:mi-ddd:hh24:mi

    The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region , occurring on a random day of the week.

    Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

    Constraints: Minimum 30-minute window.

    tags List<Property Map>
    The tags to be assigned to the instance. You can assign up to 10 tags to an instance.

    Outputs

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

    Endpoint string
    The connection endpoint for the instance. For example: sample-cluster.cluster-abcdefghijkl.us-east-1.docdb.amazonaws.com .
    Id string
    The provider-assigned unique ID for this managed resource.
    Port string
    The port number on which the database accepts connections, such as 27017 .
    Endpoint string
    The connection endpoint for the instance. For example: sample-cluster.cluster-abcdefghijkl.us-east-1.docdb.amazonaws.com .
    Id string
    The provider-assigned unique ID for this managed resource.
    Port string
    The port number on which the database accepts connections, such as 27017 .
    endpoint string
    The connection endpoint for the instance. For example: sample-cluster.cluster-abcdefghijkl.us-east-1.docdb.amazonaws.com .
    id string
    The provider-assigned unique ID for this managed resource.
    port string
    The port number on which the database accepts connections, such as 27017 .
    endpoint String
    The connection endpoint for the instance. For example: sample-cluster.cluster-abcdefghijkl.us-east-1.docdb.amazonaws.com .
    id String
    The provider-assigned unique ID for this managed resource.
    port String
    The port number on which the database accepts connections, such as 27017 .
    endpoint string
    The connection endpoint for the instance. For example: sample-cluster.cluster-abcdefghijkl.us-east-1.docdb.amazonaws.com .
    id string
    The provider-assigned unique ID for this managed resource.
    port string
    The port number on which the database accepts connections, such as 27017 .
    endpoint str
    The connection endpoint for the instance. For example: sample-cluster.cluster-abcdefghijkl.us-east-1.docdb.amazonaws.com .
    id str
    The provider-assigned unique ID for this managed resource.
    port str
    The port number on which the database accepts connections, such as 27017 .
    endpoint String
    The connection endpoint for the instance. For example: sample-cluster.cluster-abcdefghijkl.us-east-1.docdb.amazonaws.com .
    id String
    The provider-assigned unique ID for this managed resource.
    port String
    The port number on which the database accepts connections, such as 27017 .

    Look up Existing DbInstance Resource

    Get an existing DbInstance 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>, opts?: CustomResourceOptions): DbInstance
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None) -> DbInstance
    func GetDbInstance(ctx *Context, name string, id IDInput, state *DbInstanceState, opts ...ResourceOption) (*DbInstance, error)
    public static DbInstance Get(string name, Input<string> id, CustomResourceOptions? opts = null)
    public static DbInstance get(String name, Output<String> id, CustomResourceOptions options)
    resources:  existingDbInstance:    type: aws-native:docdb:DbInstance    get:      id: ${id}
    import {
      to = aws-native_docdb_db_instance.example
      id = "${id}"
    }
    
    name string
    The unique name of the resulting resource.
    id Input<ID>
    The unique provider ID of the resource to look up.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resulting resource.
    id str
    The unique provider ID of the resource to look up.
    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 resulting resource.
    id IDInput
    The unique provider ID of the resource to look up.
    state DbInstanceState
    Pass nil. This resource has no state arguments.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resulting resource.
    id Input<string>
    The unique provider ID of the resource to look up.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resulting resource.
    id Output<String>
    The unique provider ID of the resource to look up.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Supporting Types

    Tag, TagArgs

    A set of tags to apply to the resource.

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo aws-native logo AWS Cloud Control

    We recommend new projects start with resources from the AWS provider.

    Viewing docs for AWS Cloud Control v1.86.0
    published on Wednesday, Nov 18, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial