com.amazonaws.services.athena.model.EncryptionConfiguration Maven / Gradle / Ivy
Show all versions of aws-java-sdk-athena 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.athena.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* If query and calculation results are encrypted in Amazon S3, indicates the encryption option used (for example,
* SSE_KMS or CSE_KMS) and key information.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class EncryptionConfiguration implements Serializable, Cloneable, StructuredPojo {
/**
*
* Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys (SSE_S3), server-side
* encryption with KMS-managed keys (SSE_KMS), or client-side encryption with KMS-managed keys (
* CSE_KMS) is used.
*
*
* If a query runs in a workgroup and the workgroup overrides client-side settings, then the workgroup's setting for
* encryption is used. It specifies whether query results must be encrypted, for all queries that run in this
* workgroup.
*
*/
private String encryptionOption;
/**
*
* For SSE_KMS and CSE_KMS, this is the KMS key ARN or ID.
*
*/
private String kmsKey;
/**
*
* Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys (SSE_S3), server-side
* encryption with KMS-managed keys (SSE_KMS), or client-side encryption with KMS-managed keys (
* CSE_KMS) is used.
*
*
* If a query runs in a workgroup and the workgroup overrides client-side settings, then the workgroup's setting for
* encryption is used. It specifies whether query results must be encrypted, for all queries that run in this
* workgroup.
*
*
* @param encryptionOption
* Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys (SSE_S3),
* server-side encryption with KMS-managed keys (SSE_KMS), or client-side encryption with
* KMS-managed keys (CSE_KMS) is used.
*
* If a query runs in a workgroup and the workgroup overrides client-side settings, then the workgroup's
* setting for encryption is used. It specifies whether query results must be encrypted, for all queries that
* run in this workgroup.
* @see EncryptionOption
*/
public void setEncryptionOption(String encryptionOption) {
this.encryptionOption = encryptionOption;
}
/**
*
* Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys (SSE_S3), server-side
* encryption with KMS-managed keys (SSE_KMS), or client-side encryption with KMS-managed keys (
* CSE_KMS) is used.
*
*
* If a query runs in a workgroup and the workgroup overrides client-side settings, then the workgroup's setting for
* encryption is used. It specifies whether query results must be encrypted, for all queries that run in this
* workgroup.
*
*
* @return Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys (SSE_S3),
* server-side encryption with KMS-managed keys (SSE_KMS), or client-side encryption with
* KMS-managed keys (CSE_KMS) is used.
*
* If a query runs in a workgroup and the workgroup overrides client-side settings, then the workgroup's
* setting for encryption is used. It specifies whether query results must be encrypted, for all queries
* that run in this workgroup.
* @see EncryptionOption
*/
public String getEncryptionOption() {
return this.encryptionOption;
}
/**
*
* Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys (SSE_S3), server-side
* encryption with KMS-managed keys (SSE_KMS), or client-side encryption with KMS-managed keys (
* CSE_KMS) is used.
*
*
* If a query runs in a workgroup and the workgroup overrides client-side settings, then the workgroup's setting for
* encryption is used. It specifies whether query results must be encrypted, for all queries that run in this
* workgroup.
*
*
* @param encryptionOption
* Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys (SSE_S3),
* server-side encryption with KMS-managed keys (SSE_KMS), or client-side encryption with
* KMS-managed keys (CSE_KMS) is used.
*
* If a query runs in a workgroup and the workgroup overrides client-side settings, then the workgroup's
* setting for encryption is used. It specifies whether query results must be encrypted, for all queries that
* run in this workgroup.
* @return Returns a reference to this object so that method calls can be chained together.
* @see EncryptionOption
*/
public EncryptionConfiguration withEncryptionOption(String encryptionOption) {
setEncryptionOption(encryptionOption);
return this;
}
/**
*
* Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys (SSE_S3), server-side
* encryption with KMS-managed keys (SSE_KMS), or client-side encryption with KMS-managed keys (
* CSE_KMS) is used.
*
*
* If a query runs in a workgroup and the workgroup overrides client-side settings, then the workgroup's setting for
* encryption is used. It specifies whether query results must be encrypted, for all queries that run in this
* workgroup.
*
*
* @param encryptionOption
* Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys (SSE_S3),
* server-side encryption with KMS-managed keys (SSE_KMS), or client-side encryption with
* KMS-managed keys (CSE_KMS) is used.
*
* If a query runs in a workgroup and the workgroup overrides client-side settings, then the workgroup's
* setting for encryption is used. It specifies whether query results must be encrypted, for all queries that
* run in this workgroup.
* @see EncryptionOption
*/
public void setEncryptionOption(EncryptionOption encryptionOption) {
withEncryptionOption(encryptionOption);
}
/**
*
* Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys (SSE_S3), server-side
* encryption with KMS-managed keys (SSE_KMS), or client-side encryption with KMS-managed keys (
* CSE_KMS) is used.
*
*
* If a query runs in a workgroup and the workgroup overrides client-side settings, then the workgroup's setting for
* encryption is used. It specifies whether query results must be encrypted, for all queries that run in this
* workgroup.
*
*
* @param encryptionOption
* Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys (SSE_S3),
* server-side encryption with KMS-managed keys (SSE_KMS), or client-side encryption with
* KMS-managed keys (CSE_KMS) is used.
*
* If a query runs in a workgroup and the workgroup overrides client-side settings, then the workgroup's
* setting for encryption is used. It specifies whether query results must be encrypted, for all queries that
* run in this workgroup.
* @return Returns a reference to this object so that method calls can be chained together.
* @see EncryptionOption
*/
public EncryptionConfiguration withEncryptionOption(EncryptionOption encryptionOption) {
this.encryptionOption = encryptionOption.toString();
return this;
}
/**
*
* For SSE_KMS and CSE_KMS, this is the KMS key ARN or ID.
*
*
* @param kmsKey
* For SSE_KMS and CSE_KMS, this is the KMS key ARN or ID.
*/
public void setKmsKey(String kmsKey) {
this.kmsKey = kmsKey;
}
/**
*
* For SSE_KMS and CSE_KMS, this is the KMS key ARN or ID.
*
*
* @return For SSE_KMS and CSE_KMS, this is the KMS key ARN or ID.
*/
public String getKmsKey() {
return this.kmsKey;
}
/**
*
* For SSE_KMS and CSE_KMS, this is the KMS key ARN or ID.
*
*
* @param kmsKey
* For SSE_KMS and CSE_KMS, this is the KMS key ARN or ID.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public EncryptionConfiguration withKmsKey(String kmsKey) {
setKmsKey(kmsKey);
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 (getEncryptionOption() != null)
sb.append("EncryptionOption: ").append(getEncryptionOption()).append(",");
if (getKmsKey() != null)
sb.append("KmsKey: ").append(getKmsKey());
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.getEncryptionOption() == null ^ this.getEncryptionOption() == null)
return false;
if (other.getEncryptionOption() != null && other.getEncryptionOption().equals(this.getEncryptionOption()) == false)
return false;
if (other.getKmsKey() == null ^ this.getKmsKey() == null)
return false;
if (other.getKmsKey() != null && other.getKmsKey().equals(this.getKmsKey()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getEncryptionOption() == null) ? 0 : getEncryptionOption().hashCode());
hashCode = prime * hashCode + ((getKmsKey() == null) ? 0 : getKmsKey().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.athena.model.transform.EncryptionConfigurationMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}