@Generated(value="software.amazon.awssdk:codegen") public final class StartStreamEncryptionRequest extends KinesisRequest implements ToCopyableBuilder<StartStreamEncryptionRequest.Builder,StartStreamEncryptionRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
StartStreamEncryptionRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static StartStreamEncryptionRequest.Builder |
builder() |
EncryptionType |
encryptionType()
The encryption type to use.
|
String |
encryptionTypeAsString()
The encryption type to use.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
String |
keyId()
The GUID for the customer-managed Amazon Web Services KMS key to use for encryption.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends StartStreamEncryptionRequest.Builder> |
serializableBuilderClass() |
String |
streamName()
The name of the stream for which to start encrypting records.
|
StartStreamEncryptionRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
overrideConfiguration
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final String streamName()
The name of the stream for which to start encrypting records.
public final EncryptionType encryptionType()
The encryption type to use. The only valid value is KMS
.
If the service returns an enum value that is not available in the current SDK version, encryptionType
will return EncryptionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from encryptionTypeAsString()
.
KMS
.EncryptionType
public final String encryptionTypeAsString()
The encryption type to use. The only valid value is KMS
.
If the service returns an enum value that is not available in the current SDK version, encryptionType
will return EncryptionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from encryptionTypeAsString()
.
KMS
.EncryptionType
public final String keyId()
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
public StartStreamEncryptionRequest.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<StartStreamEncryptionRequest.Builder,StartStreamEncryptionRequest>
toBuilder
in class KinesisRequest
public static StartStreamEncryptionRequest.Builder builder()
public static Class<? extends StartStreamEncryptionRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField
in class SdkRequest
Copyright © 2022. All rights reserved.