KmsKeyConfiguration (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.accessanalyzer.model.KmsKeyConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class KmsKeyConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Proposed access control configuration for a KMS key. You can propose a configuration for a new KMS key or an existing KMS key that you own by specifying the key policy and KMS grant configuration. If the configuration is for an existing key and you do not specify the key policy, the access preview uses the existing policy for the key. If the access preview is for a new resource and you do not specify the key policy, then the access preview uses the default key policy. The proposed key policy cannot be an empty string. For more information, see Default key policy. For more information about key policy limits, see Resource quotas.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

KmsKeyConfiguration()

Constructors
Constructor and Description
`KmsKeyConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`KmsKeyConfiguration`	`addKeyPoliciesEntry(String key, String value)` Add a single KeyPolicies entry
`KmsKeyConfiguration`	`clearKeyPoliciesEntries()` Removes all the entries added into KeyPolicies.
`KmsKeyConfiguration`	`clone()`
`boolean`	`equals(Object obj)`
`List<KmsGrantConfiguration>`	`getGrants()` A list of proposed grant configurations for the KMS key.
`Map<String,String>`	`getKeyPolicies()` Resource policy configuration for the KMS key.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setGrants(Collection<KmsGrantConfiguration> grants)` A list of proposed grant configurations for the KMS key.
`void`	`setKeyPolicies(Map<String,String> keyPolicies)` Resource policy configuration for the KMS key.
`String`	`toString()` Returns a string representation of this object.
`KmsKeyConfiguration`	`withGrants(Collection<KmsGrantConfiguration> grants)` A list of proposed grant configurations for the KMS key.
`KmsKeyConfiguration`	`withGrants(KmsGrantConfiguration... grants)` A list of proposed grant configurations for the KMS key.
`KmsKeyConfiguration`	`withKeyPolicies(Map<String,String> keyPolicies)` Resource policy configuration for the KMS key.

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

- Constructor Detail
  - KmsKeyConfiguration
```
public KmsKeyConfiguration()
```
- Method Detail
  - getGrants
```
public List<KmsGrantConfiguration> getGrants()
```
    A list of proposed grant configurations for the KMS key. If the proposed grant configuration is for an existing key, the access preview uses the proposed list of grant configurations in place of the existing grants. Otherwise, the access preview uses the existing grants for the key.
    
    Returns:
    
    A list of proposed grant configurations for the KMS key. If the proposed grant configuration is for an existing key, the access preview uses the proposed list of grant configurations in place of the existing grants. Otherwise, the access preview uses the existing grants for the key.
  - setGrants
```
public void setGrants(Collection<KmsGrantConfiguration> grants)
```
    A list of proposed grant configurations for the KMS key. If the proposed grant configuration is for an existing key, the access preview uses the proposed list of grant configurations in place of the existing grants. Otherwise, the access preview uses the existing grants for the key.
    
    Parameters:
    
    grants - A list of proposed grant configurations for the KMS key. If the proposed grant configuration is for an existing key, the access preview uses the proposed list of grant configurations in place of the existing grants. Otherwise, the access preview uses the existing grants for the key.
  - withGrants
```
public KmsKeyConfiguration withGrants(KmsGrantConfiguration... grants)
```
    A list of proposed grant configurations for the KMS key. If the proposed grant configuration is for an existing key, the access preview uses the proposed list of grant configurations in place of the existing grants. Otherwise, the access preview uses the existing grants for the key.
    
    NOTE: This method appends the values to the existing list (if any). Use setGrants(java.util.Collection) or withGrants(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    grants - A list of proposed grant configurations for the KMS key. If the proposed grant configuration is for an existing key, the access preview uses the proposed list of grant configurations in place of the existing grants. Otherwise, the access preview uses the existing grants for the key.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withGrants
```
public KmsKeyConfiguration withGrants(Collection<KmsGrantConfiguration> grants)
```
    A list of proposed grant configurations for the KMS key. If the proposed grant configuration is for an existing key, the access preview uses the proposed list of grant configurations in place of the existing grants. Otherwise, the access preview uses the existing grants for the key.
    
    Parameters:
    
    grants - A list of proposed grant configurations for the KMS key. If the proposed grant configuration is for an existing key, the access preview uses the proposed list of grant configurations in place of the existing grants. Otherwise, the access preview uses the existing grants for the key.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getKeyPolicies
```
public Map<String,String> getKeyPolicies()
```
    Resource policy configuration for the KMS key. The only valid value for the name of the key policy is default. For more information, see Default key policy.
    
    Returns:
    
    Resource policy configuration for the KMS key. The only valid value for the name of the key policy is default. For more information, see Default key policy.
  - setKeyPolicies
```
public void setKeyPolicies(Map<String,String> keyPolicies)
```
    Resource policy configuration for the KMS key. The only valid value for the name of the key policy is default. For more information, see Default key policy.
    
    Parameters:
    
    keyPolicies - Resource policy configuration for the KMS key. The only valid value for the name of the key policy is default. For more information, see Default key policy.
  - withKeyPolicies
```
public KmsKeyConfiguration withKeyPolicies(Map<String,String> keyPolicies)
```
    Resource policy configuration for the KMS key. The only valid value for the name of the key policy is default. For more information, see Default key policy.
    
    Parameters:
    
    keyPolicies - Resource policy configuration for the KMS key. The only valid value for the name of the key policy is default. For more information, see Default key policy.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addKeyPoliciesEntry
```
public KmsKeyConfiguration addKeyPoliciesEntry(String key,
                                               String value)
```
    Add a single KeyPolicies entry
    
    See Also:
    
    withKeyPolicies(java.util.Map<java.lang.String, java.lang.String>)
  - clearKeyPoliciesEntries
```
public KmsKeyConfiguration clearKeyPoliciesEntries()
```
    Removes all the entries added into KeyPolicies.
    
    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 KmsKeyConfiguration 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 KmsKeyConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

KmsKeyConfiguration

Method Detail

getGrants

setGrants

withGrants

withGrants

getKeyPolicies

setKeyPolicies

withKeyPolicies

addKeyPoliciesEntry

clearKeyPoliciesEntries

toString

equals

hashCode

clone

marshall