DBInstance

import type { DBInstance } from "https://aws-api.deno.dev/v0.3/services/neptune.ts?docs=full";

Contains the details of an Amazon Neptune DB instance.

This data type is used as a response element in the "DescribeDBInstances" action.

interface DBInstance {

AllocatedStorage?: number | null;

AutoMinorVersionUpgrade?: boolean | null;

AvailabilityZone?: string | null;

BackupRetentionPeriod?: number | null;

CACertificateIdentifier?: string | null;

CharacterSetName?: string | null;

CopyTagsToSnapshot?: boolean | null;

DBClusterIdentifier?: string | null;

DBInstanceArn?: string | null;

DBInstanceClass?: string | null;

DBInstanceIdentifier?: string | null;

DbInstancePort?: number | null;

DBInstanceStatus?: string | null;

DbiResourceId?: string | null;

DBName?: string | null;

DBParameterGroups: DBParameterGroupStatus[];

DBSecurityGroups: DBSecurityGroupMembership[];

DBSubnetGroup?: DBSubnetGroup | null;

DeletionProtection?: boolean | null;

DomainMemberships: DomainMembership[];

EnabledCloudwatchLogsExports: string[];

Endpoint?: Endpoint | null;

Engine?: string | null;

EngineVersion?: string | null;

EnhancedMonitoringResourceArn?: string | null;

IAMDatabaseAuthenticationEnabled?: boolean | null;

InstanceCreateTime?: Date | number | null;

Iops?: number | null;

KmsKeyId?: string | null;

LatestRestorableTime?: Date | number | null;

LicenseModel?: string | null;

MasterUsername?: string | null;

MonitoringInterval?: number | null;

MonitoringRoleArn?: string | null;

MultiAZ?: boolean | null;

OptionGroupMemberships: OptionGroupMembership[];

PendingModifiedValues?: PendingModifiedValues | null;

PerformanceInsightsEnabled?: boolean | null;

PerformanceInsightsKMSKeyId?: string | null;

PreferredBackupWindow?: string | null;

PreferredMaintenanceWindow?: string | null;

PromotionTier?: number | null;

PubliclyAccessible?: boolean | null;

ReadReplicaDBClusterIdentifiers: string[];

ReadReplicaDBInstanceIdentifiers: string[];

ReadReplicaSourceDBInstanceIdentifier?: string | null;

SecondaryAvailabilityZone?: string | null;

StatusInfos: DBInstanceStatusInfo[];

StorageEncrypted?: boolean | null;

StorageType?: string | null;

TdeCredentialArn?: string | null;

Timezone?: string | null;

VpcSecurityGroups: VpcSecurityGroupMembership[];

}

§Properties

AllocatedStorage?: number | null

[src]

Not supported by Neptune.

AutoMinorVersionUpgrade?: boolean | null

[src]

Indicates that minor version patches are applied automatically.

AvailabilityZone?: string | null

[src]

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

BackupRetentionPeriod?: number | null

[src]

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

CACertificateIdentifier?: string | null

[src]

The identifier of the CA certificate for this DB instance.

CharacterSetName?: string | null

[src]

(Not supported by Neptune)

CopyTagsToSnapshot?: boolean | null

[src]

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

DBClusterIdentifier?: string | null

[src]

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.

DBInstanceArn?: string | null

[src]

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

DBInstanceClass?: string | null

[src]

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

DBInstanceIdentifier?: string | null

[src]

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

DbInstancePort?: number | null

[src]

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.

DBInstanceStatus?: string | null

[src]

Specifies the current state of this database.

DbiResourceId?: string | null

[src]

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.

DBName?: string | null

[src]

The database name.

DBParameterGroups: DBParameterGroupStatus[]

[src]

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

DBSecurityGroups: DBSecurityGroupMembership[]

[src]

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

DBSubnetGroup?: DBSubnetGroup | null

[src]

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

DeletionProtection?: boolean | null

[src]

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.

DomainMemberships: DomainMembership[]

[src]

Not supported

EnabledCloudwatchLogsExports: string[]

[src]

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

Endpoint?: Endpoint | null

[src]

Specifies the connection endpoint.

Engine?: string | null

[src]

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

EngineVersion?: string | null

[src]

Indicates the database engine version.

EnhancedMonitoringResourceArn?: string | null

[src]

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

IAMDatabaseAuthenticationEnabled?: boolean | null

[src]

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

InstanceCreateTime?: Date | number | null

[src]

Provides the date and time the DB instance was created.

Iops?: number | null

[src]

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

KmsKeyId?: string | null

[src]

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

LatestRestorableTime?: Date | number | null

[src]

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

LicenseModel?: string | null

[src]

License model information for this DB instance.

MasterUsername?: string | null

[src]

Not supported by Neptune.

MonitoringInterval?: number | null

[src]

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

MonitoringRoleArn?: string | null

[src]

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

MultiAZ?: boolean | null

[src]

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

OptionGroupMemberships: OptionGroupMembership[]

[src]

(Not supported by Neptune)

PendingModifiedValues?: PendingModifiedValues | null

[src]

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

PerformanceInsightsEnabled?: boolean | null

[src]

(Not supported by Neptune)

PerformanceInsightsKMSKeyId?: string | null

[src]

(Not supported by Neptune)

PreferredBackupWindow?: string | null

[src]

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

PreferredMaintenanceWindow?: string | null

[src]

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

PromotionTier?: number | null

[src]

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.

PubliclyAccessible?: boolean | null

[src]

This flag should no longer be used.

ReadReplicaDBClusterIdentifiers: string[]

[src]

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

ReadReplicaDBInstanceIdentifiers: string[]

[src]

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

ReadReplicaSourceDBInstanceIdentifier?: string | null

[src]

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

SecondaryAvailabilityZone?: string | null

[src]

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

StatusInfos: DBInstanceStatusInfo[]

[src]

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

StorageEncrypted?: boolean | null

[src]

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

StorageType?: string | null

[src]

Specifies the storage type associated with DB instance.

TdeCredentialArn?: string | null

[src]

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

Timezone?: string | null

[src]

Not supported.

VpcSecurityGroups: VpcSecurityGroupMembership[]

[src]

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