com.amazonaws.services.kinesis.model

Class StopStreamEncryptionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.kinesis.model.StopStreamEncryptionRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class StopStreamEncryptionRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Disables server-side encryption for a specified stream.

Stopping encryption is an asynchronous operation. Upon receiving the request, Kinesis Data Streams returns immediately and sets the status of the stream to UPDATING. After the update is complete, Kinesis Data Streams sets the status of the stream back to ACTIVE. Stopping encryption normally takes a few seconds to complete, but it can take minutes. You can continue to read and write data to your stream while its status is UPDATING. Once the status of the stream is ACTIVE, records written to the stream are no longer encrypted by Kinesis Data Streams.

API Limits: You can successfully disable server-side encryption 25 times in a rolling 24-hour period.

Note: It can take up to five seconds after the stream is in an ACTIVE status before all records written to the stream are no longer subject to encryption. After you disabled encryption, you can verify that encryption is not applied by inspecting the API response from PutRecord or PutRecords.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
StopStreamEncryptionRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getEncryptionType() The encryption type.
java.lang.String	getKeyId() The GUID for the customer-managed AWS KMS key to use for encryption.
java.lang.String	getStreamName() The name of the stream on which to stop encrypting records.
int	hashCode()
void	setEncryptionType(EncryptionType encryptionType) The encryption type.
void	setEncryptionType(java.lang.String encryptionType) The encryption type.
void	setKeyId(java.lang.String keyId) The GUID for the customer-managed AWS KMS key to use for encryption.
void	setStreamName(java.lang.String streamName) The name of the stream on which to stop encrypting records.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
StopStreamEncryptionRequest	withEncryptionType(EncryptionType encryptionType) The encryption type.
StopStreamEncryptionRequest	withEncryptionType(java.lang.String encryptionType) The encryption type.
StopStreamEncryptionRequest	withKeyId(java.lang.String keyId) The GUID for the customer-managed AWS KMS key to use for encryption.
StopStreamEncryptionRequest	withStreamName(java.lang.String streamName) The name of the stream on which to stop encrypting records.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StopStreamEncryptionRequest

public StopStreamEncryptionRequest()

Method Detail

getStreamName

public java.lang.String getStreamName()

The name of the stream on which to stop encrypting records.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+

Returns:

The name of the stream on which to stop encrypting records.

setStreamName

public void setStreamName(java.lang.String streamName)

The name of the stream on which to stop encrypting records.

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+

Parameters:

streamName -

The name of the stream on which to stop encrypting records.

withStreamName

public StopStreamEncryptionRequest withStreamName(java.lang.String streamName)

The name of the stream on which to stop encrypting records.

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

Constraints:
Length: 1 - 128
Pattern: [a-zA-Z0-9_.-]+

Parameters:

streamName -

The name of the stream on which to stop encrypting records.

Returns:

A reference to this updated object so that method calls can be chained together.

getEncryptionType

public java.lang.String getEncryptionType()

The encryption type. The only valid value is KMS.

Constraints:
Allowed Values: NONE, KMS

Returns:

The encryption type. The only valid value is KMS.

See Also:

EncryptionType

setEncryptionType

public void setEncryptionType(java.lang.String encryptionType)

The encryption type. The only valid value is KMS.

Constraints:
Allowed Values: NONE, KMS

Parameters:

encryptionType -

The encryption type. The only valid value is KMS.

See Also:

EncryptionType

withEncryptionType

public StopStreamEncryptionRequest withEncryptionType(java.lang.String encryptionType)

The encryption type. The only valid value is KMS.

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

Constraints:
Allowed Values: NONE, KMS

Parameters:

encryptionType -

The encryption type. The only valid value is KMS.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

EncryptionType

setEncryptionType

public void setEncryptionType(EncryptionType encryptionType)

The encryption type. The only valid value is KMS.

Constraints:
Allowed Values: NONE, KMS

Parameters:

encryptionType -

The encryption type. The only valid value is KMS.

See Also:

EncryptionType

withEncryptionType

public StopStreamEncryptionRequest withEncryptionType(EncryptionType encryptionType)

The encryption type. The only valid value is KMS.

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

Constraints:
Allowed Values: NONE, KMS

Parameters:

encryptionType -

The encryption type. The only valid value is KMS.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

EncryptionType

getKeyId

public java.lang.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

Constraints:
Length: 1 - 2048

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

setKeyId

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

Constraints:
Length: 1 - 2048

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

withKeyId

public StopStreamEncryptionRequest withKeyId(java.lang.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

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

Constraints:
Length: 1 - 2048

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:

A reference to this updated object so that method calls can be chained together.

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object