#[non_exhaustive]pub struct AwsRedshiftClusterDetails { /* private fields */ }
Expand description
Details about an Amazon Redshift cluster.
Implementations§
source§impl AwsRedshiftClusterDetails
impl AwsRedshiftClusterDetails
sourcepub fn allow_version_upgrade(&self) -> bool
pub fn allow_version_upgrade(&self) -> bool
Indicates whether major version upgrades are applied automatically to the cluster during the maintenance window.
sourcepub fn automated_snapshot_retention_period(&self) -> i32
pub fn automated_snapshot_retention_period(&self) -> i32
The number of days that automatic cluster snapshots are retained.
sourcepub fn availability_zone(&self) -> Option<&str>
pub fn availability_zone(&self) -> Option<&str>
The name of the Availability Zone in which the cluster is located.
sourcepub fn cluster_availability_status(&self) -> Option<&str>
pub fn cluster_availability_status(&self) -> Option<&str>
The availability status of the cluster for queries. Possible values are the following:
-
Available
- The cluster is available for queries. -
Unavailable
- The cluster is not available for queries. -
Maintenance
- The cluster is intermittently available for queries due to maintenance activities. -
Modifying
-The cluster is intermittently available for queries due to changes that modify the cluster. -
Failed
- The cluster failed and is not available for queries.
sourcepub fn cluster_create_time(&self) -> Option<&str>
pub fn cluster_create_time(&self) -> Option<&str>
Indicates when the cluster was created.
Uses the date-time
format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z
.
sourcepub fn cluster_identifier(&self) -> Option<&str>
pub fn cluster_identifier(&self) -> Option<&str>
The unique identifier of the cluster.
sourcepub fn cluster_nodes(&self) -> Option<&[AwsRedshiftClusterClusterNode]>
pub fn cluster_nodes(&self) -> Option<&[AwsRedshiftClusterClusterNode]>
The nodes in the cluster.
sourcepub fn cluster_parameter_groups(
&self
) -> Option<&[AwsRedshiftClusterClusterParameterGroup]>
pub fn cluster_parameter_groups(
&self
) -> Option<&[AwsRedshiftClusterClusterParameterGroup]>
The list of cluster parameter groups that are associated with this cluster.
sourcepub fn cluster_public_key(&self) -> Option<&str>
pub fn cluster_public_key(&self) -> Option<&str>
The public key for the cluster.
sourcepub fn cluster_revision_number(&self) -> Option<&str>
pub fn cluster_revision_number(&self) -> Option<&str>
The specific revision number of the database in the cluster.
sourcepub fn cluster_security_groups(
&self
) -> Option<&[AwsRedshiftClusterClusterSecurityGroup]>
pub fn cluster_security_groups(
&self
) -> Option<&[AwsRedshiftClusterClusterSecurityGroup]>
A list of cluster security groups that are associated with the cluster.
sourcepub fn cluster_snapshot_copy_status(
&self
) -> Option<&AwsRedshiftClusterClusterSnapshotCopyStatus>
pub fn cluster_snapshot_copy_status(
&self
) -> Option<&AwsRedshiftClusterClusterSnapshotCopyStatus>
Information about the destination Region and retention period for the cross-Region snapshot copy.
sourcepub fn cluster_status(&self) -> Option<&str>
pub fn cluster_status(&self) -> Option<&str>
The current status of the cluster.
Valid values: available
| available, prep-for-resize
| available, resize-cleanup
| cancelling-resize
| creating
| deleting
| final-snapshot
| hardware-failure
| incompatible-hsm
| incompatible-network
| incompatible-parameters
| incompatible-restore
| modifying
| paused
| rebooting
| renaming
| resizing
| rotating-keys
| storage-full
| updating-hsm
sourcepub fn cluster_subnet_group_name(&self) -> Option<&str>
pub fn cluster_subnet_group_name(&self) -> Option<&str>
The name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC.
sourcepub fn cluster_version(&self) -> Option<&str>
pub fn cluster_version(&self) -> Option<&str>
The version ID of the Amazon Redshift engine that runs on the cluster.
sourcepub fn db_name(&self) -> Option<&str>
pub fn db_name(&self) -> Option<&str>
The name of the initial database that was created when the cluster was created.
The same name is returned for the life of the cluster.
If an initial database is not specified, a database named devdev
is created by default.
sourcepub fn deferred_maintenance_windows(
&self
) -> Option<&[AwsRedshiftClusterDeferredMaintenanceWindow]>
pub fn deferred_maintenance_windows(
&self
) -> Option<&[AwsRedshiftClusterDeferredMaintenanceWindow]>
List of time windows during which maintenance was deferred.
sourcepub fn elastic_ip_status(&self) -> Option<&AwsRedshiftClusterElasticIpStatus>
pub fn elastic_ip_status(&self) -> Option<&AwsRedshiftClusterElasticIpStatus>
Information about the status of the Elastic IP (EIP) address.
sourcepub fn elastic_resize_number_of_node_options(&self) -> Option<&str>
pub fn elastic_resize_number_of_node_options(&self) -> Option<&str>
The number of nodes that you can use the elastic resize method to resize the cluster to.
sourcepub fn encrypted(&self) -> bool
pub fn encrypted(&self) -> bool
Indicates whether the data in the cluster is encrypted at rest.
sourcepub fn endpoint(&self) -> Option<&AwsRedshiftClusterEndpoint>
pub fn endpoint(&self) -> Option<&AwsRedshiftClusterEndpoint>
The connection endpoint.
sourcepub fn enhanced_vpc_routing(&self) -> bool
pub fn enhanced_vpc_routing(&self) -> bool
Indicates whether to create the cluster with enhanced VPC routing enabled.
sourcepub fn expected_next_snapshot_schedule_time(&self) -> Option<&str>
pub fn expected_next_snapshot_schedule_time(&self) -> Option<&str>
Indicates when the next snapshot is expected to be taken. The cluster must have a valid snapshot schedule and have backups enabled.
Uses the date-time
format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z
.
sourcepub fn expected_next_snapshot_schedule_time_status(&self) -> Option<&str>
pub fn expected_next_snapshot_schedule_time_status(&self) -> Option<&str>
The status of the next expected snapshot.
Valid values: OnTrack
| Pending
sourcepub fn hsm_status(&self) -> Option<&AwsRedshiftClusterHsmStatus>
pub fn hsm_status(&self) -> Option<&AwsRedshiftClusterHsmStatus>
Information about whether the Amazon Redshift cluster finished applying any changes to hardware security module (HSM) settings that were specified in a modify cluster command.
sourcepub fn iam_roles(&self) -> Option<&[AwsRedshiftClusterIamRole]>
pub fn iam_roles(&self) -> Option<&[AwsRedshiftClusterIamRole]>
A list of IAM roles that the cluster can use to access other Amazon Web Services services.
sourcepub fn kms_key_id(&self) -> Option<&str>
pub fn kms_key_id(&self) -> Option<&str>
The identifier of the KMS encryption key that is used to encrypt data in the cluster.
sourcepub fn maintenance_track_name(&self) -> Option<&str>
pub fn maintenance_track_name(&self) -> Option<&str>
The name of the maintenance track for the cluster.
sourcepub fn manual_snapshot_retention_period(&self) -> i32
pub fn manual_snapshot_retention_period(&self) -> i32
The default number of days to retain a manual snapshot.
If the value is -1
, the snapshot is retained indefinitely.
This setting doesn't change the retention period of existing snapshots.
Valid values: Either -1
or an integer between 1 and 3,653
sourcepub fn master_username(&self) -> Option<&str>
pub fn master_username(&self) -> Option<&str>
The master user name for the cluster. This name is used to connect to the database that is specified in as the value of DBName
.
sourcepub fn next_maintenance_window_start_time(&self) -> Option<&str>
pub fn next_maintenance_window_start_time(&self) -> Option<&str>
Indicates the start of the next maintenance window.
Uses the date-time
format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z
.
sourcepub fn number_of_nodes(&self) -> i32
pub fn number_of_nodes(&self) -> i32
The number of compute nodes in the cluster.
sourcepub fn pending_actions(&self) -> Option<&[String]>
pub fn pending_actions(&self) -> Option<&[String]>
A list of cluster operations that are waiting to start.
sourcepub fn pending_modified_values(
&self
) -> Option<&AwsRedshiftClusterPendingModifiedValues>
pub fn pending_modified_values(
&self
) -> Option<&AwsRedshiftClusterPendingModifiedValues>
A list of changes to the cluster that are currently pending.
sourcepub fn preferred_maintenance_window(&self) -> Option<&str>
pub fn preferred_maintenance_window(&self) -> Option<&str>
The weekly time range, in Universal Coordinated Time (UTC), during which system maintenance can occur.
Format:
For the day values, use mon
| tue
| wed
| thu
| fri
| sat
| sun
For example, sun:09:32-sun:10:02
sourcepub fn publicly_accessible(&self) -> bool
pub fn publicly_accessible(&self) -> bool
Whether the cluster can be accessed from a public network.
sourcepub fn resize_info(&self) -> Option<&AwsRedshiftClusterResizeInfo>
pub fn resize_info(&self) -> Option<&AwsRedshiftClusterResizeInfo>
Information about the resize operation for the cluster.
sourcepub fn restore_status(&self) -> Option<&AwsRedshiftClusterRestoreStatus>
pub fn restore_status(&self) -> Option<&AwsRedshiftClusterRestoreStatus>
Information about the status of a cluster restore action. Only applies to a cluster that was created by restoring a snapshot.
sourcepub fn snapshot_schedule_identifier(&self) -> Option<&str>
pub fn snapshot_schedule_identifier(&self) -> Option<&str>
A unique identifier for the cluster snapshot schedule.
sourcepub fn snapshot_schedule_state(&self) -> Option<&str>
pub fn snapshot_schedule_state(&self) -> Option<&str>
The current state of the cluster snapshot schedule.
Valid values: MODIFYING
| ACTIVE
| FAILED
sourcepub fn vpc_id(&self) -> Option<&str>
pub fn vpc_id(&self) -> Option<&str>
The identifier of the VPC that the cluster is in, if the cluster is in a VPC.
sourcepub fn vpc_security_groups(
&self
) -> Option<&[AwsRedshiftClusterVpcSecurityGroup]>
pub fn vpc_security_groups(
&self
) -> Option<&[AwsRedshiftClusterVpcSecurityGroup]>
The list of VPC security groups that the cluster belongs to, if the cluster is in a VPC.
sourcepub fn logging_status(&self) -> Option<&AwsRedshiftClusterLoggingStatus>
pub fn logging_status(&self) -> Option<&AwsRedshiftClusterLoggingStatus>
Information about the logging status of the cluster.
source§impl AwsRedshiftClusterDetails
impl AwsRedshiftClusterDetails
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture AwsRedshiftClusterDetails
.
Trait Implementations§
source§impl Clone for AwsRedshiftClusterDetails
impl Clone for AwsRedshiftClusterDetails
source§fn clone(&self) -> AwsRedshiftClusterDetails
fn clone(&self) -> AwsRedshiftClusterDetails
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for AwsRedshiftClusterDetails
impl Debug for AwsRedshiftClusterDetails
source§impl PartialEq<AwsRedshiftClusterDetails> for AwsRedshiftClusterDetails
impl PartialEq<AwsRedshiftClusterDetails> for AwsRedshiftClusterDetails
source§fn eq(&self, other: &AwsRedshiftClusterDetails) -> bool
fn eq(&self, other: &AwsRedshiftClusterDetails) -> bool
self
and other
values to be equal, and is used
by ==
.