AWS::Neptune::DBInstance

Neptune DBInstance

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

Properties

12 configurable properties. 1 required. Click a row to see details.

Filter:

Property	Type	Flags
`DBInstanceClass`	`string`	Required
`AllowMajorVersionUpgrade`	`boolean`	Write-only
`AutoMinorVersionUpgrade`	`boolean`
`AvailabilityZone`	`string`	Create-only
`DBClusterIdentifier`	`string`	Create-only
`DBInstanceIdentifier`	`string`	Create-only
`DBParameterGroupName`	`string`
`DBSnapshotIdentifier`	`string`	Create-onlyWrite-onlyDeprecated
`DBSubnetGroupName`	`string`	Create-only
`PreferredMaintenanceWindow`	`string`
`PubliclyAccessible`	`boolean`
`Tags`	`Array<Tag>`

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`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`.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::Neptune::DBInstance

Resources:
  MyResource:
    Type: AWS::Neptune::DBInstance
    Properties:
      DBInstanceClass: "value"
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

ec2:DescribeAccountAttributesec2:DescribeAvailabilityZonesec2:DescribeInternetGatewaysiam:GetRoleiam:ListRolesiam:PassRolerds:AddTagsToResourcerds:CreateDBInstance

read

ec2:DescribeAccountAttributesec2:DescribeAvailabilityZonesec2:DescribeInternetGatewaysrds:DescribeDBInstancesrds:ListTagsForResource

update

ec2:DescribeAccountAttributesec2:DescribeAvailabilityZonesec2:DescribeInternetGatewaysiam:GetRoleiam:ListRolesiam:PassRolerds:AddTagsToResourcerds:DescribeDBClusters

delete

rds:AddTagsToResourcerds:CreateDBSnapshotrds:DeleteDBInstancerds:DescribeDBInstances

list

rds:DescribeDBInstancesrds:ListTagsForResource

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceNeptune

Properties14

Required1

TaggingSupported

Primary IDDBInstanceIdentifier

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

AvailabilityZoneDBClusterIdentifierDBInstanceIdentifierDBSnapshotIdentifierDBSubnetGroupName

Related Resources

External Links

AWS Documentation