Module Values.DBInstanceSource

Contains the details of an Amazon Neptune DB instance. This data type is used as a response element in the DescribeDBInstances action.

Sourcetype nonrec t = {
  1. dBInstanceIdentifier : String_.t option;
    (*

    Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.

    *)
  2. dBInstanceClass : String_.t option;
    (*

    Contains the name of the compute and memory capacity class of the DB instance.

    *)
  3. engine : String_.t option;
    (*

    Provides the name of the database engine to be used for this DB instance.

    *)
  4. dBInstanceStatus : String_.t option;
    (*

    Specifies the current state of this database.

    *)
  5. masterUsername : String_.t option;
    (*

    Not supported by Neptune.

    *)
  6. dBName : String_.t option;
    (*

    The database name.

    *)
  7. endpoint : Endpoint.t option;
    (*

    Specifies the connection endpoint.

    *)
  8. allocatedStorage : Integer.t option;
    (*

    Not supported by Neptune.

    *)
  9. instanceCreateTime : TStamp.t option;
    (*

    Provides the date and time the DB instance was created.

    *)
  10. preferredBackupWindow : String_.t option;
    (*

    Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

    *)
  11. backupRetentionPeriod : Integer.t option;
    (*

    Specifies the number of days for which automatic DB snapshots are retained.

    *)
  12. dBSecurityGroups : DBSecurityGroupMembershipList.t option;
    (*

    Provides List of DB security group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.

    *)
  13. vpcSecurityGroups : VpcSecurityGroupMembershipList.t option;
    (*

    Provides a list of VPC security group elements that the DB instance belongs to.

    *)
  14. dBParameterGroups : DBParameterGroupStatusList.t option;
    (*

    Provides the list of DB parameter groups applied to this DB instance.

    *)
  15. availabilityZone : String_.t option;
    (*

    Specifies the name of the Availability Zone the DB instance is located in.

    *)
  16. dBSubnetGroup : DBSubnetGroup.t option;
    (*

    Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.

    *)
  17. preferredMaintenanceWindow : String_.t option;
    (*

    Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

    *)
  18. pendingModifiedValues : PendingModifiedValues.t option;
    (*

    Specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.

    *)
  19. latestRestorableTime : TStamp.t option;
    (*

    Specifies the latest time to which a database can be restored with point-in-time restore.

    *)
  20. multiAZ : Boolean.t option;
    (*

    Specifies if the DB instance is a Multi-AZ deployment.

    *)
  21. engineVersion : String_.t option;
    (*

    Indicates the database engine version.

    *)
  22. autoMinorVersionUpgrade : Boolean.t option;
    (*

    Indicates that minor version patches are applied automatically.

    *)
  23. readReplicaSourceDBInstanceIdentifier : String_.t option;
    (*

    Contains the identifier of the source DB instance if this DB instance is a Read Replica.

    *)
  24. readReplicaDBInstanceIdentifiers : ReadReplicaDBInstanceIdentifierList.t option;
    (*

    Contains one or more identifiers of the Read Replicas associated with this DB instance.

    *)
  25. readReplicaDBClusterIdentifiers : ReadReplicaDBClusterIdentifierList.t option;
    (*

    Contains one or more identifiers of DB clusters that are Read Replicas of this DB instance.

    *)
  26. licenseModel : String_.t option;
    (*

    License model information for this DB instance.

    *)
  27. iops : IntegerOptional.t option;
    (*

    Specifies the Provisioned IOPS (I/O operations per second) value.

    *)
  28. optionGroupMemberships : OptionGroupMembershipList.t option;
    (*

    (Not supported by Neptune)

    *)
  29. characterSetName : String_.t option;
    (*

    (Not supported by Neptune)

    *)
  30. secondaryAvailabilityZone : String_.t option;
    (*

    If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.

    *)
  31. publiclyAccessible : Boolean.t option;
    (*

    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.

    *)
  32. statusInfos : DBInstanceStatusInfoList.t option;
    (*

    The status of a Read Replica. If the instance is not a Read Replica, this is blank.

    *)
  33. storageType : String_.t option;
    (*

    Specifies the storage type associated with the DB instance.

    *)
  34. tdeCredentialArn : String_.t option;
    (*

    The ARN from the key store with which the instance is associated for TDE encryption.

    *)
  35. dbInstancePort : Integer.t option;
    (*

    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.

    *)
  36. dBClusterIdentifier : String_.t option;
    (*

    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.

    *)
  37. storageEncrypted : Boolean.t option;
    (*

    Not supported: The encryption for DB instances is managed by the DB cluster.

    *)
  38. kmsKeyId : String_.t option;
    (*

    Not supported: The encryption for DB instances is managed by the DB cluster.

    *)
  39. dbiResourceId : String_.t option;
    (*

    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.

    *)
  40. cACertificateIdentifier : String_.t option;
    (*

    The identifier of the CA certificate for this DB instance.

    *)
  41. domainMemberships : DomainMembershipList.t option;
    (*

    Not supported

    *)
  42. copyTagsToSnapshot : Boolean.t option;
    (*

    Specifies whether tags are copied from the DB instance to snapshots of the DB instance.

    *)
  43. monitoringInterval : IntegerOptional.t option;
    (*

    The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.

    *)
  44. enhancedMonitoringResourceArn : String_.t option;
    (*

    The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.

    *)
  45. monitoringRoleArn : String_.t option;
    (*

    The ARN for the IAM role that permits Neptune to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.

    *)
  46. promotionTier : IntegerOptional.t option;
    (*

    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.

    *)
  47. dBInstanceArn : String_.t option;
    (*

    The Amazon Resource Name (ARN) for the DB instance.

    *)
  48. timezone : String_.t option;
    (*

    Not supported.

    *)
  49. iAMDatabaseAuthenticationEnabled : Boolean.t option;
    (*

    True if Amazon Identity and Access Management (IAM) authentication is enabled, and otherwise false.

    *)
  50. performanceInsightsEnabled : BooleanOptional.t option;
    (*

    (Not supported by Neptune)

    *)
  51. performanceInsightsKMSKeyId : String_.t option;
    (*

    (Not supported by Neptune)

    *)
  52. enabledCloudwatchLogsExports : LogTypeList.t option;
    (*

    A list of log types that this DB instance is configured to export to CloudWatch Logs.

    *)
  53. deletionProtection : BooleanOptional.t option;
    (*

    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.

    *)
}
Sourceval make : ?dBInstanceIdentifier:??? -> ?dBInstanceClass:??? -> ?engine:??? -> ?dBInstanceStatus:??? -> ?masterUsername:??? -> ?dBName:??? -> ?endpoint:??? -> ?allocatedStorage:??? -> ?instanceCreateTime:??? -> ?preferredBackupWindow:??? -> ?backupRetentionPeriod:??? -> ?dBSecurityGroups:??? -> ?vpcSecurityGroups:??? -> ?dBParameterGroups:??? -> ?availabilityZone:??? -> ?dBSubnetGroup:??? -> ?preferredMaintenanceWindow:??? -> ?pendingModifiedValues:??? -> ?latestRestorableTime:??? -> ?multiAZ:??? -> ?engineVersion:??? -> ?autoMinorVersionUpgrade:??? -> ?readReplicaSourceDBInstanceIdentifier:??? -> ?readReplicaDBInstanceIdentifiers:??? -> ?readReplicaDBClusterIdentifiers:??? -> ?licenseModel:??? -> ?iops:??? -> ?optionGroupMemberships:??? -> ?characterSetName:??? -> ?secondaryAvailabilityZone:??? -> ?publiclyAccessible:??? -> ?statusInfos:??? -> ?storageType:??? -> ?tdeCredentialArn:??? -> ?dbInstancePort:??? -> ?dBClusterIdentifier:??? -> ?storageEncrypted:??? -> ?kmsKeyId:??? -> ?dbiResourceId:??? -> ?cACertificateIdentifier:??? -> ?domainMemberships:??? -> ?copyTagsToSnapshot:??? -> ?monitoringInterval:??? -> ?enhancedMonitoringResourceArn:??? -> ?monitoringRoleArn:??? -> ?promotionTier:??? -> ?dBInstanceArn:??? -> ?timezone:??? -> ?iAMDatabaseAuthenticationEnabled:??? -> ?performanceInsightsEnabled:??? -> ?performanceInsightsKMSKeyId:??? -> ?enabledCloudwatchLogsExports:??? -> ?deletionProtection:??? -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Boolean of Boolean.t | `Integer of Integer.t | `List of [> `String of String_.t | `Structure of (string * [> `Boolean of Boolean.t | `String of String_.t ]) list ] list | `String of String_.t | `Structure of (string * [> `Boolean of BooleanOptional.t | `Integer of Integer.t | `List of [> `Structure of (string * [> `String of String_.t | `Structure of (string * [> `String of String_.t ]) list ]) list ] list | `String of String_.t | `Structure of (string * [> `List of [> `String of String_.t ] list ]) list ]) list | `Timestamp of TStamp.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t