KeyAttributes (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.paymentcryptography.model.KeyAttributes

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class KeyAttributes
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

KeyAttributes()

Constructors
Constructor and Description
`KeyAttributes()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`KeyAttributes`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getKeyAlgorithm()` The key algorithm to be use during creation of an Amazon Web Services Payment Cryptography key.
`String`	`getKeyClass()` The type of Amazon Web Services Payment Cryptography key to create, which determines the classiﬁcation of the cryptographic method and whether Amazon Web Services Payment Cryptography key contains a symmetric key or an asymmetric key pair.
`KeyModesOfUse`	`getKeyModesOfUse()` The list of cryptographic operations that you can perform using the key.
`String`	`getKeyUsage()` The cryptographic usage of an Amazon Web Services Payment Cryptography key as deﬁned in section A.5.2 of the TR-31 spec.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setKeyAlgorithm(String keyAlgorithm)` The key algorithm to be use during creation of an Amazon Web Services Payment Cryptography key.
`void`	`setKeyClass(String keyClass)` The type of Amazon Web Services Payment Cryptography key to create, which determines the classiﬁcation of the cryptographic method and whether Amazon Web Services Payment Cryptography key contains a symmetric key or an asymmetric key pair.
`void`	`setKeyModesOfUse(KeyModesOfUse keyModesOfUse)` The list of cryptographic operations that you can perform using the key.
`void`	`setKeyUsage(String keyUsage)` The cryptographic usage of an Amazon Web Services Payment Cryptography key as deﬁned in section A.5.2 of the TR-31 spec.
`String`	`toString()` Returns a string representation of this object.
`KeyAttributes`	`withKeyAlgorithm(KeyAlgorithm keyAlgorithm)` The key algorithm to be use during creation of an Amazon Web Services Payment Cryptography key.
`KeyAttributes`	`withKeyAlgorithm(String keyAlgorithm)` The key algorithm to be use during creation of an Amazon Web Services Payment Cryptography key.
`KeyAttributes`	`withKeyClass(KeyClass keyClass)` The type of Amazon Web Services Payment Cryptography key to create, which determines the classiﬁcation of the cryptographic method and whether Amazon Web Services Payment Cryptography key contains a symmetric key or an asymmetric key pair.
`KeyAttributes`	`withKeyClass(String keyClass)` The type of Amazon Web Services Payment Cryptography key to create, which determines the classiﬁcation of the cryptographic method and whether Amazon Web Services Payment Cryptography key contains a symmetric key or an asymmetric key pair.
`KeyAttributes`	`withKeyModesOfUse(KeyModesOfUse keyModesOfUse)` The list of cryptographic operations that you can perform using the key.
`KeyAttributes`	`withKeyUsage(KeyUsage keyUsage)` The cryptographic usage of an Amazon Web Services Payment Cryptography key as deﬁned in section A.5.2 of the TR-31 spec.
`KeyAttributes`	`withKeyUsage(String keyUsage)` The cryptographic usage of an Amazon Web Services Payment Cryptography key as deﬁned in section A.5.2 of the TR-31 spec.

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

- Constructor Detail
  - KeyAttributes
```
public KeyAttributes()
```
- Method Detail
  - setKeyUsage
```
public void setKeyUsage(String keyUsage)
```
    The cryptographic usage of an Amazon Web Services Payment Cryptography key as deﬁned in section A.5.2 of the TR-31 spec.
    
    Parameters:
    
    keyUsage - The cryptographic usage of an Amazon Web Services Payment Cryptography key as deﬁned in section A.5.2 of the TR-31 spec.
    
    See Also:
    
    KeyUsage
  - getKeyUsage
```
public String getKeyUsage()
```
    The cryptographic usage of an Amazon Web Services Payment Cryptography key as deﬁned in section A.5.2 of the TR-31 spec.
    
    Returns:
    
    The cryptographic usage of an Amazon Web Services Payment Cryptography key as deﬁned in section A.5.2 of the TR-31 spec.
    
    See Also:
    
    KeyUsage
  - withKeyUsage
```
public KeyAttributes withKeyUsage(String keyUsage)
```
    The cryptographic usage of an Amazon Web Services Payment Cryptography key as deﬁned in section A.5.2 of the TR-31 spec.
    
    Parameters:
    
    keyUsage - The cryptographic usage of an Amazon Web Services Payment Cryptography key as deﬁned in section A.5.2 of the TR-31 spec.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    KeyUsage
  - withKeyUsage
```
public KeyAttributes withKeyUsage(KeyUsage keyUsage)
```
    The cryptographic usage of an Amazon Web Services Payment Cryptography key as deﬁned in section A.5.2 of the TR-31 spec.
    
    Parameters:
    
    keyUsage - The cryptographic usage of an Amazon Web Services Payment Cryptography key as deﬁned in section A.5.2 of the TR-31 spec.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    KeyUsage
  - setKeyClass
```
public void setKeyClass(String keyClass)
```
    The type of Amazon Web Services Payment Cryptography key to create, which determines the classiﬁcation of the cryptographic method and whether Amazon Web Services Payment Cryptography key contains a symmetric key or an asymmetric key pair.
    
    Parameters:
    
    keyClass - The type of Amazon Web Services Payment Cryptography key to create, which determines the classiﬁcation of the cryptographic method and whether Amazon Web Services Payment Cryptography key contains a symmetric key or an asymmetric key pair.
    
    See Also:
    
    KeyClass
  - getKeyClass
```
public String getKeyClass()
```
    The type of Amazon Web Services Payment Cryptography key to create, which determines the classiﬁcation of the cryptographic method and whether Amazon Web Services Payment Cryptography key contains a symmetric key or an asymmetric key pair.
    
    Returns:
    
    The type of Amazon Web Services Payment Cryptography key to create, which determines the classiﬁcation of the cryptographic method and whether Amazon Web Services Payment Cryptography key contains a symmetric key or an asymmetric key pair.
    
    See Also:
    
    KeyClass
  - withKeyClass
```
public KeyAttributes withKeyClass(String keyClass)
```
    The type of Amazon Web Services Payment Cryptography key to create, which determines the classiﬁcation of the cryptographic method and whether Amazon Web Services Payment Cryptography key contains a symmetric key or an asymmetric key pair.
    
    Parameters:
    
    keyClass - The type of Amazon Web Services Payment Cryptography key to create, which determines the classiﬁcation of the cryptographic method and whether Amazon Web Services Payment Cryptography key contains a symmetric key or an asymmetric key pair.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    KeyClass
  - withKeyClass
```
public KeyAttributes withKeyClass(KeyClass keyClass)
```
    The type of Amazon Web Services Payment Cryptography key to create, which determines the classiﬁcation of the cryptographic method and whether Amazon Web Services Payment Cryptography key contains a symmetric key or an asymmetric key pair.
    
    Parameters:
    
    keyClass - The type of Amazon Web Services Payment Cryptography key to create, which determines the classiﬁcation of the cryptographic method and whether Amazon Web Services Payment Cryptography key contains a symmetric key or an asymmetric key pair.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    KeyClass
  - setKeyAlgorithm
```
public void setKeyAlgorithm(String keyAlgorithm)
```
    The key algorithm to be use during creation of an Amazon Web Services Payment Cryptography key.
    
    For symmetric keys, Amazon Web Services Payment Cryptography supports AES and TDES algorithms. For asymmetric keys, Amazon Web Services Payment Cryptography supports RSA and ECC_NIST algorithms.
    
    Parameters:
    
    keyAlgorithm - The key algorithm to be use during creation of an Amazon Web Services Payment Cryptography key.
    
    For symmetric keys, Amazon Web Services Payment Cryptography supports AES and TDES algorithms. For asymmetric keys, Amazon Web Services Payment Cryptography supports RSA and ECC_NIST algorithms.
    
    See Also:
    
    KeyAlgorithm
  - getKeyAlgorithm
```
public String getKeyAlgorithm()
```
    The key algorithm to be use during creation of an Amazon Web Services Payment Cryptography key.
    
    For symmetric keys, Amazon Web Services Payment Cryptography supports AES and TDES algorithms. For asymmetric keys, Amazon Web Services Payment Cryptography supports RSA and ECC_NIST algorithms.
    
    Returns:
    
    The key algorithm to be use during creation of an Amazon Web Services Payment Cryptography key.
    
    For symmetric keys, Amazon Web Services Payment Cryptography supports AES and TDES algorithms. For asymmetric keys, Amazon Web Services Payment Cryptography supports RSA and ECC_NIST algorithms.
    
    See Also:
    
    KeyAlgorithm
  - withKeyAlgorithm
```
public KeyAttributes withKeyAlgorithm(String keyAlgorithm)
```
    The key algorithm to be use during creation of an Amazon Web Services Payment Cryptography key.
    
    For symmetric keys, Amazon Web Services Payment Cryptography supports AES and TDES algorithms. For asymmetric keys, Amazon Web Services Payment Cryptography supports RSA and ECC_NIST algorithms.
    
    Parameters:
    
    keyAlgorithm - The key algorithm to be use during creation of an Amazon Web Services Payment Cryptography key.
    
    For symmetric keys, Amazon Web Services Payment Cryptography supports AES and TDES algorithms. For asymmetric keys, Amazon Web Services Payment Cryptography supports RSA and ECC_NIST algorithms.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    KeyAlgorithm
  - withKeyAlgorithm
```
public KeyAttributes withKeyAlgorithm(KeyAlgorithm keyAlgorithm)
```
    The key algorithm to be use during creation of an Amazon Web Services Payment Cryptography key.
    
    For symmetric keys, Amazon Web Services Payment Cryptography supports AES and TDES algorithms. For asymmetric keys, Amazon Web Services Payment Cryptography supports RSA and ECC_NIST algorithms.
    
    Parameters:
    
    keyAlgorithm - The key algorithm to be use during creation of an Amazon Web Services Payment Cryptography key.
    
    For symmetric keys, Amazon Web Services Payment Cryptography supports AES and TDES algorithms. For asymmetric keys, Amazon Web Services Payment Cryptography supports RSA and ECC_NIST algorithms.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    KeyAlgorithm
  - setKeyModesOfUse
```
public void setKeyModesOfUse(KeyModesOfUse keyModesOfUse)
```
    The list of cryptographic operations that you can perform using the key.
    
    Parameters:
    
    keyModesOfUse - The list of cryptographic operations that you can perform using the key.
  - getKeyModesOfUse
```
public KeyModesOfUse getKeyModesOfUse()
```
    The list of cryptographic operations that you can perform using the key.
    
    Returns:
    
    The list of cryptographic operations that you can perform using the key.
  - withKeyModesOfUse
```
public KeyAttributes withKeyModesOfUse(KeyModesOfUse keyModesOfUse)
```
    The list of cryptographic operations that you can perform using the key.
    
    Parameters:
    
    keyModesOfUse - The list of cryptographic operations that you can perform using 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 KeyAttributes clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.792

Class KeyAttributes

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

KeyAttributes

Method Detail

setKeyUsage

getKeyUsage

withKeyUsage

withKeyUsage

setKeyClass

getKeyClass

withKeyClass

withKeyClass

setKeyAlgorithm

getKeyAlgorithm

withKeyAlgorithm

withKeyAlgorithm

setKeyModesOfUse

getKeyModesOfUse

withKeyModesOfUse

toString

equals

hashCode

clone

marshall