com.amazonaws.services.kms.model

Class GenerateRandomRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kms.model.GenerateRandomRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class GenerateRandomRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Returns a random byte string that is cryptographically secure.

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

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

Required permissions: kms:GenerateRandom (IAM policy)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GenerateRandomRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getCustomKeyStoreId() Generates the random byte string in the AWS CloudHSM cluster that is associated with the specified custom key store.
java.lang.Integer	getNumberOfBytes() The length of the byte string.
int	hashCode()
void	setCustomKeyStoreId(java.lang.String customKeyStoreId) Generates the random byte string in the AWS CloudHSM cluster that is associated with the specified custom key store.
void	setNumberOfBytes(java.lang.Integer numberOfBytes) The length of the byte string.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
GenerateRandomRequest	withCustomKeyStoreId(java.lang.String customKeyStoreId) Generates the random byte string in the AWS CloudHSM cluster that is associated with the specified custom key store.
GenerateRandomRequest	withNumberOfBytes(java.lang.Integer numberOfBytes) The length of the byte string.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GenerateRandomRequest

public GenerateRandomRequest()

Method Detail

getNumberOfBytes

public java.lang.Integer getNumberOfBytes()

The length of the byte string.

Constraints:
Range: 1 - 1024

Returns:

The length of the byte string.

setNumberOfBytes

public void setNumberOfBytes(java.lang.Integer numberOfBytes)

The length of the byte string.

Constraints:
Range: 1 - 1024

Parameters:

numberOfBytes -

The length of the byte string.

withNumberOfBytes

public GenerateRandomRequest withNumberOfBytes(java.lang.Integer numberOfBytes)

The length of the byte string.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Range: 1 - 1024

Parameters:

numberOfBytes -

The length of the byte string.

Returns:

A reference to this updated object so that method calls can be chained together.

getCustomKeyStoreId

public java.lang.String getCustomKeyStoreId()

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

Constraints:
Length: 1 - 64

Returns:

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

setCustomKeyStoreId

public void setCustomKeyStoreId(java.lang.String customKeyStoreId)

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

Constraints:
Length: 1 - 64

Parameters:

customKeyStoreId -

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

withCustomKeyStoreId

public GenerateRandomRequest withCustomKeyStoreId(java.lang.String customKeyStoreId)

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

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 64

Parameters:

customKeyStoreId -

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

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object