Struct rusoto_rds::DBCluster

pub struct DBCluster {

    pub activity_stream_kinesis_stream_name: Option<String>,
    pub activity_stream_kms_key_id: Option<String>,
    pub activity_stream_mode: Option<String>,
    pub activity_stream_status: Option<String>,
    pub allocated_storage: Option<i64>,
    pub associated_roles: Option<Vec<DBClusterRole>>,
    pub availability_zones: Option<Vec<String>>,
    pub backtrack_consumed_change_records: Option<i64>,
    pub backtrack_window: Option<i64>,
    pub backup_retention_period: Option<i64>,
    pub capacity: Option<i64>,
    pub character_set_name: Option<String>,
    pub clone_group_id: Option<String>,
    pub cluster_create_time: Option<String>,
    pub copy_tags_to_snapshot: Option<bool>,
    pub cross_account_clone: Option<bool>,
    pub custom_endpoints: Option<Vec<String>>,
    pub db_cluster_arn: Option<String>,
    pub db_cluster_identifier: Option<String>,
    pub db_cluster_members: Option<Vec<DBClusterMember>>,
    pub db_cluster_option_group_memberships: Option<Vec<DBClusterOptionGroupStatus>>,
    pub db_cluster_parameter_group: Option<String>,
    pub db_subnet_group: Option<String>,
    pub database_name: Option<String>,
    pub db_cluster_resource_id: Option<String>,
    pub deletion_protection: Option<bool>,
    pub domain_memberships: Option<Vec<DomainMembership>>,
    pub earliest_backtrack_time: Option<String>,
    pub earliest_restorable_time: Option<String>,
    pub enabled_cloudwatch_logs_exports: Option<Vec<String>>,
    pub endpoint: Option<String>,
    pub engine: Option<String>,
    pub engine_mode: Option<String>,
    pub engine_version: Option<String>,
    pub global_write_forwarding_requested: Option<bool>,
    pub global_write_forwarding_status: Option<String>,
    pub hosted_zone_id: Option<String>,
    pub http_endpoint_enabled: Option<bool>,
    pub iam_database_authentication_enabled: Option<bool>,
    pub kms_key_id: Option<String>,
    pub latest_restorable_time: Option<String>,
    pub master_username: Option<String>,
    pub multi_az: Option<bool>,
    pub pending_modified_values: Option<ClusterPendingModifiedValues>,
    pub percent_progress: Option<String>,
    pub port: Option<i64>,
    pub preferred_backup_window: Option<String>,
    pub preferred_maintenance_window: Option<String>,
    pub read_replica_identifiers: Option<Vec<String>>,
    pub reader_endpoint: Option<String>,
    pub replication_source_identifier: Option<String>,
    pub scaling_configuration_info: Option<ScalingConfigurationInfo>,
    pub status: Option<String>,
    pub storage_encrypted: Option<bool>,
    pub tag_list: Option<Vec<Tag>>,
    pub vpc_security_groups: Option<Vec<VpcSecurityGroupMembership>>,
}

Contains the details of an Amazon Aurora DB cluster.

This data type is used as a response element in the DescribeDBClusters, StopDBCluster, and StartDBCluster actions.

Fields

activity_stream_kinesis_stream_name: Option<String>

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

activity_stream_kms_key_id: Option<String>

The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).

activity_stream_mode: Option<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.

activity_stream_status: Option<String>

The status of the database activity stream.

allocated_storage: Option<i64>

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.

associated_roles: Option<Vec<DBClusterRole>>

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

availability_zones: Option<Vec<String>>

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

backtrack_consumed_change_records: Option<i64>

The number of change records stored for Backtrack.

backtrack_window: Option<i64>

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

backup_retention_period: Option<i64>

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

capacity: Option<i64>

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.

character_set_name: Option<String>

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

clone_group_id: Option<String>

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

cluster_create_time: Option<String>

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

copy_tags_to_snapshot: Option<bool>

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

cross_account_clone: Option<bool>

Specifies whether the DB cluster is a clone of a DB cluster owned by a different Amazon Web Services account.

custom_endpoints: Option<Vec<String>>

Identifies all custom endpoints associated with the cluster.

db_cluster_arn: Option<String>

The Amazon Resource Name (ARN) for 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_members: Option<Vec<DBClusterMember>>

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

db_cluster_option_group_memberships: Option<Vec<DBClusterOptionGroupStatus>>

Provides the list of option group memberships for this 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.

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_resource_id: Option<String>

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

deletion_protection: Option<bool>

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

domain_memberships: Option<Vec<DomainMembership>>

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

earliest_backtrack_time: Option<String>

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

earliest_restorable_time: Option<String>

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

enabled_cloudwatch_logs_exports: Option<Vec<String>>

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.

endpoint: Option<String>

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

engine: Option<String>

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

engine_mode: Option<String>

The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster.

For more information, see CreateDBCluster.

engine_version: Option<String>

Indicates the database engine version.

global_write_forwarding_requested: Option<bool>

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.

global_write_forwarding_status: Option<String>

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

hosted_zone_id: Option<String>

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

http_endpoint_enabled: Option<bool>

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.

iam_database_authentication_enabled: Option<bool>

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

kms_key_id: Option<String>

If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS customer master key (CMK).

latest_restorable_time: Option<String>

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

master_username: Option<String>

Contains the master username for the DB cluster.

multi_az: Option<bool>

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

pending_modified_values: Option<ClusterPendingModifiedValues>

A value that specifies that changes to the DB cluster are pending. This element is only included when changes are pending. Specific changes are identified by subelements.

percent_progress: Option<String>

Specifies the progress of the operation as a percentage.

port: Option<i64>

Specifies the port that the database engine is listening on.

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).

read_replica_identifiers: Option<Vec<String>>

Contains one or more identifiers of the read replicas associated with this 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 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.

replication_source_identifier: Option<String>

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

scaling_configuration_info: Option<ScalingConfigurationInfo>

status: Option<String>

Specifies the current state of this DB cluster.

storage_encrypted: Option<bool>

Specifies whether the DB cluster is encrypted.

tag_list: Option<Vec<Tag>>

vpc_security_groups: Option<Vec<VpcSecurityGroupMembership>>

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

Trait Implementations

impl Clone for DBCluster

fn clone(&self) -> DBCluster

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DBCluster

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

Formats the value using the given formatter.

impl Default for DBCluster

fn default() -> DBCluster

Returns the “default value” for a type.

impl PartialEq<DBCluster> for DBCluster

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for DBCluster