# Data Types The Amazon Neptune API contains several data types that various actions use. This section describes each data type in detail. **Note** The order of each element in a data type structure is not guaranteed. Applications should not assume a particular order. The following data types are supported: + [AvailabilityZone](API_AvailabilityZone.md) + [CharacterSet](API_CharacterSet.md) + [CloudwatchLogsExportConfiguration](API_CloudwatchLogsExportConfiguration.md) + [ClusterPendingModifiedValues](API_ClusterPendingModifiedValues.md) + [DBCluster](API_DBCluster.md) + [DBClusterEndpoint](API_DBClusterEndpoint.md) + [DBClusterMember](API_DBClusterMember.md) + [DBClusterOptionGroupStatus](API_DBClusterOptionGroupStatus.md) + [DBClusterParameterGroup](API_DBClusterParameterGroup.md) + [DBClusterRole](API_DBClusterRole.md) + [DBClusterSnapshot](API_DBClusterSnapshot.md) + [DBClusterSnapshotAttribute](API_DBClusterSnapshotAttribute.md) + [DBClusterSnapshotAttributesResult](API_DBClusterSnapshotAttributesResult.md) + [DBEngineVersion](API_DBEngineVersion.md) + [DBInstance](API_DBInstance.md) + [DBInstanceStatusInfo](API_DBInstanceStatusInfo.md) + [DBParameterGroup](API_DBParameterGroup.md) + [DBParameterGroupStatus](API_DBParameterGroupStatus.md) + [DBSecurityGroupMembership](API_DBSecurityGroupMembership.md) + [DBSubnetGroup](API_DBSubnetGroup.md) + [DomainMembership](API_DomainMembership.md) + [DoubleRange](API_DoubleRange.md) + [Endpoint](API_Endpoint.md) + [EngineDefaults](API_EngineDefaults.md) + [Event](API_Event.md) + [EventCategoriesMap](API_EventCategoriesMap.md) + [EventSubscription](API_EventSubscription.md) + [FailoverState](API_FailoverState.md) + [Filter](API_Filter.md) + [GlobalCluster](API_GlobalCluster.md) + [GlobalClusterMember](API_GlobalClusterMember.md) + [OptionGroupMembership](API_OptionGroupMembership.md) + [OrderableDBInstanceOption](API_OrderableDBInstanceOption.md) + [Parameter](API_Parameter.md) + [PendingCloudwatchLogsExports](API_PendingCloudwatchLogsExports.md) + [PendingMaintenanceAction](API_PendingMaintenanceAction.md) + [PendingModifiedValues](API_PendingModifiedValues.md) + [Range](API_Range.md) + [ResourcePendingMaintenanceActions](API_ResourcePendingMaintenanceActions.md) + [ServerlessV2ScalingConfiguration](API_ServerlessV2ScalingConfiguration.md) + [ServerlessV2ScalingConfigurationInfo](API_ServerlessV2ScalingConfigurationInfo.md) + [Subnet](API_Subnet.md) + [Tag](API_Tag.md) + [Timezone](API_Timezone.md) + [UpgradeTarget](API_UpgradeTarget.md) + [ValidDBInstanceModificationsMessage](API_ValidDBInstanceModificationsMessage.md) + [ValidStorageOptions](API_ValidStorageOptions.md) + [VpcSecurityGroupMembership](API_VpcSecurityGroupMembership.md) # AvailabilityZone Specifies an Availability Zone. ## Contents ** Name ** The name of the availability zone. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/AvailabilityZone) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/AvailabilityZone) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/AvailabilityZone) # CharacterSet Specifies a character set. ## Contents ** CharacterSetDescription ** The description of the character set. Type: String Required: No ** CharacterSetName ** The name of the character set. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/CharacterSet) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/CharacterSet) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/CharacterSet) # CloudwatchLogsExportConfiguration The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance or DB cluster. The `EnableLogTypes` and `DisableLogTypes` arrays determine which logs will be exported (or not exported) to CloudWatch Logs. Valid log types are: `audit` (to publish audit logs) and `slowquery` (to publish slow-query logs). See [Publishing Neptune logs to Amazon CloudWatch logs](https://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch-logs.html). ## Contents ** DisableLogTypes.member.N ** The list of log types to disable. Type: Array of strings Required: No ** EnableLogTypes.member.N ** The list of log types to enable. Type: Array of strings Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/CloudwatchLogsExportConfiguration) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/CloudwatchLogsExportConfiguration) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/CloudwatchLogsExportConfiguration) # ClusterPendingModifiedValues This data type is used as a response element in the `ModifyDBCluster` operation and contains changes that will be applied during the next maintenance window. ## Contents ** AllocatedStorage ** The allocated storage size in gibibytes (GiB) for database engines. For Neptune, `AllocatedStorage` always returns 1, because Neptune DB cluster storage size isn't fixed, but instead automatically adjusts as needed. Type: Integer Required: No ** BackupRetentionPeriod ** The number of days for which automatic DB snapshots are retained. Type: Integer Required: No ** DBClusterIdentifier ** The DBClusterIdentifier value for the DB cluster. Type: String Required: No ** EngineVersion ** The database engine version. Type: String Required: No ** IAMDatabaseAuthenticationEnabled ** A value that indicates whether mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled. Type: Boolean Required: No ** Iops ** The Provisioned IOPS (I/O operations per second) value. This setting is only for Multi-AZ DB clusters. Type: Integer Required: No ** PendingCloudwatchLogsExports ** This `PendingCloudwatchLogsExports` structure specifies pending changes to which CloudWatch logs are enabled and which are disabled. Type: [PendingCloudwatchLogsExports](API_PendingCloudwatchLogsExports.md) object Required: No ** StorageType ** The pending change in storage type for the DB cluster.   Valid Values: + ** `standard` **   –   ( *the default* ) Configures cost-effective database storage for applications with moderate to small I/O usage. + ** `iopt1` **   –   Enables [I/O-Optimized storage](https://docs.aws.amazon.com/neptune/latest/userguide/storage-types.html#provisioned-iops-storage) that's designed to meet the needs of I/O-intensive graph workloads that require predictable pricing with low I/O latency and consistent I/O throughput. Neptune I/O-Optimized storage is only available starting with engine release 1.3.0.0. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/ClusterPendingModifiedValues) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/ClusterPendingModifiedValues) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/ClusterPendingModifiedValues) # DBCluster Contains the details of an Amazon Neptune DB cluster. This data type is used as a response element in the [DescribeDBClusters](API_DescribeDBClusters.md). ## Contents ** AllocatedStorage ** `AllocatedStorage` always returns 1, because Neptune DB cluster storage size is not fixed, but instead automatically adjusts as needed. Type: Integer Required: No ** AssociatedRoles.DBClusterRole.N ** 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. Type: Array of [DBClusterRole](API_DBClusterRole.md) objects Required: No ** AutomaticRestartTime ** Time at which the DB cluster will be automatically restarted. Type: Timestamp Required: No ** AvailabilityZones.AvailabilityZone.N ** Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in. Type: Array of strings Required: No ** BackupRetentionPeriod ** Specifies the number of days for which automatic DB snapshots are retained. Type: Integer Required: No ** CharacterSetName ** Not supported by Neptune. Type: String Required: No ** CloneGroupId ** Identifies the clone group to which the DB cluster is associated. Type: String Required: No ** ClusterCreateTime ** Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC). Type: Timestamp Required: No ** CopyTagsToSnapshot ** *If set to `true`, tags are copied to any snapshot of the DB cluster that is created.* Type: Boolean Required: No ** CrossAccountClone ** If set to `true`, the DB cluster can be cloned across accounts. Type: Boolean Required: No ** DatabaseName ** Contains the name of the initial database of this DB cluster that was provided at create time, if one was specified when the DB cluster was created. This same name is returned for the life of the DB cluster. Type: String Required: No ** DBClusterArn ** The Amazon Resource Name (ARN) for the DB cluster. Type: String Required: No ** DBClusterIdentifier ** Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster. Type: String Required: No ** DBClusterMembers.DBClusterMember.N ** Provides the list of instances that make up the DB cluster. Type: Array of [DBClusterMember](API_DBClusterMember.md) objects Required: No ** DBClusterOptionGroupMemberships.DBClusterOptionGroup.N ** Not supported by Neptune. Type: Array of [DBClusterOptionGroupStatus](API_DBClusterOptionGroupStatus.md) objects Required: No ** DBClusterParameterGroup ** Specifies the name of the DB cluster parameter group for the DB cluster. Type: String Required: No ** DbClusterResourceId ** The Amazon Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon CloudTrail log entries whenever the Amazon KMS key for the DB cluster is accessed. Type: String Required: No ** DBSubnetGroup ** Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group. Type: String Required: No ** DeletionProtection ** Indicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. Type: Boolean Required: No ** EarliestRestorableTime ** Specifies the earliest time to which a database can be restored with point-in-time restore. Type: Timestamp Required: No ** EnabledCloudwatchLogsExports.member.N ** A list of the log types that this DB cluster is configured to export to CloudWatch Logs. Valid log types are: `audit` (to publish audit logs to CloudWatch) and slowquery (to publish slow-query logs to CloudWatch). See [Publishing Neptune logs to Amazon CloudWatch logs](https://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch-logs.html). Type: Array of strings Required: No ** Endpoint ** Specifies the connection endpoint for the primary instance of the DB cluster. Type: String Required: No ** Engine ** Provides the name of the database engine to be used for this DB cluster. Type: String Required: No ** EngineVersion ** Indicates the database engine version. Type: String Required: No ** GlobalClusterIdentifier ** Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `[A-Za-z][0-9A-Za-z-:._]*` Required: No ** HostedZoneId ** Specifies the ID that Amazon Route 53 assigns when you create a hosted zone. Type: String Required: No ** IAMDatabaseAuthenticationEnabled ** True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false. Type: Boolean Required: No ** IOOptimizedNextAllowedModificationTime ** The next time you can modify the DB cluster to use the `iopt1` storage type. Type: Timestamp Required: No ** KmsKeyId ** If `StorageEncrypted` is true, the Amazon KMS key identifier for the encrypted DB cluster. Type: String Required: No ** LatestRestorableTime ** Specifies the latest time to which a database can be restored with point-in-time restore. Type: Timestamp Required: No ** MasterUsername ** Not supported by Neptune. Type: String Required: No ** MultiAZ ** Specifies whether the DB cluster has instances in multiple Availability Zones. Type: Boolean Required: No ** PendingModifiedValues ** This data type is used as a response element in the `ModifyDBCluster` operation and contains changes that will be applied during the next maintenance window. Type: [ClusterPendingModifiedValues](API_ClusterPendingModifiedValues.md) object Required: No ** PercentProgress ** Specifies the progress of the operation as a percentage. Type: String Required: No ** Port ** Specifies the port that the database engine is listening on. Type: Integer Required: No ** PreferredBackupWindow ** Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the `BackupRetentionPeriod`. Type: String Required: No ** PreferredMaintenanceWindow ** Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Type: String Required: No ** ReaderEndpoint ** The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Read Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Neptune distributes the connection requests among the Read Replicas in the DB cluster. This functionality can help balance your read workload across multiple Read Replicas in your DB cluster. If a failover occurs, and the Read Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Read Replicas in the cluster, you can then reconnect to the reader endpoint. Type: String Required: No ** ReadReplicaIdentifiers.ReadReplicaIdentifier.N ** Contains one or more identifiers of the Read Replicas associated with this DB cluster. Type: Array of strings Required: No ** ReplicationSourceIdentifier ** Not supported by Neptune. Type: String Required: No ** ServerlessV2ScalingConfiguration ** Shows the scaling configuration for a Neptune Serverless DB cluster. For more information, see [Using Amazon Neptune Serverless](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html) in the *Amazon Neptune User Guide*. Type: [ServerlessV2ScalingConfigurationInfo](API_ServerlessV2ScalingConfigurationInfo.md) object Required: No ** Status ** Specifies the current state of this DB cluster. Type: String Required: No ** StorageEncrypted ** Specifies whether the DB cluster is encrypted. Type: Boolean Required: No ** StorageType ** The storage type used by the DB cluster. Valid Values: + ** `standard` **   –   ( *the default* ) Provides cost-effective database storage for applications with moderate to small I/O usage. + ** `iopt1` **   –   Enables [I/O-Optimized storage](https://docs.aws.amazon.com/neptune/latest/userguide/storage-types.html#provisioned-iops-storage) that's designed to meet the needs of I/O-intensive graph workloads that require predictable pricing with low I/O latency and consistent I/O throughput. Neptune I/O-Optimized storage is only available starting with engine release 1.3.0.0. Type: String Required: No ** VpcSecurityGroups.VpcSecurityGroupMembership.N ** Provides a list of VPC security groups that the DB cluster belongs to. Type: Array of [VpcSecurityGroupMembership](API_VpcSecurityGroupMembership.md) objects Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/DBCluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/DBCluster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/DBCluster) # DBClusterEndpoint This data type represents the information you need to connect to an Amazon Neptune DB cluster. This data type is used as a response element in the following actions: + `CreateDBClusterEndpoint` + `DescribeDBClusterEndpoints` + `ModifyDBClusterEndpoint` + `DeleteDBClusterEndpoint` For the data structure that represents Amazon Neptune DB instance endpoints, see `Endpoint`. ## Contents ** CustomEndpointType ** The type associated with a custom endpoint. One of: `READER`, `WRITER`, `ANY`. Type: String Required: No ** DBClusterEndpointArn ** The Amazon Resource Name (ARN) for the endpoint. Type: String Required: No ** DBClusterEndpointIdentifier ** The identifier associated with the endpoint. This parameter is stored as a lowercase string. Type: String Required: No ** DBClusterEndpointResourceIdentifier ** A unique system-generated identifier for an endpoint. It remains the same for the whole life of the endpoint. Type: String Required: No ** DBClusterIdentifier ** The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string. Type: String Required: No ** Endpoint ** The DNS address of the endpoint. Type: String Required: No ** EndpointType ** The type of the endpoint. One of: `READER`, `WRITER`, `CUSTOM`. Type: String Required: No ** ExcludedMembers.member.N ** List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty. Type: Array of strings Required: No ** StaticMembers.member.N ** List of DB instance identifiers that are part of the custom endpoint group. Type: Array of strings Required: No ** Status ** The current status of the endpoint. One of: `creating`, `available`, `deleting`, `inactive`, `modifying`. The `inactive` state applies to an endpoint that cannot be used for a certain kind of cluster, such as a `writer` endpoint for a read-only secondary cluster in a global database. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/DBClusterEndpoint) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/DBClusterEndpoint) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/DBClusterEndpoint) # DBClusterMember Contains information about an instance that is part of a DB cluster. ## Contents ** DBClusterParameterGroupStatus ** Specifies the status of the DB cluster parameter group for this member of the DB cluster. Type: String Required: No ** DBInstanceIdentifier ** Specifies the instance identifier for this member of the DB cluster. Type: String Required: No ** IsClusterWriter ** Value that is `true` if the cluster member is the primary instance for the DB cluster and `false` otherwise. Type: Boolean Required: No ** PromotionTier ** A value that specifies the order in which a Read Replica is promoted to the primary instance after a failure of the existing primary instance. Type: Integer Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/DBClusterMember) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/DBClusterMember) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/DBClusterMember) # DBClusterOptionGroupStatus Not supported by Neptune. ## Contents ** DBClusterOptionGroupName ** Not supported by Neptune. Type: String Required: No ** Status ** Not supported by Neptune. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/DBClusterOptionGroupStatus) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/DBClusterOptionGroupStatus) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/DBClusterOptionGroupStatus) # DBClusterParameterGroup Contains the details of an Amazon Neptune DB cluster parameter group. This data type is used as a response element in the [DescribeDBClusterParameterGroups](API_DescribeDBClusterParameterGroups.md) action. ## Contents ** DBClusterParameterGroupArn ** The Amazon Resource Name (ARN) for the DB cluster parameter group. Type: String Required: No ** DBClusterParameterGroupName ** Provides the name of the DB cluster parameter group. Type: String Required: No ** DBParameterGroupFamily ** Provides the name of the DB parameter group family that this DB cluster parameter group is compatible with. Type: String Required: No ** Description ** Provides the customer-specified description for this DB cluster parameter group. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/DBClusterParameterGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/DBClusterParameterGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/DBClusterParameterGroup) # DBClusterRole Describes an Amazon Identity and Access Management (IAM) role that is associated with a DB cluster. ## Contents ** FeatureName ** The name of the feature associated with the Amazon Identity and Access Management (IAM) role. For the list of supported feature names, see [DescribeDBEngineVersions](API_DescribeDBEngineVersions.md). Type: String Required: No ** RoleArn ** The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster. Type: String Required: No ** Status ** Describes the state of association between the IAM role and the DB cluster. The Status property returns one of the following values: + `ACTIVE` - the IAM role ARN is associated with the DB cluster and can be used to access other Amazon services on your behalf. + `PENDING` - the IAM role ARN is being associated with the DB cluster. + `INVALID` - the IAM role ARN is associated with the DB cluster, but the DB cluster is unable to assume the IAM role in order to access other Amazon services on your behalf. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/DBClusterRole) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/DBClusterRole) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/DBClusterRole) # DBClusterSnapshot Contains the details for an Amazon Neptune DB cluster snapshot This data type is used as a response element in the [DescribeDBClusterSnapshots](API_DescribeDBClusterSnapshots.md) action. ## Contents ** AllocatedStorage ** Specifies the allocated storage size in gibibytes (GiB). Type: Integer Required: No ** AvailabilityZones.AvailabilityZone.N ** Provides the list of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in. Type: Array of strings Required: No ** ClusterCreateTime ** Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC). Type: Timestamp Required: No ** DBClusterIdentifier ** Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from. Type: String Required: No ** DBClusterSnapshotArn ** The Amazon Resource Name (ARN) for the DB cluster snapshot. Type: String Required: No ** DBClusterSnapshotIdentifier ** Specifies the identifier for a DB cluster snapshot. Must match the identifier of an existing snapshot. After you restore a DB cluster using a `DBClusterSnapshotIdentifier`, you must specify the same `DBClusterSnapshotIdentifier` 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 `DBClusterSnapshotIdentifier`, 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 `DBClusterSnapshotIdentifier`, and the original DB cluster is deleted. Type: String Required: No ** Engine ** Specifies the name of the database engine. Type: String Required: No ** EngineVersion ** Provides the version of the database engine for this DB cluster snapshot. Type: String Required: No ** IAMDatabaseAuthenticationEnabled ** True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false. Type: Boolean Required: No ** KmsKeyId ** If `StorageEncrypted` is true, the Amazon KMS key identifier for the encrypted DB cluster snapshot. Type: String Required: No ** LicenseModel ** Provides the license model information for this DB cluster snapshot. Type: String Required: No ** MasterUsername ** Not supported by Neptune. Type: String Required: No ** PercentProgress ** Specifies the percentage of the estimated data that has been transferred. Type: Integer Required: No ** Port ** Specifies the port that the DB cluster was listening on at the time of the snapshot. Type: Integer Required: No ** SnapshotCreateTime ** Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC). Type: Timestamp Required: No ** SnapshotType ** Provides the type of the DB cluster snapshot. Type: String Required: No ** SourceDBClusterSnapshotArn ** If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value. Type: String Required: No ** Status ** Specifies the status of this DB cluster snapshot. Type: String Required: No ** StorageEncrypted ** Specifies whether the DB cluster snapshot is encrypted. Type: Boolean Required: No ** StorageType ** The storage type associated with the DB cluster snapshot. Type: String Required: No ** VpcId ** Provides the VPC ID associated with the DB cluster snapshot. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/DBClusterSnapshot) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/DBClusterSnapshot) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/DBClusterSnapshot) # DBClusterSnapshotAttribute Contains the name and values of a manual DB cluster snapshot attribute. Manual DB cluster snapshot attributes are used to authorize other Amazon accounts to restore a manual DB cluster snapshot. For more information, see the [ModifyDBClusterSnapshotAttribute](API_ModifyDBClusterSnapshotAttribute.md) API action. ## Contents ** AttributeName ** The name of the manual DB cluster snapshot attribute. The attribute named `restore` refers to the list of Amazon accounts that have permission to copy or restore the manual DB cluster snapshot. For more information, see the [ModifyDBClusterSnapshotAttribute](API_ModifyDBClusterSnapshotAttribute.md) API action. Type: String Required: No ** AttributeValues.AttributeValue.N ** The value(s) for the manual DB cluster snapshot attribute. If the `AttributeName` field is set to `restore`, then this element returns a list of IDs of the Amazon accounts that are authorized to copy or restore the manual DB cluster snapshot. If a value of `all` is in the list, then the manual DB cluster snapshot is public and available for any Amazon account to copy or restore. Type: Array of strings Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/DBClusterSnapshotAttribute) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/DBClusterSnapshotAttribute) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/DBClusterSnapshotAttribute) # DBClusterSnapshotAttributesResult Contains the results of a successful call to the [DescribeDBClusterSnapshotAttributes](API_DescribeDBClusterSnapshotAttributes.md) API action. Manual DB cluster snapshot attributes are used to authorize other Amazon accounts to copy or restore a manual DB cluster snapshot. For more information, see the [ModifyDBClusterSnapshotAttribute](API_ModifyDBClusterSnapshotAttribute.md) API action. ## Contents ** DBClusterSnapshotAttributes.DBClusterSnapshotAttribute.N ** The list of attributes and values for the manual DB cluster snapshot. Type: Array of [DBClusterSnapshotAttribute](API_DBClusterSnapshotAttribute.md) objects Required: No ** DBClusterSnapshotIdentifier ** The identifier of the manual DB cluster snapshot that the attributes apply to. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/DBClusterSnapshotAttributesResult) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/DBClusterSnapshotAttributesResult) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/DBClusterSnapshotAttributesResult) # DBEngineVersion This data type is used as a response element in the action [DescribeDBEngineVersions](API_DescribeDBEngineVersions.md). ## Contents ** DBEngineDescription ** The description of the database engine. Type: String Required: No ** DBEngineVersionDescription ** The description of the database engine version. Type: String Required: No ** DBParameterGroupFamily ** The name of the DB parameter group family for the database engine. Type: String Required: No ** DefaultCharacterSet ** *(Not supported by Neptune)* Type: [CharacterSet](API_CharacterSet.md) object Required: No ** Engine ** The name of the database engine. Type: String Required: No ** EngineVersion ** The version number of the database engine. Type: String Required: No ** ExportableLogTypes.member.N ** The types of logs that the database engine has available for export to CloudWatch Logs. Type: Array of strings Required: No ** SupportedCharacterSets.CharacterSet.N ** *(Not supported by Neptune)* Type: Array of [CharacterSet](API_CharacterSet.md) objects Required: No ** SupportedTimezones.Timezone.N ** A list of the time zones supported by this engine for the `Timezone` parameter of the `CreateDBInstance` action. Type: Array of [Timezone](API_Timezone.md) objects Required: No ** SupportsGlobalDatabases ** A value that indicates whether you can use Aurora global databases with a specific DB engine version. Type: Boolean Required: No ** SupportsLogExportsToCloudwatchLogs ** A value that indicates whether the engine version supports exporting the log types specified by ExportableLogTypes to CloudWatch Logs. Type: Boolean Required: No ** SupportsReadReplica ** Indicates whether the database engine version supports read replicas. Type: Boolean Required: No ** ValidUpgradeTarget.UpgradeTarget.N ** A list of engine versions that this database engine version can be upgraded to. Type: Array of [UpgradeTarget](API_UpgradeTarget.md) objects Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/DBEngineVersion) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/DBEngineVersion) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/DBEngineVersion) # DBInstance Contains the details of an Amazon Neptune DB instance. This data type is used as a response element in the [DescribeDBInstances](API_DescribeDBInstances.md) action. ## Contents ** AllocatedStorage ** Not supported by Neptune. Type: Integer Required: No ** AutoMinorVersionUpgrade ** Indicates that minor version patches are applied automatically. Type: Boolean Required: No ** AvailabilityZone ** Specifies the name of the Availability Zone the DB instance is located in. Type: String Required: No ** BackupRetentionPeriod ** Specifies the number of days for which automatic DB snapshots are retained. Type: Integer Required: No ** CACertificateIdentifier ** The identifier of the CA certificate for this DB instance. Type: String Required: No ** CharacterSetName ** *(Not supported by Neptune)* Type: String Required: No ** CopyTagsToSnapshot ** Specifies whether tags are copied from the DB instance to snapshots of the DB instance. Type: Boolean Required: No ** DBClusterIdentifier ** 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. Type: String Required: No ** DBInstanceArn ** The Amazon Resource Name (ARN) for the DB instance. Type: String Required: No ** DBInstanceClass ** Contains the name of the compute and memory capacity class of the DB instance. Type: String Required: No ** DBInstanceIdentifier ** Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance. Type: String Required: No ** DbInstancePort ** Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port. Type: Integer Required: No ** DBInstanceStatus ** Specifies the current state of this database. Type: String Required: No ** DbiResourceId ** The Amazon Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon CloudTrail log entries whenever the Amazon KMS key for the DB instance is accessed. Type: String Required: No ** DBName ** The database name. Type: String Required: No ** DBParameterGroups.DBParameterGroup.N ** Provides the list of DB parameter groups applied to this DB instance. Type: Array of [DBParameterGroupStatus](API_DBParameterGroupStatus.md) objects Required: No ** DBSecurityGroups.DBSecurityGroup.N ** Provides List of DB security group elements containing only `DBSecurityGroup.Name` and `DBSecurityGroup.Status` subelements. Type: Array of [DBSecurityGroupMembership](API_DBSecurityGroupMembership.md) objects Required: No ** DBSubnetGroup ** Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group. Type: [DBSubnetGroup](API_DBSubnetGroup.md) object Required: No ** DeletionProtection ** Indicates whether or not the DB instance has deletion protection enabled. The instance can't be deleted when deletion protection is enabled. See [Deleting a DB Instance](https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-instances-delete.html). Type: Boolean Required: No ** DomainMemberships.DomainMembership.N ** Not supported Type: Array of [DomainMembership](API_DomainMembership.md) objects Required: No ** EnabledCloudwatchLogsExports.member.N ** A list of log types that this DB instance is configured to export to CloudWatch Logs. Type: Array of strings Required: No ** Endpoint ** Specifies the connection endpoint. Type: [Endpoint](API_Endpoint.md) object Required: No ** Engine ** Provides the name of the database engine to be used for this DB instance. Type: String Required: No ** EngineVersion ** Indicates the database engine version. Type: String Required: No ** EnhancedMonitoringResourceArn ** The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance. Type: String Required: No ** IAMDatabaseAuthenticationEnabled ** True if Amazon Identity and Access Management (IAM) authentication is enabled, and otherwise false. Type: Boolean Required: No ** InstanceCreateTime ** Provides the date and time the DB instance was created. Type: Timestamp Required: No ** Iops ** Specifies the Provisioned IOPS (I/O operations per second) value. Type: Integer Required: No ** KmsKeyId ** Not supported: The encryption for DB instances is managed by the DB cluster. Type: String Required: No ** LatestRestorableTime ** Specifies the latest time to which a database can be restored with point-in-time restore. Type: Timestamp Required: No ** LicenseModel ** License model information for this DB instance. Type: String Required: No ** MasterUsername ** Not supported by Neptune. Type: String Required: No ** MonitoringInterval ** The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. Type: Integer Required: No ** MonitoringRoleArn ** The ARN for the IAM role that permits Neptune to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. Type: String Required: No ** MultiAZ ** Specifies if the DB instance is a Multi-AZ deployment. Type: Boolean Required: No ** OptionGroupMemberships.OptionGroupMembership.N ** *(Not supported by Neptune)* Type: Array of [OptionGroupMembership](API_OptionGroupMembership.md) objects Required: No ** PendingModifiedValues ** Specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements. Type: [PendingModifiedValues](API_PendingModifiedValues.md) object Required: No ** PerformanceInsightsEnabled ** *(Not supported by Neptune)* Type: Boolean Required: No ** PerformanceInsightsKMSKeyId ** *(Not supported by Neptune)* Type: String Required: No ** PreferredBackupWindow ** Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the `BackupRetentionPeriod`. Type: String Required: No ** PreferredMaintenanceWindow ** Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Type: String Required: No ** PromotionTier ** A value that specifies the order in which a Read Replica is promoted to the primary instance after a failure of the existing primary instance. Type: Integer Required: No ** PubliclyAccessible ** 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. Type: Boolean Required: No ** ReadReplicaDBClusterIdentifiers.ReadReplicaDBClusterIdentifier.N ** Contains one or more identifiers of DB clusters that are Read Replicas of this DB instance. Type: Array of strings Required: No ** ReadReplicaDBInstanceIdentifiers.ReadReplicaDBInstanceIdentifier.N ** Contains one or more identifiers of the Read Replicas associated with this DB instance. Type: Array of strings Required: No ** ReadReplicaSourceDBInstanceIdentifier ** Contains the identifier of the source DB instance if this DB instance is a Read Replica. Type: String Required: No ** SecondaryAvailabilityZone ** If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support. Type: String Required: No ** StatusInfos.DBInstanceStatusInfo.N ** The status of a Read Replica. If the instance is not a Read Replica, this is blank. Type: Array of [DBInstanceStatusInfo](API_DBInstanceStatusInfo.md) objects Required: No ** StorageEncrypted ** Not supported: The encryption for DB instances is managed by the DB cluster. Type: Boolean Required: No ** StorageType ** Specifies the storage type associated with the DB instance. Type: String Required: No ** TdeCredentialArn ** The ARN from the key store with which the instance is associated for TDE encryption. Type: String Required: No ** Timezone ** Not supported. Type: String Required: No ** VpcSecurityGroups.VpcSecurityGroupMembership.N ** Provides a list of VPC security group elements that the DB instance belongs to. Type: Array of [VpcSecurityGroupMembership](API_VpcSecurityGroupMembership.md) objects Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/DBInstance) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/DBInstance) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/DBInstance) # DBInstanceStatusInfo Provides a list of status information for a DB instance. ## Contents ** Message ** Details of the error if there is an error for the instance. If the instance is not in an error state, this value is blank. Type: String Required: No ** Normal ** Boolean value that is true if the instance is operating normally, or false if the instance is in an error state. Type: Boolean Required: No ** Status ** Status of the DB instance. For a StatusType of read replica, the values can be replicating, error, stopped, or terminated. Type: String Required: No ** StatusType ** This value is currently "read replication." Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/DBInstanceStatusInfo) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/DBInstanceStatusInfo) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/DBInstanceStatusInfo) # DBParameterGroup Contains the details of an Amazon Neptune DB parameter group. This data type is used as a response element in the [DescribeDBParameterGroups](API_DescribeDBParameterGroups.md) action. ## Contents ** DBParameterGroupArn ** The Amazon Resource Name (ARN) for the DB parameter group. Type: String Required: No ** DBParameterGroupFamily ** Provides the name of the DB parameter group family that this DB parameter group is compatible with. Type: String Required: No ** DBParameterGroupName ** Provides the name of the DB parameter group. Type: String Required: No ** Description ** Provides the customer-specified description for this DB parameter group. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/DBParameterGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/DBParameterGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/DBParameterGroup) # DBParameterGroupStatus The status of the DB parameter group. This data type is used as a response element in the following actions: + [CreateDBInstance](API_CreateDBInstance.md) + [DeleteDBInstance](API_DeleteDBInstance.md) + [ModifyDBInstance](API_ModifyDBInstance.md) + [RebootDBInstance](API_RebootDBInstance.md) ## Contents ** DBParameterGroupName ** The name of the DP parameter group. Type: String Required: No ** ParameterApplyStatus ** The status of parameter updates. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/DBParameterGroupStatus) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/DBParameterGroupStatus) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/DBParameterGroupStatus) # DBSecurityGroupMembership Specifies membership in a designated DB security group. ## Contents ** DBSecurityGroupName ** The name of the DB security group. Type: String Required: No ** Status ** The status of the DB security group. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/DBSecurityGroupMembership) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/DBSecurityGroupMembership) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/DBSecurityGroupMembership) # DBSubnetGroup Contains the details of an Amazon Neptune DB subnet group. This data type is used as a response element in the [DescribeDBSubnetGroups](API_DescribeDBSubnetGroups.md) action. ## Contents ** DBSubnetGroupArn ** The Amazon Resource Name (ARN) for the DB subnet group. Type: String Required: No ** DBSubnetGroupDescription ** Provides the description of the DB subnet group. Type: String Required: No ** DBSubnetGroupName ** The name of the DB subnet group. Type: String Required: No ** SubnetGroupStatus ** Provides the status of the DB subnet group. Type: String Required: No ** Subnets.Subnet.N ** Contains a list of [Subnet](API_Subnet.md) elements. Type: Array of [Subnet](API_Subnet.md) objects Required: No ** VpcId ** Provides the VpcId of the DB subnet group. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/DBSubnetGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/DBSubnetGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/DBSubnetGroup) # DomainMembership An Active Directory Domain membership record associated with a DB instance. ## Contents ** Domain ** The identifier of the Active Directory Domain. Type: String Required: No ** FQDN ** The fully qualified domain name of the Active Directory Domain. Type: String Required: No ** IAMRoleName ** The name of the IAM role to be used when making API calls to the Directory Service. Type: String Required: No ** Status ** The status of the DB instance's Active Directory Domain membership, such as joined, pending-join, failed etc). Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/DomainMembership) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/DomainMembership) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/DomainMembership) # DoubleRange A range of double values. ## Contents ** From ** The minimum value in the range. Type: Double Required: No ** To ** The maximum value in the range. Type: Double Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/DoubleRange) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/DoubleRange) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/DoubleRange) # Endpoint Specifies a connection endpoint. For the data structure that represents Amazon Neptune DB cluster endpoints, see `DBClusterEndpoint`. ## Contents ** Address ** Specifies the DNS address of the DB instance. Type: String Required: No ** HostedZoneId ** Specifies the ID that Amazon Route 53 assigns when you create a hosted zone. Type: String Required: No ** Port ** Specifies the port that the database engine is listening on. Type: Integer Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/Endpoint) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/Endpoint) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/Endpoint) # EngineDefaults Contains the result of a successful invocation of the [DescribeEngineDefaultParameters](API_DescribeEngineDefaultParameters.md) action. ## Contents ** DBParameterGroupFamily ** Specifies the name of the DB parameter group family that the engine default parameters apply to. Type: String Required: No ** Marker ** An optional pagination token provided by a previous EngineDefaults request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords` . Type: String Required: No ** Parameters.Parameter.N ** Contains a list of engine default parameters. Type: Array of [Parameter](API_Parameter.md) objects Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/EngineDefaults) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/EngineDefaults) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/EngineDefaults) # Event This data type is used as a response element in the [DescribeEvents](API_DescribeEvents.md) action. ## Contents ** Date ** Specifies the date and time of the event. Type: Timestamp Required: No ** EventCategories.EventCategory.N ** Specifies the category for the event. Type: Array of strings Required: No ** Message ** Provides the text of this event. Type: String Required: No ** SourceArn ** The Amazon Resource Name (ARN) for the event. Type: String Required: No ** SourceIdentifier ** Provides the identifier for the source of the event. Type: String Required: No ** SourceType ** Specifies the source type for this event. Type: String Valid Values: `db-instance | db-parameter-group | db-security-group | db-snapshot | db-cluster | db-cluster-snapshot` Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/Event) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/Event) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/Event) # EventCategoriesMap Contains the results of a successful invocation of the [DescribeEventCategories](API_DescribeEventCategories.md) action. ## Contents ** EventCategories.EventCategory.N ** The event categories for the specified source type Type: Array of strings Required: No ** SourceType ** The source type that the returned categories belong to Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/EventCategoriesMap) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/EventCategoriesMap) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/EventCategoriesMap) # EventSubscription Contains the results of a successful invocation of the [DescribeEventSubscriptions](API_DescribeEventSubscriptions.md) action. ## Contents ** CustomerAwsId ** The Amazon customer account associated with the event notification subscription. Type: String Required: No ** CustSubscriptionId ** The event notification subscription Id. Type: String Required: No ** Enabled ** A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled. Type: Boolean Required: No ** EventCategoriesList.EventCategory.N ** A list of event categories for the event notification subscription. Type: Array of strings Required: No ** EventSubscriptionArn ** The Amazon Resource Name (ARN) for the event subscription. Type: String Required: No ** SnsTopicArn ** The topic ARN of the event notification subscription. Type: String Required: No ** SourceIdsList.SourceId.N ** A list of source IDs for the event notification subscription. Type: Array of strings Required: No ** SourceType ** The source type for the event notification subscription. Type: String Required: No ** Status ** The status of the event notification subscription. Constraints: Can be one of the following: creating \$1 modifying \$1 deleting \$1 active \$1 no-permission \$1 topic-not-exist The status "no-permission" indicates that Neptune no longer has permission to post to the SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created. Type: String Required: No ** SubscriptionCreationTime ** The time the event notification subscription was created. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/EventSubscription) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/EventSubscription) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/EventSubscription) # FailoverState Contains the state of scheduled or in-process operations on a global cluster (Neptune global database). This data type is empty unless a switchover or failover operation is scheduled or is in progress on the Neptune global database. ## Contents ** FromDbClusterArn ** The Amazon Resource Name (ARN) of the Neptune DB cluster that is currently being demoted, and which is associated with this state. Type: String Required: No ** IsDataLossAllowed ** Indicates whether the operation is a global switchover or a global failover. If data loss is allowed, then the operation is a global failover. Otherwise, it's a switchover. Type: Boolean Required: No ** Status ** The current status of the global cluster. Possible values are as follows: + pending – The service received a request to switch over or fail over the global cluster. The global cluster's primary DB cluster and the specified secondary DB cluster are being verified before the operation starts. + failing-over – Neptune is promoting the chosen secondary Neptune DB cluster to become the new primary DB cluster to fail over the global cluster. + cancelling – The request to switch over or fail over the global cluster was cancelled and the primary Neptune DB cluster and the selected secondary Neptune DB cluster are returning to their previous states. + switching-over – This status covers the range of Neptune internal operations that take place during the switchover process, such as demoting the primary Neptune DB cluster, promoting the secondary Neptune DB cluster, and synchronizing replicas. Type: String Valid Values: `pending | failing-over | cancelling` Required: No ** ToDbClusterArn ** The Amazon Resource Name (ARN) of the Neptune DB cluster that is currently being promoted, and which is associated with this state. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/FailoverState) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/FailoverState) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/FailoverState) # Filter This type is not currently supported. ## Contents ** Name ** This parameter is not currently supported. Type: String Required: Yes ** Values.Value.N ** This parameter is not currently supported. Type: Array of strings Required: Yes ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/Filter) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/Filter) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/Filter) # GlobalCluster Contains the details of an Amazon Neptune global database. This data type is used as a response element for the [CreateGlobalCluster](API_CreateGlobalCluster.md), [DescribeGlobalClusters](API_DescribeGlobalClusters.md), [ModifyGlobalCluster](API_ModifyGlobalCluster.md), [DeleteGlobalCluster](API_DeleteGlobalCluster.md), [FailoverGlobalCluster](API_FailoverGlobalCluster.md), and [RemoveFromGlobalCluster](API_RemoveFromGlobalCluster.md) actions. ## Contents ** DeletionProtection ** The deletion protection setting for the global database. Type: Boolean Required: No ** Engine ** The Neptune database engine used by the global database (`"neptune"`). Type: String Required: No ** EngineVersion ** The Neptune engine version used by the global database. Type: String Required: No ** FailoverState ** A data object containing all properties for the current state of an in-process or pending switchover or failover process for this global cluster (Neptune global database). This object is empty unless the `SwitchoverGlobalCluster` or `FailoverGlobalCluster` operation was called on this global cluster. Type: [FailoverState](API_FailoverState.md) object Required: No ** GlobalClusterArn ** The Amazon Resource Name (ARN) for the global database. Type: String Required: No ** GlobalClusterIdentifier ** Contains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: `[A-Za-z][0-9A-Za-z-:._]*` Required: No ** GlobalClusterMembers.GlobalClusterMember.N ** A list of cluster ARNs and instance ARNs for all the DB clusters that are part of the global database. Type: Array of [GlobalClusterMember](API_GlobalClusterMember.md) objects Required: No ** GlobalClusterResourceId ** An immutable identifier for the global database that is unique within in all regions. This identifier is found in CloudTrail log entries whenever the KMS key for the DB cluster is accessed. Type: String Required: No ** Status ** Specifies the current state of this global database. Type: String Required: No ** StorageEncrypted ** The storage encryption setting for the global database. Type: Boolean Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/GlobalCluster) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/GlobalCluster) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/GlobalCluster) # GlobalClusterMember A data structure with information about any primary and secondary clusters associated with an Neptune global database. ## Contents ** DBClusterArn ** The Amazon Resource Name (ARN) for each Neptune cluster. Type: String Required: No ** IsWriter ** Specifies whether the Neptune cluster is the primary cluster (that is, has read-write capability) for the Neptune global database with which it is associated. Type: Boolean Required: No ** Readers.member.N ** The Amazon Resource Name (ARN) for each read-only secondary cluster associated with the Neptune global database. Type: Array of strings Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/GlobalClusterMember) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/GlobalClusterMember) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/GlobalClusterMember) # OptionGroupMembership Not supported by Neptune. ## Contents ** OptionGroupName ** Not supported by Neptune. Type: String Required: No ** Status ** Not supported by Neptune. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/OptionGroupMembership) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/OptionGroupMembership) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/OptionGroupMembership) # OrderableDBInstanceOption Contains a list of available options for a DB instance. This data type is used as a response element in the [DescribeOrderableDBInstanceOptions](API_DescribeOrderableDBInstanceOptions.md) action. ## Contents ** AvailabilityZones.AvailabilityZone.N ** A list of Availability Zones for a DB instance. Type: Array of [AvailabilityZone](API_AvailabilityZone.md) objects Required: No ** DBInstanceClass ** The DB instance class for a DB instance. Type: String Required: No ** Engine ** The engine type of a DB instance. Type: String Required: No ** EngineVersion ** The engine version of a DB instance. Type: String Required: No ** LicenseModel ** The license model for a DB instance. Type: String Required: No ** MaxIopsPerDbInstance ** Maximum total provisioned IOPS for a DB instance. Type: Integer Required: No ** MaxIopsPerGib ** Maximum provisioned IOPS per GiB for a DB instance. Type: Double Required: No ** MaxStorageSize ** Maximum storage size for a DB instance. Type: Integer Required: No ** MinIopsPerDbInstance ** Minimum total provisioned IOPS for a DB instance. Type: Integer Required: No ** MinIopsPerGib ** Minimum provisioned IOPS per GiB for a DB instance. Type: Double Required: No ** MinStorageSize ** Minimum storage size for a DB instance. Type: Integer Required: No ** MultiAZCapable ** Indicates whether a DB instance is Multi-AZ capable. Type: Boolean Required: No ** ReadReplicaCapable ** Indicates whether a DB instance can have a Read Replica. Type: Boolean Required: No ** StorageType ** Not applicable. In Neptune the storage type is managed at the DB Cluster level. Type: String Required: No ** SupportsEnhancedMonitoring ** Indicates whether a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds. Type: Boolean Required: No ** SupportsGlobalDatabases ** A value that indicates whether you can use Neptune global databases with a specific combination of other DB engine attributes. Type: Boolean Required: No ** SupportsIAMDatabaseAuthentication ** Indicates whether a DB instance supports IAM database authentication. Type: Boolean Required: No ** SupportsIops ** Indicates whether a DB instance supports provisioned IOPS. Type: Boolean Required: No ** SupportsPerformanceInsights ** *(Not supported by Neptune)* Type: Boolean Required: No ** SupportsStorageEncryption ** Indicates whether a DB instance supports encrypted storage. Type: Boolean Required: No ** Vpc ** Indicates whether a DB instance is in a VPC. Type: Boolean Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/OrderableDBInstanceOption) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/OrderableDBInstanceOption) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/OrderableDBInstanceOption) # Parameter Specifies a parameter. ## Contents ** AllowedValues ** Specifies the valid range of values for the parameter. Type: String Required: No ** ApplyMethod ** Indicates when to apply parameter updates. Type: String Valid Values: `immediate | pending-reboot` Required: No ** ApplyType ** Specifies the engine specific parameters type. Type: String Required: No ** DataType ** Specifies the valid data type for the parameter. Type: String Required: No ** Description ** Provides a description of the parameter. Type: String Required: No ** IsModifiable ** Indicates whether (`true`) or not (`false`) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed. Type: Boolean Required: No ** MinimumEngineVersion ** The earliest engine version to which the parameter can apply. Type: String Required: No ** ParameterName ** Specifies the name of the parameter. Type: String Required: No ** ParameterValue ** Specifies the value of the parameter. Type: String Required: No ** Source ** Indicates the source of the parameter value. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/Parameter) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/Parameter) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/Parameter) # PendingCloudwatchLogsExports A list of the log types whose configuration is still pending. In other words, these log types are in the process of being activated or deactivated. Valid log types are: `audit` (to publish audit logs) and `slowquery` (to publish slow-query logs). See [Publishing Neptune logs to Amazon CloudWatch logs](https://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch-logs.html). ## Contents ** LogTypesToDisable.member.N ** Log types that are in the process of being enabled. After they are enabled, these log types are exported to CloudWatch Logs. Type: Array of strings Required: No ** LogTypesToEnable.member.N ** Log types that are in the process of being deactivated. After they are deactivated, these log types aren't exported to CloudWatch Logs. Type: Array of strings Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/PendingCloudwatchLogsExports) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/PendingCloudwatchLogsExports) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/PendingCloudwatchLogsExports) # PendingMaintenanceAction Provides information about a pending maintenance action for a resource. ## Contents ** Action ** The type of pending maintenance action that is available for the resource. Type: String Required: No ** AutoAppliedAfterDate ** The date of the maintenance window when the action is applied. The maintenance action is applied to the resource during its first maintenance window after this date. If this date is specified, any `next-maintenance` opt-in requests are ignored. Type: Timestamp Required: No ** CurrentApplyDate ** The effective date when the pending maintenance action is applied to the resource. This date takes into account opt-in requests received from the [ApplyPendingMaintenanceAction](API_ApplyPendingMaintenanceAction.md) API, the `AutoAppliedAfterDate`, and the `ForcedApplyDate`. This value is blank if an opt-in request has not been received and nothing has been specified as `AutoAppliedAfterDate` or `ForcedApplyDate`. Type: Timestamp Required: No ** Description ** A description providing more detail about the maintenance action. Type: String Required: No ** ForcedApplyDate ** The date when the maintenance action is automatically applied. The maintenance action is applied to the resource on this date regardless of the maintenance window for the resource. If this date is specified, any `immediate` opt-in requests are ignored. Type: Timestamp Required: No ** OptInStatus ** Indicates the type of opt-in request that has been received for the resource. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/PendingMaintenanceAction) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/PendingMaintenanceAction) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/PendingMaintenanceAction) # PendingModifiedValues This data type is used as a response element in the [ModifyDBInstance](API_ModifyDBInstance.md) action. ## Contents ** AllocatedStorage ** Contains the new `AllocatedStorage` size for the DB instance that will be applied or is currently being applied. Type: Integer Required: No ** BackupRetentionPeriod ** Specifies the pending number of days for which automated backups are retained. Type: Integer Required: No ** CACertificateIdentifier ** Specifies the identifier of the CA certificate for the DB instance. Type: String Required: No ** DBInstanceClass ** Contains the new `DBInstanceClass` for the DB instance that will be applied or is currently being applied. Type: String Required: No ** DBInstanceIdentifier ** Contains the new `DBInstanceIdentifier` for the DB instance that will be applied or is currently being applied. Type: String Required: No ** DBSubnetGroupName ** The new DB subnet group for the DB instance. Type: String Required: No ** EngineVersion ** Indicates the database engine version. Type: String Required: No ** Iops ** Specifies the new Provisioned IOPS value for the DB instance that will be applied or is currently being applied. Type: Integer Required: No ** LicenseModel ** Not supported by Neptune. Type: String Required: No ** MasterUserPassword ** Not supported by Neptune. Type: String Required: No ** MultiAZ ** Indicates that the Single-AZ DB instance is to change to a Multi-AZ deployment. Type: Boolean Required: No ** PendingCloudwatchLogsExports ** This `PendingCloudwatchLogsExports` structure specifies pending changes to which CloudWatch logs are enabled and which are disabled. Type: [PendingCloudwatchLogsExports](API_PendingCloudwatchLogsExports.md) object Required: No ** Port ** Specifies the pending port for the DB instance. Type: Integer Required: No ** StorageType ** Not applicable. In Neptune the storage type is managed at the DB Cluster level. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/PendingModifiedValues) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/PendingModifiedValues) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/PendingModifiedValues) # Range A range of integer values. ## Contents ** From ** The minimum value in the range. Type: Integer Required: No ** Step ** The step value for the range. For example, if you have a range of 5,000 to 10,000, with a step value of 1,000, the valid values start at 5,000 and step up by 1,000. Even though 7,500 is within the range, it isn't a valid value for the range. The valid values are 5,000, 6,000, 7,000, 8,000... Type: Integer Required: No ** To ** The maximum value in the range. Type: Integer Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/Range) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/Range) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/Range) # ResourcePendingMaintenanceActions Describes the pending maintenance actions for a resource. ## Contents ** PendingMaintenanceActionDetails.PendingMaintenanceAction.N ** A list that provides details about the pending maintenance actions for the resource. Type: Array of [PendingMaintenanceAction](API_PendingMaintenanceAction.md) objects Required: No ** ResourceIdentifier ** The ARN of the resource that has pending maintenance actions. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/ResourcePendingMaintenanceActions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/ResourcePendingMaintenanceActions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/ResourcePendingMaintenanceActions) # ServerlessV2ScalingConfiguration Contains the scaling configuration of a Neptune Serverless DB cluster. For more information, see [Using Amazon Neptune Serverless](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html) in the *Amazon Neptune User Guide*. ## Contents ** MaxCapacity ** 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. Type: Double Required: No ** MinCapacity ** 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. Type: Double Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/ServerlessV2ScalingConfiguration) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/ServerlessV2ScalingConfiguration) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/ServerlessV2ScalingConfiguration) # ServerlessV2ScalingConfigurationInfo Shows the scaling configuration for a Neptune Serverless DB cluster. For more information, see [Using Amazon Neptune Serverless](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html) in the *Amazon Neptune User Guide*. ## Contents ** MaxCapacity ** 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. Type: Double Required: No ** MinCapacity ** 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. Type: Double Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/ServerlessV2ScalingConfigurationInfo) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/ServerlessV2ScalingConfigurationInfo) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/ServerlessV2ScalingConfigurationInfo) # Subnet Specifies a subnet. This data type is used as a response element in the [DescribeDBSubnetGroups](API_DescribeDBSubnetGroups.md) action. ## Contents ** SubnetAvailabilityZone ** Specifies the EC2 Availability Zone that the subnet is in. Type: [AvailabilityZone](API_AvailabilityZone.md) object Required: No ** SubnetIdentifier ** Specifies the identifier of the subnet. Type: String Required: No ** SubnetStatus ** Specifies the status of the subnet. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/Subnet) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/Subnet) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/Subnet) # Tag Metadata assigned to an Amazon Neptune resource consisting of a key-value pair. ## Contents ** Key ** 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"). Type: String Required: No ** Value ** 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"). Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/Tag) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/Tag) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/Tag) # Timezone A time zone associated with a [DBInstance](API_DBInstance.md). ## Contents ** TimezoneName ** The name of the time zone. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/Timezone) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/Timezone) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/Timezone) # UpgradeTarget The version of the database engine that a DB instance can be upgraded to. ## Contents ** AutoUpgrade ** A value that indicates whether the target version is applied to any source DB instances that have AutoMinorVersionUpgrade set to true. Type: Boolean Required: No ** Description ** The version of the database engine that a DB instance can be upgraded to. Type: String Required: No ** Engine ** The name of the upgrade target database engine. Type: String Required: No ** EngineVersion ** The version number of the upgrade target database engine. Type: String Required: No ** IsMajorVersionUpgrade ** A value that indicates whether a database engine is upgraded to a major version. Type: Boolean Required: No ** SupportsGlobalDatabases ** A value that indicates whether you can use Neptune global databases with the target engine version. Type: Boolean Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/UpgradeTarget) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/UpgradeTarget) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/UpgradeTarget) # ValidDBInstanceModificationsMessage Information about valid modifications that you can make to your DB instance. Contains the result of a successful call to the [DescribeValidDBInstanceModifications](API_DescribeValidDBInstanceModifications.md) action. You can use this information when you call [ModifyDBInstance](API_ModifyDBInstance.md). ## Contents ** Storage.ValidStorageOptions.N ** Valid storage options for your DB instance. Type: Array of [ValidStorageOptions](API_ValidStorageOptions.md) objects Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/ValidDBInstanceModificationsMessage) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/ValidDBInstanceModificationsMessage) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/ValidDBInstanceModificationsMessage) # ValidStorageOptions Not applicable. In Neptune the storage type is managed at the DB Cluster level. ## Contents ** IopsToStorageRatio.DoubleRange.N ** Not applicable. In Neptune the storage type is managed at the DB Cluster level. Type: Array of [DoubleRange](API_DoubleRange.md) objects Required: No ** ProvisionedIops.Range.N ** Not applicable. In Neptune the storage type is managed at the DB Cluster level. Type: Array of [Range](API_Range.md) objects Required: No ** StorageSize.Range.N ** Not applicable. In Neptune the storage type is managed at the DB Cluster level. Type: Array of [Range](API_Range.md) objects Required: No ** StorageType ** Not applicable. In Neptune the storage type is managed at the DB Cluster level. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/ValidStorageOptions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/ValidStorageOptions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/ValidStorageOptions) # VpcSecurityGroupMembership This data type is used as a response element for queries on VPC security group membership. ## Contents ** Status ** The status of the VPC security group. Type: String Required: No ** VpcSecurityGroupId ** The name of the VPC security group. Type: String Required: No ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/neptune-2014-10-31/VpcSecurityGroupMembership) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/neptune-2014-10-31/VpcSecurityGroupMembership) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/neptune-2014-10-31/VpcSecurityGroupMembership)