DBInstance

public struct DBInstance : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

  • Indicates that minor version patches are applied automatically.

    Declaration

    Swift

    public let autoMinorVersionUpgrade: Bool?

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

    Declaration

    Swift

    public let availabilityZone: String?

  • Specifies the number of days for which automatic 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?

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

    Declaration

    Swift

    public let dBClusterIdentifier: String?

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

    Declaration

    Swift

    public let dBInstanceArn: String?

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

    Declaration

    Swift

    public let dBInstanceClass: String?

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

    Declaration

    Swift

    public let dBInstanceIdentifier: String?

  • Specifies the current state of this database.

    Declaration

    Swift

    public let dBInstanceStatus: String?

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

    Declaration

    Swift

    public let dbiResourceId: String?

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

    Declaration

    Swift

    public let dBSubnetGroup: DBSubnetGroup?

  • A list of log types that this instance is configured to export to Amazon 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 instance.

    Declaration

    Swift

    public let engine: String?

  • Indicates the database engine version.

    Declaration

    Swift

    public let engineVersion: String?

  • Provides the date and time that the instance was created.

    Declaration

    Swift

    public let instanceCreateTime: TimeStamp?

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

    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?

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

    Declaration

    Swift

    public let pendingModifiedValues: PendingModifiedValues?

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

    Declaration

    Swift

    public let promotionTier: Int?

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

    Declaration

    Swift

    public let publiclyAccessible: Bool?

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

    Declaration

    Swift

    public let statusInfos: [DBInstanceStatusInfo]?

  • Specifies whether or not the instance is encrypted.

    Declaration

    Swift

    public let storageEncrypted: Bool?

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

    Declaration

    Swift

    public let vpcSecurityGroups: [VpcSecurityGroupMembership]?

  • Undocumented

    Declaration

    Swift

    public init(autoMinorVersionUpgrade: Bool? = nil, availabilityZone: String? = nil, backupRetentionPeriod: Int? = nil, cACertificateIdentifier: String? = nil, dBClusterIdentifier: String? = nil, dBInstanceArn: String? = nil, dBInstanceClass: String? = nil, dBInstanceIdentifier: String? = nil, dBInstanceStatus: String? = nil, dbiResourceId: String? = nil, dBSubnetGroup: DBSubnetGroup? = nil, enabledCloudwatchLogsExports: [String]? = nil, endpoint: Endpoint? = nil, engine: String? = nil, engineVersion: String? = nil, instanceCreateTime: TimeStamp? = nil, kmsKeyId: String? = nil, latestRestorableTime: TimeStamp? = nil, pendingModifiedValues: PendingModifiedValues? = nil, preferredBackupWindow: String? = nil, preferredMaintenanceWindow: String? = nil, promotionTier: Int? = nil, publiclyAccessible: Bool? = nil, statusInfos: [DBInstanceStatusInfo]? = nil, storageEncrypted: Bool? = nil, vpcSecurityGroups: [VpcSecurityGroupMembership]? = nil)