DBInstance

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

Detailed information about an instance.

interface DBInstance {

AutoMinorVersionUpgrade?: boolean | null;

AvailabilityZone?: string | null;

BackupRetentionPeriod?: number | null;

CACertificateIdentifier?: string | null;

CopyTagsToSnapshot?: boolean | null;

DBClusterIdentifier?: string | null;

DBInstanceArn?: string | null;

DBInstanceClass?: string | null;

DBInstanceIdentifier?: string | null;

DBInstanceStatus?: string | null;

DbiResourceId?: string | null;

DBSubnetGroup?: DBSubnetGroup | null;

EnabledCloudwatchLogsExports: string[];

Endpoint?: Endpoint | null;

Engine?: string | null;

EngineVersion?: string | null;

InstanceCreateTime?: Date | number | null;

KmsKeyId?: string | null;

LatestRestorableTime?: Date | number | null;

PendingModifiedValues?: PendingModifiedValues | null;

PreferredBackupWindow?: string | null;

PreferredMaintenanceWindow?: string | null;

PromotionTier?: number | null;

PubliclyAccessible?: boolean | null;

StatusInfos: DBInstanceStatusInfo[];

StorageEncrypted?: boolean | null;

VpcSecurityGroups: VpcSecurityGroupMembership[];

}

§Properties

AutoMinorVersionUpgrade?: boolean | null

[src]

Does not apply. This parameter does not apply to Amazon DocumentDB. Amazon DocumentDB does not perform minor version upgrades regardless of the value set.

AvailabilityZone?: string | null

[src]

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

BackupRetentionPeriod?: number | null

[src]

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

CACertificateIdentifier?: string | null

[src]

The identifier of the CA certificate for this DB instance.

CopyTagsToSnapshot?: boolean | null

[src]

A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied.

DBClusterIdentifier?: string | null

[src]

Contains the name of the cluster that the instance is a member of if the instance is a member of a cluster.

DBInstanceArn?: string | null

[src]

The Amazon Resource Name (ARN) for the instance.

DBInstanceClass?: string | null

[src]

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

DBInstanceIdentifier?: string | null

[src]

Contains a user-provided database identifier. This identifier is the unique key that identifies an instance.

DBInstanceStatus?: string | null

[src]

Specifies the current state of this database.

DbiResourceId?: string | null

[src]

The Amazon Web Services Region-unique, immutable identifier for the instance. This identifier is found in CloudTrail log entries whenever the KMS key for the instance is accessed.

DBSubnetGroup?: DBSubnetGroup | null

[src]

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

EnabledCloudwatchLogsExports: string[]

[src]

A list of log types that this 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 instance.

EngineVersion?: string | null

[src]

Indicates the database engine version.

InstanceCreateTime?: Date | number | null

[src]

Provides the date and time that the instance was created.

KmsKeyId?: string | null

[src]

If StorageEncrypted is true, the KMS key identifier for the encrypted instance.

LatestRestorableTime?: Date | number | null

[src]

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

PendingModifiedValues?: PendingModifiedValues | null

[src]

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

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 an Amazon DocumentDB replica is promoted to the primary instance after a failure of the existing primary instance.

PubliclyAccessible?: boolean | null

[src]

Not supported. Amazon DocumentDB does not currently support public endpoints. The value of PubliclyAccessible is always false.

StatusInfos: DBInstanceStatusInfo[]

[src]

The status of a read replica. If the instance is not a read replica, this is blank.

StorageEncrypted?: boolean | null

[src]

Specifies whether or not the instance is encrypted.

VpcSecurityGroups: VpcSecurityGroupMembership[]

[src]

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