Struct aws_sdk_dynamodb::types::ReplicaDescription
source · #[non_exhaustive]pub struct ReplicaDescription {
pub region_name: Option<String>,
pub replica_status: Option<ReplicaStatus>,
pub replica_status_description: Option<String>,
pub replica_status_percent_progress: Option<String>,
pub kms_master_key_id: Option<String>,
pub provisioned_throughput_override: Option<ProvisionedThroughputOverride>,
pub on_demand_throughput_override: Option<OnDemandThroughputOverride>,
pub global_secondary_indexes: Option<Vec<ReplicaGlobalSecondaryIndexDescription>>,
pub replica_inaccessible_date_time: Option<DateTime>,
pub replica_table_class_summary: Option<TableClassSummary>,
}
Expand description
Contains the details of the replica.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.region_name: Option<String>
The name of the Region.
replica_status: Option<ReplicaStatus>
The current state of the replica:
-
CREATING
- The replica is being created. -
UPDATING
- The replica is being updated. -
DELETING
- The replica is being deleted. -
ACTIVE
- The replica is ready for use. -
REGION_DISABLED
- The replica is inaccessible because the Amazon Web Services Region has been disabled.If the Amazon Web Services Region remains inaccessible for more than 20 hours, DynamoDB will remove this replica from the replication group. The replica will not be deleted and replication will stop from and to this region.
-
INACCESSIBLE_ENCRYPTION_CREDENTIALS
- The KMS key used to encrypt the table is inaccessible.If the KMS key remains inaccessible for more than 20 hours, DynamoDB will remove this replica from the replication group. The replica will not be deleted and replication will stop from and to this region.
replica_status_description: Option<String>
Detailed information about the replica status.
replica_status_percent_progress: Option<String>
Specifies the progress of a Create, Update, or Delete action on the replica as a percentage.
kms_master_key_id: Option<String>
The KMS key of the replica that will be used for KMS encryption.
provisioned_throughput_override: Option<ProvisionedThroughputOverride>
Replica-specific provisioned throughput. If not described, uses the source table's provisioned throughput settings.
on_demand_throughput_override: Option<OnDemandThroughputOverride>
Overrides the maximum on-demand throughput settings for the specified replica table.
global_secondary_indexes: Option<Vec<ReplicaGlobalSecondaryIndexDescription>>
Replica-specific global secondary index settings.
replica_inaccessible_date_time: Option<DateTime>
The time at which the replica was first detected as inaccessible. To determine cause of inaccessibility check the ReplicaStatus
property.
replica_table_class_summary: Option<TableClassSummary>
Contains details of the table class.
Implementations§
source§impl ReplicaDescription
impl ReplicaDescription
sourcepub fn region_name(&self) -> Option<&str>
pub fn region_name(&self) -> Option<&str>
The name of the Region.
sourcepub fn replica_status(&self) -> Option<&ReplicaStatus>
pub fn replica_status(&self) -> Option<&ReplicaStatus>
The current state of the replica:
-
CREATING
- The replica is being created. -
UPDATING
- The replica is being updated. -
DELETING
- The replica is being deleted. -
ACTIVE
- The replica is ready for use. -
REGION_DISABLED
- The replica is inaccessible because the Amazon Web Services Region has been disabled.If the Amazon Web Services Region remains inaccessible for more than 20 hours, DynamoDB will remove this replica from the replication group. The replica will not be deleted and replication will stop from and to this region.
-
INACCESSIBLE_ENCRYPTION_CREDENTIALS
- The KMS key used to encrypt the table is inaccessible.If the KMS key remains inaccessible for more than 20 hours, DynamoDB will remove this replica from the replication group. The replica will not be deleted and replication will stop from and to this region.
sourcepub fn replica_status_description(&self) -> Option<&str>
pub fn replica_status_description(&self) -> Option<&str>
Detailed information about the replica status.
sourcepub fn replica_status_percent_progress(&self) -> Option<&str>
pub fn replica_status_percent_progress(&self) -> Option<&str>
Specifies the progress of a Create, Update, or Delete action on the replica as a percentage.
sourcepub fn kms_master_key_id(&self) -> Option<&str>
pub fn kms_master_key_id(&self) -> Option<&str>
The KMS key of the replica that will be used for KMS encryption.
sourcepub fn provisioned_throughput_override(
&self,
) -> Option<&ProvisionedThroughputOverride>
pub fn provisioned_throughput_override( &self, ) -> Option<&ProvisionedThroughputOverride>
Replica-specific provisioned throughput. If not described, uses the source table's provisioned throughput settings.
sourcepub fn on_demand_throughput_override(
&self,
) -> Option<&OnDemandThroughputOverride>
pub fn on_demand_throughput_override( &self, ) -> Option<&OnDemandThroughputOverride>
Overrides the maximum on-demand throughput settings for the specified replica table.
sourcepub fn global_secondary_indexes(
&self,
) -> &[ReplicaGlobalSecondaryIndexDescription]
pub fn global_secondary_indexes( &self, ) -> &[ReplicaGlobalSecondaryIndexDescription]
Replica-specific global secondary index settings.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .global_secondary_indexes.is_none()
.
sourcepub fn replica_inaccessible_date_time(&self) -> Option<&DateTime>
pub fn replica_inaccessible_date_time(&self) -> Option<&DateTime>
The time at which the replica was first detected as inaccessible. To determine cause of inaccessibility check the ReplicaStatus
property.
sourcepub fn replica_table_class_summary(&self) -> Option<&TableClassSummary>
pub fn replica_table_class_summary(&self) -> Option<&TableClassSummary>
Contains details of the table class.
source§impl ReplicaDescription
impl ReplicaDescription
sourcepub fn builder() -> ReplicaDescriptionBuilder
pub fn builder() -> ReplicaDescriptionBuilder
Creates a new builder-style object to manufacture ReplicaDescription
.
Trait Implementations§
source§impl Clone for ReplicaDescription
impl Clone for ReplicaDescription
source§fn clone(&self) -> ReplicaDescription
fn clone(&self) -> ReplicaDescription
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for ReplicaDescription
impl Debug for ReplicaDescription
source§impl PartialEq for ReplicaDescription
impl PartialEq for ReplicaDescription
source§fn eq(&self, other: &ReplicaDescription) -> bool
fn eq(&self, other: &ReplicaDescription) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for ReplicaDescription
Auto Trait Implementations§
impl Freeze for ReplicaDescription
impl RefUnwindSafe for ReplicaDescription
impl Send for ReplicaDescription
impl Sync for ReplicaDescription
impl Unpin for ReplicaDescription
impl UnwindSafe for ReplicaDescription
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling [Attribute
] value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
[Quirk
] value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the [Condition
] value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);