AwsRdsDbInstanceDetails

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

Contains the details of an Amazon RDS DB instance.

interface AwsRdsDbInstanceDetails {

AllocatedStorage?: number | null;

AssociatedRoles?: AwsRdsDbInstanceAssociatedRole[] | null;

AutoMinorVersionUpgrade?: boolean | null;

AvailabilityZone?: string | null;

BackupRetentionPeriod?: number | null;

CACertificateIdentifier?: string | null;

CharacterSetName?: string | null;

CopyTagsToSnapshot?: boolean | null;

DBClusterIdentifier?: string | null;

DBInstanceClass?: string | null;

DBInstanceIdentifier?: string | null;

DbInstancePort?: number | null;

DbInstanceStatus?: string | null;

DbiResourceId?: string | null;

DBName?: string | null;

DbParameterGroups?: AwsRdsDbParameterGroup[] | null;

DbSecurityGroups?: string[] | null;

DbSubnetGroup?: AwsRdsDbSubnetGroup | null;

DeletionProtection?: boolean | null;

DomainMemberships?: AwsRdsDbDomainMembership[] | null;

EnabledCloudWatchLogsExports?: string[] | null;

Endpoint?: AwsRdsDbInstanceEndpoint | null;

Engine?: string | null;

EngineVersion?: string | null;

EnhancedMonitoringResourceArn?: string | null;

IAMDatabaseAuthenticationEnabled?: boolean | null;

InstanceCreateTime?: string | null;

Iops?: number | null;

KmsKeyId?: string | null;

LatestRestorableTime?: string | null;

LicenseModel?: string | null;

ListenerEndpoint?: AwsRdsDbInstanceEndpoint | null;

MasterUsername?: string | null;

MaxAllocatedStorage?: number | null;

MonitoringInterval?: number | null;

MonitoringRoleArn?: string | null;

MultiAz?: boolean | null;

OptionGroupMemberships?: AwsRdsDbOptionGroupMembership[] | null;

PendingModifiedValues?: AwsRdsDbPendingModifiedValues | null;

PerformanceInsightsEnabled?: boolean | null;

PerformanceInsightsKmsKeyId?: string | null;

PerformanceInsightsRetentionPeriod?: number | null;

PreferredBackupWindow?: string | null;

PreferredMaintenanceWindow?: string | null;

ProcessorFeatures?: AwsRdsDbProcessorFeature[] | null;

PromotionTier?: number | null;

PubliclyAccessible?: boolean | null;

ReadReplicaDBClusterIdentifiers?: string[] | null;

ReadReplicaDBInstanceIdentifiers?: string[] | null;

ReadReplicaSourceDBInstanceIdentifier?: string | null;

SecondaryAvailabilityZone?: string | null;

StatusInfos?: AwsRdsDbStatusInfo[] | null;

StorageEncrypted?: boolean | null;

StorageType?: string | null;

TdeCredentialArn?: string | null;

Timezone?: string | null;

VpcSecurityGroups?: AwsRdsDbInstanceVpcSecurityGroup[] | null;

}

§Properties

AllocatedStorage?: number | null

[src]

The amount of storage (in gigabytes) to initially allocate for the DB instance.

AssociatedRoles?: AwsRdsDbInstanceAssociatedRole[] | null

[src]

The IAM roles associated with the DB instance.

AutoMinorVersionUpgrade?: boolean | null

[src]

Indicates whether minor version patches are applied automatically.

AvailabilityZone?: string | null

[src]

The Availability Zone where the DB instance will be created.

BackupRetentionPeriod?: number | null

[src]

The number of days for which to retain automated backups.

CACertificateIdentifier?: string | null

[src]

The identifier of the CA certificate for this DB instance.

CharacterSetName?: string | null

[src]

The name of the character set that this DB instance is associated with.

CopyTagsToSnapshot?: boolean | null

[src]

Whether to copy resource tags 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.

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]

The current status of the DB instance.

DbiResourceId?: string | null

[src]

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

DBName?: string | null

[src]

The meaning of this parameter differs according to the database engine you use.

MySQL, MariaDB, SQL Server, PostgreSQL

Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.

Oracle

Contains the Oracle System ID (SID) of the created DB instance. Not shown when the returned parameters do not apply to an Oracle DB instance.

DbParameterGroups?: AwsRdsDbParameterGroup[] | null

[src]

A list of the DB parameter groups to assign to the DB instance.

DbSecurityGroups?: string[] | null

[src]

A list of the DB security groups to assign to the DB instance.

