/* * Copyright 2018-2023 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.kinesis.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 StartStreamEncryptionRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *
* The name of the stream for which to start encrypting records. *
*/ private String streamName; /** *
* The encryption type to use. The only valid value is KMS
.
*
* The GUID for the customer-managed Amazon Web Services KMS key to use for encryption. This value can be a globally
* unique identifier, a fully specified Amazon Resource Name (ARN) to either an alias or a key, or an alias name
* prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams by specifying the alias
* aws/kinesis
.
*
* Key ARN example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
*
* Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
*
* Globally unique key ID example: 12345678-1234-1234-1234-123456789012
*
* Alias name example: alias/MyAliasName
*
* Master key owned by Kinesis Data Streams: alias/aws/kinesis
*
* The ARN of the stream. *
*/ private String streamARN; /** ** The name of the stream for which to start encrypting records. *
* * @param streamName * The name of the stream for which to start encrypting records. */ public void setStreamName(String streamName) { this.streamName = streamName; } /** ** The name of the stream for which to start encrypting records. *
* * @return The name of the stream for which to start encrypting records. */ public String getStreamName() { return this.streamName; } /** ** The name of the stream for which to start encrypting records. *
* * @param streamName * The name of the stream for which to start encrypting records. * @return Returns a reference to this object so that method calls can be chained together. */ public StartStreamEncryptionRequest withStreamName(String streamName) { setStreamName(streamName); return this; } /** *
* The encryption type to use. The only valid value is KMS
.
*
KMS
.
* @see EncryptionType
*/
public void setEncryptionType(String encryptionType) {
this.encryptionType = encryptionType;
}
/**
*
* The encryption type to use. The only valid value is KMS
.
*
KMS
.
* @see EncryptionType
*/
public String getEncryptionType() {
return this.encryptionType;
}
/**
*
* The encryption type to use. The only valid value is KMS
.
*
KMS
.
* @return Returns a reference to this object so that method calls can be chained together.
* @see EncryptionType
*/
public StartStreamEncryptionRequest withEncryptionType(String encryptionType) {
setEncryptionType(encryptionType);
return this;
}
/**
*
* The encryption type to use. The only valid value is KMS
.
*
KMS
.
* @see EncryptionType
*/
public void setEncryptionType(EncryptionType encryptionType) {
withEncryptionType(encryptionType);
}
/**
*
* The encryption type to use. The only valid value is KMS
.
*
KMS
.
* @return Returns a reference to this object so that method calls can be chained together.
* @see EncryptionType
*/
public StartStreamEncryptionRequest withEncryptionType(EncryptionType encryptionType) {
this.encryptionType = encryptionType.toString();
return this;
}
/**
*
* The GUID for the customer-managed Amazon Web Services KMS key to use for encryption. This value can be a globally
* unique identifier, a fully specified Amazon Resource Name (ARN) to either an alias or a key, or an alias name
* prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams by specifying the alias
* aws/kinesis
.
*
* Key ARN example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
*
* Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
*
* Globally unique key ID example: 12345678-1234-1234-1234-123456789012
*
* Alias name example: alias/MyAliasName
*
* Master key owned by Kinesis Data Streams: alias/aws/kinesis
*
aws/kinesis
.
*
* Key ARN example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
*
* Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
*
* Globally unique key ID example: 12345678-1234-1234-1234-123456789012
*
* Alias name example: alias/MyAliasName
*
* Master key owned by Kinesis Data Streams: alias/aws/kinesis
*
* The GUID for the customer-managed Amazon Web Services KMS key to use for encryption. This value can be a globally
* unique identifier, a fully specified Amazon Resource Name (ARN) to either an alias or a key, or an alias name
* prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams by specifying the alias
* aws/kinesis
.
*
* Key ARN example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
*
* Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
*
* Globally unique key ID example: 12345678-1234-1234-1234-123456789012
*
* Alias name example: alias/MyAliasName
*
* Master key owned by Kinesis Data Streams: alias/aws/kinesis
*
aws/kinesis
.
*
* Key ARN example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
*
* Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
*
* Globally unique key ID example: 12345678-1234-1234-1234-123456789012
*
* Alias name example: alias/MyAliasName
*
* Master key owned by Kinesis Data Streams: alias/aws/kinesis
*
* The GUID for the customer-managed Amazon Web Services KMS key to use for encryption. This value can be a globally
* unique identifier, a fully specified Amazon Resource Name (ARN) to either an alias or a key, or an alias name
* prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams by specifying the alias
* aws/kinesis
.
*
* Key ARN example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
*
* Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
*
* Globally unique key ID example: 12345678-1234-1234-1234-123456789012
*
* Alias name example: alias/MyAliasName
*
* Master key owned by Kinesis Data Streams: alias/aws/kinesis
*
aws/kinesis
.
*
* Key ARN example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012
*
* Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName
*
* Globally unique key ID example: 12345678-1234-1234-1234-123456789012
*
* Alias name example: alias/MyAliasName
*
* Master key owned by Kinesis Data Streams: alias/aws/kinesis
*
* The ARN of the stream. *
* * @param streamARN * The ARN of the stream. */ public void setStreamARN(String streamARN) { this.streamARN = streamARN; } /** ** The ARN of the stream. *
* * @return The ARN of the stream. */ public String getStreamARN() { return this.streamARN; } /** ** The ARN of the stream. *
* * @param streamARN * The ARN of the stream. * @return Returns a reference to this object so that method calls can be chained together. */ public StartStreamEncryptionRequest withStreamARN(String streamARN) { setStreamARN(streamARN); 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 (getStreamName() != null) sb.append("StreamName: ").append(getStreamName()).append(","); if (getEncryptionType() != null) sb.append("EncryptionType: ").append(getEncryptionType()).append(","); if (getKeyId() != null) sb.append("KeyId: ").append(getKeyId()).append(","); if (getStreamARN() != null) sb.append("StreamARN: ").append(getStreamARN()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof StartStreamEncryptionRequest == false) return false; StartStreamEncryptionRequest other = (StartStreamEncryptionRequest) obj; if (other.getStreamName() == null ^ this.getStreamName() == null) return false; if (other.getStreamName() != null && other.getStreamName().equals(this.getStreamName()) == false) return false; if (other.getEncryptionType() == null ^ this.getEncryptionType() == null) return false; if (other.getEncryptionType() != null && other.getEncryptionType().equals(this.getEncryptionType()) == false) return false; if (other.getKeyId() == null ^ this.getKeyId() == null) return false; if (other.getKeyId() != null && other.getKeyId().equals(this.getKeyId()) == false) return false; if (other.getStreamARN() == null ^ this.getStreamARN() == null) return false; if (other.getStreamARN() != null && other.getStreamARN().equals(this.getStreamARN()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getStreamName() == null) ? 0 : getStreamName().hashCode()); hashCode = prime * hashCode + ((getEncryptionType() == null) ? 0 : getEncryptionType().hashCode()); hashCode = prime * hashCode + ((getKeyId() == null) ? 0 : getKeyId().hashCode()); hashCode = prime * hashCode + ((getStreamARN() == null) ? 0 : getStreamARN().hashCode()); return hashCode; } @Override public StartStreamEncryptionRequest clone() { return (StartStreamEncryptionRequest) super.clone(); } }