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

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

    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 dictionary
    data "aws-native_docdb_get_db_instance" "name" {
        # arguments
    }

    The following arguments are supported:

    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

    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

    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

    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

    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

    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

    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

    getDbInstance Result

    The following output properties are available:

    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

    CaCertificateIdentifier string
    The identifier of the CA certificate for this DB instance.
    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.
    EnablePerformanceInsights bool
    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 .
    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.Outputs.Tag>
    The tags to be assigned to the instance. You can assign up to 10 tags to an instance.
    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

    CaCertificateIdentifier string
    The identifier of the CA certificate for this DB instance.
    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.
    EnablePerformanceInsights bool
    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 .
    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.
    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

    ca_certificate_identifier string
    The identifier of the CA certificate for this DB instance.
    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.
    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 .
    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_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.
    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

    caCertificateIdentifier String
    The identifier of the CA certificate for this DB instance.
    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.
    enablePerformanceInsights Boolean
    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 .
    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.
    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

    caCertificateIdentifier string
    The identifier of the CA certificate for this DB instance.
    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.
    enablePerformanceInsights boolean
    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 .
    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.
    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

    ca_certificate_identifier str
    The identifier of the CA certificate for this DB instance.
    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.
    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 .
    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_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[root_Tag]
    The tags to be assigned to the instance. You can assign up to 10 tags to an instance.
    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

    caCertificateIdentifier String
    The identifier of the CA certificate for this DB instance.
    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.
    enablePerformanceInsights Boolean
    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 .
    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.

    Supporting Types

    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 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