Struct DbCluster

Source

#[non_exhaustive]
pub struct DbCluster {Show 45 fields
    pub allocated_storage: Option<i32>,
    pub availability_zones: Option<Vec<String>>,
    pub backup_retention_period: Option<i32>,
    pub character_set_name: Option<String>,
    pub database_name: Option<String>,
    pub db_cluster_identifier: Option<String>,
    pub db_cluster_parameter_group: Option<String>,
    pub db_subnet_group: Option<String>,
    pub status: Option<String>,
    pub percent_progress: Option<String>,
    pub earliest_restorable_time: Option<DateTime>,
    pub endpoint: Option<String>,
    pub reader_endpoint: Option<String>,
    pub multi_az: Option<bool>,
    pub engine: Option<String>,
    pub engine_version: Option<String>,
    pub latest_restorable_time: Option<DateTime>,
    pub port: Option<i32>,
    pub master_username: Option<String>,
    pub db_cluster_option_group_memberships: Option<Vec<DbClusterOptionGroupStatus>>,
    pub preferred_backup_window: Option<String>,
    pub preferred_maintenance_window: Option<String>,
    pub replication_source_identifier: Option<String>,
    pub read_replica_identifiers: Option<Vec<String>>,
    pub db_cluster_members: Option<Vec<DbClusterMember>>,
    pub vpc_security_groups: Option<Vec<VpcSecurityGroupMembership>>,
    pub hosted_zone_id: Option<String>,
    pub storage_encrypted: Option<bool>,
    pub kms_key_id: Option<String>,
    pub db_cluster_resource_id: Option<String>,
    pub db_cluster_arn: Option<String>,
    pub associated_roles: Option<Vec<DbClusterRole>>,
    pub iam_database_authentication_enabled: Option<bool>,
    pub clone_group_id: Option<String>,
    pub cluster_create_time: Option<DateTime>,
    pub copy_tags_to_snapshot: Option<bool>,
    pub enabled_cloudwatch_logs_exports: Option<Vec<String>>,
    pub pending_modified_values: Option<ClusterPendingModifiedValues>,
    pub deletion_protection: Option<bool>,
    pub cross_account_clone: Option<bool>,
    pub automatic_restart_time: Option<DateTime>,
    pub serverless_v2_scaling_configuration: Option<ServerlessV2ScalingConfigurationInfo>,
    pub global_cluster_identifier: Option<String>,
    pub io_optimized_next_allowed_modification_time: Option<DateTime>,
    pub storage_type: Option<String>,
}

Expand description

Contains the details of an Amazon Neptune DB cluster.

This data type is used as a response element in the DescribeDBClusters.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

§allocated_storage: Option<i32>

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

§availability_zones: Option<Vec<String>>

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

§backup_retention_period: Option<i32>

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

§character_set_name: Option<String>

Not supported by Neptune.

§database_name: Option<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.

§db_cluster_identifier: Option<String>

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

§db_cluster_parameter_group: Option<String>

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

§db_subnet_group: Option<String>

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

§status: Option<String>

Specifies the current state of this DB cluster.

§percent_progress: Option<String>

Specifies the progress of the operation as a percentage.

§earliest_restorable_time: Option<DateTime>

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

§endpoint: Option<String>

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

§reader_endpoint: Option<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.

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.

§multi_az: Option<bool>

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

§engine: Option<String>

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

§engine_version: Option<String>

Indicates the database engine version.

§latest_restorable_time: Option<DateTime>

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

§port: Option<i32>

Specifies the port that the database engine is listening on.

§master_username: Option<String>

Not supported by Neptune.

§db_cluster_option_group_memberships: Option<Vec<DbClusterOptionGroupStatus>>

Not supported by Neptune.

§preferred_backup_window: Option<String>

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.

§preferred_maintenance_window: Option<String>

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

§replication_source_identifier: Option<String>

Not supported by Neptune.

§read_replica_identifiers: Option<Vec<String>>

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

§db_cluster_members: Option<Vec<DbClusterMember>>

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

§vpc_security_groups: Option<Vec<VpcSecurityGroupMembership>>

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

§hosted_zone_id: Option<String>

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

§storage_encrypted: Option<bool>

Specifies whether the DB cluster is encrypted.

§kms_key_id: Option<String>

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

§db_cluster_resource_id: Option<String>

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

§db_cluster_arn: Option<String>

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

§associated_roles: Option<Vec<DbClusterRole>>

Provides a list of the Amazon 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 Amazon services on your behalf.

§iam_database_authentication_enabled: Option<bool>

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

§clone_group_id: Option<String>

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

§cluster_create_time: Option<DateTime>

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

§copy_tags_to_snapshot: Option<bool>

If set to true, tags are copied to any snapshot of the DB cluster that is created.

§enabled_cloudwatch_logs_exports: Option<Vec<String>>

A list of the log types that this DB cluster is configured to export to CloudWatch Logs. Valid log types are: audit (to publish audit logs to CloudWatch) and slowquery (to publish slow-query logs to CloudWatch). See Publishing Neptune logs to Amazon CloudWatch logs.

§pending_modified_values: Option<ClusterPendingModifiedValues>

This data type is used as a response element in the ModifyDBCluster operation and contains changes that will be applied during the next maintenance window.

§deletion_protection: Option<bool>

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

