Neptune Cluster

This table represents the Neptune Cluster resource from Amazon Web Services.

aws.neptune_cluster

Fields

TitleIDTypeData TypeDescription
_keycorestring
account_idcorestring
allocated_storagecoreint64<code>AllocatedStorage</code> always returns 1, because Neptune DB cluster storage size is not fixed, but instead automatically adjusts as needed.
associated_rolescorejsonProvides 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.
automatic_restart_timecoretimestampTime at which the DB cluster will be automatically restarted.
availability_zonescorearray<string>Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
backup_retention_periodcoreint64Specifies the number of days for which automatic DB snapshots are retained.
character_set_namecorestringNot supported by Neptune.
clone_group_idcorestringIdentifies the clone group to which the DB cluster is associated.
cluster_create_timecoretimestampSpecifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
copy_tags_to_snapshotcorebool<i>If set to <code>true</code>, tags are copied to any snapshot of the DB cluster that is created.</i>
cross_account_clonecoreboolIf set to <code>true</code>, the DB cluster can be cloned across accounts.
database_namecorestringContains 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.
db_cluster_arncorestringThe Amazon Resource Name (ARN) for the DB cluster.
db_cluster_identifiercorestringContains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
db_cluster_memberscorejsonProvides the list of instances that make up the DB cluster.
db_cluster_option_group_membershipscorejsonNot supported by Neptune.
db_cluster_parameter_groupcorestringSpecifies the name of the DB cluster parameter group for the DB cluster.
db_cluster_resource_idcorestringThe 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.
db_subnet_groupcorestringSpecifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
deletion_protectioncoreboolIndicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
earliest_restorable_timecoretimestampSpecifies the earliest time to which a database can be restored with point-in-time restore.
enabled_cloudwatch_logs_exportscorearray<string>A list of the log types that this DB cluster is configured to export to CloudWatch Logs. Valid log types are: <code>audit</code> (to publish audit logs to CloudWatch) and slowquery (to publish slow-query logs to CloudWatch). See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch-logs.html">Publishing Neptune logs to Amazon CloudWatch logs</a>.
endpointcorestringSpecifies the connection endpoint for the primary instance of the DB cluster.
enginecorestringProvides the name of the database engine to be used for this DB cluster.
engine_versioncorestringIndicates the database engine version.
global_cluster_identifiercorestringContains a user-supplied global database cluster identifier. This identifier is the unique key that identifies a global database.
hosted_zone_idcorestringSpecifies the ID that Amazon Route 53 assigns when you create a hosted zone.
iam_database_authentication_enabledcoreboolTrue if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
io_optimized_next_allowed_modification_timecoretimestampThe next time you can modify the DB cluster to use the <code>iopt1</code> storage type.
kms_key_idcorestringIf <code>StorageEncrypted</code> is true, the Amazon KMS key identifier for the encrypted DB cluster.
latest_restorable_timecoretimestampSpecifies the latest time to which a database can be restored with point-in-time restore.
master_usernamecorestringNot supported by Neptune.
multi_azcoreboolSpecifies whether the DB cluster has instances in multiple Availability Zones.
pending_modified_valuescorejsonThis data type is used as a response element in the <code>ModifyDBCluster</code> operation and contains changes that will be applied during the next maintenance window.
percent_progresscorestringSpecifies the progress of the operation as a percentage.
portcoreint64Specifies the port that the database engine is listening on.
preferred_backup_windowcorestringSpecifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the <code>BackupRetentionPeriod</code>.
preferred_maintenance_windowcorestringSpecifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
read_replica_identifierscorearray<string>Contains one or more identifiers of the Read Replicas associated with this DB cluster.
reader_endpointcorestringThe 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.
replication_source_identifiercorestringNot supported by Neptune.
serverless_v2_scaling_configurationcorejsonShows the scaling configuration for a Neptune Serverless DB cluster. For more information, see <a href="https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html">Using Amazon Neptune Serverless</a> in the <i>Amazon Neptune User Guide</i>.
statuscorestringSpecifies the current state of this DB cluster.
storage_encryptedcoreboolSpecifies whether the DB cluster is encrypted.
storage_typecorestringThe storage type associated with the DB cluster.
tagscorehstore
vpc_security_groupscorejsonProvides a list of VPC security groups that the DB cluster belongs to.