AwsRdsDbInstanceDetails

public struct AwsRdsDbInstanceDetails : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

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

    Declaration

    Swift

    public let allocatedStorage: Int?

  • The AWS Identity and Access Management (IAM) roles associated with the DB instance.

    Declaration

    Swift

    public let associatedRoles: [AwsRdsDbInstanceAssociatedRole]?

  • Indicates whether minor version patches are applied automatically.

    Declaration

    Swift

    public let autoMinorVersionUpgrade: Bool?

  • The Availability Zone where the DB instance will be created.

    Declaration

    Swift

    public let availabilityZone: String?

  • The number of days for which to retain automated backups.

    Declaration

    Swift

    public let backupRetentionPeriod: Int?

  • The identifier of the CA certificate for this DB instance.

    Declaration

    Swift

    public let cACertificateIdentifier: String?

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

    Declaration

    Swift

    public let characterSetName: String?

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

  • 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?

  • The current status of the DB instance.

    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 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.

    Declaration

    Swift

    public let dBName: String?

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

    Declaration

    Swift

    public let dbParameterGroups: [AwsRdsDbParameterGroup]?

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

    Declaration

    Swift

    public let dbSecurityGroups: [String]?

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

    Declaration

    Swift

    public let dbSubnetGroup: AwsRdsDbSubnetGroup?

  • Indicates whether the DB instance has deletion protection enabled. When deletion protection is enabled, the database cannot be deleted.

    Declaration

    Swift

    public let deletionProtection: Bool?

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

    Declaration

    Swift

    public let domainMemberships: [AwsRdsDbDomainMembership]?

  • 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: AwsRdsDbInstanceEndpoint?

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

    Declaration

    Swift

    public let engine: String?

  • Indicates the database engine version.

    Declaration

    Swift

    public let engineVersion: String?

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

    Declaration

    Swift

    public let enhancedMonitoringResourceArn: String?

  • True if mapping of AWS Identity and Access Management (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

    Declaration

    Swift

    public let iAMDatabaseAuthenticationEnabled: Bool?

  • 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. For example, 2020-03-22T13:22:13.933Z.

    Declaration

    Swift

    public let instanceCreateTime: String?

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

    Declaration

    Swift

    public let iops: Int?

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

    Declaration

    Swift

    public let kmsKeyId: String?

  • Specifies the latest time to which a database can be restored with point-in-time restore. Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

    Declaration

    Swift

    public let latestRestorableTime: String?

  • License model information for this DB instance.

    Declaration

    Swift

    public let licenseModel: String?

  • Undocumented

    Declaration

    Swift

    public let listenerEndpoint: AwsRdsDbInstanceEndpoint?

  • The master user name of the DB instance.

    Declaration

    Swift

    public let masterUsername: String?

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

    Declaration

    Swift

    public let maxAllocatedStorage: Int?

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

    Declaration

    Swift

    public let monitoringRoleArn: String?

  • Whether the DB instance is a multiple Availability Zone deployment.

    Declaration

    Swift

    public let multiAz: Bool?

  • The list of option group memberships for this DB instance.

    Declaration

    Swift

    public let optionGroupMemberships: [AwsRdsDbOptionGroupMembership]?

  • Changes to the DB instance that are currently pending.

    Declaration

    Swift

    public let pendingModifiedValues: AwsRdsDbPendingModifiedValues?

  • Indicates whether Performance Insights is enabled for the DB instance.

    Declaration

    Swift

    public let performanceInsightsEnabled: Bool?

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

    Declaration

    Swift

    public let performanceInsightsKmsKeyId: String?

  • The number of days to retain Performance Insights data.

    Declaration

    Swift

    public let performanceInsightsRetentionPeriod: Int?

  • 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.

    Declaration

    Swift

    public let preferredBackupWindow: String?

  • 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.

    Declaration

    Swift

    public let preferredMaintenanceWindow: String?

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

    Declaration

    Swift

    public let processorFeatures: [AwsRdsDbProcessorFeature]?

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

    Declaration

    Swift

    public let promotionTier: Int?

  • 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.

    Declaration

    Swift

    public let publiclyAccessible: Bool?

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

    Declaration

    Swift

    public let readReplicaDBClusterIdentifiers: [String]?

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

    Declaration

    Swift

    public let readReplicaDBInstanceIdentifiers: [String]?

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

    Declaration

    Swift

    public let readReplicaSourceDBInstanceIdentifier: String?

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

    Declaration

    Swift

    public let secondaryAvailabilityZone: String?

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

    Declaration

    Swift

    public let statusInfos: [AwsRdsDbStatusInfo]?

  • Specifies whether the DB instance is encrypted.

    Declaration

    Swift

    public let storageEncrypted: Bool?

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

  • The time zone of the DB instance.

    Declaration

    Swift

    public let timezone: String?

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

    Declaration

    Swift

    public let vpcSecurityGroups: [AwsRdsDbInstanceVpcSecurityGroup]?
  • init(allocatedStorage:associatedRoles:autoMinorVersionUpgrade:availabilityZone:backupRetentionPeriod:cACertificateIdentifier:characterSetName:copyTagsToSnapshot:dBClusterIdentifier:dBInstanceClass:dBInstanceIdentifier:dbInstancePort:dbInstanceStatus:dbiResourceId:dBName:dbParameterGroups:dbSecurityGroups:dbSubnetGroup:deletionProtection:domainMemberships:enabledCloudWatchLogsExports:endpoint:engine:engineVersion:enhancedMonitoringResourceArn:iAMDatabaseAuthenticationEnabled:instanceCreateTime:iops:kmsKeyId:latestRestorableTime:licenseModel:listenerEndpoint:masterUsername:maxAllocatedStorage:monitoringInterval:monitoringRoleArn:multiAz:optionGroupMemberships:pendingModifiedValues:performanceInsightsEnabled:performanceInsightsKmsKeyId:performanceInsightsRetentionPeriod:preferredBackupWindow:preferredMaintenanceWindow:processorFeatures:promotionTier:publiclyAccessible:readReplicaDBClusterIdentifiers:readReplicaDBInstanceIdentifiers:readReplicaSourceDBInstanceIdentifier:secondaryAvailabilityZone:statusInfos:storageEncrypted:storageType:tdeCredentialArn:timezone:vpcSecurityGroups:)

    Undocumented

    Declaration

    Swift

    public init(allocatedStorage: Int? = nil, associatedRoles: [AwsRdsDbInstanceAssociatedRole]? = nil, autoMinorVersionUpgrade: Bool? = nil, availabilityZone: String? = nil, backupRetentionPeriod: Int? = nil, cACertificateIdentifier: String? = nil, characterSetName: String? = nil, copyTagsToSnapshot: Bool? = nil, dBClusterIdentifier: String? = nil, dBInstanceClass: String? = nil, dBInstanceIdentifier: String? = nil, dbInstancePort: Int? = nil, dbInstanceStatus: String? = nil, dbiResourceId: String? = nil, dBName: String? = nil, dbParameterGroups: [AwsRdsDbParameterGroup]? = nil, dbSecurityGroups: [String]? = nil, dbSubnetGroup: AwsRdsDbSubnetGroup? = nil, deletionProtection: Bool? = nil, domainMemberships: [AwsRdsDbDomainMembership]? = nil, enabledCloudWatchLogsExports: [String]? = nil, endpoint: AwsRdsDbInstanceEndpoint? = nil, engine: String? = nil, engineVersion: String? = nil, enhancedMonitoringResourceArn: String? = nil, iAMDatabaseAuthenticationEnabled: Bool? = nil, instanceCreateTime: String? = nil, iops: Int? = nil, kmsKeyId: String? = nil, latestRestorableTime: String? = nil, licenseModel: String? = nil, listenerEndpoint: AwsRdsDbInstanceEndpoint? = nil, masterUsername: String? = nil, maxAllocatedStorage: Int? = nil, monitoringInterval: Int? = nil, monitoringRoleArn: String? = nil, multiAz: Bool? = nil, optionGroupMemberships: [AwsRdsDbOptionGroupMembership]? = nil, pendingModifiedValues: AwsRdsDbPendingModifiedValues? = nil, performanceInsightsEnabled: Bool? = nil, performanceInsightsKmsKeyId: String? = nil, performanceInsightsRetentionPeriod: Int? = nil, preferredBackupWindow: String? = nil, preferredMaintenanceWindow: String? = nil, processorFeatures: [AwsRdsDbProcessorFeature]? = nil, promotionTier: Int? = nil, publiclyAccessible: Bool? = nil, readReplicaDBClusterIdentifiers: [String]? = nil, readReplicaDBInstanceIdentifiers: [String]? = nil, readReplicaSourceDBInstanceIdentifier: String? = nil, secondaryAvailabilityZone: String? = nil, statusInfos: [AwsRdsDbStatusInfo]? = nil, storageEncrypted: Bool? = nil, storageType: String? = nil, tdeCredentialArn: String? = nil, timezone: String? = nil, vpcSecurityGroups: [AwsRdsDbInstanceVpcSecurityGroup]? = nil)

  • Declaration

    Swift

    public func validate(name: String) throws