Package software.amazon.awssdk.services.kinesis.model

Class StartStreamEncryptionRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.kinesis.model.KinesisRequest

software.amazon.awssdk.services.kinesis.model.StartStreamEncryptionRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartStreamEncryptionRequest.Builder,StartStreamEncryptionRequest>

@Generated("software.amazon.awssdk:codegen")
public final class StartStreamEncryptionRequest
extends KinesisRequest
implements ToCopyableBuilder<StartStreamEncryptionRequest.Builder,StartStreamEncryptionRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StartStreamEncryptionRequest.Builder

Method Summary

Modifier and Type	Method	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	streamARN()	The ARN of the stream.
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.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

streamName

public final String streamName()

The name of the stream for which to start encrypting records.

Returns:

The name of the stream for which to start encrypting records.

encryptionType

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().

Returns:

The encryption type to use. The only valid value is KMS.

See Also:

EncryptionType

encryptionTypeAsString

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().

Returns:

The encryption type to use. The only valid value is KMS.

See Also:

EncryptionType

keyId

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

Returns:

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

streamARN

public final String streamARN()

The ARN of the stream.

Returns:

The ARN of the stream.

toBuilder

public StartStreamEncryptionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartStreamEncryptionRequest.Builder,StartStreamEncryptionRequest>

Specified by:

toBuilder in class KinesisRequest

builder

public static StartStreamEncryptionRequest.Builder builder()

serializableBuilderClass

public static Class<? extends StartStreamEncryptionRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo