Cluster

Struct Cluster 

Source
pub struct Cluster {
Show 46 fields pub allow_version_upgrade: Option<bool>, pub automated_snapshot_retention_period: Option<i64>, pub availability_zone: Option<String>, pub cluster_availability_status: Option<String>, pub cluster_create_time: Option<String>, pub cluster_identifier: Option<String>, pub cluster_nodes: Option<Vec<ClusterNode>>, pub cluster_parameter_groups: Option<Vec<ClusterParameterGroupStatus>>, pub cluster_public_key: Option<String>, pub cluster_revision_number: Option<String>, pub cluster_security_groups: Option<Vec<ClusterSecurityGroupMembership>>, pub cluster_snapshot_copy_status: Option<ClusterSnapshotCopyStatus>, pub cluster_status: Option<String>, pub cluster_subnet_group_name: Option<String>, pub cluster_version: Option<String>, pub db_name: Option<String>, pub data_transfer_progress: Option<DataTransferProgress>, pub deferred_maintenance_windows: Option<Vec<DeferredMaintenanceWindow>>, pub elastic_ip_status: Option<ElasticIpStatus>, pub elastic_resize_number_of_node_options: Option<String>, pub encrypted: Option<bool>, pub endpoint: Option<Endpoint>, pub enhanced_vpc_routing: Option<bool>, pub expected_next_snapshot_schedule_time: Option<String>, pub expected_next_snapshot_schedule_time_status: Option<String>, pub hsm_status: Option<HsmStatus>, pub iam_roles: Option<Vec<ClusterIamRole>>, pub kms_key_id: Option<String>, pub maintenance_track_name: Option<String>, pub manual_snapshot_retention_period: Option<i64>, pub master_username: Option<String>, pub modify_status: Option<String>, pub next_maintenance_window_start_time: Option<String>, pub node_type: Option<String>, pub number_of_nodes: Option<i64>, pub pending_actions: Option<Vec<String>>, pub pending_modified_values: Option<PendingModifiedValues>, pub preferred_maintenance_window: Option<String>, pub publicly_accessible: Option<bool>, pub resize_info: Option<ResizeInfo>, pub restore_status: Option<RestoreStatus>, pub snapshot_schedule_identifier: Option<String>, pub snapshot_schedule_state: Option<String>, pub tags: Option<Vec<Tag>>, pub vpc_id: Option<String>, pub vpc_security_groups: Option<Vec<VpcSecurityGroupMembership>>,
}
Expand description

Describes a cluster.

Fields§

§allow_version_upgrade: Option<bool>

A boolean value that, if true, indicates that major version upgrades will be applied automatically to the cluster during the maintenance window.

§automated_snapshot_retention_period: Option<i64>

The number of days that automatic cluster snapshots are retained.

§availability_zone: Option<String>

The name of the Availability Zone in which the cluster is located.

§cluster_availability_status: Option<String>

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.

§cluster_create_time: Option<String>

The date and time that the cluster was created.

§cluster_identifier: Option<String>

The unique identifier of the cluster.

§cluster_nodes: Option<Vec<ClusterNode>>

The nodes in the cluster.

§cluster_parameter_groups: Option<Vec<ClusterParameterGroupStatus>>

The list of cluster parameter groups that are associated with this cluster. Each parameter group in the list is returned with its status.

§cluster_public_key: Option<String>

The public key for the cluster.

§cluster_revision_number: Option<String>

The specific revision number of the database in the cluster.

§cluster_security_groups: Option<Vec<ClusterSecurityGroupMembership>>

A list of cluster security group that are associated with the cluster. Each security group is represented by an element that contains ClusterSecurityGroup.Name and ClusterSecurityGroup.Status subelements.

Cluster security groups are used when the cluster is not created in an Amazon Virtual Private Cloud (VPC). Clusters that are created in a VPC use VPC security groups, which are listed by the VpcSecurityGroups parameter.

§cluster_snapshot_copy_status: Option<ClusterSnapshotCopyStatus>

A value that returns the destination region and retention period that are configured for cross-region snapshot copy.

§cluster_status: Option<String>

The current state of the cluster. Possible values are the following:

  • 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

§cluster_subnet_group_name: Option<String>

