com.amazonaws.services.kms.model.UpdatePrimaryRegionRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-kms Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.kms.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class UpdatePrimaryRegionRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* Identifies the current primary key. When the operation completes, this KMS key will be a replica key.
*
*
* 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.
*
*/
private String keyId;
/**
*
* The Amazon Web Services Region of the new primary key. Enter the Region ID, such as us-east-1 or
* ap-southeast-2. There must be an existing replica key in this Region.
*
*
* When the operation completes, the multi-Region key in this Region will be the primary key.
*
*/
private String primaryRegion;
/**
*
* Identifies the current primary key. When the operation completes, this KMS key will be a replica key.
*
*
* 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.
*
*
* @param keyId
* Identifies the current primary key. When the operation completes, this KMS key will be a replica key.
*
* 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.
*/
public void setKeyId(String keyId) {
this.keyId = keyId;
}
/**
*
* Identifies the current primary key. When the operation completes, this KMS key will be a replica key.
*
*
* 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.
*
*
* @return Identifies the current primary key. When the operation completes, this KMS key will be a replica key.
*
* 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.
*/
public String getKeyId() {
return this.keyId;
}
/**
*
* Identifies the current primary key. When the operation completes, this KMS key will be a replica key.
*
*
* 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.
*
*
* @param keyId
* Identifies the current primary key. When the operation completes, this KMS key will be a replica key.
*
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdatePrimaryRegionRequest withKeyId(String keyId) {
setKeyId(keyId);
return this;
}
/**
*
* The Amazon Web Services Region of the new primary key. Enter the Region ID, such as us-east-1 or
* ap-southeast-2. There must be an existing replica key in this Region.
*
*
* When the operation completes, the multi-Region key in this Region will be the primary key.
*
*
* @param primaryRegion
* The Amazon Web Services Region of the new primary key. Enter the Region ID, such as us-east-1
* or ap-southeast-2. There must be an existing replica key in this Region.
*
* When the operation completes, the multi-Region key in this Region will be the primary key.
*/
public void setPrimaryRegion(String primaryRegion) {
this.primaryRegion = primaryRegion;
}
/**
*
* The Amazon Web Services Region of the new primary key. Enter the Region ID, such as us-east-1 or
* ap-southeast-2. There must be an existing replica key in this Region.
*
*
* When the operation completes, the multi-Region key in this Region will be the primary key.
*
*
* @return The Amazon Web Services Region of the new primary key. Enter the Region ID, such as
* us-east-1 or ap-southeast-2. There must be an existing replica key in this
* Region.
*
* When the operation completes, the multi-Region key in this Region will be the primary key.
*/
public String getPrimaryRegion() {
return this.primaryRegion;
}
/**
*
* The Amazon Web Services Region of the new primary key. Enter the Region ID, such as us-east-1 or
* ap-southeast-2. There must be an existing replica key in this Region.
*
*
* When the operation completes, the multi-Region key in this Region will be the primary key.
*
*
* @param primaryRegion
* The Amazon Web Services Region of the new primary key. Enter the Region ID, such as us-east-1
* or ap-southeast-2. There must be an existing replica key in this Region.
*
* When the operation completes, the multi-Region key in this Region will be the primary key.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdatePrimaryRegionRequest withPrimaryRegion(String primaryRegion) {
setPrimaryRegion(primaryRegion);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getKeyId() != null)
sb.append("KeyId: ").append(getKeyId()).append(",");
if (getPrimaryRegion() != null)
sb.append("PrimaryRegion: ").append(getPrimaryRegion());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof UpdatePrimaryRegionRequest == false)
return false;
UpdatePrimaryRegionRequest other = (UpdatePrimaryRegionRequest) obj;
if (other.getKeyId() == null ^ this.getKeyId() == null)
return false;
if (other.getKeyId() != null && other.getKeyId().equals(this.getKeyId()) == false)
return false;
if (other.getPrimaryRegion() == null ^ this.getPrimaryRegion() == null)
return false;
if (other.getPrimaryRegion() != null && other.getPrimaryRegion().equals(this.getPrimaryRegion()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getKeyId() == null) ? 0 : getKeyId().hashCode());
hashCode = prime * hashCode + ((getPrimaryRegion() == null) ? 0 : getPrimaryRegion().hashCode());
return hashCode;
}
@Override
public UpdatePrimaryRegionRequest clone() {
return (UpdatePrimaryRegionRequest) super.clone();
}
}