Enum aws_sdk_kms::model::CustomerMasterKeySpec

#[non_exhaustive]
pub enum CustomerMasterKeySpec {
    EccNistP256,
    EccNistP384,
    EccNistP521,
    EccSecgP256K1,
    Hmac224,
    Hmac256,
    Hmac384,
    Hmac512,
    Rsa2048,
    Rsa3072,
    Rsa4096,
    Sm2,
    SymmetricDefault,
    Unknown(UnknownVariantValue),
}

👎Deprecated: This enum has been deprecated. Instead, use the KeySpec enum.

When writing a match expression against CustomerMasterKeySpec, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

Here is an example of how you can make a match expression forward-compatible:

# let customermasterkeyspec = unimplemented!();
match customermasterkeyspec {
    CustomerMasterKeySpec::EccNistP256 => { /* ... */ },
    CustomerMasterKeySpec::EccNistP384 => { /* ... */ },
    CustomerMasterKeySpec::EccNistP521 => { /* ... */ },
    CustomerMasterKeySpec::EccSecgP256K1 => { /* ... */ },
    CustomerMasterKeySpec::Hmac224 => { /* ... */ },
    CustomerMasterKeySpec::Hmac256 => { /* ... */ },
    CustomerMasterKeySpec::Hmac384 => { /* ... */ },
    CustomerMasterKeySpec::Hmac512 => { /* ... */ },
    CustomerMasterKeySpec::Rsa2048 => { /* ... */ },
    CustomerMasterKeySpec::Rsa3072 => { /* ... */ },
    CustomerMasterKeySpec::Rsa4096 => { /* ... */ },
    CustomerMasterKeySpec::Sm2 => { /* ... */ },
    CustomerMasterKeySpec::SymmetricDefault => { /* ... */ },
    other @ _ if other.as_str() == "NewFeature" => { /* handles a case for `NewFeature` */ },
    _ => { /* ... */ },
}

The above code demonstrates that when customermasterkeyspec represents NewFeature, the execution path will lead to the second last match arm, even though the enum does not contain a variant CustomerMasterKeySpec::NewFeature in the current version of SDK. The reason is that the variable other, created by the @ operator, is bound to CustomerMasterKeySpec::Unknown(UnknownVariantValue("NewFeature".to_owned())) and calling as_str on it yields "NewFeature". This match expression is forward-compatible when executed with a newer version of SDK where the variant CustomerMasterKeySpec::NewFeature is defined. Specifically, when customermasterkeyspec represents NewFeature, the execution path will hit the second last match arm as before by virtue of calling as_str on CustomerMasterKeySpec::NewFeature also yielding "NewFeature".

Explicitly matching on the Unknown variant should be avoided for two reasons:

• The inner data UnknownVariantValue is opaque, and no further information can be extracted.
• It might inadvertently shadow other intended match arms.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

EccNistP256

👎Deprecated: This enum has been deprecated. Instead, use the KeySpec enum.

EccNistP384

👎Deprecated: This enum has been deprecated. Instead, use the KeySpec enum.

EccNistP521

👎Deprecated: This enum has been deprecated. Instead, use the KeySpec enum.

EccSecgP256K1

👎Deprecated: This enum has been deprecated. Instead, use the KeySpec enum.

Hmac224

👎Deprecated: This enum has been deprecated. Instead, use the KeySpec enum.

Hmac256

👎Deprecated: This enum has been deprecated. Instead, use the KeySpec enum.

Hmac384

👎Deprecated: This enum has been deprecated. Instead, use the KeySpec enum.

Hmac512

👎Deprecated: This enum has been deprecated. Instead, use the KeySpec enum.

Rsa2048

👎Deprecated: This enum has been deprecated. Instead, use the KeySpec enum.

Rsa3072

👎Deprecated: This enum has been deprecated. Instead, use the KeySpec enum.

Rsa4096

👎Deprecated: This enum has been deprecated. Instead, use the KeySpec enum.

Sm2

👎Deprecated: This enum has been deprecated. Instead, use the KeySpec enum.

SymmetricDefault

👎Deprecated: This enum has been deprecated. Instead, use the KeySpec enum.

Unknown(UnknownVariantValue)

👎Deprecated: This enum has been deprecated. Instead, use the KeySpec enum.

Unknown contains new variants that have been added since this code was generated.

Implementations

impl CustomerMasterKeySpec

pub fn as_str(&self) -> &str

Returns the &str value of the enum member.

Examples found in repository

src/model.rs (line 1834)

    fn as_ref(&self) -> &str {
        self.as_str()
    }

src/json_ser.rs (line 111)

pub fn serialize_structure_crate_input_create_key_input(
    object: &mut aws_smithy_json::serialize::JsonObjectWriter,
    input: &crate::input::CreateKeyInput,
) -> Result<(), aws_smithy_http::operation::error::SerializationError> {
    if let Some(var_21) = &input.policy {
        object.key("Policy").string(var_21.as_str());
    }
    if let Some(var_22) = &input.description {
        object.key("Description").string(var_22.as_str());
    }
    if let Some(var_23) = &input.key_usage {
        object.key("KeyUsage").string(var_23.as_str());
    }
    if let Some(var_24) = &input.customer_master_key_spec {
        object.key("CustomerMasterKeySpec").string(var_24.as_str());
    }
    if let Some(var_25) = &input.key_spec {
        object.key("KeySpec").string(var_25.as_str());
    }
    if let Some(var_26) = &input.origin {
        object.key("Origin").string(var_26.as_str());
    }
    if let Some(var_27) = &input.custom_key_store_id {
        object.key("CustomKeyStoreId").string(var_27.as_str());
    }
    if input.bypass_policy_lockout_safety_check {
        object
            .key("BypassPolicyLockoutSafetyCheck")
            .boolean(input.bypass_policy_lockout_safety_check);
    }
    if let Some(var_28) = &input.tags {
        let mut array_29 = object.key("Tags").start_array();
        for item_30 in var_28 {
            {
                #[allow(unused_mut)]
                let mut object_31 = array_29.value().start_object();
                crate::json_ser::serialize_structure_crate_model_tag(&mut object_31, item_30)?;
                object_31.finish();
            }
        }
        array_29.finish();
    }
    if let Some(var_32) = &input.multi_region {
        object.key("MultiRegion").boolean(*var_32);
    }
    Ok(())
}

pub const fn values() -> &'static [&'static str]

Returns all the &str values of the enum members.

Trait Implementations

impl AsRef<str> for CustomerMasterKeySpec

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for CustomerMasterKeySpec

fn clone(&self) -> CustomerMasterKeySpec

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CustomerMasterKeySpec

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

Formats the value using the given formatter.

impl From<&str> for CustomerMasterKeySpec

fn from(s: &str) -> Self

Converts to this type from the input type.

impl FromStr for CustomerMasterKeySpec

type Err = Infallible

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for CustomerMasterKeySpec

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,
    Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for CustomerMasterKeySpec

fn cmp(&self, other: &CustomerMasterKeySpec) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<CustomerMasterKeySpec> for CustomerMasterKeySpec

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<CustomerMasterKeySpec> for CustomerMasterKeySpec

fn partial_cmp(&self, other: &CustomerMasterKeySpec) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for CustomerMasterKeySpec

impl StructuralEq for CustomerMasterKeySpec

impl StructuralPartialEq for CustomerMasterKeySpec