com.amazonaws.services.kinesis.model

Class StartStreamEncryptionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kinesis.model.StartStreamEncryptionRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class StartStreamEncryptionRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
StartStreamEncryptionRequest()

Method Summary

Modifier and Type	Method and Description
StartStreamEncryptionRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getEncryptionType() The encryption type to use.
String	getKeyId() The GUID for the customer-managed AWS KMS key to use for encryption.
String	getStreamName() The name of the stream for which to start encrypting records.
int	hashCode()
void	setEncryptionType(EncryptionType encryptionType) The encryption type to use.
void	setEncryptionType(String encryptionType) The encryption type to use.
void	setKeyId(String keyId) The GUID for the customer-managed AWS KMS key to use for encryption.
void	setStreamName(String streamName) The name of the stream for which to start encrypting records.
String	toString() Returns a string representation of this object.
StartStreamEncryptionRequest	withEncryptionType(EncryptionType encryptionType) The encryption type to use.
StartStreamEncryptionRequest	withEncryptionType(String encryptionType) The encryption type to use.
StartStreamEncryptionRequest	withKeyId(String keyId) The GUID for the customer-managed AWS KMS key to use for encryption.
StartStreamEncryptionRequest	withStreamName(String streamName) The name of the stream for which to start encrypting records.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StartStreamEncryptionRequest

public StartStreamEncryptionRequest()

Method Detail

setStreamName

public void setStreamName(String streamName)

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

Parameters:

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

getStreamName

public String getStreamName()

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

Returns:

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

withStreamName

public StartStreamEncryptionRequest withStreamName(String streamName)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setEncryptionType

public void setEncryptionType(String encryptionType)

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

Parameters:

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

See Also:

EncryptionType

getEncryptionType

public String getEncryptionType()

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

Returns:

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

See Also:

EncryptionType

withEncryptionType

public StartStreamEncryptionRequest withEncryptionType(String encryptionType)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

EncryptionType

setEncryptionType

public void setEncryptionType(EncryptionType encryptionType)

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

Parameters:

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

See Also:

EncryptionType

withEncryptionType

public StartStreamEncryptionRequest withEncryptionType(EncryptionType encryptionType)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

EncryptionType

setKeyId

public void setKeyId(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

Parameters:

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

getKeyId

public String getKeyId()

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

Returns:

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

withKeyId

public StartStreamEncryptionRequest withKeyId(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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public StartStreamEncryptionRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()