This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# Amazon Neptune
<a name="AWS_Neptune"></a>

**Resource types**
+ [AWS::Neptune::DBCluster](aws-resource-neptune-dbcluster.md)
+ [AWS::Neptune::DBClusterParameterGroup](aws-resource-neptune-dbclusterparametergroup.md)
+ [AWS::Neptune::DBInstance](aws-resource-neptune-dbinstance.md)
+ [AWS::Neptune::DBParameterGroup](aws-resource-neptune-dbparametergroup.md)
+ [AWS::Neptune::DBSubnetGroup](aws-resource-neptune-dbsubnetgroup.md)
+ [AWS::Neptune::EventSubscription](aws-resource-neptune-eventsubscription.md)

# AWS::Neptune::DBCluster
<a name="aws-resource-neptune-dbcluster"></a>

The `AWS::Neptune::DBCluster` resource creates an Amazon Neptune DB cluster. Neptune is a fully managed graph database.

**Note**  
Currently, you can create this resource only in AWS Regions in which Amazon Neptune is supported.

If no `DeletionPolicy` is set for `AWS::Neptune::DBCluster` resources, the default deletion behavior is that the entire volume will be deleted without a snapshot. To retain a backup of the volume, the `DeletionPolicy` should be set to `Snapshot`. For more information about how CloudFormation deletes resources, see [DeletionPolicy Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html).

You can use `AWS::Neptune::DBCluster.DeletionProtection` to help guard against unintended deletion of your DB cluster.

## Syntax
<a name="aws-resource-neptune-dbcluster-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-neptune-dbcluster-syntax.json"></a>

```
{
  "Type" : "AWS::Neptune::DBCluster",
  "Properties" : {
      "[AssociatedRoles](#cfn-neptune-dbcluster-associatedroles)" : [ DBClusterRole, ... ],
      "[AvailabilityZones](#cfn-neptune-dbcluster-availabilityzones)" : [ String, ... ],
      "[BackupRetentionPeriod](#cfn-neptune-dbcluster-backupretentionperiod)" : Integer,
      "[CopyTagsToSnapshot](#cfn-neptune-dbcluster-copytagstosnapshot)" : Boolean,
      "[DBClusterIdentifier](#cfn-neptune-dbcluster-dbclusteridentifier)" : String,
      "[DBClusterParameterGroupName](#cfn-neptune-dbcluster-dbclusterparametergroupname)" : String,
      "[DBInstanceParameterGroupName](#cfn-neptune-dbcluster-dbinstanceparametergroupname)" : String,
      "[DBPort](#cfn-neptune-dbcluster-dbport)" : Integer,
      "[DBSubnetGroupName](#cfn-neptune-dbcluster-dbsubnetgroupname)" : String,
      "[DeletionProtection](#cfn-neptune-dbcluster-deletionprotection)" : Boolean,
      "[EnableCloudwatchLogsExports](#cfn-neptune-dbcluster-enablecloudwatchlogsexports)" : [ String, ... ],
      "[EngineVersion](#cfn-neptune-dbcluster-engineversion)" : String,
      "[IamAuthEnabled](#cfn-neptune-dbcluster-iamauthenabled)" : Boolean,
      "[KmsKeyId](#cfn-neptune-dbcluster-kmskeyid)" : String,
      "[Port](#cfn-neptune-dbcluster-port)" : String,
      "[PreferredBackupWindow](#cfn-neptune-dbcluster-preferredbackupwindow)" : String,
      "[PreferredMaintenanceWindow](#cfn-neptune-dbcluster-preferredmaintenancewindow)" : String,
      "[RestoreToTime](#cfn-neptune-dbcluster-restoretotime)" : String,
      "[RestoreType](#cfn-neptune-dbcluster-restoretype)" : String,
      "[ServerlessScalingConfiguration](#cfn-neptune-dbcluster-serverlessscalingconfiguration)" : ServerlessScalingConfiguration,
      "[SnapshotIdentifier](#cfn-neptune-dbcluster-snapshotidentifier)" : String,
      "[SourceDBClusterIdentifier](#cfn-neptune-dbcluster-sourcedbclusteridentifier)" : String,
      "[StorageEncrypted](#cfn-neptune-dbcluster-storageencrypted)" : Boolean,
      "[Tags](#cfn-neptune-dbcluster-tags)" : [ Tag, ... ],
      "[UseLatestRestorableTime](#cfn-neptune-dbcluster-uselatestrestorabletime)" : Boolean,
      "[VpcSecurityGroupIds](#cfn-neptune-dbcluster-vpcsecuritygroupids)" : [ String, ... ]
    }
}
```

### YAML
<a name="aws-resource-neptune-dbcluster-syntax.yaml"></a>

```
Type: AWS::Neptune::DBCluster
Properties:
  [AssociatedRoles](#cfn-neptune-dbcluster-associatedroles): 
    - DBClusterRole
  [AvailabilityZones](#cfn-neptune-dbcluster-availabilityzones): 
    - String
  [BackupRetentionPeriod](#cfn-neptune-dbcluster-backupretentionperiod): Integer
  [CopyTagsToSnapshot](#cfn-neptune-dbcluster-copytagstosnapshot): Boolean
  [DBClusterIdentifier](#cfn-neptune-dbcluster-dbclusteridentifier): String
  [DBClusterParameterGroupName](#cfn-neptune-dbcluster-dbclusterparametergroupname): String
  [DBInstanceParameterGroupName](#cfn-neptune-dbcluster-dbinstanceparametergroupname): String
  [DBPort](#cfn-neptune-dbcluster-dbport): Integer
  [DBSubnetGroupName](#cfn-neptune-dbcluster-dbsubnetgroupname): String
  [DeletionProtection](#cfn-neptune-dbcluster-deletionprotection): Boolean
  [EnableCloudwatchLogsExports](#cfn-neptune-dbcluster-enablecloudwatchlogsexports): 
    - String
  [EngineVersion](#cfn-neptune-dbcluster-engineversion): String
  [IamAuthEnabled](#cfn-neptune-dbcluster-iamauthenabled): Boolean
  [KmsKeyId](#cfn-neptune-dbcluster-kmskeyid): String
  [Port](#cfn-neptune-dbcluster-port): String
  [PreferredBackupWindow](#cfn-neptune-dbcluster-preferredbackupwindow): String
  [PreferredMaintenanceWindow](#cfn-neptune-dbcluster-preferredmaintenancewindow): String
  [RestoreToTime](#cfn-neptune-dbcluster-restoretotime): String
  [RestoreType](#cfn-neptune-dbcluster-restoretype): String
  [ServerlessScalingConfiguration](#cfn-neptune-dbcluster-serverlessscalingconfiguration): 
    ServerlessScalingConfiguration
  [SnapshotIdentifier](#cfn-neptune-dbcluster-snapshotidentifier): String
  [SourceDBClusterIdentifier](#cfn-neptune-dbcluster-sourcedbclusteridentifier): String
  [StorageEncrypted](#cfn-neptune-dbcluster-storageencrypted): Boolean
  [Tags](#cfn-neptune-dbcluster-tags): 
    - Tag
  [UseLatestRestorableTime](#cfn-neptune-dbcluster-uselatestrestorabletime): Boolean
  [VpcSecurityGroupIds](#cfn-neptune-dbcluster-vpcsecuritygroupids): 
    - String
```

