AwsKmsKeyDetails (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.securityhub.model.AwsKmsKeyDetails

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AwsKmsKeyDetails
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Contains metadata about a customer master key (CMK).

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

AwsKmsKeyDetails()

Constructors
Constructor and Description
`AwsKmsKeyDetails()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AwsKmsKeyDetails`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAWSAccountId()` The twelve-digit account ID of the AWS account that owns the CMK.
`Double`	`getCreationDate()` Indicates when the CMK was created.
`String`	`getDescription()` A description of the key.
`String`	`getKeyId()` The globally unique identifier for the CMK.
`String`	`getKeyManager()` The manager of the CMK.
`String`	`getKeyState()` The state of the CMK.
`String`	`getOrigin()` The source of the CMK's key material.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAWSAccountId(String aWSAccountId)` The twelve-digit account ID of the AWS account that owns the CMK.
`void`	`setCreationDate(Double creationDate)` Indicates when the CMK was created.
`void`	`setDescription(String description)` A description of the key.
`void`	`setKeyId(String keyId)` The globally unique identifier for the CMK.
`void`	`setKeyManager(String keyManager)` The manager of the CMK.
`void`	`setKeyState(String keyState)` The state of the CMK.
`void`	`setOrigin(String origin)` The source of the CMK's key material.
`String`	`toString()` Returns a string representation of this object.
`AwsKmsKeyDetails`	`withAWSAccountId(String aWSAccountId)` The twelve-digit account ID of the AWS account that owns the CMK.
`AwsKmsKeyDetails`	`withCreationDate(Double creationDate)` Indicates when the CMK was created.
`AwsKmsKeyDetails`	`withDescription(String description)` A description of the key.
`AwsKmsKeyDetails`	`withKeyId(String keyId)` The globally unique identifier for the CMK.
`AwsKmsKeyDetails`	`withKeyManager(String keyManager)` The manager of the CMK.
`AwsKmsKeyDetails`	`withKeyState(String keyState)` The state of the CMK.
`AwsKmsKeyDetails`	`withOrigin(String origin)` The source of the CMK's key material.

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

- Constructor Detail
  - AwsKmsKeyDetails
```
public AwsKmsKeyDetails()
```
- Method Detail
  - setAWSAccountId
```
public void setAWSAccountId(String aWSAccountId)
```
    The twelve-digit account ID of the AWS account that owns the CMK.
    
    Parameters:
    
    aWSAccountId - The twelve-digit account ID of the AWS account that owns the CMK.
  - getAWSAccountId
```
public String getAWSAccountId()
```
    The twelve-digit account ID of the AWS account that owns the CMK.
    
    Returns:
    
    The twelve-digit account ID of the AWS account that owns the CMK.
  - withAWSAccountId
```
public AwsKmsKeyDetails withAWSAccountId(String aWSAccountId)
```
    The twelve-digit account ID of the AWS account that owns the CMK.
    
    Parameters:
    
    aWSAccountId - The twelve-digit account ID of the AWS account that owns the CMK.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationDate
```
public void setCreationDate(Double creationDate)
```
    Indicates when the CMK was created.
    
    Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.
    
    Parameters:
    
    creationDate - Indicates when the CMK was created.
    
    Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.
  - getCreationDate
```
public Double getCreationDate()
```
    Indicates when the CMK was created.
    
    Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.
    
    Returns:
    
    Indicates when the CMK was created.
    
    Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.
  - withCreationDate
```
public AwsKmsKeyDetails withCreationDate(Double creationDate)
```
    Indicates when the CMK was created.
    
    Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.
    
    Parameters:
    
    creationDate - Indicates when the CMK was created.
    
    Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setKeyId
```
public void setKeyId(String keyId)
```
    The globally unique identifier for the CMK.
    
    Parameters:
    
    keyId - The globally unique identifier for the CMK.
  - getKeyId
```
public String getKeyId()
```
    The globally unique identifier for the CMK.
    
    Returns:
    
    The globally unique identifier for the CMK.
  - withKeyId
```
public AwsKmsKeyDetails withKeyId(String keyId)
```
    The globally unique identifier for the CMK.
    
    Parameters:
    
    keyId - The globally unique identifier for the CMK.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setKeyManager
```
public void setKeyManager(String keyManager)
```
    The manager of the CMK. CMKs in your AWS account are either customer managed or AWS managed.
    
    Parameters:
    
    keyManager - The manager of the CMK. CMKs in your AWS account are either customer managed or AWS managed.
  - getKeyManager
```
public String getKeyManager()
```
    The manager of the CMK. CMKs in your AWS account are either customer managed or AWS managed.
    
    Returns:
    
    The manager of the CMK. CMKs in your AWS account are either customer managed or AWS managed.
  - withKeyManager
```
public AwsKmsKeyDetails withKeyManager(String keyManager)
```
    The manager of the CMK. CMKs in your AWS account are either customer managed or AWS managed.
    
    Parameters:
    
    keyManager - The manager of the CMK. CMKs in your AWS account are either customer managed or AWS managed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setKeyState
```
public void setKeyState(String keyState)
```
    The state of the CMK.
    
    Parameters:
    
    keyState - The state of the CMK.
  - getKeyState
```
public String getKeyState()
```
    The state of the CMK.
    
    Returns:
    
    The state of the CMK.
  - withKeyState
```
public AwsKmsKeyDetails withKeyState(String keyState)
```
    The state of the CMK.
    
    Parameters:
    
    keyState - The state of the CMK.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOrigin
```
public void setOrigin(String origin)
```
    The source of the CMK's key material.
    
    When this value is AWS_KMS, AWS KMS created the key material.
    
    When this value is EXTERNAL, the key material was imported from your existing key management infrastructure or the CMK lacks key material.
    
    When this value is AWS_CLOUDHSM, the key material was created in the AWS CloudHSM cluster associated with a custom key store.
    
    Parameters:
    
    origin - The source of the CMK's key material.
    
    When this value is AWS_KMS, AWS KMS created the key material.
    
    When this value is EXTERNAL, the key material was imported from your existing key management infrastructure or the CMK lacks key material.
    
    When this value is AWS_CLOUDHSM, the key material was created in the AWS CloudHSM cluster associated with a custom key store.
  - getOrigin
```
public String getOrigin()
```
    The source of the CMK's key material.
    
    When this value is AWS_KMS, AWS KMS created the key material.
    
    When this value is EXTERNAL, the key material was imported from your existing key management infrastructure or the CMK lacks key material.
    
    When this value is AWS_CLOUDHSM, the key material was created in the AWS CloudHSM cluster associated with a custom key store.
    
    Returns:
    
    The source of the CMK's key material.
    
    When this value is AWS_KMS, AWS KMS created the key material.
    
    When this value is EXTERNAL, the key material was imported from your existing key management infrastructure or the CMK lacks key material.
    
    When this value is AWS_CLOUDHSM, the key material was created in the AWS CloudHSM cluster associated with a custom key store.
  - withOrigin
```
public AwsKmsKeyDetails withOrigin(String origin)
```
    The source of the CMK's key material.
    
    When this value is AWS_KMS, AWS KMS created the key material.
    
    When this value is EXTERNAL, the key material was imported from your existing key management infrastructure or the CMK lacks key material.
    
    When this value is AWS_CLOUDHSM, the key material was created in the AWS CloudHSM cluster associated with a custom key store.
    
    Parameters:
    
    origin - The source of the CMK's key material.
    
    When this value is AWS_KMS, AWS KMS created the key material.
    
    When this value is EXTERNAL, the key material was imported from your existing key management infrastructure or the CMK lacks key material.
    
    When this value is AWS_CLOUDHSM, the key material was created in the AWS CloudHSM cluster associated with a custom key store.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    A description of the key.
    
    Parameters:
    
    description - A description of the key.
  - getDescription
```
public String getDescription()
```
    A description of the key.
    
    Returns:
    
    A description of the key.
  - withDescription
```
public AwsKmsKeyDetails withDescription(String description)
```
    A description of the key.
    
    Parameters:
    
    description - A description of 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 AwsKmsKeyDetails 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.

Did this page help you?

Class AwsKmsKeyDetails

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AwsKmsKeyDetails

Method Detail

setAWSAccountId

getAWSAccountId

withAWSAccountId

setCreationDate

getCreationDate

withCreationDate

setKeyId

getKeyId

withKeyId

setKeyManager

getKeyManager

withKeyManager

setKeyState

getKeyState

withKeyState

setOrigin

getOrigin

withOrigin

setDescription

getDescription

withDescription

toString

equals

hashCode

clone

marshall