The name of the subnet group that is associated with the cluster. This parameter is valid only when the cluster is in a VPC.

§cluster_version: Option<String>

The version ID of the Amazon Redshift engine that is running on the cluster.

§db_name: Option<String>

The name of the initial database that was created when the cluster was created. This same name is returned for the life of the cluster. If an initial database was not specified, a database named devdev was created by default.

§data_transfer_progress: Option<DataTransferProgress>

§deferred_maintenance_windows: Option<Vec<DeferredMaintenanceWindow>>

Describes a group of DeferredMaintenanceWindow objects.

§elastic_ip_status: Option<ElasticIpStatus>

The status of the elastic IP (EIP) address.

§elastic_resize_number_of_node_options: Option<String>

The number of nodes that you can resize the cluster to with the elastic resize method.

§encrypted: Option<bool>

A boolean value that, if true, indicates that data in the cluster is encrypted at rest.

§endpoint: Option<Endpoint>

The connection endpoint.

§enhanced_vpc_routing: Option<bool>

An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

If this option is true, enhanced VPC routing is enabled.

Default: false

§expected_next_snapshot_schedule_time: Option<String>

The date and time when the next snapshot is expected to be taken for clusters with a valid snapshot schedule and backups enabled.

§expected_next_snapshot_schedule_time_status: Option<String>

The status of next expected snapshot for clusters having a valid snapshot schedule and backups enabled. Possible values are the following:

  • OnTrack - The next snapshot is expected to be taken on time.

  • Pending - The next snapshot is pending to be taken.

§hsm_status: Option<HsmStatus>

A value that reports whether the Amazon Redshift cluster has finished applying any hardware security module (HSM) settings changes specified in a modify cluster command.

Values: active, applying

§iam_roles: Option<Vec<ClusterIamRole>>

A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services.

§kms_key_id: Option<String>

The AWS Key Management Service (AWS KMS) key ID of the encryption key used to encrypt data in the cluster.

§maintenance_track_name: Option<String>

The name of the maintenance track for the cluster.

§manual_snapshot_retention_period: Option<i64>

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.

The value must be either -1 or an integer between 1 and 3,653.

§master_username: Option<String>

The master user name for the cluster. This name is used to connect to the database that is specified in the DBName parameter.

§modify_status: Option<String>

The status of a modify operation, if any, initiated for the cluster.

§next_maintenance_window_start_time: Option<String>

The date and time in UTC when system maintenance can begin.

§node_type: Option<String>

The node type for the nodes in the cluster.

§number_of_nodes: Option<i64>

The number of compute nodes in the cluster.

§pending_actions: Option<Vec<String>>

Cluster operations that are waiting to be started.

§pending_modified_values: Option<PendingModifiedValues>

A value that, if present, indicates that changes to the cluster are pending. Specific pending changes are identified by subelements.

§preferred_maintenance_window: Option<String>

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

§publicly_accessible: Option<bool>

A boolean value that, if true, indicates that the cluster can be accessed from a public network.

§resize_info: Option<ResizeInfo>

Returns the following:

  • AllowCancelResize: a boolean value indicating if the resize operation can be cancelled.

  • ResizeType: Returns ClassicResize

§restore_status: Option<RestoreStatus>

A value that describes the status of a cluster restore action. This parameter returns null if the cluster was not created by restoring a snapshot.

§snapshot_schedule_identifier: Option<String>

A unique identifier for the cluster snapshot schedule.

§snapshot_schedule_state: Option<String>

The current state of the cluster snapshot schedule.

§tags: Option<Vec<Tag>>

The list of tags for the cluster.

§vpc_id: Option<String>

The identifier of the VPC the cluster is in, if the cluster is in a VPC.

§vpc_security_groups: Option<Vec<VpcSecurityGroupMembership>>

A list of Amazon Virtual Private Cloud (Amazon VPC) security groups that are associated with the cluster. This parameter is returned only if the cluster is in a VPC.

Trait Implementations§

Source§

impl Clone for Cluster

Source§

fn clone(&self) -> Cluster

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Cluster

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Cluster

Source§

fn default() -> Cluster

Returns the “default value” for a type. Read more
Source§

impl PartialEq for Cluster

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for Cluster

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

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

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,