§cross_account_clone: Option<bool>

If set to true, the DB cluster can be cloned across accounts.

§automatic_restart_time: Option<DateTime>

Time at which the DB cluster will be automatically restarted.

§serverless_v2_scaling_configuration: Option<ServerlessV2ScalingConfigurationInfo>

Shows the scaling configuration for a Neptune Serverless DB cluster.

For more information, see Using Amazon Neptune Serverless in the Amazon Neptune User Guide.

§global_cluster_identifier: Option<String>

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

§io_optimized_next_allowed_modification_time: Option<DateTime>

The next time you can modify the DB cluster to use the iopt1 storage type.

§storage_type: Option<String>

The storage type used by the DB cluster.

Valid Values:

standard – ( the default ) Provides cost-effective database storage for applications with moderate to small I/O usage.
iopt1 – Enables I/O-Optimized storage that's designed to meet the needs of I/O-intensive graph workloads that require predictable pricing with low I/O latency and consistent I/O throughput.

Neptune I/O-Optimized storage is only available starting with engine release 1.3.0.0.

Struct DbCluster Copy item path

Fields (Non-exhaustive)§

Implementations§

impl DbCluster

pub fn allocated_storage(&self) -> Option<i32>

pub fn availability_zones(&self) -> &[String]

pub fn backup_retention_period(&self) -> Option<i32>

pub fn character_set_name(&self) -> Option<&str>

pub fn database_name(&self) -> Option<&str>

pub fn db_cluster_identifier(&self) -> Option<&str>

pub fn db_cluster_parameter_group(&self) -> Option<&str>

pub fn db_subnet_group(&self) -> Option<&str>

pub fn status(&self) -> Option<&str>

pub fn percent_progress(&self) -> Option<&str>

pub fn earliest_restorable_time(&self) -> Option<&DateTime>

pub fn endpoint(&self) -> Option<&str>

pub fn reader_endpoint(&self) -> Option<&str>

pub fn multi_az(&self) -> Option<bool>

pub fn engine(&self) -> Option<&str>

pub fn engine_version(&self) -> Option<&str>

pub fn latest_restorable_time(&self) -> Option<&DateTime>

pub fn port(&self) -> Option<i32>

pub fn master_username(&self) -> Option<&str>

pub fn db_cluster_option_group_memberships( &self, ) -> &[DbClusterOptionGroupStatus]

pub fn preferred_backup_window(&self) -> Option<&str>

pub fn preferred_maintenance_window(&self) -> Option<&str>

pub fn replication_source_identifier(&self) -> Option<&str>

pub fn read_replica_identifiers(&self) -> &[String]

pub fn db_cluster_members(&self) -> &[DbClusterMember]

pub fn vpc_security_groups(&self) -> &[VpcSecurityGroupMembership]

pub fn hosted_zone_id(&self) -> Option<&str>

pub fn storage_encrypted(&self) -> Option<bool>

pub fn kms_key_id(&self) -> Option<&str>

pub fn db_cluster_resource_id(&self) -> Option<&str>

pub fn db_cluster_arn(&self) -> Option<&str>

pub fn associated_roles(&self) -> &[DbClusterRole]

pub fn iam_database_authentication_enabled(&self) -> Option<bool>

pub fn clone_group_id(&self) -> Option<&str>

pub fn cluster_create_time(&self) -> Option<&DateTime>

pub fn copy_tags_to_snapshot(&self) -> Option<bool>

pub fn enabled_cloudwatch_logs_exports(&self) -> &[String]

pub fn pending_modified_values(&self) -> Option<&ClusterPendingModifiedValues>

pub fn deletion_protection(&self) -> Option<bool>

pub fn cross_account_clone(&self) -> Option<bool>

pub fn automatic_restart_time(&self) -> Option<&DateTime>

pub fn serverless_v2_scaling_configuration( &self, ) -> Option<&ServerlessV2ScalingConfigurationInfo>

pub fn global_cluster_identifier(&self) -> Option<&str>

pub fn io_optimized_next_allowed_modification_time(&self) -> Option<&DateTime>

pub fn storage_type(&self) -> Option<&str>

impl DbCluster

pub fn builder() -> DbClusterBuilder

Trait Implementations§

impl Clone for DbCluster

fn clone(&self) -> DbCluster

fn clone_from(&mut self, source: &Self)

impl Debug for DbCluster

fn fmt(&self, f: &mut Formatter<'_>) -> Result

impl PartialEq for DbCluster

fn eq(&self, other: &DbCluster) -> bool

fn ne(&self, other: &Rhs) -> bool

impl StructuralPartialEq for DbCluster

Auto Trait Implementations§

impl Freeze for DbCluster

impl RefUnwindSafe for DbCluster

impl Send for DbCluster

impl Sync for DbCluster

impl Unpin for DbCluster

impl UnwindSafe for DbCluster

Blanket Implementations§

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> CloneToUninit for Twhere T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

Struct DbCluster

impl<T> Any for T
where T: 'static + ?Sized,

impl<T> Borrow<T> for T
where T: ?Sized,

impl<T> BorrowMut<T> for T
where T: ?Sized,

impl<T> CloneToUninit for T
where T: Clone,

impl<T, U> Into<U> for T
where U: From<T>,

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

impl<T> Paint for T
where T: ?Sized,