@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) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
String |
keyId()
The GUID for the customer-managed AWS KMS key to use for encryption.
|
static Class<? extends StartStreamEncryptionRequest.Builder> |
serializableBuilderClass() |
String |
streamName()
The name of the stream for which to start encrypting records.
|
StartStreamEncryptionRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
overrideConfiguration
copy
public String streamName()
The name of the stream for which to start encrypting records.
public 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 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 String keyId()
The GUID for the customer-managed AWS 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()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<StartStreamEncryptionRequest.Builder,StartStreamEncryptionRequest>
toBuilder
in class KinesisRequest
public static StartStreamEncryptionRequest.Builder builder()
public static Class<? extends StartStreamEncryptionRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.