CreateKeyRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.paymentcryptography.model.CreateKeyRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateKeyRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

CreateKeyRequest()

Constructors
Constructor and Description
`CreateKeyRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateKeyRequest`	`clone()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals(Object obj)`
`Boolean`	`getEnabled()` Specifies whether to enable the key.
`Boolean`	`getExportable()` Specifies whether the key is exportable from the service.
`KeyAttributes`	`getKeyAttributes()` The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key.
`String`	`getKeyCheckValueAlgorithm()` The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV) for DES and AES keys.
`List<Tag>`	`getTags()` The tags to attach to the key.
`int`	`hashCode()`
`Boolean`	`isEnabled()` Specifies whether to enable the key.
`Boolean`	`isExportable()` Specifies whether the key is exportable from the service.
`void`	`setEnabled(Boolean enabled)` Specifies whether to enable the key.
`void`	`setExportable(Boolean exportable)` Specifies whether the key is exportable from the service.
`void`	`setKeyAttributes(KeyAttributes keyAttributes)` The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key.
`void`	`setKeyCheckValueAlgorithm(String keyCheckValueAlgorithm)` The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV) for DES and AES keys.
`void`	`setTags(Collection<Tag> tags)` The tags to attach to the key.
`String`	`toString()` Returns a string representation of this object.
`CreateKeyRequest`	`withEnabled(Boolean enabled)` Specifies whether to enable the key.
`CreateKeyRequest`	`withExportable(Boolean exportable)` Specifies whether the key is exportable from the service.
`CreateKeyRequest`	`withKeyAttributes(KeyAttributes keyAttributes)` The role of the key, the algorithm it supports, and the cryptographic operations allowed with the key.
`CreateKeyRequest`	`withKeyCheckValueAlgorithm(KeyCheckValueAlgorithm keyCheckValueAlgorithm)` The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV) for DES and AES keys.
`CreateKeyRequest`	`withKeyCheckValueAlgorithm(String keyCheckValueAlgorithm)` The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV) for DES and AES keys.
`CreateKeyRequest`	`withTags(Collection<Tag> tags)` The tags to attach to the key.
`CreateKeyRequest`	`withTags(Tag... tags)` The tags to attach to the key.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CreateKeyRequest
```
public CreateKeyRequest()
```
- Method Detail
  - setEnabled
```
public void setEnabled(Boolean enabled)
```
    Specifies whether to enable the key. If the key is enabled, it is activated for use within the service. If the key not enabled, then it is created but not activated. The default value is enabled.
    
    Parameters:
    
    enabled - Specifies whether to enable the key. If the key is enabled, it is activated for use within the service. If the key not enabled, then it is created but not activated. The default value is enabled.
  - getEnabled
```
public Boolean getEnabled()
```
    Specifies whether to enable the key. If the key is enabled, it is activated for use within the service. If the key not enabled, then it is created but not activated. The default value is enabled.
    
    Returns:
    
    Specifies whether to enable the key. If the key is enabled, it is activated for use within the service. If the key not enabled, then it is created but not activated. The default value is enabled.
  - withEnabled
```
public CreateKeyRequest withEnabled(Boolean enabled)
```
    Specifies whether to enable the key. If the key is enabled, it is activated for use within the service. If the key not enabled, then it is created but not activated. The default value is enabled.
    
    Parameters:
    
    enabled - Specifies whether to enable the key. If the key is enabled, it is activated for use within the service. If the key not enabled, then it is created but not activated. The default value is enabled.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isEnabled
```
public Boolean isEnabled()
```
    Specifies whether to enable the key. If the key is enabled, it is activated for use within the service. If the key not enabled, then it is created but not activated. The default value is enabled.
    
    Returns:
    
    Specifies whether to enable the key. If the key is enabled, it is activated for use within the service. If the key not enabled, then it is created but not activated. The default value is enabled.
  - setExportable
```
public void setExportable(Boolean exportable)
```
    Specifies whether the key is exportable from the service.
    
    Parameters:
    
    exportable - Specifies whether the key is exportable from the service.
  - getExportable
```
public Boolean getExportable()
```
    Specifies whether the key is exportable from the service.
    
    Returns:
    
    Specifies whether the key is exportable from the service.
  - withExportable
```
public CreateKeyRequest withExportable(Boolean exportable)
```
    Specifies whether the key is exportable from the service.
    
    Parameters:
    
    exportable - Specifies whether the key is exportable from the service.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isExportable
```
public Boolean isExportable()
```
    Specifies whether the key is exportable from the service.
    
    Returns:
    
    Specifies whether the key is exportable from the service.
  - setKeyAttributes
