Struct aws_sdk_kms::client::fluent_builders::GenerateRandom

pub struct GenerateRandom { /* private fields */ }

Fluent builder constructing a request to GenerateRandom.

Returns a random byte string that is cryptographically secure.

You must use the NumberOfBytes parameter to specify the length of the random byte string. There is no default value for string length.

By default, the random byte string is generated in KMS. To generate the byte string in the CloudHSM cluster that is associated with a custom key store, specify the custom key store ID.

Applications in Amazon Web Services Nitro Enclaves can call this operation by using the Amazon Web Services Nitro Enclaves Development Kit. For information about the supporting parameters, see How Amazon Web Services Nitro Enclaves use KMS in the Key Management Service Developer Guide.

For more information about entropy and random number generation, see Key Management Service Cryptographic Details.

Cross-account use: Not applicable. GenerateRandom does not use any account-specific resources, such as KMS keys.

Required permissions: kms:GenerateRandom (IAM policy)

Implementations

impl GenerateRandom

pub async fn customize(
    self
) -> Result<CustomizableOperation<GenerateRandom, AwsResponseRetryClassifier>, SdkError<GenerateRandomError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(
    self
) -> Result<GenerateRandomOutput, SdkError<GenerateRandomError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn number_of_bytes(self, input: i32) -> Self

The length of the random byte string. This parameter is required.

pub fn set_number_of_bytes(self, input: Option<i32>) -> Self

The length of the random byte string. This parameter is required.

pub fn custom_key_store_id(self, input: impl Into<String>) -> Self

Generates the random byte string in the CloudHSM cluster that is associated with the specified custom key store. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.

pub fn set_custom_key_store_id(self, input: Option<String>) -> Self

Generates the random byte string in the CloudHSM cluster that is associated with the specified custom key store. To find the ID of a custom key store, use the DescribeCustomKeyStores operation.

Trait Implementations

impl Clone for GenerateRandom

fn clone(&self) -> GenerateRandom

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GenerateRandom

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

Formats the value using the given formatter.