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
Using getDbInstance
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getDbInstance(args: GetDbInstanceArgs, opts?: InvokeOptions): Promise<GetDbInstanceResult>
function getDbInstanceOutput(args: GetDbInstanceOutputArgs, opts?: InvokeOutputOptions): Output<GetDbInstanceResult>def get_db_instance(db_instance_identifier: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetDbInstanceResult
def get_db_instance_output(db_instance_identifier: pulumi.Input[Optional[str]] = None,
opts: Optional[InvokeOutputOptions] = None) -> Output[GetDbInstanceResult]func LookupDbInstance(ctx *Context, args *LookupDbInstanceArgs, opts ...InvokeOption) (*LookupDbInstanceResult, error)
func LookupDbInstanceOutput(ctx *Context, args *LookupDbInstanceOutputArgs, opts ...InvokeOption) LookupDbInstanceResultOutput> Note: This function is named LookupDbInstance in the Go SDK.
public static class GetDbInstance
{
public static Task<GetDbInstanceResult> InvokeAsync(GetDbInstanceArgs args, InvokeOptions? opts = null)
public static Output<GetDbInstanceResult> Invoke(GetDbInstanceInvokeArgs args, InvokeOptions? opts = null)
public static Output<GetDbInstanceResult> Invoke(GetDbInstanceInvokeArgs args, InvokeOutputOptions opts)
}public static CompletableFuture<GetDbInstanceResult> getDbInstance(GetDbInstanceArgs args, InvokeOptions options)
public static Output<GetDbInstanceResult> getDbInstance(GetDbInstanceArgs args, InvokeOptions options)
public static Output<GetDbInstanceResult> getDbInstance(GetDbInstanceArgs args, InvokeOutputOptions options)
fn::invoke:
function: aws-native:docdb:getDbInstance
arguments:
# arguments dictionarydata "aws-native_docdb_get_db_instance" "name" {
# arguments
}The following arguments are supported:
- 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
- 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
- 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
- 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
- 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
- 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
- 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
getDbInstance Result
The following output properties are available:
- 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- Ca
Certificate stringIdentifier - The identifier of the CA certificate for this DB instance.
- 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. - Enable
Performance boolInsights - A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights .
- Endpoint string
- The connection endpoint for the instance. For example:
sample-cluster.cluster-abcdefghijkl.us-east-1.docdb.amazonaws.com. - Port string
- The port number on which the database accepts connections, such as
27017. - 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. Outputs. Tag> - The tags to be assigned to the instance. You can assign up to 10 tags to an instance.
- 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- Ca
Certificate stringIdentifier - The identifier of the CA certificate for this DB instance.
- 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. - Enable
Performance boolInsights - A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights .
- Endpoint string
- The connection endpoint for the instance. For example:
sample-cluster.cluster-abcdefghijkl.us-east-1.docdb.amazonaws.com. - Port string
- The port number on which the database accepts connections, such as
27017. - 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.
- 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- ca_
certificate_ stringidentifier - The identifier of the CA certificate for this DB instance.
- 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. - enable_
performance_ boolinsights - A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights .
- endpoint string
- The connection endpoint for the instance. For example:
sample-cluster.cluster-abcdefghijkl.us-east-1.docdb.amazonaws.com. - port string
- The port number on which the database accepts connections, such as
27017. - 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.
- 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- ca
Certificate StringIdentifier - The identifier of the CA certificate for this DB instance.
- 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. - enable
Performance BooleanInsights - A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights .
- endpoint String
- The connection endpoint for the instance. For example:
sample-cluster.cluster-abcdefghijkl.us-east-1.docdb.amazonaws.com. - port String
- The port number on which the database accepts connections, such as
27017. - 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.
- 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- ca
Certificate stringIdentifier - The identifier of the CA certificate for this DB instance.
- 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. - enable
Performance booleanInsights - A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights .
- endpoint string
- The connection endpoint for the instance. For example:
sample-cluster.cluster-abcdefghijkl.us-east-1.docdb.amazonaws.com. - port string
- The port number on which the database accepts connections, such as
27017. - 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.
- 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- ca_
certificate_ stridentifier - The identifier of the CA certificate for this DB instance.
- 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. - enable_
performance_ boolinsights - A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights .
- endpoint str
- The connection endpoint for the instance. For example:
sample-cluster.cluster-abcdefghijkl.us-east-1.docdb.amazonaws.com. - port str
- The port number on which the database accepts connections, such as
27017. - 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[root_Tag]
- The tags to be assigned to the instance. You can assign up to 10 tags to an instance.
- 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- ca
Certificate StringIdentifier - The identifier of the CA certificate for this DB instance.
- 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. - enable
Performance BooleanInsights - A value that indicates whether to enable Performance Insights for the DB Instance. For more information, see Using Amazon Performance Insights .
- endpoint String
- The connection endpoint for the instance. For example:
sample-cluster.cluster-abcdefghijkl.us-east-1.docdb.amazonaws.com. - port String
- The port number on which the database accepts connections, such as
27017. - 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.
Supporting Types
Tag
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