Struct aws_sdk_paymentcryptography::operation::create_key::builders::CreateKeyInputBuilder

#[non_exhaustive]
pub struct CreateKeyInputBuilder { /* private fields */ }

A builder for CreateKeyInput.

Implementations

impl CreateKeyInputBuilder

pub fn key_attributes(self, input: KeyAttributes) -> Self

The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. This data is immutable after the key is created.

This field is required.

pub fn set_key_attributes(self, input: Option<KeyAttributes>) -> Self

The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. This data is immutable after the key is created.

pub fn get_key_attributes(&self) -> &Option<KeyAttributes>

The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key. This data is immutable after the key is created.

pub fn key_check_value_algorithm(self, input: KeyCheckValueAlgorithm) -> Self

The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity.

For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.

pub fn set_key_check_value_algorithm( self, input: Option<KeyCheckValueAlgorithm> ) -> Self

The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity.

For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.

pub fn get_key_check_value_algorithm(&self) -> &Option<KeyCheckValueAlgorithm>

The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity.

For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.

pub fn exportable(self, input: bool) -> Self

Specifies whether the key is exportable from the service.

This field is required.

pub fn set_exportable(self, input: Option<bool>) -> Self

Specifies whether the key is exportable from the service.

pub fn get_exportable(&self) -> &Option<bool>

Specifies whether the key is exportable from the service.

pub fn enabled(self, input: bool) -> Self

Specifies whether to enable the key. If the key is enabled, it is activated for use within the service. If the key is not enabled, then it is created but not activated. The default value is enabled.

pub fn set_enabled(self, input: Option<bool>) -> Self

Specifies whether to enable the key. If the key is enabled, it is activated for use within the service. If the key is not enabled, then it is created but not activated. The default value is enabled.

pub fn get_enabled(&self) -> &Option<bool>

Specifies whether to enable the key. If the key is enabled, it is activated for use within the service. If the key is not enabled, then it is created but not activated. The default value is enabled.

pub fn tags(self, input: Tag) -> Self

Appends an item to tags.

To override the contents of this collection use set_tags.

Assigns one or more tags to the Amazon Web Services Payment Cryptography key. Use this parameter to tag a key when it is created. To tag an existing Amazon Web Services Payment Cryptography key, use the TagResource operation.

Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. You can't have more than one tag on an Amazon Web Services Payment Cryptography key with the same tag key.

Don't include personal, confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

Tagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

Assigns one or more tags to the Amazon Web Services Payment Cryptography key. Use this parameter to tag a key when it is created. To tag an existing Amazon Web Services Payment Cryptography key, use the TagResource operation.

Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. You can't have more than one tag on an Amazon Web Services Payment Cryptography key with the same tag key.

Don't include personal, confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

Tagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.

pub fn get_tags(&self) -> &Option<Vec<Tag>>

Assigns one or more tags to the Amazon Web Services Payment Cryptography key. Use this parameter to tag a key when it is created. To tag an existing Amazon Web Services Payment Cryptography key, use the TagResource operation.

Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required, but the tag value can be an empty (null) string. You can't have more than one tag on an Amazon Web Services Payment Cryptography key with the same tag key.

Don't include personal, confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

Tagging or untagging an Amazon Web Services Payment Cryptography key can allow or deny permission to the key.

pub fn build(self) -> Result<CreateKeyInput, BuildError>

Consumes the builder and constructs a CreateKeyInput.

impl CreateKeyInputBuilder

pub async fn send_with( self, client: &Client ) -> Result<CreateKeyOutput, SdkError<CreateKeyError, HttpResponse>>

Sends a request with this input using the given client.

Trait Implementations

impl Clone for CreateKeyInputBuilder

fn clone(&self) -> CreateKeyInputBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateKeyInputBuilder

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

Formats the value using the given formatter.

impl Default for CreateKeyInputBuilder

fn default() -> CreateKeyInputBuilder

Returns the “default value” for a type.

impl PartialEq for CreateKeyInputBuilder

fn eq(&self, other: &CreateKeyInputBuilder) -> 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 StructuralPartialEq for CreateKeyInputBuilder