DBCluster

public struct DBCluster : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

  • The name of the Amazon Kinesis data stream used for the database activity stream.

    Declaration

    Swift

    public let activityStreamKinesisStreamName: String?

  • The AWS KMS key identifier used for encrypting messages in the database activity stream.

    Declaration

    Swift

    public let activityStreamKmsKeyId: String?

  • The mode of the database activity stream. Database events such as a change or access generate an activity stream event. The database session can handle these events either synchronously or asynchronously.

    Declaration

    Swift

    public let activityStreamMode: ActivityStreamMode?

  • The status of the database activity stream.

    Declaration

    Swift

    public let activityStreamStatus: ActivityStreamStatus?

  • For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn’t fixed, but instead automatically adjusts as needed.

    Declaration

    Swift

    public let allocatedStorage: Int?

  • Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf.

    Declaration

    Swift

    public let associatedRoles: [DBClusterRole]?

  • Provides the list of Availability Zones (AZs) where instances in the DB cluster can be created.

    Declaration

    Swift

    public let availabilityZones: [String]?

  • The number of change records stored for Backtrack.

    Declaration

    Swift

    public let backtrackConsumedChangeRecords: Int64?

  • The target backtrack window, in seconds. If this value is set to 0, backtracking is disabled for the DB cluster. Otherwise, backtracking is enabled.

    Declaration

    Swift

    public let backtrackWindow: Int64?

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

    Declaration

    Swift

    public let backupRetentionPeriod: Int?

  • The current capacity of an Aurora Serverless DB cluster. The capacity is 0 (zero) when the cluster is paused. For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide.

    Declaration

    Swift

    public let capacity: Int?

  • If present, specifies the name of the character set that this cluster is associated with.

    Declaration

    Swift

    public let characterSetName: String?

  • Identifies the clone group to which the DB cluster is associated.

    Declaration

    Swift

    public let cloneGroupId: String?

  • Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).

    Declaration

    Swift

    public let clusterCreateTime: TimeStamp?

  • Specifies whether tags are copied from the DB cluster to snapshots of the DB cluster.

    Declaration

    Swift

    public let copyTagsToSnapshot: Bool?

  • Specifies whether the DB cluster is a clone of a DB cluster owned by a different AWS account.

    Declaration

    Swift

    public let crossAccountClone: Bool?

  • Identifies all custom endpoints associated with the cluster.

    Declaration

    Swift

    public let customEndpoints: [String]?

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

    Declaration

    Swift

    public let databaseName: String?

  • The Amazon Resource Name (ARN) for the DB cluster.

    Declaration

    Swift

    public let dBClusterArn: String?

  • Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.

    Declaration

    Swift

    public let dBClusterIdentifier: String?

  • Provides the list of instances that make up the DB cluster.

    Declaration

    Swift

    public let dBClusterMembers: [DBClusterMember]?

  • Provides the list of option group memberships for this DB cluster.

    Declaration

    Swift

    public let dBClusterOptionGroupMemberships: [DBClusterOptionGroupStatus]?

  • Specifies the name of the DB cluster parameter group for the DB cluster.

    Declaration

    Swift

    public let dBClusterParameterGroup: String?

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

    Declaration

    Swift

    public let dbClusterResourceId: String?

  • Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

    Declaration

    Swift

    public let dBSubnetGroup: String?

  • Indicates if the DB cluster has deletion protection enabled. The database can’t be deleted when deletion protection is enabled.

    Declaration

    Swift

    public let deletionProtection: Bool?

  • The Active Directory Domain membership records associated with the DB cluster.

    Declaration

    Swift

    public let domainMemberships: [DomainMembership]?

  • The earliest time to which a DB cluster can be backtracked.

    Declaration

    Swift

    public let earliestBacktrackTime: TimeStamp?

  • The earliest time to which a database can be restored with point-in-time restore.

    Declaration

    Swift

    public let earliestRestorableTime: TimeStamp?

  • A list of log types that this DB cluster is configured to export to CloudWatch Logs. Log types vary by DB engine. For information about the log types for each DB engine, see Amazon RDS Database Log Files in the Amazon Aurora User Guide.

    Declaration

    Swift

    public let enabledCloudwatchLogsExports: [String]?

  • Specifies the connection endpoint for the primary instance of the DB cluster.

    Declaration

    Swift

    public let endpoint: String?

  • Provides the name of the database engine to be used for this DB cluster.

    Declaration

    Swift

    public let engine: String?

  • The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster. global engine mode only applies for global database clusters created with Aurora MySQL version 5.6.10a. For higher Aurora MySQL versions, the clusters in a global database use provisioned engine mode. To check if a DB cluster is part of a global database, use DescribeGlobalClusters instead of checking the EngineMode return value from DescribeDBClusters.

    Declaration

    Swift

    public let engineMode: String?

  • Indicates the database engine version.

    Declaration

    Swift

    public let engineVersion: String?

  • Specifies whether you have requested to enable write forwarding for a secondary cluster in an Aurora global database. Because write forwarding takes time to enable, check the value of GlobalWriteForwardingStatus to confirm that the request has completed before using the write forwarding feature for this cluster.

    Declaration

    Swift

    public let globalWriteForwardingRequested: Bool?

  • Specifies whether a secondary cluster in an Aurora global database has write forwarding enabled, not enabled, or is in the process of enabling it.

    Declaration

    Swift

    public let globalWriteForwardingStatus: WriteForwardingStatus?

  • Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

    Declaration

    Swift

    public let hostedZoneId: String?

  • A value that indicates whether the HTTP endpoint for an Aurora Serverless DB cluster is enabled. When enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor. For more information, see Using the Data API for Aurora Serverless in the Amazon Aurora User Guide.

    Declaration

    Swift

    public let httpEndpointEnabled: Bool?

  • A value that indicates whether the mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled.

    Declaration

    Swift

    public let iAMDatabaseAuthenticationEnabled: Bool?

  • If StorageEncrypted is enabled, the AWS KMS key identifier for the encrypted 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?

  • Contains the master username for the DB cluster.

    Declaration

    Swift

    public let masterUsername: String?

  • Specifies whether the DB cluster has instances in multiple Availability Zones.

    Declaration

    Swift

    public let multiAZ: Bool?

  • Specifies the progress of the operation as a percentage.

    Declaration

    Swift

    public let percentProgress: String?

  • Specifies the port that the database engine is listening on.

    Declaration

    Swift

    public let port: Int?

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

  • The reader endpoint for the DB cluster. The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster. If a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.

    Declaration

    Swift

    public let readerEndpoint: String?

  • Contains one or more identifiers of the read replicas associated with this DB cluster.

    Declaration

    Swift

    public let readReplicaIdentifiers: [String]?

  • Contains the identifier of the source DB cluster if this DB cluster is a read replica.

    Declaration

    Swift

    public let replicationSourceIdentifier: String?

  • Undocumented

    Declaration

    Swift

    public let scalingConfigurationInfo: ScalingConfigurationInfo?

  • Specifies the current state of this DB cluster.

    Declaration

    Swift

    public let status: String?

  • Specifies whether the DB cluster is encrypted.

    Declaration

    Swift

    public let storageEncrypted: Bool?

  • Provides a list of VPC security groups that the DB cluster belongs to.

    Declaration

    Swift

    public let vpcSecurityGroups: [VpcSecurityGroupMembership]?
  • init(activityStreamKinesisStreamName:activityStreamKmsKeyId:activityStreamMode:activityStreamStatus:allocatedStorage:associatedRoles:availabilityZones:backtrackConsumedChangeRecords:backtrackWindow:backupRetentionPeriod:capacity:characterSetName:cloneGroupId:clusterCreateTime:copyTagsToSnapshot:crossAccountClone:customEndpoints:databaseName:dBClusterArn:dBClusterIdentifier:dBClusterMembers:dBClusterOptionGroupMemberships:dBClusterParameterGroup:dbClusterResourceId:dBSubnetGroup:deletionProtection:domainMemberships:earliestBacktrackTime:earliestRestorableTime:enabledCloudwatchLogsExports:endpoint:engine:engineMode:engineVersion:globalWriteForwardingRequested:globalWriteForwardingStatus:hostedZoneId:httpEndpointEnabled:iAMDatabaseAuthenticationEnabled:kmsKeyId:latestRestorableTime:masterUsername:multiAZ:percentProgress:port:preferredBackupWindow:preferredMaintenanceWindow:readerEndpoint:readReplicaIdentifiers:replicationSourceIdentifier:scalingConfigurationInfo:status:storageEncrypted:vpcSecurityGroups:)

    Undocumented

    Declaration

    Swift

    public init(activityStreamKinesisStreamName: String? = nil, activityStreamKmsKeyId: String? = nil, activityStreamMode: ActivityStreamMode? = nil, activityStreamStatus: ActivityStreamStatus? = nil, allocatedStorage: Int? = nil, associatedRoles: [DBClusterRole]? = nil, availabilityZones: [String]? = nil, backtrackConsumedChangeRecords: Int64? = nil, backtrackWindow: Int64? = nil, backupRetentionPeriod: Int? = nil, capacity: Int? = nil, characterSetName: String? = nil, cloneGroupId: String? = nil, clusterCreateTime: TimeStamp? = nil, copyTagsToSnapshot: Bool? = nil, crossAccountClone: Bool? = nil, customEndpoints: [String]? = nil, databaseName: String? = nil, dBClusterArn: String? = nil, dBClusterIdentifier: String? = nil, dBClusterMembers: [DBClusterMember]? = nil, dBClusterOptionGroupMemberships: [DBClusterOptionGroupStatus]? = nil, dBClusterParameterGroup: String? = nil, dbClusterResourceId: String? = nil, dBSubnetGroup: String? = nil, deletionProtection: Bool? = nil, domainMemberships: [DomainMembership]? = nil, earliestBacktrackTime: TimeStamp? = nil, earliestRestorableTime: TimeStamp? = nil, enabledCloudwatchLogsExports: [String]? = nil, endpoint: String? = nil, engine: String? = nil, engineMode: String? = nil, engineVersion: String? = nil, globalWriteForwardingRequested: Bool? = nil, globalWriteForwardingStatus: WriteForwardingStatus? = nil, hostedZoneId: String? = nil, httpEndpointEnabled: Bool? = nil, iAMDatabaseAuthenticationEnabled: Bool? = nil, kmsKeyId: String? = nil, latestRestorableTime: TimeStamp? = nil, masterUsername: String? = nil, multiAZ: Bool? = nil, percentProgress: String? = nil, port: Int? = nil, preferredBackupWindow: String? = nil, preferredMaintenanceWindow: String? = nil, readerEndpoint: String? = nil, readReplicaIdentifiers: [String]? = nil, replicationSourceIdentifier: String? = nil, scalingConfigurationInfo: ScalingConfigurationInfo? = nil, status: String? = nil, storageEncrypted: Bool? = nil, vpcSecurityGroups: [VpcSecurityGroupMembership]? = nil)