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

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

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.

    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_instance_class: Optional[str] = None,
               allow_major_version_upgrade: Optional[bool] = None,
               auto_minor_version_upgrade: Optional[bool] = None,
               availability_zone: Optional[str] = None,
               db_cluster_identifier: Optional[str] = None,
               db_instance_identifier: Optional[str] = None,
               db_parameter_group_name: Optional[str] = None,
               db_snapshot_identifier: Optional[str] = None,
               db_subnet_group_name: Optional[str] = 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:neptune:DbInstance
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    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:

    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.

    AllowMajorVersionUpgrade bool
    Indicates that major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.
    AutoMinorVersionUpgrade bool

    Indicates that minor version patches are applied automatically.

    When updating this property, some interruptions may occur.

    AvailabilityZone string
    Specifies the name of the Availability Zone the DB instance is located in.
    DbClusterIdentifier string
    If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.
    DbInstanceIdentifier string
    Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
    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.
    DbSnapshotIdentifier string

    This parameter is not supported.

    AWS::Neptune::DBInstance does not support restoring from snapshots.

    AWS::Neptune::DBCluster does support restoring from snapshots.

    DbSubnetGroupName string
    A DB subnet group to associate with the DB instance. If you update this value, the new subnet group must be a subnet group in a new virtual private cloud (VPC).
    PreferredMaintenanceWindow string
    Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    An arbitrary set of tags (key-value pairs) for this DB instance.
    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.

    AllowMajorVersionUpgrade bool
    Indicates that major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.
    AutoMinorVersionUpgrade bool

    Indicates that minor version patches are applied automatically.

    When updating this property, some interruptions may occur.

    AvailabilityZone string
    Specifies the name of the Availability Zone the DB instance is located in.
    DbClusterIdentifier string
    If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.
    DbInstanceIdentifier string
    Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
    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.
    DbSnapshotIdentifier string

    This parameter is not supported.

    AWS::Neptune::DBInstance does not support restoring from snapshots.

    AWS::Neptune::DBCluster does support restoring from snapshots.

    DbSubnetGroupName string
    A DB subnet group to associate with the DB instance. If you update this value, the new subnet group must be a subnet group in a new virtual private cloud (VPC).
    PreferredMaintenanceWindow string
    Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
    Tags TagArgs
    An arbitrary set of tags (key-value pairs) for this DB instance.
    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.

    allowMajorVersionUpgrade Boolean
    Indicates that major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.
    autoMinorVersionUpgrade Boolean

    Indicates that minor version patches are applied automatically.

    When updating this property, some interruptions may occur.

    availabilityZone String
    Specifies the name of the Availability Zone the DB instance is located in.
    dbClusterIdentifier String
    If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.
    dbInstanceIdentifier String
    Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
    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.
    dbSnapshotIdentifier String

    This parameter is not supported.

    AWS::Neptune::DBInstance does not support restoring from snapshots.

    AWS::Neptune::DBCluster does support restoring from snapshots.

    dbSubnetGroupName String
    A DB subnet group to associate with the DB instance. If you update this value, the new subnet group must be a subnet group in a new virtual private cloud (VPC).
    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.
    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.

    allowMajorVersionUpgrade boolean
    Indicates that major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.
    autoMinorVersionUpgrade boolean

    Indicates that minor version patches are applied automatically.

    When updating this property, some interruptions may occur.

    availabilityZone string
    Specifies the name of the Availability Zone the DB instance is located in.
    dbClusterIdentifier string
    If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.
    dbInstanceIdentifier string
    Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
    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.
    dbSnapshotIdentifier string

    This parameter is not supported.

    AWS::Neptune::DBInstance does not support restoring from snapshots.

    AWS::Neptune::DBCluster does support restoring from snapshots.

    dbSubnetGroupName string
    A DB subnet group to associate with the DB instance. If you update this value, the new subnet group must be a subnet group in a new virtual private cloud (VPC).
    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.
    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.

    allow_major_version_upgrade bool
    Indicates that major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.
    auto_minor_version_upgrade bool

    Indicates that minor version patches are applied automatically.

    When updating this property, some interruptions may occur.

    availability_zone str
    Specifies the name of the Availability Zone the DB instance is located in.
    db_cluster_identifier str
    If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.
    db_instance_identifier str
    Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
    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.
    db_snapshot_identifier str

    This parameter is not supported.

    AWS::Neptune::DBInstance does not support restoring from snapshots.

    AWS::Neptune::DBCluster does support restoring from snapshots.

    db_subnet_group_name str
    A DB subnet group to associate with the DB instance. If you update this value, the new subnet group must be a subnet group in a new virtual private cloud (VPC).
    preferred_maintenance_window str
    Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
    tags Sequence[TagArgs]
    An arbitrary set of tags (key-value pairs) for this DB instance.
    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.

    allowMajorVersionUpgrade Boolean
    Indicates that major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.
    autoMinorVersionUpgrade Boolean

    Indicates that minor version patches are applied automatically.

    When updating this property, some interruptions may occur.

    availabilityZone String
    Specifies the name of the Availability Zone the DB instance is located in.
    dbClusterIdentifier String
    If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.
    dbInstanceIdentifier String
    Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
    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.
    dbSnapshotIdentifier String

    This parameter is not supported.

    AWS::Neptune::DBInstance does not support restoring from snapshots.

    AWS::Neptune::DBCluster does support restoring from snapshots.

    dbSubnetGroupName String
    A DB subnet group to associate with the DB instance. If you update this value, the new subnet group must be a subnet group in a new virtual private cloud (VPC).
    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.

    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 database. For example: mystack-mydb-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com.
    Id string
    The provider-assigned unique ID for this managed resource.
    Port string
    The port number on which the database accepts connections. For example: 8182.
    Endpoint string
    The connection endpoint for the database. For example: mystack-mydb-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com.
    Id string
    The provider-assigned unique ID for this managed resource.
    Port string
    The port number on which the database accepts connections. For example: 8182.
    endpoint String
    The connection endpoint for the database. For example: mystack-mydb-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com.
    id String
    The provider-assigned unique ID for this managed resource.
    port String
    The port number on which the database accepts connections. For example: 8182.
    endpoint string
    The connection endpoint for the database. For example: mystack-mydb-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com.
    id string
    The provider-assigned unique ID for this managed resource.
    port string
    The port number on which the database accepts connections. For example: 8182.
    endpoint str
    The connection endpoint for the database. For example: mystack-mydb-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com.
    id str
    The provider-assigned unique ID for this managed resource.
    port str
    The port number on which the database accepts connections. For example: 8182.
    endpoint String
    The connection endpoint for the database. For example: mystack-mydb-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com.
    id String
    The provider-assigned unique ID for this managed resource.
    port String
    The port number on which the database accepts connections. For example: 8182.

    Supporting Types

    Tag, TagArgs

    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