## Properties
<a name="aws-resource-neptune-dbcluster-properties"></a>

`AssociatedRoles`  <a name="cfn-neptune-dbcluster-associatedroles"></a>
Provides a list of the Amazon Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon services on your behalf.  
*Required*: No  
*Type*: Array of [DBClusterRole](aws-properties-neptune-dbcluster-dbclusterrole.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`AvailabilityZones`  <a name="cfn-neptune-dbcluster-availabilityzones"></a>
Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.  
*Required*: No  
*Type*: Array of String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`BackupRetentionPeriod`  <a name="cfn-neptune-dbcluster-backupretentionperiod"></a>
Specifies the number of days for which automatic DB snapshots are retained.  
An update may require some interruption. See [ModifyDBInstance](https://docs.aws.amazon.com/neptune/latest/userguide/api-instances.html#ModifyDBInstance) in the Amazon Neptune User Guide for more information.  
*Required*: No  
*Type*: Integer  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CopyTagsToSnapshot`  <a name="cfn-neptune-dbcluster-copytagstosnapshot"></a>
 *If set to `true`, tags are copied to any snapshot of the DB cluster that is created.*   
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DBClusterIdentifier`  <a name="cfn-neptune-dbcluster-dbclusteridentifier"></a>
Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.  
*Required*: No  
*Type*: String  
*Pattern*: `^[a-zA-Z]{1}(?:-?[a-zA-Z0-9]){0,62}$`  
*Minimum*: `1`  
*Maximum*: `63`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`DBClusterParameterGroupName`  <a name="cfn-neptune-dbcluster-dbclusterparametergroupname"></a>
Provides the name of the DB cluster parameter group.  
An update may require some interruption. See [ModifyDBInstance](https://docs.aws.amazon.com/neptune/latest/userguide/api-instances.html#ModifyDBInstance) in the Amazon Neptune User Guide for more information.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DBInstanceParameterGroupName`  <a name="cfn-neptune-dbcluster-dbinstanceparametergroupname"></a>
The name of the DB parameter group to apply to all instances of the DB cluster. Used only in case of a major engine version upgrade request  
Note that when you apply a parameter group using `DBInstanceParameterGroupName`, parameter changes are applied immediately, not during the next maintenance window.  

**Constraints**
+ The DB parameter group must be in the same DB parameter group family as the target DB cluster version.
+ The `DBInstanceParameterGroupName` parameter is only valid for major engine version upgrades.
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DBPort`  <a name="cfn-neptune-dbcluster-dbport"></a>
The port number on which the DB instances in the DB cluster accept connections.  
If not specified, the default port used is `8182`.  
The `Port` property will soon be deprecated. Please update existing templates to use the new `DBPort` property that has the same functionality.
*Required*: No  
*Type*: Integer  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DBSubnetGroupName`  <a name="cfn-neptune-dbcluster-dbsubnetgroupname"></a>
Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.  
*Required*: No  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`DeletionProtection`  <a name="cfn-neptune-dbcluster-deletionprotection"></a>
Indicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`EnableCloudwatchLogsExports`  <a name="cfn-neptune-dbcluster-enablecloudwatchlogsexports"></a>
Specifies a list of log types that are enabled for export to CloudWatch Logs.  
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`EngineVersion`  <a name="cfn-neptune-dbcluster-engineversion"></a>
Indicates the database engine version.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`IamAuthEnabled`  <a name="cfn-neptune-dbcluster-iamauthenabled"></a>
True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`KmsKeyId`  <a name="cfn-neptune-dbcluster-kmskeyid"></a>
The Amazon Resource Name (ARN) of the KMS key that is used to encrypt the database instances in the DB cluster, such as `arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef`. If you enable the `StorageEncrypted` property but don't specify this property, the default KMS key is used. If you specify this property, you must set the `StorageEncrypted` property to `true`.  
*Required*: No  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Port`  <a name="cfn-neptune-dbcluster-port"></a>
The port number on which the DB instances in the DB cluster accept connections.  
If not specified, the default port used is `8182`.  
This property will soon be deprecated. Please update existing templates to use the new `DBPort` property that has the same functionality.
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`PreferredBackupWindow`  <a name="cfn-neptune-dbcluster-preferredbackupwindow"></a>
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the `BackupRetentionPeriod`.  
An update may require some interruption.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`PreferredMaintenanceWindow`  <a name="cfn-neptune-dbcluster-preferredmaintenancewindow"></a>
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RestoreToTime`  <a name="cfn-neptune-dbcluster-restoretotime"></a>
Creates a new DB cluster from a DB snapshot or DB cluster snapshot.  
If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.  
If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.  
*Required*: No  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`RestoreType`  <a name="cfn-neptune-dbcluster-restoretype"></a>
Creates a new DB cluster from a DB snapshot or DB cluster snapshot.  
If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.  
If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.  
*Required*: No  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ServerlessScalingConfiguration`  <a name="cfn-neptune-dbcluster-serverlessscalingconfiguration"></a>
Property description not available.  
*Required*: No  
*Type*: [ServerlessScalingConfiguration](aws-properties-neptune-dbcluster-serverlessscalingconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SnapshotIdentifier`  <a name="cfn-neptune-dbcluster-snapshotidentifier"></a>
Specifies the identifier for a DB cluster snapshot. Must match the identifier of an existing snapshot.  
After you restore a DB cluster using a `SnapshotIdentifier`, you must specify the same `SnapshotIdentifier` for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed.  
However, if you don't specify the `SnapshotIdentifier`, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the snapshot specified by the `SnapshotIdentifier`, and the original DB cluster is deleted.  
*Required*: No  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`SourceDBClusterIdentifier`  <a name="cfn-neptune-dbcluster-sourcedbclusteridentifier"></a>
Creates a new DB cluster from a DB snapshot or DB cluster snapshot.  
If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.  
If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.  
*Required*: No  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`StorageEncrypted`  <a name="cfn-neptune-dbcluster-storageencrypted"></a>
Indicates whether the DB cluster is encrypted.  
If you specify the `KmsKeyId` property, then you must enable encryption and set this property to `true`.  
If you enable the `StorageEncrypted` property but don't specify the `KmsKeyId` property, then the default KMS key is used. If you specify the `KmsKeyId` property, then that KMS key is used to encrypt the database instances in the DB cluster.  
If you specify the `SourceDBClusterIdentifier` property, and don't specify this property or disable it, the value is inherited from the source DB cluster. If the source DB cluster is encrypted, the `KmsKeyId` property from the source cluster is used.  
If you specify the `DBSnapshotIdentifier` and don't specify this property or disable it, the value is inherited from the snapshot and the specified `KmsKeyId` property from the snapshot is used.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Tags`  <a name="cfn-neptune-dbcluster-tags"></a>
The tags assigned to this cluster.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-neptune-dbcluster-tag.md)  
*Maximum*: `50`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`UseLatestRestorableTime`  <a name="cfn-neptune-dbcluster-uselatestrestorabletime"></a>
Creates a new DB cluster from a DB snapshot or DB cluster snapshot.  
If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group.  
If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`VpcSecurityGroupIds`  <a name="cfn-neptune-dbcluster-vpcsecuritygroupids"></a>
Provides a list of VPC security groups that the DB cluster belongs to.  
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-neptune-dbcluster-return-values"></a>

### Ref
<a name="aws-resource-neptune-dbcluster-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name.

For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-neptune-dbcluster-return-values-fn--getatt"></a>

The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-neptune-dbcluster-return-values-fn--getatt-fn--getatt"></a>

`ClusterResourceId`  <a name="ClusterResourceId-fn::getatt"></a>
The resource id for the DB cluster. For example: `cluster-ABCD1234EFGH5678IJKL90MNOP`. The cluster ID uniquely identifies the cluster and is used in things like IAM authentication policies.

`Endpoint`  <a name="Endpoint-fn::getatt"></a>
The connection endpoint for the DB cluster. For example: `mystack-mydbcluster-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com`

`Port`  <a name="Port-fn::getatt"></a>
The port number on which the DB instances in the DB cluster accept connections.

`ReadEndpoint`  <a name="ReadEndpoint-fn::getatt"></a>
The reader endpoint for the DB cluster. For example: `mystack-mydbcluster-ro-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com`

# AWS::Neptune::DBCluster DBClusterRole
<a name="aws-properties-neptune-dbcluster-dbclusterrole"></a>

Describes an Amazon Identity and Access Management (IAM) role that is associated with a DB cluster.

## Syntax
<a name="aws-properties-neptune-dbcluster-dbclusterrole-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-neptune-dbcluster-dbclusterrole-syntax.json"></a>

```
{
  "[FeatureName](#cfn-neptune-dbcluster-dbclusterrole-featurename)" : String,
  "[RoleArn](#cfn-neptune-dbcluster-dbclusterrole-rolearn)" : String
}
```

### YAML
<a name="aws-properties-neptune-dbcluster-dbclusterrole-syntax.yaml"></a>

```
  [FeatureName](#cfn-neptune-dbcluster-dbclusterrole-featurename): String
  [RoleArn](#cfn-neptune-dbcluster-dbclusterrole-rolearn): String
```

## Properties
<a name="aws-properties-neptune-dbcluster-dbclusterrole-properties"></a>

`FeatureName`  <a name="cfn-neptune-dbcluster-dbclusterrole-featurename"></a>
The name of the feature associated with the Amazon Identity and Access Management (IAM) role. For the list of supported feature names, see [DescribeDBEngineVersions](https://docs.aws.amazon.com/neptune/latest/userguide/api-other-apis.html#DescribeDBEngineVersions).  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RoleArn`  <a name="cfn-neptune-dbcluster-dbclusterrole-rolearn"></a>
The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Neptune::DBCluster ServerlessScalingConfiguration
<a name="aws-properties-neptune-dbcluster-serverlessscalingconfiguration"></a>

Contains the scaling configuration of a Neptune Serverless DB cluster.

## Syntax
<a name="aws-properties-neptune-dbcluster-serverlessscalingconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-neptune-dbcluster-serverlessscalingconfiguration-syntax.json"></a>

```
{
  "[MaxCapacity](#cfn-neptune-dbcluster-serverlessscalingconfiguration-maxcapacity)" : Number,
  "[MinCapacity](#cfn-neptune-dbcluster-serverlessscalingconfiguration-mincapacity)" : Number
}
```

### YAML
<a name="aws-properties-neptune-dbcluster-serverlessscalingconfiguration-syntax.yaml"></a>

```
  [MaxCapacity](#cfn-neptune-dbcluster-serverlessscalingconfiguration-maxcapacity): Number
  [MinCapacity](#cfn-neptune-dbcluster-serverlessscalingconfiguration-mincapacity): Number
```

## Properties
<a name="aws-properties-neptune-dbcluster-serverlessscalingconfiguration-properties"></a>

`MaxCapacity`  <a name="cfn-neptune-dbcluster-serverlessscalingconfiguration-maxcapacity"></a>
The maximum number of Neptune capacity units (NCUs) for a DB instance in a Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 40, 40.5, 41, and so on.  
*Required*: Yes  
*Type*: Number  
*Minimum*: `2`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MinCapacity`  <a name="cfn-neptune-dbcluster-serverlessscalingconfiguration-mincapacity"></a>
The minimum number of Neptune capacity units (NCUs) for a DB instance in a Neptune Serverless cluster. You can specify NCU values in half-step increments, such as 8, 8.5, 9, and so on.  
*Required*: Yes  
*Type*: Number  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Neptune::DBCluster Tag
<a name="aws-properties-neptune-dbcluster-tag"></a>

Metadata assigned to an Amazon Neptune resource consisting of a key-value pair.

## Syntax
<a name="aws-properties-neptune-dbcluster-tag-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-neptune-dbcluster-tag-syntax.json"></a>

```
{
  "[Key](#cfn-neptune-dbcluster-tag-key)" : String,
  "[Value](#cfn-neptune-dbcluster-tag-value)" : String
}
```

### YAML
<a name="aws-properties-neptune-dbcluster-tag-syntax.yaml"></a>

```
  [Key](#cfn-neptune-dbcluster-tag-key): String
  [Value](#cfn-neptune-dbcluster-tag-value): String
```

## Properties
<a name="aws-properties-neptune-dbcluster-tag-properties"></a>

`Key`  <a name="cfn-neptune-dbcluster-tag-key"></a>
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with `aws:` or `rds:`. The string can only contain the set of Unicode letters, digits, white-space, '\$1', '.', '/', '=', '\$1', '-' (Java regex: "^([\$1\$1p\$1L\$1\$1\$1p\$1Z\$1\$1\$1p\$1N\$1\$1.:/=\$1\$1\$1-]\$1)\$1").  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-neptune-dbcluster-tag-value"></a>
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with `aws:` or `rds:`. The string can only contain the set of Unicode letters, digits, white-space, '\$1', '.', '/', '=', '\$1', '-' (Java regex: "^([\$1\$1p\$1L\$1\$1\$1p\$1Z\$1\$1\$1p\$1N\$1\$1.:/=\$1\$1\$1-]\$1)\$1").  
*Required*: No  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Neptune::DBClusterParameterGroup
<a name="aws-resource-neptune-dbclusterparametergroup"></a>

The `AWS::Neptune::DBClusterParameterGroup` resource creates a new Amazon Neptune DB cluster parameter group.

**Note**  
Applying a parameter group to a DB cluster might require instances to reboot, resulting in a database outage while the instances reboot.

**Note**  
If you provide a custom `DBClusterParameterGroup` that you associate with the `DBCluster`, it is best to specify an `EngineVersion` property in the `DBCluster`. That `EngineVersion` needs to be compatible with the value of the `Family` property in the `DBClusterParameterGroup`.

## Syntax
<a name="aws-resource-neptune-dbclusterparametergroup-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-neptune-dbclusterparametergroup-syntax.json"></a>

```
{
  "Type" : "AWS::Neptune::DBClusterParameterGroup",
  "Properties" : {
      "[Description](#cfn-neptune-dbclusterparametergroup-description)" : String,
      "[Family](#cfn-neptune-dbclusterparametergroup-family)" : String,
      "[Name](#cfn-neptune-dbclusterparametergroup-name)" : String,
      "[Parameters](#cfn-neptune-dbclusterparametergroup-parameters)" : Json,
      "[Tags](#cfn-neptune-dbclusterparametergroup-tags)" : [ Tag, ... ]
    }
}
```

### YAML
<a name="aws-resource-neptune-dbclusterparametergroup-syntax.yaml"></a>

```
Type: AWS::Neptune::DBClusterParameterGroup
Properties:
  [Description](#cfn-neptune-dbclusterparametergroup-description): String
  [Family](#cfn-neptune-dbclusterparametergroup-family): String
  [Name](#cfn-neptune-dbclusterparametergroup-name): String
  [Parameters](#cfn-neptune-dbclusterparametergroup-parameters): Json
  [Tags](#cfn-neptune-dbclusterparametergroup-tags): 
    - Tag
```

## Properties
<a name="aws-resource-neptune-dbclusterparametergroup-properties"></a>

`Description`  <a name="cfn-neptune-dbclusterparametergroup-description"></a>
Provides the customer-specified description for this DB cluster parameter group.  
*Required*: Yes  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Family`  <a name="cfn-neptune-dbclusterparametergroup-family"></a>
Must be `neptune1` for engine versions prior to [1.2.0.0](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.2.0.0.html), or `neptune1.2` for engine version `1.2.0.0` and higher.  
*Required*: Yes  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Name`  <a name="cfn-neptune-dbclusterparametergroup-name"></a>
Provides the name of the DB cluster parameter group.  
*Required*: No  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Parameters`  <a name="cfn-neptune-dbclusterparametergroup-parameters"></a>
The parameters to set for this DB cluster parameter group.  
The parameters are expressed as a JSON object consisting of key-value pairs.  
If you update the parameters, some interruption may occur depending on which parameters you update.  
*Required*: Yes  
*Type*: Json  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tags`  <a name="cfn-neptune-dbclusterparametergroup-tags"></a>
The tags that you want to attach to this parameter group.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-neptune-dbclusterparametergroup-tag.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-neptune-dbclusterparametergroup-return-values"></a>

### Ref
<a name="aws-resource-neptune-dbclusterparametergroup-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name.

For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

# AWS::Neptune::DBClusterParameterGroup Tag
<a name="aws-properties-neptune-dbclusterparametergroup-tag"></a>

Metadata assigned to an Amazon Neptune resource consisting of a key-value pair.

## Syntax
<a name="aws-properties-neptune-dbclusterparametergroup-tag-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-neptune-dbclusterparametergroup-tag-syntax.json"></a>

```
{
  "[Key](#cfn-neptune-dbclusterparametergroup-tag-key)" : String,
  "[Value](#cfn-neptune-dbclusterparametergroup-tag-value)" : String
}
```

### YAML
<a name="aws-properties-neptune-dbclusterparametergroup-tag-syntax.yaml"></a>

```
  [Key](#cfn-neptune-dbclusterparametergroup-tag-key): String
  [Value](#cfn-neptune-dbclusterparametergroup-tag-value): String
```

## Properties
<a name="aws-properties-neptune-dbclusterparametergroup-tag-properties"></a>

`Key`  <a name="cfn-neptune-dbclusterparametergroup-tag-key"></a>
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with `aws:` or `rds:`. The string can only contain the set of Unicode letters, digits, white-space, '\$1', '.', '/', '=', '\$1', '-' (Java regex: "^([\$1\$1p\$1L\$1\$1\$1p\$1Z\$1\$1\$1p\$1N\$1\$1.:/=\$1\$1\$1-]\$1)\$1").  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-neptune-dbclusterparametergroup-tag-value"></a>
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with `aws:` or `rds:`. The string can only contain the set of Unicode letters, digits, white-space, '\$1', '.', '/', '=', '\$1', '-' (Java regex: "^([\$1\$1p\$1L\$1\$1\$1p\$1Z\$1\$1\$1p\$1N\$1\$1.:/=\$1\$1\$1-]\$1)\$1").  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Neptune::DBInstance
<a name="aws-resource-neptune-dbinstance"></a>

The `AWS::Neptune::DBInstance` type creates an Amazon Neptune DB instance.

 **Updating DB Instances** 

You can set a deletion policy for your DB instance to control how CloudFormation handles the instance when the stack is deleted. For Neptune DB instances, you can choose to *retain* the instance, to *delete* the instance, or to *create a snapshot* of the instance. The default CloudFormation behavior depends on the `DBClusterIdentifier` property:
+ For `AWS::Neptune::DBInstance` resources that don't specify the `DBClusterIdentifier` property, CloudFormation saves a snapshot of the DB instance.
+ For `AWS::Neptune::DBInstance` resources that do specify the `DBClusterIdentifier` property, CloudFormation deletes the DB instance.

 **Deleting DB Instances** 

**Important**  
If a DB instance is deleted or replaced during an update, CloudFormation deletes all automated snapshots. However, it retains manual DB snapshots. During an update that requires replacement, you can apply a stack policy to prevent DB instances from being replaced.

When properties labeled *Update requires: Replacement* are updated, CloudFormation first creates a replacement DB instance, changes references from other dependent resources to point to the replacement DB instance, and finally deletes the old DB instance.

**Important**  
We highly recommend that you take a snapshot of the database before updating the stack. If you don't, you lose the data when CloudFormation replaces your DB instance. To preserve your data, perform the following procedure:  
Deactivate any applications that are using the DB instance so that there's no activity on the DB instance.
Create a snapshot of the DB instance.
If you want to restore your instance using a DB snapshot, modify the updated template with your DB instance changes and add the `DBSnapshotIdentifier` property with the ID of the DB snapshot that you want to use.
Update the stack.

## Syntax
<a name="aws-resource-neptune-dbinstance-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-neptune-dbinstance-syntax.json"></a>

```
{
  "Type" : "AWS::Neptune::DBInstance",
  "Properties" : {
      "[AllowMajorVersionUpgrade](#cfn-neptune-dbinstance-allowmajorversionupgrade)" : Boolean,
      "[AutoMinorVersionUpgrade](#cfn-neptune-dbinstance-autominorversionupgrade)" : Boolean,
      "[AvailabilityZone](#cfn-neptune-dbinstance-availabilityzone)" : String,
      "[DBClusterIdentifier](#cfn-neptune-dbinstance-dbclusteridentifier)" : String,
      "[DBInstanceClass](#cfn-neptune-dbinstance-dbinstanceclass)" : String,
      "[DBInstanceIdentifier](#cfn-neptune-dbinstance-dbinstanceidentifier)" : String,
      "[DBParameterGroupName](#cfn-neptune-dbinstance-dbparametergroupname)" : String,
      "[DBSubnetGroupName](#cfn-neptune-dbinstance-dbsubnetgroupname)" : String,
      "[PreferredMaintenanceWindow](#cfn-neptune-dbinstance-preferredmaintenancewindow)" : String,
      "[PubliclyAccessible](#cfn-neptune-dbinstance-publiclyaccessible)" : Boolean,
      "[Tags](#cfn-neptune-dbinstance-tags)" : [ Tag, ... ]
    }
}
```

### YAML
<a name="aws-resource-neptune-dbinstance-syntax.yaml"></a>

```
Type: AWS::Neptune::DBInstance
Properties:
  [AllowMajorVersionUpgrade](#cfn-neptune-dbinstance-allowmajorversionupgrade): Boolean
  [AutoMinorVersionUpgrade](#cfn-neptune-dbinstance-autominorversionupgrade): Boolean
  [AvailabilityZone](#cfn-neptune-dbinstance-availabilityzone): String
  [DBClusterIdentifier](#cfn-neptune-dbinstance-dbclusteridentifier): String
  [DBInstanceClass](#cfn-neptune-dbinstance-dbinstanceclass): String
  [DBInstanceIdentifier](#cfn-neptune-dbinstance-dbinstanceidentifier): String
  [DBParameterGroupName](#cfn-neptune-dbinstance-dbparametergroupname): String
  [DBSubnetGroupName](#cfn-neptune-dbinstance-dbsubnetgroupname): String
  [PreferredMaintenanceWindow](#cfn-neptune-dbinstance-preferredmaintenancewindow): String
  [PubliclyAccessible](#cfn-neptune-dbinstance-publiclyaccessible): Boolean
  [Tags](#cfn-neptune-dbinstance-tags): 
    - Tag
```

## Properties
<a name="aws-resource-neptune-dbinstance-properties"></a>

`AllowMajorVersionUpgrade`  <a name="cfn-neptune-dbinstance-allowmajorversionupgrade"></a>
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.   
When you change this parameter for an existing DB cluster, CloudFormation will replace your existing DB cluster with a new, empty one that uses the engine version you specified.
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`AutoMinorVersionUpgrade`  <a name="cfn-neptune-dbinstance-autominorversionupgrade"></a>
Indicates that minor version patches are applied automatically.  
When updating this property, some interruptions may occur.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)

`AvailabilityZone`  <a name="cfn-neptune-dbinstance-availabilityzone"></a>
Specifies the name of the Availability Zone the DB instance is located in.  
*Required*: No  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`DBClusterIdentifier`  <a name="cfn-neptune-dbinstance-dbclusteridentifier"></a>
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.  
*Required*: No  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`DBInstanceClass`  <a name="cfn-neptune-dbinstance-dbinstanceclass"></a>
Contains the name of the compute and memory capacity class of the DB instance.  
If you update this property, some interruptions may occur.  
*Required*: Yes  
*Type*: String  
*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)

`DBInstanceIdentifier`  <a name="cfn-neptune-dbinstance-dbinstanceidentifier"></a>
Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.  
*Required*: No  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`DBParameterGroupName`  <a name="cfn-neptune-dbinstance-dbparametergroupname"></a>
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.  
*Required*: No  
*Type*: String  
*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)

`DBSubnetGroupName`  <a name="cfn-neptune-dbinstance-dbsubnetgroupname"></a>
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).  
*Required*: No  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`PreferredMaintenanceWindow`  <a name="cfn-neptune-dbinstance-preferredmaintenancewindow"></a>
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).  
*Required*: No  
*Type*: String  
*Update requires*: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt)

`PubliclyAccessible`  <a name="cfn-neptune-dbinstance-publiclyaccessible"></a>
Indicates whether the DB instance is publicly accessible.  
When the DB instance is publicly accessible and you connect from outside of the DB instance's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB instance, the endpoint resolves to the private IP address. Access to the DB instance is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.  
When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tags`  <a name="cfn-neptune-dbinstance-tags"></a>
An arbitrary set of tags (key-value pairs) for this DB instance.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-neptune-dbinstance-tag.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-neptune-dbinstance-return-values"></a>

### Ref
<a name="aws-resource-neptune-dbinstance-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name.

For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-neptune-dbinstance-return-values-fn--getatt"></a>

The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-neptune-dbinstance-return-values-fn--getatt-fn--getatt"></a>

`Endpoint`  <a name="Endpoint-fn::getatt"></a>
The connection endpoint for the database. For example: `mystack-mydb-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com`.

`Port`  <a name="Port-fn::getatt"></a>
The port number on which the database accepts connections. For example: `8182`.

# AWS::Neptune::DBInstance Tag
<a name="aws-properties-neptune-dbinstance-tag"></a>

Metadata assigned to an Amazon Neptune resource consisting of a key-value pair.

## Syntax
<a name="aws-properties-neptune-dbinstance-tag-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-neptune-dbinstance-tag-syntax.json"></a>

```
{
  "[Key](#cfn-neptune-dbinstance-tag-key)" : String,
  "[Value](#cfn-neptune-dbinstance-tag-value)" : String
}
```

### YAML
<a name="aws-properties-neptune-dbinstance-tag-syntax.yaml"></a>

```
  [Key](#cfn-neptune-dbinstance-tag-key): String
  [Value](#cfn-neptune-dbinstance-tag-value): String
```

## Properties
<a name="aws-properties-neptune-dbinstance-tag-properties"></a>

`Key`  <a name="cfn-neptune-dbinstance-tag-key"></a>
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with `aws:` or `rds:`. The string can only contain the set of Unicode letters, digits, white-space, '\$1', '.', '/', '=', '\$1', '-' (Java regex: "^([\$1\$1p\$1L\$1\$1\$1p\$1Z\$1\$1\$1p\$1N\$1\$1.:/=\$1\$1\$1-]\$1)\$1").  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-neptune-dbinstance-tag-value"></a>
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with `aws:` or `rds:`. The string can only contain the set of Unicode letters, digits, white-space, '\$1', '.', '/', '=', '\$1', '-' (Java regex: "^([\$1\$1p\$1L\$1\$1\$1p\$1Z\$1\$1\$1p\$1N\$1\$1.:/=\$1\$1\$1-]\$1)\$1").  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Neptune::DBParameterGroup
<a name="aws-resource-neptune-dbparametergroup"></a>

`AWS::Neptune::DBParameterGroup` creates a new DB parameter group. This type can be declared in a template and referenced in the `DBParameterGroupName` parameter of `AWS::Neptune::DBInstance`.

**Note**  
Applying a parameter group to a DB instance might require the instance to reboot, resulting in a database outage for the duration of the reboot.

**Note**  
If you provide a custom `DBParameterGroup` that you associate with `DBInstance`, it is best to specify an `EngineVersion` property in `DBCluster`. That `EngineVersion` needs to be compatible with the value of the `Family` property in the `DBParameterGroup`.

A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using *ModifyDBParameterGroup*. Once you've created a DB parameter group, you need to associate it with your DB instance using *ModifyDBInstance*. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect.

**Important**  
After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon Neptune to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the `character_set_database` parameter. You can use the *Parameter Groups* option of the Amazon Neptune console or the *DescribeDBParameters* command to verify that your DB parameter group has been created or modified.

## Syntax
<a name="aws-resource-neptune-dbparametergroup-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-neptune-dbparametergroup-syntax.json"></a>

```
{
  "Type" : "AWS::Neptune::DBParameterGroup",
  "Properties" : {
      "[Description](#cfn-neptune-dbparametergroup-description)" : String,
      "[Family](#cfn-neptune-dbparametergroup-family)" : String,
      "[Name](#cfn-neptune-dbparametergroup-name)" : String,
      "[Parameters](#cfn-neptune-dbparametergroup-parameters)" : Json,
      "[Tags](#cfn-neptune-dbparametergroup-tags)" : [ Tag, ... ]
    }
}
```

### YAML
<a name="aws-resource-neptune-dbparametergroup-syntax.yaml"></a>

```
Type: AWS::Neptune::DBParameterGroup
Properties:
  [Description](#cfn-neptune-dbparametergroup-description): String
  [Family](#cfn-neptune-dbparametergroup-family): String
  [Name](#cfn-neptune-dbparametergroup-name): String
  [Parameters](#cfn-neptune-dbparametergroup-parameters): Json
  [Tags](#cfn-neptune-dbparametergroup-tags): 
    - Tag
```

## Properties
<a name="aws-resource-neptune-dbparametergroup-properties"></a>

`Description`  <a name="cfn-neptune-dbparametergroup-description"></a>
Provides the customer-specified description for this DB parameter group.  
*Required*: Yes  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Family`  <a name="cfn-neptune-dbparametergroup-family"></a>
Must be `neptune1` for engine versions prior to [1.2.0.0](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.2.0.0.html), or `neptune1.2` for engine version `1.2.0.0` and higher.  
*Required*: Yes  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Name`  <a name="cfn-neptune-dbparametergroup-name"></a>
Provides the name of the DB parameter group.  
*Required*: No  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Parameters`  <a name="cfn-neptune-dbparametergroup-parameters"></a>
The parameters to set for this DB parameter group.  
The parameters are expressed as a JSON object consisting of key-value pairs.  
Changes to dynamic parameters are applied immediately. During an update, if you have static parameters (whether they were changed or not), it triggers CloudFormation to reboot the associated DB instance without failover.  
*Required*: Yes  
*Type*: Json  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tags`  <a name="cfn-neptune-dbparametergroup-tags"></a>
The tags that you want to attach to this parameter group.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-neptune-dbparametergroup-tag.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-neptune-dbparametergroup-return-values"></a>

### Ref
<a name="aws-resource-neptune-dbparametergroup-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name.

For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

# AWS::Neptune::DBParameterGroup Tag
<a name="aws-properties-neptune-dbparametergroup-tag"></a>

Metadata assigned to an Amazon Neptune resource consisting of a key-value pair.

## Syntax
<a name="aws-properties-neptune-dbparametergroup-tag-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-neptune-dbparametergroup-tag-syntax.json"></a>

```
{
  "[Key](#cfn-neptune-dbparametergroup-tag-key)" : String,
  "[Value](#cfn-neptune-dbparametergroup-tag-value)" : String
}
```

### YAML
<a name="aws-properties-neptune-dbparametergroup-tag-syntax.yaml"></a>

```
  [Key](#cfn-neptune-dbparametergroup-tag-key): String
  [Value](#cfn-neptune-dbparametergroup-tag-value): String
```

## Properties
<a name="aws-properties-neptune-dbparametergroup-tag-properties"></a>

`Key`  <a name="cfn-neptune-dbparametergroup-tag-key"></a>
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with `aws:` or `rds:`. The string can only contain the set of Unicode letters, digits, white-space, '\$1', '.', '/', '=', '\$1', '-' (Java regex: "^([\$1\$1p\$1L\$1\$1\$1p\$1Z\$1\$1\$1p\$1N\$1\$1.:/=\$1\$1\$1-]\$1)\$1").  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-neptune-dbparametergroup-tag-value"></a>
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with `aws:` or `rds:`. The string can only contain the set of Unicode letters, digits, white-space, '\$1', '.', '/', '=', '\$1', '-' (Java regex: "^([\$1\$1p\$1L\$1\$1\$1p\$1Z\$1\$1\$1p\$1N\$1\$1.:/=\$1\$1\$1-]\$1)\$1").  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Neptune::DBSubnetGroup
<a name="aws-resource-neptune-dbsubnetgroup"></a>

The `AWS::Neptune::DBSubnetGroup` type creates an Amazon Neptune DB subnet group. Subnet groups must contain at least two subnets in two different Availability Zones in the same AWS Region.

## Syntax
<a name="aws-resource-neptune-dbsubnetgroup-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-neptune-dbsubnetgroup-syntax.json"></a>

```
{
  "Type" : "AWS::Neptune::DBSubnetGroup",
  "Properties" : {
      "[DBSubnetGroupDescription](#cfn-neptune-dbsubnetgroup-dbsubnetgroupdescription)" : String,
      "[DBSubnetGroupName](#cfn-neptune-dbsubnetgroup-dbsubnetgroupname)" : String,
      "[SubnetIds](#cfn-neptune-dbsubnetgroup-subnetids)" : [ String, ... ],
      "[Tags](#cfn-neptune-dbsubnetgroup-tags)" : [ Tag, ... ]
    }
}
```

### YAML
<a name="aws-resource-neptune-dbsubnetgroup-syntax.yaml"></a>

```
Type: AWS::Neptune::DBSubnetGroup
Properties:
  [DBSubnetGroupDescription](#cfn-neptune-dbsubnetgroup-dbsubnetgroupdescription): String
  [DBSubnetGroupName](#cfn-neptune-dbsubnetgroup-dbsubnetgroupname): String
  [SubnetIds](#cfn-neptune-dbsubnetgroup-subnetids): 
    - String
  [Tags](#cfn-neptune-dbsubnetgroup-tags): 
    - Tag
```

## Properties
<a name="aws-resource-neptune-dbsubnetgroup-properties"></a>

`DBSubnetGroupDescription`  <a name="cfn-neptune-dbsubnetgroup-dbsubnetgroupdescription"></a>
Provides the description of the DB subnet group.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`DBSubnetGroupName`  <a name="cfn-neptune-dbsubnetgroup-dbsubnetgroupname"></a>
The name of the DB subnet group.  
*Required*: No  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`SubnetIds`  <a name="cfn-neptune-dbsubnetgroup-subnetids"></a>
The Amazon EC2 subnet IDs for the DB subnet group.  
*Required*: Yes  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tags`  <a name="cfn-neptune-dbsubnetgroup-tags"></a>
The tags that you want to attach to the DB subnet group.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-neptune-dbsubnetgroup-tag.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-neptune-dbsubnetgroup-return-values"></a>

### Ref
<a name="aws-resource-neptune-dbsubnetgroup-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the resource name.

For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

# AWS::Neptune::DBSubnetGroup Tag
<a name="aws-properties-neptune-dbsubnetgroup-tag"></a>

Metadata assigned to an Amazon Neptune resource consisting of a key-value pair.

## Syntax
<a name="aws-properties-neptune-dbsubnetgroup-tag-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-neptune-dbsubnetgroup-tag-syntax.json"></a>

```
{
  "[Key](#cfn-neptune-dbsubnetgroup-tag-key)" : String,
  "[Value](#cfn-neptune-dbsubnetgroup-tag-value)" : String
}
```

### YAML
<a name="aws-properties-neptune-dbsubnetgroup-tag-syntax.yaml"></a>

```
  [Key](#cfn-neptune-dbsubnetgroup-tag-key): String
  [Value](#cfn-neptune-dbsubnetgroup-tag-value): String
```

## Properties
<a name="aws-properties-neptune-dbsubnetgroup-tag-properties"></a>

`Key`  <a name="cfn-neptune-dbsubnetgroup-tag-key"></a>
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with `aws:` or `rds:`. The string can only contain the set of Unicode letters, digits, white-space, '\$1', '.', '/', '=', '\$1', '-' (Java regex: "^([\$1\$1p\$1L\$1\$1\$1p\$1Z\$1\$1\$1p\$1N\$1\$1.:/=\$1\$1\$1-]\$1)\$1").  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-neptune-dbsubnetgroup-tag-value"></a>
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with `aws:` or `rds:`. The string can only contain the set of Unicode letters, digits, white-space, '\$1', '.', '/', '=', '\$1', '-' (Java regex: "^([\$1\$1p\$1L\$1\$1\$1p\$1Z\$1\$1\$1p\$1N\$1\$1.:/=\$1\$1\$1-]\$1)\$1").  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::Neptune::EventSubscription
<a name="aws-resource-neptune-eventsubscription"></a>

Creates an event notification subscription. This action requires a topic ARN (Amazon Resource Name) created by either the Neptune console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.

You can specify the type of source (SourceType) you want to be notified of, provide a list of Neptune sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.

If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIdentifier = myDBInstance1, you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you receive notice of the events for that source type for all your Neptune sources. If you do not specify either the SourceType nor the SourceIdentifier, you are notified of events generated from all Neptune sources belonging to your customer account.

## Syntax
<a name="aws-resource-neptune-eventsubscription-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-neptune-eventsubscription-syntax.json"></a>

```
{
  "Type" : "AWS::Neptune::EventSubscription",
  "Properties" : {
      "[Enabled](#cfn-neptune-eventsubscription-enabled)" : Boolean,
      "[EventCategories](#cfn-neptune-eventsubscription-eventcategories)" : [ String, ... ],
      "[SnsTopicArn](#cfn-neptune-eventsubscription-snstopicarn)" : String,
      "[SourceIds](#cfn-neptune-eventsubscription-sourceids)" : [ String, ... ],
      "[SourceType](#cfn-neptune-eventsubscription-sourcetype)" : String,
      "[SubscriptionName](#cfn-neptune-eventsubscription-subscriptionname)" : String,
      "[Tags](#cfn-neptune-eventsubscription-tags)" : [ Tag, ... ]
    }
}
```

### YAML
<a name="aws-resource-neptune-eventsubscription-syntax.yaml"></a>

```
Type: AWS::Neptune::EventSubscription
Properties:
  [Enabled](#cfn-neptune-eventsubscription-enabled): Boolean
  [EventCategories](#cfn-neptune-eventsubscription-eventcategories): 
    - String
  [SnsTopicArn](#cfn-neptune-eventsubscription-snstopicarn): String
  [SourceIds](#cfn-neptune-eventsubscription-sourceids): 
    - String
  [SourceType](#cfn-neptune-eventsubscription-sourcetype): String
  [SubscriptionName](#cfn-neptune-eventsubscription-subscriptionname): String
  [Tags](#cfn-neptune-eventsubscription-tags): 
    - Tag
```

## Properties
<a name="aws-resource-neptune-eventsubscription-properties"></a>

`Enabled`  <a name="cfn-neptune-eventsubscription-enabled"></a>
A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`EventCategories`  <a name="cfn-neptune-eventsubscription-eventcategories"></a>
Property description not available.  
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SnsTopicArn`  <a name="cfn-neptune-eventsubscription-snstopicarn"></a>
The topic ARN of the event notification subscription.  
*Required*: Yes  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`SourceIds`  <a name="cfn-neptune-eventsubscription-sourceids"></a>
Property description not available.  
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SourceType`  <a name="cfn-neptune-eventsubscription-sourcetype"></a>
The source type for the event notification subscription.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SubscriptionName`  <a name="cfn-neptune-eventsubscription-subscriptionname"></a>
Property description not available.  
*Required*: No  
*Type*: String  
*Maximum*: `255`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Tags`  <a name="cfn-neptune-eventsubscription-tags"></a>
Property description not available.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-neptune-eventsubscription-tag.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-neptune-eventsubscription-return-values"></a>

### Ref
<a name="aws-resource-neptune-eventsubscription-return-values-ref"></a>

# AWS::Neptune::EventSubscription Tag
<a name="aws-properties-neptune-eventsubscription-tag"></a>

Metadata assigned to an Amazon Neptune resource consisting of a key-value pair.

## Syntax
<a name="aws-properties-neptune-eventsubscription-tag-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-neptune-eventsubscription-tag-syntax.json"></a>

```
{
  "[Key](#cfn-neptune-eventsubscription-tag-key)" : String,
  "[Value](#cfn-neptune-eventsubscription-tag-value)" : String
}
```

### YAML
<a name="aws-properties-neptune-eventsubscription-tag-syntax.yaml"></a>

```
  [Key](#cfn-neptune-eventsubscription-tag-key): String
  [Value](#cfn-neptune-eventsubscription-tag-value): String
```

## Properties
<a name="aws-properties-neptune-eventsubscription-tag-properties"></a>

`Key`  <a name="cfn-neptune-eventsubscription-tag-key"></a>
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with `aws:` or `rds:`. The string can only contain the set of Unicode letters, digits, white-space, '\$1', '.', '/', '=', '\$1', '-' (Java regex: "^([\$1\$1p\$1L\$1\$1\$1p\$1Z\$1\$1\$1p\$1N\$1\$1.:/=\$1\$1\$1-]\$1)\$1").  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-neptune-eventsubscription-tag-value"></a>
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with `aws:` or `rds:`. The string can only contain the set of Unicode letters, digits, white-space, '\$1', '.', '/', '=', '\$1', '-' (Java regex: "^([\$1\$1p\$1L\$1\$1\$1p\$1Z\$1\$1\$1p\$1N\$1\$1.:/=\$1\$1\$1-]\$1)\$1").  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)