ReplicateKeyRequest (AWS Java SDK for AWS KMS 1.12.114 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.kms.model.ReplicateKeyRequest

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

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ReplicateKeyRequest
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

ReplicateKeyRequest()

Constructors
Constructor and Description
`ReplicateKeyRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ReplicateKeyRequest`	`clone()`
`boolean`	`equals(Object obj)`
`Boolean`	`getBypassPolicyLockoutSafetyCheck()` A flag to indicate whether to bypass the key policy lockout safety check.
`String`	`getDescription()` A description of the KMS key.
`String`	`getKeyId()` Identifies the multi-Region primary key that is being replicated.
`String`	`getPolicy()` The key policy to attach to the KMS key.
`String`	`getReplicaRegion()` The Region ID of the Amazon Web Services Region for this replica key.
`List<Tag>`	`getTags()` Assigns one or more tags to the replica key.
`int`	`hashCode()`
`Boolean`	`isBypassPolicyLockoutSafetyCheck()` A flag to indicate whether to bypass the key policy lockout safety check.
`void`	`setBypassPolicyLockoutSafetyCheck(Boolean bypassPolicyLockoutSafetyCheck)` A flag to indicate whether to bypass the key policy lockout safety check.
`void`	`setDescription(String description)` A description of the KMS key.
`void`	`setKeyId(String keyId)` Identifies the multi-Region primary key that is being replicated.
`void`	`setPolicy(String policy)` The key policy to attach to the KMS key.
`void`	`setReplicaRegion(String replicaRegion)` The Region ID of the Amazon Web Services Region for this replica key.
`void`	`setTags(Collection<Tag> tags)` Assigns one or more tags to the replica key.
`String`	`toString()` Returns a string representation of this object.
`ReplicateKeyRequest`	`withBypassPolicyLockoutSafetyCheck(Boolean bypassPolicyLockoutSafetyCheck)` A flag to indicate whether to bypass the key policy lockout safety check.
`ReplicateKeyRequest`	`withDescription(String description)` A description of the KMS key.
`ReplicateKeyRequest`	`withKeyId(String keyId)` Identifies the multi-Region primary key that is being replicated.
`ReplicateKeyRequest`	`withPolicy(String policy)` The key policy to attach to the KMS key.
`ReplicateKeyRequest`	`withReplicaRegion(String replicaRegion)` The Region ID of the Amazon Web Services Region for this replica key.
`ReplicateKeyRequest`	`withTags(Collection<Tag> tags)` Assigns one or more tags to the replica key.
`ReplicateKeyRequest`	`withTags(Tag... tags)` Assigns one or more tags to the replica key.

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

- Constructor Detail
  - ReplicateKeyRequest
```
public ReplicateKeyRequest()
```
- Method Detail
  - setKeyId
```
public void setKeyId(String keyId)
```
    Identifies the multi-Region primary key that is being replicated. To determine whether a KMS key is a multi-Region primary key, use the DescribeKey operation to check the value of the MultiRegionKeyType property.
    
    Specify the key ID or key ARN of a multi-Region primary key.
    
    For example:
    - Key ID: mrk-1234abcd12ab34cd56ef1234567890ab
    - Key ARN: arn:aws:kms:us-east-2:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab
    To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
    Parameters:
    keyId - Identifies the multi-Region primary key that is being replicated. To determine whether a KMS key is a multi-Region primary key, use the DescribeKey operation to check the value of the MultiRegionKeyType property.
    
    Specify the key ID or key ARN of a multi-Region primary key.
    
    For example:
    
    Key ID: mrk-1234abcd12ab34cd56ef1234567890ab
    
    Key ARN: arn:aws:kms:us-east-2:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab
    
    To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
  - getKeyId
```
public String getKeyId()
```
    Identifies the multi-Region primary key that is being replicated. To determine whether a KMS key is a multi-Region primary key, use the DescribeKey operation to check the value of the MultiRegionKeyType property.
    
    Specify the key ID or key ARN of a multi-Region primary key.
    
    For example:
    - Key ID: mrk-1234abcd12ab34cd56ef1234567890ab
    - Key ARN: arn:aws:kms:us-east-2:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab
    To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
    Returns:
    Identifies the multi-Region primary key that is being replicated. To determine whether a KMS key is a multi-Region primary key, use the DescribeKey operation to check the value of the MultiRegionKeyType property.
    
    Specify the key ID or key ARN of a multi-Region primary key.
    
    For example:
    
    Key ID: mrk-1234abcd12ab34cd56ef1234567890ab
    
    Key ARN: arn:aws:kms:us-east-2:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab
    
    To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
  - withKeyId
```
public ReplicateKeyRequest withKeyId(String keyId)
```
    Identifies the multi-Region primary key that is being replicated. To determine whether a KMS key is a multi-Region primary key, use the DescribeKey operation to check the value of the MultiRegionKeyType property.
    
    Specify the key ID or key ARN of a multi-Region primary key.
    
    For example:
    - Key ID: mrk-1234abcd12ab34cd56ef1234567890ab
    - Key ARN: arn:aws:kms:us-east-2:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab
    To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
    Parameters:
    keyId - Identifies the multi-Region primary key that is being replicated. To determine whether a KMS key is a multi-Region primary key, use the DescribeKey operation to check the value of the MultiRegionKeyType property.
    
    Specify the key ID or key ARN of a multi-Region primary key.
    
    For example:
    
    Key ID: mrk-1234abcd12ab34cd56ef1234567890ab
    
    Key ARN: arn:aws:kms:us-east-2:111122223333:key/mrk-1234abcd12ab34cd56ef1234567890ab
    
    To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setReplicaRegion
```
public void setReplicaRegion(String replicaRegion)
```
    The Region ID of the Amazon Web Services Region for this replica key.
    
    Enter the Region ID, such as us-east-1 or ap-southeast-2. For a list of Amazon Web Services Regions in which KMS is supported, see KMS service endpoints in the Amazon Web Services General Reference.
    
    The replica must be in a different Amazon Web Services Region than its primary key and other replicas of that primary key, but in the same Amazon Web Services partition. KMS must be available in the replica Region. If the Region is not enabled by default, the Amazon Web Services account must be enabled in the Region.
    
    For information about Amazon Web Services partitions, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference. For information about enabling and disabling Regions, see Enabling a Region and Disabling a Region in the Amazon Web Services General Reference.
    
    Parameters:
    
    replicaRegion - The Region ID of the Amazon Web Services Region for this replica key.
    
    Enter the Region ID, such as us-east-1 or ap-southeast-2. For a list of Amazon Web Services Regions in which KMS is supported, see KMS service endpoints in the Amazon Web Services General Reference.
    
    The replica must be in a different Amazon Web Services Region than its primary key and other replicas of that primary key, but in the same Amazon Web Services partition. KMS must be available in the replica Region. If the Region is not enabled by default, the Amazon Web Services account must be enabled in the Region.
    
    For information about Amazon Web Services partitions, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference. For information about enabling and disabling Regions, see Enabling a Region and Disabling a Region in the Amazon Web Services General Reference.
  - getReplicaRegion
```
public String getReplicaRegion()
```
    The Region ID of the Amazon Web Services Region for this replica key.
    
    Enter the Region ID, such as us-east-1 or ap-southeast-2. For a list of Amazon Web Services Regions in which KMS is supported, see KMS service endpoints in the Amazon Web Services General Reference.
    
    The replica must be in a different Amazon Web Services Region than its primary key and other replicas of that primary key, but in the same Amazon Web Services partition. KMS must be available in the replica Region. If the Region is not enabled by default, the Amazon Web Services account must be enabled in the Region.
    
    For information about Amazon Web Services partitions, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference. For information about enabling and disabling Regions, see Enabling a Region and Disabling a Region in the Amazon Web Services General Reference.
    
    Returns:
    
    The Region ID of the Amazon Web Services Region for this replica key.
    
    Enter the Region ID, such as us-east-1 or ap-southeast-2. For a list of Amazon Web Services Regions in which KMS is supported, see KMS service endpoints in the Amazon Web Services General Reference.
    
    The replica must be in a different Amazon Web Services Region than its primary key and other replicas of that primary key, but in the same Amazon Web Services partition. KMS must be available in the replica Region. If the Region is not enabled by default, the Amazon Web Services account must be enabled in the Region.
    
    For information about Amazon Web Services partitions, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference. For information about enabling and disabling Regions, see Enabling a Region and Disabling a Region in the Amazon Web Services General Reference.
  - withReplicaRegion
```
public ReplicateKeyRequest withReplicaRegion(String replicaRegion)
```
    The Region ID of the Amazon Web Services Region for this replica key.
    
    Enter the Region ID, such as us-east-1 or ap-southeast-2. For a list of Amazon Web Services Regions in which KMS is supported, see KMS service endpoints in the Amazon Web Services General Reference.
    
    The replica must be in a different Amazon Web Services Region than its primary key and other replicas of that primary key, but in the same Amazon Web Services partition. KMS must be available in the replica Region. If the Region is not enabled by default, the Amazon Web Services account must be enabled in the Region.
    
    For information about Amazon Web Services partitions, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference. For information about enabling and disabling Regions, see Enabling a Region and Disabling a Region in the Amazon Web Services General Reference.
    
    Parameters:
    
    replicaRegion - The Region ID of the Amazon Web Services Region for this replica key.
    
    Enter the Region ID, such as us-east-1 or ap-southeast-2. For a list of Amazon Web Services Regions in which KMS is supported, see KMS service endpoints in the Amazon Web Services General Reference.
    
    The replica must be in a different Amazon Web Services Region than its primary key and other replicas of that primary key, but in the same Amazon Web Services partition. KMS must be available in the replica Region. If the Region is not enabled by default, the Amazon Web Services account must be enabled in the Region.
    
    For information about Amazon Web Services partitions, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference. For information about enabling and disabling Regions, see Enabling a Region and Disabling a Region in the Amazon Web Services General Reference.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPolicy
```
public void setPolicy(String policy)
```
    The key policy to attach to the KMS key. This parameter is optional. If you do not provide a key policy, KMS attaches the default key policy to the KMS key.
    
    The key policy is not a shared property of multi-Region keys. You can specify the same key policy or a different key policy for each key in a set of related multi-Region keys. KMS does not synchronize this property.
    
    If you provide a key policy, it must meet the following criteria:
    - If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must give the caller kms:PutKeyPolicy permission on the replica key. This reduces the risk that the KMS key becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the Key Management Service Developer Guide .
    - Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new Amazon Web Services principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see Changes that I make are not always immediately visible in the Identity and Access Management User Guide .
    - The key policy size quota is 32 kilobytes (32768 bytes).
    Parameters:
    policy - The key policy to attach to the KMS key. This parameter is optional. If you do not provide a key policy, KMS attaches the default key policy to the KMS key.
    
    The key policy is not a shared property of multi-Region keys. You can specify the same key policy or a different key policy for each key in a set of related multi-Region keys. KMS does not synchronize this property.
    
    If you provide a key policy, it must meet the following criteria:
    
    If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must give the caller kms:PutKeyPolicy permission on the replica key. This reduces the risk that the KMS key becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the Key Management Service Developer Guide .
    
    Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new Amazon Web Services principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see Changes that I make are not always immediately visible in the Identity and Access Management User Guide .
    
    The key policy size quota is 32 kilobytes (32768 bytes).
  - getPolicy
```
public String getPolicy()
```
    The key policy to attach to the KMS key. This parameter is optional. If you do not provide a key policy, KMS attaches the default key policy to the KMS key.
    
    The key policy is not a shared property of multi-Region keys. You can specify the same key policy or a different key policy for each key in a set of related multi-Region keys. KMS does not synchronize this property.
    
    If you provide a key policy, it must meet the following criteria:
    - If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must give the caller kms:PutKeyPolicy permission on the replica key. This reduces the risk that the KMS key becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the Key Management Service Developer Guide .
    - Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new Amazon Web Services principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see Changes that I make are not always immediately visible in the Identity and Access Management User Guide .
    - The key policy size quota is 32 kilobytes (32768 bytes).
    Returns:
    The key policy to attach to the KMS key. This parameter is optional. If you do not provide a key policy, KMS attaches the default key policy to the KMS key.
    
    The key policy is not a shared property of multi-Region keys. You can specify the same key policy or a different key policy for each key in a set of related multi-Region keys. KMS does not synchronize this property.
    
    If you provide a key policy, it must meet the following criteria:
    
    If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must give the caller kms:PutKeyPolicy permission on the replica key. This reduces the risk that the KMS key becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the Key Management Service Developer Guide .
    
    Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new Amazon Web Services principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see Changes that I make are not always immediately visible in the Identity and Access Management User Guide .
    
    The key policy size quota is 32 kilobytes (32768 bytes).
  - withPolicy
```
public ReplicateKeyRequest withPolicy(String policy)
```
    The key policy to attach to the KMS key. This parameter is optional. If you do not provide a key policy, KMS attaches the default key policy to the KMS key.
    
    The key policy is not a shared property of multi-Region keys. You can specify the same key policy or a different key policy for each key in a set of related multi-Region keys. KMS does not synchronize this property.
    
    If you provide a key policy, it must meet the following criteria:
    - If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must give the caller kms:PutKeyPolicy permission on the replica key. This reduces the risk that the KMS key becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the Key Management Service Developer Guide .
    - Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new Amazon Web Services principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see Changes that I make are not always immediately visible in the Identity and Access Management User Guide .
    - The key policy size quota is 32 kilobytes (32768 bytes).
    Parameters:
    policy - The key policy to attach to the KMS key. This parameter is optional. If you do not provide a key policy, KMS attaches the default key policy to the KMS key.
    
    The key policy is not a shared property of multi-Region keys. You can specify the same key policy or a different key policy for each key in a set of related multi-Region keys. KMS does not synchronize this property.
    
    If you provide a key policy, it must meet the following criteria:
    
    If you don't set BypassPolicyLockoutSafetyCheck to true, the key policy must give the caller kms:PutKeyPolicy permission on the replica key. This reduces the risk that the KMS key becomes unmanageable. For more information, refer to the scenario in the Default Key Policy section of the Key Management Service Developer Guide .
    
    Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new Amazon Web Services principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see Changes that I make are not always immediately visible in the Identity and Access Management User Guide .
    
    The key policy size quota is 32 kilobytes (32768 bytes).
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBypassPolicyLockoutSafetyCheck
```
public void setBypassPolicyLockoutSafetyCheck(Boolean bypassPolicyLockoutSafetyCheck)
```
    A flag to indicate whether to bypass the key policy lockout safety check.
    
    Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately.
    
    For more information, refer to the scenario in the Default Key Policy section in the Key Management Service Developer Guide.
    
    Use this parameter only when you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the KMS key.
    
    The default value is false.
    
    Parameters:
    
    bypassPolicyLockoutSafetyCheck - A flag to indicate whether to bypass the key policy lockout safety check.
    
    Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately.
    
    For more information, refer to the scenario in the Default Key Policy section in the Key Management Service Developer Guide.
    
    Use this parameter only when you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the KMS key.
    
    The default value is false.
  - getBypassPolicyLockoutSafetyCheck
```
public Boolean getBypassPolicyLockoutSafetyCheck()
```
    A flag to indicate whether to bypass the key policy lockout safety check.
    
    Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately.
    
    For more information, refer to the scenario in the Default Key Policy section in the Key Management Service Developer Guide.
    
    Use this parameter only when you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the KMS key.
    
    The default value is false.
    
    Returns:
    
    A flag to indicate whether to bypass the key policy lockout safety check.
    
    Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately.
    
    For more information, refer to the scenario in the Default Key Policy section in the Key Management Service Developer Guide.
    
    Use this parameter only when you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the KMS key.
    
    The default value is false.
  - withBypassPolicyLockoutSafetyCheck
```
public ReplicateKeyRequest withBypassPolicyLockoutSafetyCheck(Boolean bypassPolicyLockoutSafetyCheck)
```
    A flag to indicate whether to bypass the key policy lockout safety check.
    
    Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately.
    
    For more information, refer to the scenario in the Default Key Policy section in the Key Management Service Developer Guide.
    
    Use this parameter only when you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the KMS key.
    
    The default value is false.
    
    Parameters:
    
    bypassPolicyLockoutSafetyCheck - A flag to indicate whether to bypass the key policy lockout safety check.
    
    Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately.
    
    For more information, refer to the scenario in the Default Key Policy section in the Key Management Service Developer Guide.
    
    Use this parameter only when you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the KMS key.
    
    The default value is false.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isBypassPolicyLockoutSafetyCheck
```
public Boolean isBypassPolicyLockoutSafetyCheck()
```
    A flag to indicate whether to bypass the key policy lockout safety check.
    
    Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately.
    
    For more information, refer to the scenario in the Default Key Policy section in the Key Management Service Developer Guide.
    
    Use this parameter only when you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the KMS key.
    
    The default value is false.
    
    Returns:
    
    A flag to indicate whether to bypass the key policy lockout safety check.
    
    Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately.
    
    For more information, refer to the scenario in the Default Key Policy section in the Key Management Service Developer Guide.
    
    Use this parameter only when you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the KMS key.
    
    The default value is false.
  - setDescription
```
public void setDescription(String description)
```
    A description of the KMS key. The default value is an empty string (no description).
    
    The description is not a shared property of multi-Region keys. You can specify the same description or a different description for each key in a set of related multi-Region keys. KMS does not synchronize this property.
    
    Parameters:
    
    description - A description of the KMS key. The default value is an empty string (no description).
    
    The description is not a shared property of multi-Region keys. You can specify the same description or a different description for each key in a set of related multi-Region keys. KMS does not synchronize this property.
  - getDescription
```
public String getDescription()
```
    A description of the KMS key. The default value is an empty string (no description).
    
    The description is not a shared property of multi-Region keys. You can specify the same description or a different description for each key in a set of related multi-Region keys. KMS does not synchronize this property.
    
    Returns:
    
    A description of the KMS key. The default value is an empty string (no description).
    
    The description is not a shared property of multi-Region keys. You can specify the same description or a different description for each key in a set of related multi-Region keys. KMS does not synchronize this property.
  - withDescription
```
public ReplicateKeyRequest withDescription(String description)
```
    A description of the KMS key. The default value is an empty string (no description).
    
    The description is not a shared property of multi-Region keys. You can specify the same description or a different description for each key in a set of related multi-Region keys. KMS does not synchronize this property.
    
    Parameters:
    
    description - A description of the KMS key. The default value is an empty string (no description).
    
    The description is not a shared property of multi-Region keys. You can specify the same description or a different description for each key in a set of related multi-Region keys. KMS does not synchronize this property.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public List<Tag> getTags()
```
    Assigns one or more tags to the replica key. Use this parameter to tag the KMS key when it is created. To tag an existing KMS key, use the TagResource operation.
    
    Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see Using ABAC in KMS in the Key Management Service Developer Guide.
    
    To use this parameter, you must have kms:TagResource permission in an IAM policy.
    
    Tags are not a shared property of multi-Region keys. You can specify the same tags or different tags for each key in a set of related multi-Region keys. KMS does not synchronize this property.
    
    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 cannot have more than one tag on a KMS key with the same tag key. If you specify an existing tag key with a different tag value, KMS replaces the current tag value with the specified one.
    
    When you add tags to an Amazon Web Services resource, Amazon Web Services generates a cost allocation report with usage and costs aggregated by tags. Tags can also be used to control access to a KMS key. For details, see Tagging Keys.
    
    Returns:
    
    Assigns one or more tags to the replica key. Use this parameter to tag the KMS key when it is created. To tag an existing KMS key, use the TagResource operation.
    
    Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see Using ABAC in KMS in the Key Management Service Developer Guide.
    
    To use this parameter, you must have kms:TagResource permission in an IAM policy.
    
    Tags are not a shared property of multi-Region keys. You can specify the same tags or different tags for each key in a set of related multi-Region keys. KMS does not synchronize this property.
    
    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 cannot have more than one tag on a KMS key with the same tag key. If you specify an existing tag key with a different tag value, KMS replaces the current tag value with the specified one.
    
    When you add tags to an Amazon Web Services resource, Amazon Web Services generates a cost allocation report with usage and costs aggregated by tags. Tags can also be used to control access to a KMS key. For details, see Tagging Keys.
  - setTags
```
public void setTags(Collection<Tag> tags)
```
    Assigns one or more tags to the replica key. Use this parameter to tag the KMS key when it is created. To tag an existing KMS key, use the TagResource operation.
    
    Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see Using ABAC in KMS in the Key Management Service Developer Guide.
    
    To use this parameter, you must have kms:TagResource permission in an IAM policy.
    
    Tags are not a shared property of multi-Region keys. You can specify the same tags or different tags for each key in a set of related multi-Region keys. KMS does not synchronize this property.
    
    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 cannot have more than one tag on a KMS key with the same tag key. If you specify an existing tag key with a different tag value, KMS replaces the current tag value with the specified one.
    
    When you add tags to an Amazon Web Services resource, Amazon Web Services generates a cost allocation report with usage and costs aggregated by tags. Tags can also be used to control access to a KMS key. For details, see Tagging Keys.
    
    Parameters:
    
    tags - Assigns one or more tags to the replica key. Use this parameter to tag the KMS key when it is created. To tag an existing KMS key, use the TagResource operation.
    
    Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see Using ABAC in KMS in the Key Management Service Developer Guide.
    
    To use this parameter, you must have kms:TagResource permission in an IAM policy.
    
    Tags are not a shared property of multi-Region keys. You can specify the same tags or different tags for each key in a set of related multi-Region keys. KMS does not synchronize this property.
    
    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 cannot have more than one tag on a KMS key with the same tag key. If you specify an existing tag key with a different tag value, KMS replaces the current tag value with the specified one.
    
    When you add tags to an Amazon Web Services resource, Amazon Web Services generates a cost allocation report with usage and costs aggregated by tags. Tags can also be used to control access to a KMS key. For details, see Tagging Keys.
  - withTags
```
public ReplicateKeyRequest withTags(Tag... tags)
```
    Assigns one or more tags to the replica key. Use this parameter to tag the KMS key when it is created. To tag an existing KMS key, use the TagResource operation.
    
    Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see Using ABAC in KMS in the Key Management Service Developer Guide.
    
    To use this parameter, you must have kms:TagResource permission in an IAM policy.
    
    Tags are not a shared property of multi-Region keys. You can specify the same tags or different tags for each key in a set of related multi-Region keys. KMS does not synchronize this property.
    
    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 cannot have more than one tag on a KMS key with the same tag key. If you specify an existing tag key with a different tag value, KMS replaces the current tag value with the specified one.
    
    When you add tags to an Amazon Web Services resource, Amazon Web Services generates a cost allocation report with usage and costs aggregated by tags. Tags can also be used to control access to a KMS key. For details, see Tagging Keys.
    
    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 - Assigns one or more tags to the replica key. Use this parameter to tag the KMS key when it is created. To tag an existing KMS key, use the TagResource operation.
    
    Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see Using ABAC in KMS in the Key Management Service Developer Guide.
    
    To use this parameter, you must have kms:TagResource permission in an IAM policy.
    
    Tags are not a shared property of multi-Region keys. You can specify the same tags or different tags for each key in a set of related multi-Region keys. KMS does not synchronize this property.
    
    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 cannot have more than one tag on a KMS key with the same tag key. If you specify an existing tag key with a different tag value, KMS replaces the current tag value with the specified one.
    
    When you add tags to an Amazon Web Services resource, Amazon Web Services generates a cost allocation report with usage and costs aggregated by tags. Tags can also be used to control access to a KMS key. For details, see Tagging Keys.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTags
```
public ReplicateKeyRequest withTags(Collection<Tag> tags)
```
    Assigns one or more tags to the replica key. Use this parameter to tag the KMS key when it is created. To tag an existing KMS key, use the TagResource operation.
    
    Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see Using ABAC in KMS in the Key Management Service Developer Guide.
    
    To use this parameter, you must have kms:TagResource permission in an IAM policy.
    
    Tags are not a shared property of multi-Region keys. You can specify the same tags or different tags for each key in a set of related multi-Region keys. KMS does not synchronize this property.
    
    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 cannot have more than one tag on a KMS key with the same tag key. If you specify an existing tag key with a different tag value, KMS replaces the current tag value with the specified one.
    
    When you add tags to an Amazon Web Services resource, Amazon Web Services generates a cost allocation report with usage and costs aggregated by tags. Tags can also be used to control access to a KMS key. For details, see Tagging Keys.
    
    Parameters:
    
    tags - Assigns one or more tags to the replica key. Use this parameter to tag the KMS key when it is created. To tag an existing KMS key, use the TagResource operation.
    
    Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see Using ABAC in KMS in the Key Management Service Developer Guide.
    
    To use this parameter, you must have kms:TagResource permission in an IAM policy.
    
    Tags are not a shared property of multi-Region keys. You can specify the same tags or different tags for each key in a set of related multi-Region keys. KMS does not synchronize this property.
    
    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 cannot have more than one tag on a KMS key with the same tag key. If you specify an existing tag key with a different tag value, KMS replaces the current tag value with the specified one.
    
    When you add tags to an Amazon Web Services resource, Amazon Web Services generates a cost allocation report with usage and costs aggregated by tags. Tags can also be used to control access to a KMS key. For details, see Tagging Keys.
    
    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 ReplicateKeyRequest clone()
```
    Overrides:
    
    clone in class AmazonWebServiceRequest

Class ReplicateKeyRequest

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

ReplicateKeyRequest

Method Detail

setKeyId

getKeyId

withKeyId

setReplicaRegion

getReplicaRegion

withReplicaRegion

setPolicy

getPolicy

withPolicy

setBypassPolicyLockoutSafetyCheck

getBypassPolicyLockoutSafetyCheck

withBypassPolicyLockoutSafetyCheck

isBypassPolicyLockoutSafetyCheck

setDescription

getDescription

withDescription

getTags

setTags

withTags

withTags

toString

equals

hashCode

clone