We recommend new projects start with resources from the AWS provider.
published on Wednesday, Nov 18, 2026 by Pulumi
We recommend new projects start with resources from the AWS provider.
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:
- Db
Cluster stringIdentifier - The identifier of the cluster that the instance will belong to.
- Db
Instance stringClass - 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 boolVersion Upgrade 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 stringIdentifier - The identifier of the CA certificate for this DB instance.
- Certificate
Rotation boolRestart 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 stringIdentifier 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 boolInsights - A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights .
- Preferred
Maintenance stringWindow The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format:
ddd:hh24:mi-ddd:hh24:miThe 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.
-
List<Pulumi.
Aws Native. Inputs. Tag> - The tags to be assigned to the instance. You can assign up to 10 tags to an instance.
- Db
Cluster stringIdentifier - The identifier of the cluster that the instance will belong to.
- Db
Instance stringClass - 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 boolVersion Upgrade 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 stringIdentifier - The identifier of the CA certificate for this DB instance.
- Certificate
Rotation boolRestart 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 stringIdentifier 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 boolInsights - A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights .
- Preferred
Maintenance stringWindow The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format:
ddd:hh24:mi-ddd:hh24:miThe 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.
-
Tag
Args - The tags to be assigned to the instance. You can assign up to 10 tags to an instance.
- db_
cluster_ stringidentifier - The identifier of the cluster that the instance will belong to.
- db_
instance_ stringclass - 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_ boolversion_ upgrade 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_ stringidentifier - The identifier of the CA certificate for this DB instance.
- certificate_
rotation_ boolrestart 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_ stringidentifier 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_ boolinsights - A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights .
- preferred_
maintenance_ stringwindow The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format:
ddd:hh24:mi-ddd:hh24:miThe 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.
- list(object)
- The tags to be assigned to the instance. You can assign up to 10 tags to an instance.
- db
Cluster StringIdentifier - The identifier of the cluster that the instance will belong to.
- db
Instance StringClass - 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 BooleanVersion Upgrade 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 StringIdentifier - The identifier of the CA certificate for this DB instance.
- certificate
Rotation BooleanRestart 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 StringIdentifier 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 BooleanInsights - A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights .
- preferred
Maintenance StringWindow The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format:
ddd:hh24:mi-ddd:hh24:miThe 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.
- List<Tag>
- The tags to be assigned to the instance. You can assign up to 10 tags to an instance.
- db
Cluster stringIdentifier - The identifier of the cluster that the instance will belong to.
- db
Instance stringClass - 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 booleanVersion Upgrade 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 stringIdentifier - The identifier of the CA certificate for this DB instance.
- certificate
Rotation booleanRestart 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 stringIdentifier 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 booleanInsights - A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights .
- preferred
Maintenance stringWindow The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format:
ddd:hh24:mi-ddd:hh24:miThe 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.
- Tag[]
- The tags to be assigned to the instance. You can assign up to 10 tags to an instance.
- db_
cluster_ stridentifier - The identifier of the cluster that the instance will belong to.
- db_
instance_ strclass - 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_ boolversion_ upgrade 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_ stridentifier - The identifier of the CA certificate for this DB instance.
- certificate_
rotation_ boolrestart 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_ stridentifier 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_ boolinsights - A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights .
- preferred_
maintenance_ strwindow The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format:
ddd:hh24:mi-ddd:hh24:miThe 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.
-
Sequence[Tag
Args] - The tags to be assigned to the instance. You can assign up to 10 tags to an instance.
- db
Cluster StringIdentifier - The identifier of the cluster that the instance will belong to.
- db
Instance StringClass - 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 BooleanVersion Upgrade 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 StringIdentifier - The identifier of the CA certificate for this DB instance.
- certificate
Rotation BooleanRestart 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 StringIdentifier 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 BooleanInsights - A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights .
- preferred
Maintenance StringWindow The time range each week during which system maintenance can occur, in Universal Coordinated Time (UTC).
Format:
ddd:hh24:mi-ddd:hh24:miThe 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.
- 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:
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) -> DbInstancefunc 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.
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
published on Wednesday, Nov 18, 2026 by Pulumi