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

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