com.amazonaws.services.xray.model.PutEncryptionConfigRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-xray 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.xray.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 PutEncryptionConfigRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* An Amazon Web Services KMS key in one of the following formats:
*
*
* -
*
* Alias - The name of the key. For example, alias/MyKey.
*
*
* -
*
* Key ID - The KMS key ID of the key. For example, ae4aa6d49-a4d8-9df9-a475-4ff6d7898456.
* Amazon Web Services X-Ray does not support asymmetric KMS keys.
*
*
* -
*
* ARN - The full Amazon Resource Name of the key ID or alias. For example,
* arn:aws:kms:us-east-2:123456789012:key/ae4aa6d49-a4d8-9df9-a475-4ff6d7898456. Use this format to
* specify a key in a different account.
*
*
*
*
* Omit this key if you set Type to NONE.
*
*/
private String keyId;
/**
*
* The type of encryption. Set to KMS to use your own key for encryption. Set to NONE for
* default encryption.
*
*/
private String type;
/**
*
* An Amazon Web Services KMS key in one of the following formats:
*
*
* -
*
* Alias - The name of the key. For example, alias/MyKey.
*
*
* -
*
* Key ID - The KMS key ID of the key. For example, ae4aa6d49-a4d8-9df9-a475-4ff6d7898456.
* Amazon Web Services X-Ray does not support asymmetric KMS keys.
*
*
* -
*
* ARN - The full Amazon Resource Name of the key ID or alias. For example,
* arn:aws:kms:us-east-2:123456789012:key/ae4aa6d49-a4d8-9df9-a475-4ff6d7898456. Use this format to
* specify a key in a different account.
*
*
*
*
* Omit this key if you set Type to NONE.
*
*
* @param keyId
* An Amazon Web Services KMS key in one of the following formats:
*
* -
*
* Alias - The name of the key. For example, alias/MyKey.
*
*
* -
*
* Key ID - The KMS key ID of the key. For example, ae4aa6d49-a4d8-9df9-a475-4ff6d7898456
* . Amazon Web Services X-Ray does not support asymmetric KMS keys.
*
*
* -
*
* ARN - The full Amazon Resource Name of the key ID or alias. For example,
* arn:aws:kms:us-east-2:123456789012:key/ae4aa6d49-a4d8-9df9-a475-4ff6d7898456. Use this format
* to specify a key in a different account.
*
*
*
*
* Omit this key if you set Type to NONE.
*/
public void setKeyId(String keyId) {
this.keyId = keyId;
}
/**
*
* An Amazon Web Services KMS key in one of the following formats:
*
*
* -
*
* Alias - The name of the key. For example, alias/MyKey.
*
*
* -
*
* Key ID - The KMS key ID of the key. For example, ae4aa6d49-a4d8-9df9-a475-4ff6d7898456.
* Amazon Web Services X-Ray does not support asymmetric KMS keys.
*
*
* -
*
* ARN - The full Amazon Resource Name of the key ID or alias. For example,
* arn:aws:kms:us-east-2:123456789012:key/ae4aa6d49-a4d8-9df9-a475-4ff6d7898456. Use this format to
* specify a key in a different account.
*
*
*
*
* Omit this key if you set Type to NONE.
*
*
* @return An Amazon Web Services KMS key in one of the following formats:
*
* -
*
* Alias - The name of the key. For example, alias/MyKey.
*
*
* -
*
* Key ID - The KMS key ID of the key. For example,
* ae4aa6d49-a4d8-9df9-a475-4ff6d7898456. Amazon Web Services X-Ray does not support asymmetric
* KMS keys.
*
*
* -
*
* ARN - The full Amazon Resource Name of the key ID or alias. For example,
* arn:aws:kms:us-east-2:123456789012:key/ae4aa6d49-a4d8-9df9-a475-4ff6d7898456. Use this
* format to specify a key in a different account.
*
*
*
*
* Omit this key if you set Type to NONE.
*/
public String getKeyId() {
return this.keyId;
}
/**
*
* An Amazon Web Services KMS key in one of the following formats:
*
*
* -
*
* Alias - The name of the key. For example, alias/MyKey.
*
*
* -
*
* Key ID - The KMS key ID of the key. For example, ae4aa6d49-a4d8-9df9-a475-4ff6d7898456.
* Amazon Web Services X-Ray does not support asymmetric KMS keys.
*
*
* -
*
* ARN - The full Amazon Resource Name of the key ID or alias. For example,
* arn:aws:kms:us-east-2:123456789012:key/ae4aa6d49-a4d8-9df9-a475-4ff6d7898456. Use this format to
* specify a key in a different account.
*
*
*
*
* Omit this key if you set Type to NONE.
*
*
* @param keyId
* An Amazon Web Services KMS key in one of the following formats:
*
* -
*
* Alias - The name of the key. For example, alias/MyKey.
*
*
* -
*
* Key ID - The KMS key ID of the key. For example, ae4aa6d49-a4d8-9df9-a475-4ff6d7898456
* . Amazon Web Services X-Ray does not support asymmetric KMS keys.
*
*
* -
*
* ARN - The full Amazon Resource Name of the key ID or alias. For example,
* arn:aws:kms:us-east-2:123456789012:key/ae4aa6d49-a4d8-9df9-a475-4ff6d7898456. Use this format
* to specify a key in a different account.
*
*
*
*
* Omit this key if you set Type to NONE.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutEncryptionConfigRequest withKeyId(String keyId) {
setKeyId(keyId);
return this;
}
/**
*
* The type of encryption. Set to KMS to use your own key for encryption. Set to NONE for
* default encryption.
*
*
* @param type
* The type of encryption. Set to KMS to use your own key for encryption. Set to
* NONE for default encryption.
* @see EncryptionType
*/
public void setType(String type) {
this.type = type;
}
/**
*
* The type of encryption. Set to KMS to use your own key for encryption. Set to NONE for
* default encryption.
*
*
* @return The type of encryption. Set to KMS to use your own key for encryption. Set to
* NONE for default encryption.
* @see EncryptionType
*/
public String getType() {
return this.type;
}
/**
*
* The type of encryption. Set to KMS to use your own key for encryption. Set to NONE for
* default encryption.
*
*
* @param type
* The type of encryption. Set to KMS to use your own key for encryption. Set to
* NONE for default encryption.
* @return Returns a reference to this object so that method calls can be chained together.
* @see EncryptionType
*/
public PutEncryptionConfigRequest withType(String type) {
setType(type);
return this;
}
/**
*
* The type of encryption. Set to KMS to use your own key for encryption. Set to NONE for
* default encryption.
*
*
* @param type
* The type of encryption. Set to KMS to use your own key for encryption. Set to
* NONE for default encryption.
* @return Returns a reference to this object so that method calls can be chained together.
* @see EncryptionType
*/
public PutEncryptionConfigRequest withType(EncryptionType type) {
this.type = type.toString();
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 (getType() != null)
sb.append("Type: ").append(getType());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof PutEncryptionConfigRequest == false)
return false;
PutEncryptionConfigRequest other = (PutEncryptionConfigRequest) obj;
if (other.getKeyId() == null ^ this.getKeyId() == null)
return false;
if (other.getKeyId() != null && other.getKeyId().equals(this.getKeyId()) == false)
return false;
if (other.getType() == null ^ this.getType() == null)
return false;
if (other.getType() != null && other.getType().equals(this.getType()) == 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 + ((getType() == null) ? 0 : getType().hashCode());
return hashCode;
}
@Override
public PutEncryptionConfigRequest clone() {
return (PutEncryptionConfigRequest) super.clone();
}
}