View on GitHub
DBInstance Structure Reference
DBInstance
public struct DBInstance : AWSShapeUndocumented
-
Declaration
Swift
public static var _members: [AWSShapeMember] -
Specifies the allocated storage size specified in gibibytes.
Declaration
Swift
public let allocatedStorage: Int? -
Indicates that minor version patches are applied automatically.
Declaration
Swift
public let autoMinorVersionUpgrade: Bool? -
Specifies the name of the Availability Zone the DB instance is located in.
Declaration
Swift
public let availabilityZone: String? -
Specifies the number of days for which automatic DB snapshots are retained.
Declaration
Swift
public let backupRetentionPeriod: Int? -
The identifier of the CA certificate for this DB instance.
Declaration
Swift
public let cACertificateIdentifier: String? -
(Not supported by Neptune)
Declaration
Swift
public let characterSetName: String? -
Specifies whether tags are copied from the DB instance to snapshots of the DB instance.
Declaration
Swift
public let copyTagsToSnapshot: Bool? -
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.
Declaration
Swift
public let dBClusterIdentifier: String? -
The Amazon Resource Name (ARN) for the DB instance.
Declaration
Swift
public let dBInstanceArn: String? -
Contains the name of the compute and memory capacity class of the DB instance.
Declaration
Swift
public let dBInstanceClass: String? -
Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
Declaration
Swift
public let dBInstanceIdentifier: String? -
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.
Declaration
Swift
public let dbInstancePort: Int? -
Specifies the current state of this database.
Declaration
Swift
public let dBInstanceStatus: String? -
The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is accessed.
Declaration
Swift
public let dbiResourceId: String? -
The database name.
Declaration
Swift
public let dBName: String? -
Provides the list of DB parameter groups applied to this DB instance.
Declaration
Swift
public let dBParameterGroups: [DBParameterGroupStatus]? -
Provides List of DB security group elements containing only DBSecurityGroup.Name and DBSecurityGroup.Status subelements.
Declaration
Swift
public let dBSecurityGroups: [DBSecurityGroupMembership]? -
Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
Declaration
Swift
public let dBSubnetGroup: DBSubnetGroup? -
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.
Declaration
Swift
public let deletionProtection: Bool? -
Not supported
Declaration
Swift
public let domainMemberships: [DomainMembership]? -
A list of log types that this DB instance is configured to export to CloudWatch Logs.
Declaration
Swift
public let enabledCloudwatchLogsExports: [String]? -
Specifies the connection endpoint.
Declaration
Swift
public let endpoint: Endpoint? -
Provides the name of the database engine to be used for this DB instance.
Declaration
Swift
public let engine: String? -
Indicates the database engine version.
Declaration
Swift
public let engineVersion: String? -
The Amazon Resource Name (ARN) of the Amazon CloudWatch Logs log stream that receives the Enhanced Monitoring metrics data for the DB instance.
Declaration
Swift
public let enhancedMonitoringResourceArn: String? -
True if AWS Identity and Access Management (IAM) authentication is enabled, and otherwise false.
Declaration
Swift
public let iAMDatabaseAuthenticationEnabled: Bool? -
Provides the date and time the DB instance was created.
Declaration
Swift
public let instanceCreateTime: TimeStamp? -
Specifies the Provisioned IOPS (I/O operations per second) value.
Declaration
Swift
public let iops: Int? -
Not supported: The encryption for DB instances is managed by the DB cluster.
Declaration
Swift
public let kmsKeyId: String? -
Specifies the latest time to which a database can be restored with point-in-time restore.
Declaration
Swift
public let latestRestorableTime: TimeStamp? -
License model information for this DB instance.
Declaration
Swift
public let licenseModel: String? -
Contains the master username for the DB instance.
Declaration
Swift
public let masterUsername: String? -
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance.
Declaration
Swift
public let monitoringInterval: Int? -
The ARN for the IAM role that permits Neptune to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
Declaration
Swift
public let monitoringRoleArn: String? -
Specifies if the DB instance is a Multi-AZ deployment.
Declaration
Swift
public let multiAZ: Bool? -
(Not supported by Neptune)
Declaration
Swift
public let optionGroupMemberships: [OptionGroupMembership]? -
Specifies that changes to the DB instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements.
Declaration
Swift
public let pendingModifiedValues: PendingModifiedValues? -
(Not supported by Neptune)
Declaration
Swift
public let performanceInsightsEnabled: Bool? -
(Not supported by Neptune)
Declaration
Swift
public let performanceInsightsKMSKeyId: String? -
Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
Declaration
Swift
public let preferredBackupWindow: String? -
Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Declaration
Swift
public let preferredMaintenanceWindow: String? -
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.
Declaration
Swift
public let promotionTier: Int? -
Contains one or more identifiers of DB clusters that are Read Replicas of this DB instance.
Declaration
Swift
public let readReplicaDBClusterIdentifiers: [String]? -
Contains one or more identifiers of the Read Replicas associated with this DB instance.
Declaration
Swift
public let readReplicaDBInstanceIdentifiers: [String]? -
Contains the identifier of the source DB instance if this DB instance is a Read Replica.
Declaration
Swift
public let readReplicaSourceDBInstanceIdentifier: String? -
If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
Declaration
Swift
public let secondaryAvailabilityZone: String? -
The status of a Read Replica. If the instance is not a Read Replica, this is blank.
Declaration
Swift
public let statusInfos: [DBInstanceStatusInfo]? -
Not supported: The encryption for DB instances is managed by the DB cluster.
Declaration
Swift
public let storageEncrypted: Bool? -
Specifies the storage type associated with DB instance.
Declaration
Swift
public let storageType: String? -
The ARN from the key store with which the instance is associated for TDE encryption.
Declaration
Swift
public let tdeCredentialArn: String? -
Not supported.
Declaration
Swift
public let timezone: String? -
Provides a list of VPC security group elements that the DB instance belongs to.
Declaration
Swift
public let vpcSecurityGroups: [VpcSecurityGroupMembership]? -
init(allocatedStorage:autoMinorVersionUpgrade:availabilityZone:backupRetentionPeriod:cACertificateIdentifier:characterSetName:copyTagsToSnapshot:dBClusterIdentifier:dBInstanceArn:dBInstanceClass:dBInstanceIdentifier:dbInstancePort:dBInstanceStatus:dbiResourceId:dBName:dBParameterGroups:dBSecurityGroups:dBSubnetGroup:deletionProtection:domainMemberships:enabledCloudwatchLogsExports:endpoint:engine:engineVersion:enhancedMonitoringResourceArn:iAMDatabaseAuthenticationEnabled:instanceCreateTime:iops:kmsKeyId:latestRestorableTime:licenseModel:masterUsername:monitoringInterval:monitoringRoleArn:multiAZ:optionGroupMemberships:pendingModifiedValues:performanceInsightsEnabled:performanceInsightsKMSKeyId:preferredBackupWindow:preferredMaintenanceWindow:promotionTier:readReplicaDBClusterIdentifiers:readReplicaDBInstanceIdentifiers:readReplicaSourceDBInstanceIdentifier:secondaryAvailabilityZone:statusInfos:storageEncrypted:storageType:tdeCredentialArn:timezone:vpcSecurityGroups:)Undocumented
Declaration
Swift
public init(allocatedStorage: Int? = nil, autoMinorVersionUpgrade: Bool? = nil, availabilityZone: String? = nil, backupRetentionPeriod: Int? = nil, cACertificateIdentifier: String? = nil, characterSetName: String? = nil, copyTagsToSnapshot: Bool? = nil, dBClusterIdentifier: String? = nil, dBInstanceArn: String? = nil, dBInstanceClass: String? = nil, dBInstanceIdentifier: String? = nil, dbInstancePort: Int? = nil, dBInstanceStatus: String? = nil, dbiResourceId: String? = nil, dBName: String? = nil, dBParameterGroups: [DBParameterGroupStatus]? = nil, dBSecurityGroups: [DBSecurityGroupMembership]? = nil, dBSubnetGroup: DBSubnetGroup? = nil, deletionProtection: Bool? = nil, domainMemberships: [DomainMembership]? = nil, enabledCloudwatchLogsExports: [String]? = nil, endpoint: Endpoint? = nil, engine: String? = nil, engineVersion: String? = nil, enhancedMonitoringResourceArn: String? = nil, iAMDatabaseAuthenticationEnabled: Bool? = nil, instanceCreateTime: TimeStamp? = nil, iops: Int? = nil, kmsKeyId: String? = nil, latestRestorableTime: TimeStamp? = nil, licenseModel: String? = nil, masterUsername: String? = nil, monitoringInterval: Int? = nil, monitoringRoleArn: String? = nil, multiAZ: Bool? = nil, optionGroupMemberships: [OptionGroupMembership]? = nil, pendingModifiedValues: PendingModifiedValues? = nil, performanceInsightsEnabled: Bool? = nil, performanceInsightsKMSKeyId: String? = nil, preferredBackupWindow: String? = nil, preferredMaintenanceWindow: String? = nil, promotionTier: Int? = nil, readReplicaDBClusterIdentifiers: [String]? = nil, readReplicaDBInstanceIdentifiers: [String]? = nil, readReplicaSourceDBInstanceIdentifier: String? = nil, secondaryAvailabilityZone: String? = nil, statusInfos: [DBInstanceStatusInfo]? = nil, storageEncrypted: Bool? = nil, storageType: String? = nil, tdeCredentialArn: String? = nil, timezone: String? = nil, vpcSecurityGroups: [VpcSecurityGroupMembership]? = nil)