Struct aws_sdk_kms::input::GenerateDataKeyPairWithoutPlaintextInput

#[non_exhaustive]
pub struct GenerateDataKeyPairWithoutPlaintextInput {
    pub encryption_context: Option<HashMap<String, String>>,
    pub key_id: Option<String>,
    pub key_pair_spec: Option<DataKeyPairSpec>,
    pub grant_tokens: Option<Vec<String>>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

encryption_context: Option<HashMap<String, String>>

Specifies the encryption context that will be used when encrypting the private key in the data key pair.

An encryption context is a collection of non-secret key-value pairs that represent additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.

For more information, see Encryption context in the Key Management Service Developer Guide.

key_id: Option<String>

Specifies the symmetric encryption KMS key that encrypts the private key in the data key pair. You cannot specify an asymmetric KMS key or a KMS key in a custom key store. To get the type and origin of your KMS key, use the DescribeKey operation.

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

• Alias name: alias/ExampleAlias

• Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

key_pair_spec: Option<DataKeyPairSpec>

Determines the type of data key pair that is generated.

The KMS rule that restricts the use of asymmetric RSA KMS keys to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC KMS keys only to sign and verify, are not effective on data key pairs, which are used outside of KMS.

grant_tokens: Option<Vec<String>>

A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

Implementations

impl GenerateDataKeyPairWithoutPlaintextInput

pub async fn make_operation(
    &self,
    _config: &Config
) -> Result<Operation<GenerateDataKeyPairWithoutPlaintext, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<GenerateDataKeyPairWithoutPlaintext>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture GenerateDataKeyPairWithoutPlaintextInput

impl GenerateDataKeyPairWithoutPlaintextInput

pub fn encryption_context(&self) -> Option<&HashMap<String, String>>

Specifies the encryption context that will be used when encrypting the private key in the data key pair.

An encryption context is a collection of non-secret key-value pairs that represent additional authenticated data. When you use an encryption context to encrypt data, you must specify the same (an exact case-sensitive match) encryption context to decrypt the data. An encryption context is supported only on operations with symmetric encryption KMS keys. On operations with symmetric encryption KMS keys, an encryption context is optional, but it is strongly recommended.

For more information, see Encryption context in the Key Management Service Developer Guide.

pub fn key_id(&self) -> Option<&str>

Specifies the symmetric encryption KMS key that encrypts the private key in the data key pair. You cannot specify an asymmetric KMS key or a KMS key in a custom key store. To get the type and origin of your KMS key, use the DescribeKey operation.

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with "alias/". To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

For example:

• Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

• Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

• Alias name: alias/ExampleAlias

• Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

pub fn key_pair_spec(&self) -> Option<&DataKeyPairSpec>

Determines the type of data key pair that is generated.

The KMS rule that restricts the use of asymmetric RSA KMS keys to encrypt and decrypt or to sign and verify (but not both), and the rule that permits you to use ECC KMS keys only to sign and verify, are not effective on data key pairs, which are used outside of KMS.

pub fn grant_tokens(&self) -> Option<&[String]>

A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved eventual consistency. For more information, see Grant token and Using a grant token in the Key Management Service Developer Guide.

Trait Implementations

impl Clone for GenerateDataKeyPairWithoutPlaintextInput

fn clone(&self) -> GenerateDataKeyPairWithoutPlaintextInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GenerateDataKeyPairWithoutPlaintextInput

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

Formats the value using the given formatter.

impl PartialEq<GenerateDataKeyPairWithoutPlaintextInput> for GenerateDataKeyPairWithoutPlaintextInput

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

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

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

This method tests for !=.

impl StructuralPartialEq for GenerateDataKeyPairWithoutPlaintextInput