DBCluster

public struct DBCluster : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

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

    Declaration

    Swift

    public let associatedRoles: [DBClusterRole]?

  • Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.

    Declaration

    Swift

    public let availabilityZones: [String]?

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

    Declaration

    Swift

    public let backupRetentionPeriod: Int?

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

    Declaration

    Swift

    public let clusterCreateTime: TimeStamp?

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

    Declaration

    Swift

    public let dBClusterArn: String?

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

    Declaration

    Swift

    public let dBClusterIdentifier: String?

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

    Declaration

    Swift

    public let dBClusterMembers: [DBClusterMember]?

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

    Declaration

    Swift

    public let dBClusterParameterGroup: String?

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

    Declaration

    Swift

    public let dbClusterResourceId: String?

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

    Declaration

    Swift

    public let dBSubnetGroup: String?

  • Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

    Declaration

    Swift

    public let deletionProtection: Bool?

  • 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 cluster is configured to export to Amazon CloudWatch Logs.

    Declaration

    Swift

    public let enabledCloudwatchLogsExports: [String]?

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

    Declaration

    Swift

    public let endpoint: String?

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

    Declaration

    Swift

    public let engine: String?

  • Indicates the database engine version.

    Declaration

    Swift

    public let engineVersion: String?

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

    Declaration

    Swift

    public let hostedZoneId: String?

  • If StorageEncrypted is true, the AWS KMS key identifier for the encrypted 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 user name for the cluster.

    Declaration

    Swift

    public let masterUsername: String?

  • Specifies whether the 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 cluster. The reader endpoint for a cluster load balances connections across the Amazon DocumentDB replicas that are available in a cluster. As clients request new connections to the reader endpoint, Amazon DocumentDB distributes the connection requests among the Amazon DocumentDB replicas in the cluster. This functionality can help balance your read workload across multiple Amazon DocumentDB replicas in your cluster. If a failover occurs, and the Amazon DocumentDB 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 Amazon DocumentDB replicas in the cluster, you can then reconnect to the reader endpoint.

    Declaration

    Swift

    public let readerEndpoint: String?

  • Specifies the current state of this cluster.

    Declaration

    Swift

    public let status: String?

  • Specifies whether the cluster is encrypted.

    Declaration

    Swift

    public let storageEncrypted: Bool?

  • Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.

    Declaration

    Swift

    public let vpcSecurityGroups: [VpcSecurityGroupMembership]?

  • Undocumented

    Declaration

    Swift

    public init(associatedRoles: [DBClusterRole]? = nil, availabilityZones: [String]? = nil, backupRetentionPeriod: Int? = nil, clusterCreateTime: TimeStamp? = nil, dBClusterArn: String? = nil, dBClusterIdentifier: String? = nil, dBClusterMembers: [DBClusterMember]? = nil, dBClusterParameterGroup: String? = nil, dbClusterResourceId: String? = nil, dBSubnetGroup: String? = nil, deletionProtection: Bool? = nil, earliestRestorableTime: TimeStamp? = nil, enabledCloudwatchLogsExports: [String]? = nil, endpoint: String? = nil, engine: String? = nil, engineVersion: String? = nil, hostedZoneId: String? = 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, status: String? = nil, storageEncrypted: Bool? = nil, vpcSecurityGroups: [VpcSecurityGroupMembership]? = nil)