StartStreamEncryptionRequest (aws-android-sdk-kinesis 2.62.1 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.kinesis.model.StartStreamEncryptionRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class StartStreamEncryptionRequest
extends com.amazonaws.AmazonWebServiceRequest
implements java.io.Serializable
```
Enables or updates server-side encryption using an AWS KMS key for a specified stream.

Starting 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. Updating or applying 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, encryption begins for records written to the stream.

API Limits: You can successfully apply a new AWS KMS key for 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 encrypted. After you enable encryption, you can verify that encryption is applied by inspecting the API response from PutRecord or PutRecords.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

StartStreamEncryptionRequest()

Constructors
Constructor and Description
`StartStreamEncryptionRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getEncryptionType()` The encryption type to use.
`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 for which to start encrypting records.
`int`	`hashCode()`
`void`	`setEncryptionType(EncryptionType encryptionType)` The encryption type to use.
`void`	`setEncryptionType(java.lang.String encryptionType)` The encryption type to use.
`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 for which to start encrypting records.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`StartStreamEncryptionRequest`	`withEncryptionType(EncryptionType encryptionType)` The encryption type to use.
`StartStreamEncryptionRequest`	`withEncryptionType(java.lang.String encryptionType)` The encryption type to use.
`StartStreamEncryptionRequest`	`withKeyId(java.lang.String keyId)` The GUID for the customer-managed AWS KMS key to use for encryption.
`StartStreamEncryptionRequest`	`withStreamName(java.lang.String streamName)` The name of the stream for which to start encrypting records.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - StartStreamEncryptionRequest
```
public StartStreamEncryptionRequest()
```
- Method Detail
  - getStreamName
```
public java.lang.String getStreamName()
```
    The name of the stream for which to start encrypting records.
    
    Constraints:
    Length: 1 - 128
    Pattern: [a-zA-Z0-9_.-]+
    
    Returns:
    
    The name of the stream for which to start encrypting records.
  - setStreamName
```
public void setStreamName(java.lang.String streamName)
```
    The name of the stream for which to start encrypting records.
    
    Constraints:
    Length: 1 - 128
    Pattern: [a-zA-Z0-9_.-]+
    
    Parameters:
    
    streamName -
    The name of the stream for which to start encrypting records.
  - withStreamName
```
public StartStreamEncryptionRequest withStreamName(java.lang.String streamName)
```
    The name of the stream for which to start 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 for which to start 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 to use. The only valid value is KMS.
    
    Constraints:
    Allowed Values: NONE, KMS
    
    Returns:
    
    The encryption type to use. The only valid value is KMS.
    
    See Also:
    
    EncryptionType
  - setEncryptionType
```
public void setEncryptionType(java.lang.String encryptionType)
```
    The encryption type to use. The only valid value is KMS.
    
    Constraints:
    Allowed Values: NONE, KMS
    
    Parameters:
    
    encryptionType -
    The encryption type to use. The only valid value is KMS.
    
    See Also:
    
    EncryptionType
  - withEncryptionType
```
public StartStreamEncryptionRequest withEncryptionType(java.lang.String encryptionType)
```
    The encryption type to use. 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 to use. 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 to use. The only valid value is KMS.
    
    Constraints:
    Allowed Values: NONE, 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.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: NONE, KMS
    
    Parameters:
    
    encryptionType -
    The encryption type to use. 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 StartStreamEncryptionRequest 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

Class StartStreamEncryptionRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

StartStreamEncryptionRequest

Method Detail

getStreamName

setStreamName

withStreamName

getEncryptionType

setEncryptionType

withEncryptionType

setEncryptionType

withEncryptionType

getKeyId

setKeyId

withKeyId

toString

hashCode

equals