DBCluster class - neptune-2014-10-31 library

Constructors

DBCluster.new({int? allocatedStorage, List<DBClusterRole>? associatedRoles, List<String>? availabilityZones, int? backupRetentionPeriod, String? characterSetName, String? cloneGroupId, DateTime? clusterCreateTime, String? dBClusterArn, String? dBClusterIdentifier, List<DBClusterMember>? dBClusterMembers, List<DBClusterOptionGroupStatus>? dBClusterOptionGroupMemberships, String? dBClusterParameterGroup, String? dBSubnetGroup, String? databaseName, String? dbClusterResourceId, bool? deletionProtection, DateTime? earliestRestorableTime, List<String>? enabledCloudwatchLogsExports, String? endpoint, String? engine, String? engineVersion, String? hostedZoneId, bool? iAMDatabaseAuthenticationEnabled, String? kmsKeyId, DateTime? latestRestorableTime, String? masterUsername, bool? multiAZ, String? percentProgress, int? port, String? preferredBackupWindow, String? preferredMaintenanceWindow, List<String>? readReplicaIdentifiers, String? readerEndpoint, String? replicationSourceIdentifier, String? status, bool? storageEncrypted, List<VpcSecurityGroupMembership>? vpcSecurityGroups})
DBCluster.fromXml(XmlElement elem): factory

Properties

allocatedStorage → int?: AllocatedStorage always returns 1, because Neptune DB cluster storage size is not fixed, but instead automatically adjusts as needed.
final
associatedRoles → List<DBClusterRole>?: 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.
final
availabilityZones → List<String>?: Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in.
final
backupRetentionPeriod → int?: Specifies the number of days for which automatic DB snapshots are retained.
final
characterSetName → String?: (Not supported by Neptune)
final
cloneGroupId → String?: Identifies the clone group to which the DB cluster is associated.
final
clusterCreateTime → DateTime?: Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
final
databaseName → 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.
final
dBClusterArn → String?: The Amazon Resource Name (ARN) for the DB cluster.
final
dBClusterIdentifier → String?: Contains a user-supplied DB cluster identifier. This identifier is the unique key that identifies a DB cluster.
final
dBClusterMembers → List<DBClusterMember>?: Provides the list of instances that make up the DB cluster.
final
dBClusterOptionGroupMemberships → List<DBClusterOptionGroupStatus>?: (Not supported by Neptune)
final
dBClusterParameterGroup → String?: Specifies the name of the DB cluster parameter group for the DB cluster.
final
dbClusterResourceId → 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.
final
dBSubnetGroup → String?: Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
final
deletionProtection → bool?: Indicates whether or not the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled.
final
earliestRestorableTime → DateTime?: Specifies the earliest time to which a database can be restored with point-in-time restore.
final
enabledCloudwatchLogsExports → List<String>?: A list of log types that this DB cluster is configured to export to CloudWatch Logs.
final
endpoint → String?: Specifies the connection endpoint for the primary instance of the DB cluster.
final
engine → String?: Provides the name of the database engine to be used for this DB cluster.
final
engineVersion → String?: Indicates the database engine version.
final
hashCode → int: The hash code for this object.
no setterinherited
hostedZoneId → String?: Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
final
iAMDatabaseAuthenticationEnabled → bool?: True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
final
kmsKeyId → String?: If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster.
final
latestRestorableTime → DateTime?: Specifies the latest time to which a database can be restored with point-in-time restore.
final
masterUsername → String?: Contains the master username for the DB cluster.
final
multiAZ → bool?: Specifies whether the DB cluster has instances in multiple Availability Zones.
final
percentProgress → String?: Specifies the progress of the operation as a percentage.
final
port → int?: Specifies the port that the database engine is listening on.
final
preferredBackupWindow → String?: Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
final
preferredMaintenanceWindow → String?: Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
final
readerEndpoint → String?: 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.
final
readReplicaIdentifiers → List<String>?: Contains one or more identifiers of the Read Replicas associated with this DB cluster.
final
replicationSourceIdentifier → String?: Not supported by Neptune.
final
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
status → String?: Specifies the current state of this DB cluster.
final
storageEncrypted → bool?: Specifies whether the DB cluster is encrypted.
final
vpcSecurityGroups → List<VpcSecurityGroupMembership>?: Provides a list of VPC security groups that the DB cluster belongs to.
final

Methods

noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
toString() → String: A string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited