Neptune Instance

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

aws.neptune_instance

Fields

TitleIDTypeData TypeDescription
_keycorestring
account_idcorestring
allocated_storagecoreint64Not supported by Neptune.
auto_minor_version_upgradecoreboolIndicates that minor version patches are applied automatically.
availability_zonecorestringSpecifies the name of the Availability Zone the DB instance is located in.
backup_retention_periodcoreint64Specifies the number of days for which automatic DB snapshots are retained.
ca_certificate_identifiercorestringThe identifier of the CA certificate for this DB instance.
character_set_namecorestring<i>(Not supported by Neptune)</i>
copy_tags_to_snapshotcoreboolSpecifies whether tags are copied from the DB instance to snapshots of the DB instance.
db_cluster_identifiercorestringIf 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.
db_instance_arncorestringThe Amazon Resource Name (ARN) for the DB instance.
db_instance_classcorestringContains the name of the compute and memory capacity class of the DB instance.
db_instance_identifiercorestringContains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
db_instance_portcoreint64Specifies 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.
db_instance_statuscorestringSpecifies the current state of this database.
db_namecorestringThe database name.
db_parameter_groupscorejsonProvides the list of DB parameter groups applied to this DB instance.
db_security_groupscorejsonProvides List of DB security group elements containing only <code>DBSecurityGroup.Name</code> and <code>DBSecurityGroup.Status</code> subelements.
db_subnet_groupcorejsonSpecifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
dbi_resource_idcorestringThe 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.
deletion_protectioncoreboolIndicates whether or not the DB instance has deletion protection enabled. The instance can't be deleted when deletion protection is enabled. See <a href="https://docs.aws.amazon.com/neptune/latest/userguide/manage-console-instances-delete.html">Deleting a DB Instance</a>.
domain_membershipscorejsonNot supported
enabled_cloudwatch_logs_exportscorearray<string>A list of log types that this DB instance is configured to export to CloudWatch Logs.
endpointcorejsonSpecifies the connection endpoint.
enginecorestringProvides the name of the database engine to be used for this DB instance.
engine_versioncorestringIndicates the database engine version.
enhanced_monitoring_resource_arncorestringThe Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.
iam_database_authentication_enabledcoreboolTrue if Amazon Identity and Access Management (IAM) authentication is enabled, and otherwise false.
instance_create_timecoretimestampProvides the date and time the DB instance was created.
iopscoreint64Specifies the Provisioned IOPS (I/O operations per second) value.
kms_key_idcorestringNot supported: The encryption for DB instances is managed by the DB cluster.
latest_restorable_timecoretimestampSpecifies the latest time to which a database can be restored with point-in-time restore.
license_modelcorestringLicense model information for this DB instance.
master_usernamecorestringNot supported by Neptune.
monitoring_intervalcoreint64The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
monitoring_role_arncorestringThe ARN for the IAM role that permits Neptune to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
multi_azcoreboolSpecifies if the DB instance is a Multi-AZ deployment.
option_group_membershipscorejson<i>(Not supported by Neptune)</i>
pending_modified_valuescorejsonSpecifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
performance_insights_enabledcorebool<i>(Not supported by Neptune)</i>
performance_insights_kms_key_idcorestring<i>(Not supported by Neptune)</i>
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).
promotion_tiercoreint64A value that specifies the order in which a Read Replica is promoted to the primary instance after a failure of the existing primary instance.
publicly_accessiblecoreboolThis flag should no longer be used.
read_replica_db_cluster_identifierscorearray<string>Contains one or more identifiers of DB clusters that are Read Replicas of this DB instance.
read_replica_db_instance_identifierscorearray<string>Contains one or more identifiers of the Read Replicas associated with this DB instance.
read_replica_source_db_instance_identifiercorestringContains the identifier of the source DB instance if this DB instance is a Read Replica.
secondary_availability_zonecorestringIf present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
status_infoscorejsonThe status of a Read Replica. If the instance is not a Read Replica, this is blank.
storage_encryptedcoreboolNot supported: The encryption for DB instances is managed by the DB cluster.
storage_typecorestringSpecifies the storage type associated with DB instance.
tagscorehstore
tde_credential_arncorestringThe ARN from the key store with which the instance is associated for TDE encryption.
timezonecorestringNot supported.
vpc_security_groupscorejsonProvides a list of VPC security group elements that the DB instance belongs to.