@aws-cdk/aws-kinesis
Advanced tools
Amazon Kinesis provides collection and processing of large streams of data records in real time. Kinesis data streams can be used for rapid and continuous data intake and aggregation.
Amazon Kinesis Data Streams ingests a large amount of data in real time, durably stores the data, and makes the data available for consumption.
Using the CDK, a new Kinesis stream can be created as part of the stack using the construct's constructor. You may specify the streamName to give
your own identifier to the stream. If not, CloudFormation will generate a name.
new Stream(this, "MyFirstStream", {
streamName: "my-awesome-stream"
});
You can also specify properties such as shardCount to indicate how many shards the stream should choose and a retentionPeriod
to specify how long the data in the shards should remain accessible.
Read more at Creating and Managing Streams
new Stream(this, "MyFirstStream", {
streamName: "my-awesome-stream",
shardCount: 3,
retentionPeriod: Duration.hours(48)
});
Stream encryption enables server-side encryption using an AWS KMS key for a specified stream.
Encryption is enabled by default on your stream with the master key owned by Kinesis Data Streams in regions where it is supported.
new Stream(this, 'MyEncryptedStream');
You can enable encryption on your stream with a user-managed key by specifying the encryption property.
A KMS key will be created for you and associated with the stream.
new Stream(this, "MyEncryptedStream", {
encryption: StreamEncryption.KMS
});
You can also supply your own external KMS key to use for stream encryption by specifying the encryptionKey property.
import * as kms from "@aws-cdk/aws-kms";
const key = new kms.Key(this, "MyKey");
new Stream(this, "MyEncryptedStream", {
encryption: StreamEncryption.KMS,
encryptionKey: key
});
Any Kinesis stream that has been created outside the stack can be imported into your CDK app.
Streams can be imported by their ARN via the Stream.fromStreamArn() API
const stack = new Stack(app, "MyStack");
const importedStream = Stream.fromStreamArn(
stack,
"ImportedStream",
"arn:aws:kinesis:us-east-2:123456789012:stream/f3j09j2230j"
);
Encrypted Streams can also be imported by their attributes via the Stream.fromStreamAttributes() API
import { Key } from "@aws-cdk/aws-kms";
const stack = new Stack(app, "MyStack");
const importedStream = Stream.fromStreamAttributes(
stack,
"ImportedEncryptedStream",
{
streamArn: "arn:aws:kinesis:us-east-2:123456789012:stream/f3j09j2230j",
encryptionKey: kms.Key.fromKeyArn(
"arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012"
)
}
);
IAM roles, users or groups which need to be able to work with Amazon Kinesis streams at runtime should be granted IAM permissions.
Any object that implements the IGrantable interface (has an associated principal) can be granted permissions by calling:
grantRead(principal) - grants the principal read accessgrantWrite(principal) - grants the principal write permissions to a StreamgrantReadWrite(principal) - grants principal read and write permissionsGrant read access to a stream by calling the grantRead() API.
If the stream has an encryption key, read permissions will also be granted to the key.
const lambdaRole = new iam.Role(this, 'Role', {
assumedBy: new iam.ServicePrincipal('lambda.amazonaws.com'),
description: 'Example role...',
}
const stream = new Stream(this, 'MyEncryptedStream', {
encryption: StreamEncryption.KMS
});
// give lambda permissions to read stream
stream.grantRead(lambdaRole);
The following read permissions are provided to a service principal by the grantRead() API:
kinesis:DescribeStreamSummarykinesis:GetRecordskinesis:GetShardIteratorkinesis:ListShardskinesis:SubscribeToShardGrant write permissions to a stream is provided by calling the grantWrite() API.
If the stream has an encryption key, write permissions will also be granted to the key.
const lambdaRole = new iam.Role(this, 'Role', {
assumedBy: new iam.ServicePrincipal('lambda.amazonaws.com'),
description: 'Example role...',
}
const stream = new Stream(this, 'MyEncryptedStream', {
encryption: StreamEncryption.KMS
});
// give lambda permissions to write to stream
stream.grantWrite(lambdaRole);
The following write permissions are provided to a service principal by the grantWrite() API:
kinesis:ListShardskinesis:PutRecordkinesis:PutRecordsYou can add any set of permissions to a stream by calling the grant() API.
const user = new iam.User(stack, 'MyUser');
const stream = new Stream(stack, 'MyStream');
// give my user permissions to list shards
stream.grant(user, 'kinesis:ListShards');
You can use common metrics from your stream to create alarms and/or dashboards. The stream.metric('MetricName') method creates a metric with the stream namespace and dimension. You can also use pre-define methods like stream.metricGetRecordsSuccess(). To find out more about Kinesis metrics check Monitoring the Amazon Kinesis Data Streams Service with Amazon CloudWatch.
const stream = new Stream(stack, 'MyStream');
// Using base metric method passing the metric name
stream.metric('GetRecords.Success');
// using pre-defined metric method
stream.metricGetRecordsSuccess();
// using pre-defined and overriding the statistic
stream.metricGetRecordsSuccess({ statistic: 'Maximum' });
1.127.0 (2021-10-08)
Match.absentProperty() becomes Match.absent(), and its type changes from string to Matcher.hasResourceProperties is incompatible with Match.not and Match.absent (#16678) (6f0a507), closes #16626Principal: * (#16843) (6829a2a)FAQs
The CDK Construct Library for AWS::Kinesis
The npm package @aws-cdk/aws-kinesis receives a total of 20,274 weekly downloads. As such, @aws-cdk/aws-kinesis popularity was classified as popular.
We found that @aws-cdk/aws-kinesis demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.