Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. neptune
  5. getDbInstance

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

AWS Cloud Control v1.32.0 published on Wednesday, Aug 13, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.neptune.getDbInstance

Explore with Pulumi AI

aws-native logo

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

AWS Cloud Control v1.32.0 published on Wednesday, Aug 13, 2025 by Pulumi
pulumi/pulumi-aws-native

    The AWS::Neptune::DBInstance resource creates an Amazon Neptune DB instance.

    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?: InvokeOptions): 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: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = 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 CompletableFuture<GetDbInstanceResult> getDbInstance(GetDbInstanceArgs args, InvokeOptions options)
public static Output<GetDbInstanceResult> getDbInstance(GetDbInstanceArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:neptune:getDbInstance
  arguments:
    # arguments dictionary

    The following arguments are supported:

    DbInstanceIdentifier string
    Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
    DbInstanceIdentifier string
    Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
    dbInstanceIdentifier String
    Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
    dbInstanceIdentifier string
    Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
    db_instance_identifier str
    Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
    dbInstanceIdentifier String
    Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

    getDbInstance Result

    The following output properties are available:

    AutoMinorVersionUpgrade bool

    Indicates that minor version patches are applied automatically.

    When updating this property, some interruptions may occur.

    DbInstanceClass string

    Contains the name of the compute and memory capacity class of the DB instance.

    If you update this property, some interruptions may occur.

    DbParameterGroupName string
    The name of an existing DB parameter group or a reference to an AWS::Neptune::DBParameterGroup resource created in the template. If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot.
    Endpoint string
    The connection endpoint for the database. For example: mystack-mydb-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com.
    Port string
    The port number on which the database accepts connections. For example: 8182.
    PreferredMaintenanceWindow string
    Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    An arbitrary set of tags (key-value pairs) for this DB instance.
    AutoMinorVersionUpgrade bool

    Indicates that minor version patches are applied automatically.

    When updating this property, some interruptions may occur.

    DbInstanceClass string

    Contains the name of the compute and memory capacity class of the DB instance.

    If you update this property, some interruptions may occur.

    DbParameterGroupName string
    The name of an existing DB parameter group or a reference to an AWS::Neptune::DBParameterGroup resource created in the template. If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot.
    Endpoint string
    The connection endpoint for the database. For example: mystack-mydb-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com.
    Port string
    The port number on which the database accepts connections. For example: 8182.
    PreferredMaintenanceWindow string
    Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
    Tags Tag
    An arbitrary set of tags (key-value pairs) for this DB instance.
    autoMinorVersionUpgrade Boolean

    Indicates that minor version patches are applied automatically.

    When updating this property, some interruptions may occur.

    dbInstanceClass String

    Contains the name of the compute and memory capacity class of the DB instance.

    If you update this property, some interruptions may occur.

    dbParameterGroupName String
    The name of an existing DB parameter group or a reference to an AWS::Neptune::DBParameterGroup resource created in the template. If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot.
    endpoint String
    The connection endpoint for the database. For example: mystack-mydb-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com.
    port String
    The port number on which the database accepts connections. For example: 8182.
    preferredMaintenanceWindow String
    Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
    tags List<Tag>
    An arbitrary set of tags (key-value pairs) for this DB instance.
    autoMinorVersionUpgrade boolean

    Indicates that minor version patches are applied automatically.

    When updating this property, some interruptions may occur.

    dbInstanceClass string

    Contains the name of the compute and memory capacity class of the DB instance.

    If you update this property, some interruptions may occur.

    dbParameterGroupName string
    The name of an existing DB parameter group or a reference to an AWS::Neptune::DBParameterGroup resource created in the template. If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot.
    endpoint string
    The connection endpoint for the database. For example: mystack-mydb-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com.
    port string
    The port number on which the database accepts connections. For example: 8182.
    preferredMaintenanceWindow string
    Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
    tags Tag[]
    An arbitrary set of tags (key-value pairs) for this DB instance.
    auto_minor_version_upgrade bool

    Indicates that minor version patches are applied automatically.

    When updating this property, some interruptions may occur.

    db_instance_class str

    Contains the name of the compute and memory capacity class of the DB instance.

    If you update this property, some interruptions may occur.

    db_parameter_group_name str
    The name of an existing DB parameter group or a reference to an AWS::Neptune::DBParameterGroup resource created in the template. If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot.
    endpoint str
    The connection endpoint for the database. For example: mystack-mydb-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com.
    port str
    The port number on which the database accepts connections. For example: 8182.
    preferred_maintenance_window str
    Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
    tags Sequence[root_Tag]
    An arbitrary set of tags (key-value pairs) for this DB instance.
    autoMinorVersionUpgrade Boolean

    Indicates that minor version patches are applied automatically.

    When updating this property, some interruptions may occur.

    dbInstanceClass String

    Contains the name of the compute and memory capacity class of the DB instance.

    If you update this property, some interruptions may occur.

    dbParameterGroupName String
    The name of an existing DB parameter group or a reference to an AWS::Neptune::DBParameterGroup resource created in the template. If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot.
    endpoint String
    The connection endpoint for the database. For example: mystack-mydb-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com.
    port String
    The port number on which the database accepts connections. For example: 8182.
    preferredMaintenanceWindow String
    Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
    tags List<Property Map>
    An arbitrary set of tags (key-value pairs) for this DB 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 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

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

    AWS Cloud Control v1.32.0 published on Wednesday, Aug 13, 2025 by Pulumi
    pulumi/pulumi-aws-native