com.amazonaws.services.dlm.model.EncryptionConfiguration Maven / Gradle / Ivy
Show all versions of aws-java-sdk-dlm 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.dlm.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* [Event-based policies only] Specifies the encryption settings for cross-Region snapshot copies created by
* event-based policies.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class EncryptionConfiguration implements Serializable, Cloneable, StructuredPojo {
/**
*
* To encrypt a copy of an unencrypted snapshot when encryption by default is not enabled, enable encryption using
* this parameter. Copies of encrypted snapshots are encrypted, even if this parameter is false or when encryption
* by default is not enabled.
*
*/
private Boolean encrypted;
/**
*
* The Amazon Resource Name (ARN) of the KMS key to use for EBS encryption. If this parameter is not specified, the
* default KMS key for the account is used.
*
*/
private String cmkArn;
/**
*
* To encrypt a copy of an unencrypted snapshot when encryption by default is not enabled, enable encryption using
* this parameter. Copies of encrypted snapshots are encrypted, even if this parameter is false or when encryption
* by default is not enabled.
*
*
* @param encrypted
* To encrypt a copy of an unencrypted snapshot when encryption by default is not enabled, enable encryption
* using this parameter. Copies of encrypted snapshots are encrypted, even if this parameter is false or when
* encryption by default is not enabled.
*/
public void setEncrypted(Boolean encrypted) {
this.encrypted = encrypted;
}
/**
*
* To encrypt a copy of an unencrypted snapshot when encryption by default is not enabled, enable encryption using
* this parameter. Copies of encrypted snapshots are encrypted, even if this parameter is false or when encryption
* by default is not enabled.
*
*
* @return To encrypt a copy of an unencrypted snapshot when encryption by default is not enabled, enable encryption
* using this parameter. Copies of encrypted snapshots are encrypted, even if this parameter is false or
* when encryption by default is not enabled.
*/
public Boolean getEncrypted() {
return this.encrypted;
}
/**
*
* To encrypt a copy of an unencrypted snapshot when encryption by default is not enabled, enable encryption using
* this parameter. Copies of encrypted snapshots are encrypted, even if this parameter is false or when encryption
* by default is not enabled.
*
*
* @param encrypted
* To encrypt a copy of an unencrypted snapshot when encryption by default is not enabled, enable encryption
* using this parameter. Copies of encrypted snapshots are encrypted, even if this parameter is false or when
* encryption by default is not enabled.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public EncryptionConfiguration withEncrypted(Boolean encrypted) {
setEncrypted(encrypted);
return this;
}
/**
*
* To encrypt a copy of an unencrypted snapshot when encryption by default is not enabled, enable encryption using
* this parameter. Copies of encrypted snapshots are encrypted, even if this parameter is false or when encryption
* by default is not enabled.
*
*
* @return To encrypt a copy of an unencrypted snapshot when encryption by default is not enabled, enable encryption
* using this parameter. Copies of encrypted snapshots are encrypted, even if this parameter is false or
* when encryption by default is not enabled.
*/
public Boolean isEncrypted() {
return this.encrypted;
}
/**
*
* The Amazon Resource Name (ARN) of the KMS key to use for EBS encryption. If this parameter is not specified, the
* default KMS key for the account is used.
*
*
* @param cmkArn
* The Amazon Resource Name (ARN) of the KMS key to use for EBS encryption. If this parameter is not
* specified, the default KMS key for the account is used.
*/
public void setCmkArn(String cmkArn) {
this.cmkArn = cmkArn;
}
/**
*
* The Amazon Resource Name (ARN) of the KMS key to use for EBS encryption. If this parameter is not specified, the
* default KMS key for the account is used.
*
*
* @return The Amazon Resource Name (ARN) of the KMS key to use for EBS encryption. If this parameter is not
* specified, the default KMS key for the account is used.
*/
public String getCmkArn() {
return this.cmkArn;
}
/**
*
* The Amazon Resource Name (ARN) of the KMS key to use for EBS encryption. If this parameter is not specified, the
* default KMS key for the account is used.
*
*
* @param cmkArn
* The Amazon Resource Name (ARN) of the KMS key to use for EBS encryption. If this parameter is not
* specified, the default KMS key for the account is used.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public EncryptionConfiguration withCmkArn(String cmkArn) {
setCmkArn(cmkArn);
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 (getEncrypted() != null)
sb.append("Encrypted: ").append(getEncrypted()).append(",");
if (getCmkArn() != null)
sb.append("CmkArn: ").append(getCmkArn());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof EncryptionConfiguration == false)
return false;
EncryptionConfiguration other = (EncryptionConfiguration) obj;
if (other.getEncrypted() == null ^ this.getEncrypted() == null)
return false;
if (other.getEncrypted() != null && other.getEncrypted().equals(this.getEncrypted()) == false)
return false;
if (other.getCmkArn() == null ^ this.getCmkArn() == null)
return false;
if (other.getCmkArn() != null && other.getCmkArn().equals(this.getCmkArn()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getEncrypted() == null) ? 0 : getEncrypted().hashCode());
hashCode = prime * hashCode + ((getCmkArn() == null) ? 0 : getCmkArn().hashCode());
return hashCode;
}
@Override
public EncryptionConfiguration clone() {
try {
return (EncryptionConfiguration) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.dlm.model.transform.EncryptionConfigurationMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}