STARTSTREAMENCRYPTION()`¶

About StartStreamEncryption¶

Enables or updates server-side encryption using an Amazon Web Services KMS key for a specified stream.

When invoking this API, you must use either the StreamARN or the StreamName parameter, or both. It is recommended that you use the StreamARN input parameter when you invoke this API.

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 Amazon Web Services KMS key for server-side encryption 25 times in a rolling 24-hour period.

Note: It can take up to 5 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.

Method Signature¶

METHODS /AWS1/IF_KNS~STARTSTREAMENCRYPTION
  IMPORTING
    !IV_STREAMNAME TYPE /AWS1/KNSSTREAMNAME OPTIONAL
    !IV_ENCRYPTIONTYPE TYPE /AWS1/KNSENCRYPTIONTYPE OPTIONAL
    !IV_KEYID TYPE /AWS1/KNSKEYID OPTIONAL
    !IV_STREAMARN TYPE /AWS1/KNSSTREAMARN OPTIONAL
  RAISING
    /AWS1/CX_KNSACCESSDENIEDEX
    /AWS1/CX_KNSINVALIDARGUMENTEX
    /AWS1/CX_KNSKMSACCESSDENIEDEX
    /AWS1/CX_KNSKMSDISABLEDEX
    /AWS1/CX_KNSKMSINVALIDSTATEEX
    /AWS1/CX_KNSKMSNOTFOUNDEX
    /AWS1/CX_KNSKMSOPTINREQUIRED
    /AWS1/CX_KNSKMSTHROTTLINGEX
    /AWS1/CX_KNSLIMITEXCEEDEDEX
    /AWS1/CX_KNSRESOURCEINUSEEX
    /AWS1/CX_KNSRESOURCENOTFOUNDEX
    /AWS1/CX_KNSCLIENTEXC
    /AWS1/CX_KNSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_encryptiontype` `TYPE /AWS1/KNSENCRYPTIONTYPE` `/AWS1/KNSENCRYPTIONTYPE`¶

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

`iv_keyid` `TYPE /AWS1/KNSKEYID` `/AWS1/KNSKEYID`¶

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

Optional arguments:¶

`iv_streamname` `TYPE /AWS1/KNSSTREAMNAME` `/AWS1/KNSSTREAMNAME`¶

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

`iv_streamarn` `TYPE /AWS1/KNSSTREAMARN` `/AWS1/KNSSTREAMARN`¶

The ARN of the stream.

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

lo_client->startstreamencryption(
  iv_encryptiontype = |string|
  iv_keyid = |string|
  iv_streamarn = |string|
  iv_streamname = |string|
).

/AWS1/IF_KNS=>STARTSTREAMENCRYPTION()¶