DbSubnetGroup?: AwsRdsDbSubnetGroup | null

[src]

Information about the subnet group that is associated with the DB instance.

DeletionProtection?: boolean | null

[src]

Indicates whether the DB instance has deletion protection enabled.

When deletion protection is enabled, the database cannot be deleted.

DomainMemberships?: AwsRdsDbDomainMembership[] | null

[src]

The Active Directory domain membership records associated with the DB instance.

EnabledCloudWatchLogsExports?: string[] | null

[src]

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

Endpoint?: AwsRdsDbInstanceEndpoint | null

[src]

Specifies the connection endpoint.

Engine?: string | null

[src]

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

EngineVersion?: string | null

[src]

Indicates the database engine version.

EnhancedMonitoringResourceArn?: string | null

[src]

The ARN of the CloudWatch Logs log stream that receives the enhanced monitoring metrics data for the DB instance.

IAMDatabaseAuthenticationEnabled?: boolean | null

[src]

True if mapping of IAM accounts to database accounts is enabled, and otherwise false.

IAM database authentication can be enabled for the following database engines.

For MySQL 5.6, minor version 5.6.34 or higher
For MySQL 5.7, minor version 5.7.16 or higher
Aurora 5.6 or higher

InstanceCreateTime?: string | null

[src]

Indicates when the DB instance was created.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example, 2020-03-22T13:22:13.933Z.

Iops?: number | null

[src]

Specifies the provisioned IOPS (I/O operations per second) for this DB instance.

KmsKeyId?: string | null

[src]

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

LatestRestorableTime?: string | 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.

ListenerEndpoint?: AwsRdsDbInstanceEndpoint | null

[src]

MasterUsername?: string | null

[src]

The master user name of the DB instance.

MaxAllocatedStorage?: number | null

[src]

The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.

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 Amazon RDS to send enhanced monitoring metrics to CloudWatch Logs.

MultiAz?: boolean | null

[src]

Whether the DB instance is a multiple Availability Zone deployment.

OptionGroupMemberships?: AwsRdsDbOptionGroupMembership[] | null

[src]

The list of option group memberships for this DB instance.

PendingModifiedValues?: AwsRdsDbPendingModifiedValues | null

[src]

Changes to the DB instance that are currently pending.

PerformanceInsightsEnabled?: boolean | null

[src]

Indicates whether Performance Insights is enabled for the DB instance.

PerformanceInsightsKmsKeyId?: string | null

[src]

The identifier of the KMS key used to encrypt the Performance Insights data.

PerformanceInsightsRetentionPeriod?: number | null

[src]

The number of days to retain Performance Insights data.

PreferredBackupWindow?: string | null

[src]

The range of time each day when automated backups are created, if automated backups are enabled.

Uses the format HH:MM-HH:MM. For example, 04:52-05:22.

PreferredMaintenanceWindow?: string | null

[src]

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

Uses the format <day>:HH:MM-<day>:HH:MM.

For the day values, use mon|tue|wed|thu|fri|sat|sun.

For example, sun:09:32-sun:10:02.

ProcessorFeatures?: AwsRdsDbProcessorFeature[] | null

[src]

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.

PromotionTier?: number | null

[src]

The order in which to promote an Aurora replica to the primary instance after a failure of the existing primary instance.

PubliclyAccessible?: boolean | null

[src]

Specifies the accessibility options for the DB instance.

A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address.

A value of false specifies an internal instance with a DNS name that resolves to a private IP address.

ReadReplicaDBClusterIdentifiers?: string[] | null

[src]

List of identifiers of Aurora DB clusters to which the RDS DB instance is replicated as a read replica.

ReadReplicaDBInstanceIdentifiers?: string[] | null

[src]

List of identifiers of the read replicas associated with this DB instance.

ReadReplicaSourceDBInstanceIdentifier?: string | null

[src]

If this DB instance is a read replica, contains the identifier of the source DB instance.

SecondaryAvailabilityZone?: string | null

[src]

For a DB instance with multi-Availability Zone support, the name of the secondary Availability Zone.

StatusInfos?: AwsRdsDbStatusInfo[] | null

[src]

The status of a read replica. If the instance isn't a read replica, this is empty.

StorageEncrypted?: boolean | null

[src]

Specifies whether the DB instance is encrypted.

StorageType?: string | null

[src]

The storage type for the 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]

The time zone of the DB instance.

VpcSecurityGroups?: AwsRdsDbInstanceVpcSecurityGroup[] | null

[src]

A list of VPC security groups that the DB instance belongs to.