Struct aws_sdk_kms::operation::generate_data_key_pair_without_plaintext::builders::GenerateDataKeyPairWithoutPlaintextInputBuilder
source · #[non_exhaustive]pub struct GenerateDataKeyPairWithoutPlaintextInputBuilder { /* private fields */ }
Expand description
A builder for GenerateDataKeyPairWithoutPlaintextInput
.
Implementations§
source§impl GenerateDataKeyPairWithoutPlaintextInputBuilder
impl GenerateDataKeyPairWithoutPlaintextInputBuilder
sourcepub fn encryption_context(
self,
k: impl Into<String>,
v: impl Into<String>
) -> Self
pub fn encryption_context( self, k: impl Into<String>, v: impl Into<String> ) -> Self
Adds a key-value pair to encryption_context
.
To override the contents of this collection use set_encryption_context
.
Specifies the encryption context that will be used when encrypting the private key in the data key pair.
Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
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.
sourcepub fn set_encryption_context(
self,
input: Option<HashMap<String, String>>
) -> Self
pub fn set_encryption_context( self, input: Option<HashMap<String, String>> ) -> Self
Specifies the encryption context that will be used when encrypting the private key in the data key pair.
Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
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.
sourcepub fn get_encryption_context(&self) -> &Option<HashMap<String, String>>
pub fn get_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.
Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.
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.
sourcepub fn key_id(self, input: impl Into<String>) -> Self
pub fn key_id(self, input: impl Into<String>) -> Self
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
.
sourcepub fn set_key_id(self, input: Option<String>) -> Self
pub fn set_key_id(self, input: Option<String>) -> Self
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
.
sourcepub fn get_key_id(&self) -> &Option<String>
pub fn get_key_id(&self) -> &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
.
sourcepub fn key_pair_spec(self, input: DataKeyPairSpec) -> Self
pub fn key_pair_spec(self, input: DataKeyPairSpec) -> Self
Determines the type of data key pair that is generated.
The KMS rule that restricts the use of asymmetric RSA and SM2 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. The SM2 key spec is only available in China Regions.
This field is required.sourcepub fn set_key_pair_spec(self, input: Option<DataKeyPairSpec>) -> Self
pub fn set_key_pair_spec(self, input: Option<DataKeyPairSpec>) -> Self
Determines the type of data key pair that is generated.
The KMS rule that restricts the use of asymmetric RSA and SM2 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. The SM2 key spec is only available in China Regions.
sourcepub fn get_key_pair_spec(&self) -> &Option<DataKeyPairSpec>
pub fn get_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 and SM2 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. The SM2 key spec is only available in China Regions.
sourcepub fn grant_tokens(self, input: impl Into<String>) -> Self
pub fn grant_tokens(self, input: impl Into<String>) -> Self
Appends an item to grant_tokens
.
To override the contents of this collection use set_grant_tokens
.
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.
sourcepub fn set_grant_tokens(self, input: Option<Vec<String>>) -> Self
pub fn set_grant_tokens(self, input: Option<Vec<String>>) -> Self
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.
sourcepub fn get_grant_tokens(&self) -> &Option<Vec<String>>
pub fn get_grant_tokens(&self) -> &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.
sourcepub fn dry_run(self, input: bool) -> Self
pub fn dry_run(self, input: bool) -> Self
Checks if your request will succeed. DryRun
is an optional parameter.
To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management Service Developer Guide.
sourcepub fn set_dry_run(self, input: Option<bool>) -> Self
pub fn set_dry_run(self, input: Option<bool>) -> Self
Checks if your request will succeed. DryRun
is an optional parameter.
To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management Service Developer Guide.
sourcepub fn get_dry_run(&self) -> &Option<bool>
pub fn get_dry_run(&self) -> &Option<bool>
Checks if your request will succeed. DryRun
is an optional parameter.
To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management Service Developer Guide.
sourcepub fn build(
self
) -> Result<GenerateDataKeyPairWithoutPlaintextInput, BuildError>
pub fn build( self ) -> Result<GenerateDataKeyPairWithoutPlaintextInput, BuildError>
Consumes the builder and constructs a GenerateDataKeyPairWithoutPlaintextInput
.
source§impl GenerateDataKeyPairWithoutPlaintextInputBuilder
impl GenerateDataKeyPairWithoutPlaintextInputBuilder
sourcepub async fn send_with(
self,
client: &Client
) -> Result<GenerateDataKeyPairWithoutPlaintextOutput, SdkError<GenerateDataKeyPairWithoutPlaintextError, HttpResponse>>
pub async fn send_with( self, client: &Client ) -> Result<GenerateDataKeyPairWithoutPlaintextOutput, SdkError<GenerateDataKeyPairWithoutPlaintextError, HttpResponse>>
Sends a request with this input using the given client.
Trait Implementations§
source§impl Clone for GenerateDataKeyPairWithoutPlaintextInputBuilder
impl Clone for GenerateDataKeyPairWithoutPlaintextInputBuilder
source§fn clone(&self) -> GenerateDataKeyPairWithoutPlaintextInputBuilder
fn clone(&self) -> GenerateDataKeyPairWithoutPlaintextInputBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Default for GenerateDataKeyPairWithoutPlaintextInputBuilder
impl Default for GenerateDataKeyPairWithoutPlaintextInputBuilder
source§fn default() -> GenerateDataKeyPairWithoutPlaintextInputBuilder
fn default() -> GenerateDataKeyPairWithoutPlaintextInputBuilder
source§impl PartialEq for GenerateDataKeyPairWithoutPlaintextInputBuilder
impl PartialEq for GenerateDataKeyPairWithoutPlaintextInputBuilder
source§fn eq(&self, other: &GenerateDataKeyPairWithoutPlaintextInputBuilder) -> bool
fn eq(&self, other: &GenerateDataKeyPairWithoutPlaintextInputBuilder) -> bool
self
and other
values to be equal, and is used
by ==
.