DBCluster Structure Reference


                    
                    
                    _members

Declaration

Swift

public static var _members: [AWSShapeMember]


                    
                    
                    allocatedStorage

AllocatedStorage always returns 1, because Neptune DB cluster storage size is not fixed, but instead automatically adjusts as needed.

Declaration

Swift

public let allocatedStorage: Int?


                    
                    
                    associatedRoles

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


                    
                    
                    availabilityZones

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

Declaration

Swift

public let availabilityZones: [String]?


                    
                    
                    backupRetentionPeriod

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

Declaration

Swift

public let backupRetentionPeriod: Int?


                    
                    
                    characterSetName

(Not supported by Neptune)

Declaration

Swift

public let characterSetName: String?


                    
                    
                    cloneGroupId

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

Declaration

Swift

public let cloneGroupId: String?


                    
                    
                    clusterCreateTime

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

Declaration

Swift

public let clusterCreateTime: TimeStamp?


                    
                    
                    databaseName

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?


                    
                    
                    dBClusterArn

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

Declaration

Swift

public let dBClusterArn: String?


                    
                    
                    dBClusterIdentifier

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

Declaration

Swift

public let dBClusterIdentifier: String?


                    
                    
                    dBClusterMembers

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

Declaration

Swift

public let dBClusterMembers: [DBClusterMember]?


                    
                    
                    dBClusterOptionGroupMemberships

(Not supported by Neptune)

Declaration

Swift

public let dBClusterOptionGroupMemberships: [DBClusterOptionGroupStatus]?


                    
                    
                    dBClusterParameterGroup

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

Declaration

Swift

public let dBClusterParameterGroup: String?


                    
                    
                    dbClusterResourceId

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?


                    
                    
                    dBSubnetGroup

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?


                    
                    
                    deletionProtection

Indicates whether or not the DB cluster has deletion protection enabled. The database can’t be deleted when deletion protection is enabled.

Declaration

Swift

public let deletionProtection: Bool?


                    
                    
                    earliestRestorableTime

Specifies the earliest time to which a database can be restored with point-in-time restore.

Declaration

Swift

public let earliestRestorableTime: TimeStamp?


                    
                    
                    enabledCloudwatchLogsExports

A list of log types that this DB cluster is configured to export to CloudWatch Logs.

Declaration

Swift

public let enabledCloudwatchLogsExports: [String]?


                    
                    
                    endpoint

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

Declaration

Swift

public let endpoint: String?


                    
                    
                    engine

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

Declaration

Swift

public let engine: String?


                    
                    
                    engineVersion

Indicates the database engine version.

Declaration

Swift

public let engineVersion: String?


                    
                    
                    hostedZoneId

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

Declaration

Swift

public let hostedZoneId: String?


                    
                    
                    iAMDatabaseAuthenticationEnabled

True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.

Declaration

Swift

public let iAMDatabaseAuthenticationEnabled: Bool?


                    
                    
                    kmsKeyId

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

Declaration

Swift

public let kmsKeyId: String?


                    
                    
                    latestRestorableTime

Specifies the latest time to which a database can be restored with point-in-time restore.

Declaration

Swift

public let latestRestorableTime: TimeStamp?


                    
                    
                    masterUsername

Contains the master username for the DB cluster.

Declaration

Swift

public let masterUsername: String?


                    
                    
                    multiAZ

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

Declaration

Swift

public let multiAZ: Bool?


                    
                    
                    percentProgress

Specifies the progress of the operation as a percentage.

Declaration

Swift

public let percentProgress: String?


                    
                    
                    port

Specifies the port that the database engine is listening on.

Declaration

Swift

public let port: Int?


                    
                    
                    preferredBackupWindow

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?


                    
                    
                    preferredMaintenanceWindow

Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

Declaration

Swift

public let preferredMaintenanceWindow: String?


                    
                    
                    readerEndpoint

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

Declaration

Swift

public let readerEndpoint: String?


                    
                    
                    readReplicaIdentifiers

Contains one or more identifiers of the Read Replicas associated with this DB cluster.

Declaration

Swift

public let readReplicaIdentifiers: [String]?


                    
                    
                    replicationSourceIdentifier

Not supported by Neptune.

Declaration

Swift

public let replicationSourceIdentifier: String?


                    
                    
                    status

Specifies the current state of this DB cluster.

Declaration

Swift

public let status: String?


                    
                    
                    storageEncrypted

Specifies whether the DB cluster is encrypted.

Declaration

Swift

public let storageEncrypted: Bool?


                    
                    
                    vpcSecurityGroups

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

Declaration

Swift

public let vpcSecurityGroups: [VpcSecurityGroupMembership]?


                    
                    
                    init(allocatedStorage:associatedRoles:availabilityZones:backupRetentionPeriod:characterSetName:cloneGroupId:clusterCreateTime:databaseName:dBClusterArn:dBClusterIdentifier:dBClusterMembers:dBClusterOptionGroupMemberships:dBClusterParameterGroup:dbClusterResourceId:dBSubnetGroup:deletionProtection:earliestRestorableTime:enabledCloudwatchLogsExports:endpoint:engine:engineVersion:hostedZoneId:iAMDatabaseAuthenticationEnabled:kmsKeyId:latestRestorableTime:masterUsername:multiAZ:percentProgress:port:preferredBackupWindow:preferredMaintenanceWindow:readerEndpoint:readReplicaIdentifiers:replicationSourceIdentifier:status:storageEncrypted:vpcSecurityGroups:)

Undocumented

Declaration

Swift

public init(allocatedStorage: Int? = nil, associatedRoles: [DBClusterRole]? = nil, availabilityZones: [String]? = nil, backupRetentionPeriod: Int? = nil, characterSetName: String? = nil, cloneGroupId: String? = nil, clusterCreateTime: TimeStamp? = 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, earliestRestorableTime: TimeStamp? = nil, enabledCloudwatchLogsExports: [String]? = nil, endpoint: String? = nil, engine: String? = nil, engineVersion: String? = nil, hostedZoneId: String? = 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, status: String? = nil, storageEncrypted: Bool? = nil, vpcSecurityGroups: [VpcSecurityGroupMembership]? = nil)