```
public void setKeyAttributes(KeyAttributes 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.
    
    Parameters:
    
    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.
  - getKeyAttributes
```
public KeyAttributes getKeyAttributes()
```
    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.
    
    Returns:
    
    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.
  - withKeyAttributes
```
public CreateKeyRequest withKeyAttributes(KeyAttributes 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setKeyCheckValueAlgorithm
```
public void setKeyCheckValueAlgorithm(String keyCheckValueAlgorithm)
```
    The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV) for DES and AES keys.
    
    For DES key, the KCV is computed by encrypting 8 bytes, each with value '00', with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES key, the KCV is computed by encrypting 8 bytes, each with value '01', with the key to be checked and retaining the 3 highest order bytes of the encrypted result.
    
    Parameters:
    
    keyCheckValueAlgorithm - The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV) for DES and AES keys.
    
    For DES key, the KCV is computed by encrypting 8 bytes, each with value '00', with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES key, the KCV is computed by encrypting 8 bytes, each with value '01', with the key to be checked and retaining the 3 highest order bytes of the encrypted result.
    
    See Also:
    
    KeyCheckValueAlgorithm
  - getKeyCheckValueAlgorithm
```
public String getKeyCheckValueAlgorithm()
```
    The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV) for DES and AES keys.
    
    For DES key, the KCV is computed by encrypting 8 bytes, each with value '00', with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES key, the KCV is computed by encrypting 8 bytes, each with value '01', with the key to be checked and retaining the 3 highest order bytes of the encrypted result.
    
    Returns:
    
    The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV) for DES and AES keys.
    
    For DES key, the KCV is computed by encrypting 8 bytes, each with value '00', with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES key, the KCV is computed by encrypting 8 bytes, each with value '01', with the key to be checked and retaining the 3 highest order bytes of the encrypted result.
    
    See Also:
    
    KeyCheckValueAlgorithm
  - withKeyCheckValueAlgorithm
```
public CreateKeyRequest withKeyCheckValueAlgorithm(String keyCheckValueAlgorithm)
```
    The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV) for DES and AES keys.
    
    For DES key, the KCV is computed by encrypting 8 bytes, each with value '00', with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES key, the KCV is computed by encrypting 8 bytes, each with value '01', with the key to be checked and retaining the 3 highest order bytes of the encrypted result.
    
    Parameters:
    
    keyCheckValueAlgorithm - The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV) for DES and AES keys.
    
    For DES key, the KCV is computed by encrypting 8 bytes, each with value '00', with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES key, the KCV is computed by encrypting 8 bytes, each with value '01', with the key to be checked and retaining the 3 highest order bytes of the encrypted result.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    KeyCheckValueAlgorithm
  - withKeyCheckValueAlgorithm
```
public CreateKeyRequest withKeyCheckValueAlgorithm(KeyCheckValueAlgorithm keyCheckValueAlgorithm)
```
    The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV) for DES and AES keys.
    
    For DES key, the KCV is computed by encrypting 8 bytes, each with value '00', with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES key, the KCV is computed by encrypting 8 bytes, each with value '01', with the key to be checked and retaining the 3 highest order bytes of the encrypted result.
    
    Parameters:
    
    keyCheckValueAlgorithm - The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV) for DES and AES keys.
    
    For DES key, the KCV is computed by encrypting 8 bytes, each with value '00', with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES key, the KCV is computed by encrypting 8 bytes, each with value '01', with the key to be checked and retaining the 3 highest order bytes of the encrypted result.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    KeyCheckValueAlgorithm
  - getTags
```
public List<Tag> getTags()
```
    The tags to attach to the key. 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.
    
    To use this parameter, you must have TagResource permission.
    
    Don't include 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.
    
    Returns:
    
    The tags to attach to the key. 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.
    
    To use this parameter, you must have TagResource permission.
    
    Don't include 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.
  - setTags
```
public void setTags(Collection<Tag> tags)
```
    The tags to attach to the key. 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.
    
    To use this parameter, you must have TagResource permission.
    
    Don't include 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.
    
    Parameters:
    
    tags - The tags to attach to the key. 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.
    
    To use this parameter, you must have TagResource permission.
    
    Don't include 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.
  - withTags
```
public CreateKeyRequest withTags(Tag... tags)
```
    The tags to attach to the key. 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.
    
    To use this parameter, you must have TagResource permission.
    
    Don't include 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.
    
    NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    tags - The tags to attach to the key. 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.
    
    To use this parameter, you must have TagResource permission.
    
    Don't include 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTags
```
public CreateKeyRequest withTags(Collection<Tag> tags)
```
    The tags to attach to the key. 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.
    
    To use this parameter, you must have TagResource permission.
    
    Don't include 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.
    
    Parameters:
    
    tags - The tags to attach to the key. 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.
    
    To use this parameter, you must have TagResource permission.
    
    Don't include 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public CreateKeyRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

AWS SDK for Java 1.x API Reference - 1.12.559

Class CreateKeyRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateKeyRequest

Method Detail

setEnabled

getEnabled

withEnabled

isEnabled

setExportable

getExportable

withExportable

isExportable

setKeyAttributes

getKeyAttributes

withKeyAttributes

setKeyCheckValueAlgorithm

getKeyCheckValueAlgorithm

withKeyCheckValueAlgorithm

withKeyCheckValueAlgorithm

getTags

setTags

withTags

withTags

toString

equals

hashCode

clone