@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');
1.62.0 (2020-09-03)
eks.Cluster.fromClusterAttributes, the clusterArn attribute is not supported anymore, and will always be derived from clusterName.eks.Cluster is allowed per CloudFormation stack.securityGroups attribute of ClusterAttributes is now securityGroupIds.--qualifier must be alphanumeric and not longer than 10 characters when bootstrapping using newStyleStackSynthesis.SimpleSynthAction takes array of build commands (#10152) (44fcb4e), closes #9357GraphQLApi.UserPoolConfig requires DefaultAction (#10031) (6114045), closes #10028cdk docs (#9549) (663913f), closes #2847ServiceAccount in a different stack than the Cluster creates circular dependency between the two stacks (#9701) (1e96ebc), closes 40aws-cdk/aws-eks/lib/service-account.ts#L81-L95 40aws-cdk/aws-eks/lib/cluster.ts#L914-L923 40aws-cdk/aws-eks/lib/cluster.ts#L907-L909FAQs
The CDK Construct Library for AWS::Kinesis
The npm package @aws-cdk/aws-kinesis receives a total of 39,553 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
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.
Security News
React's CRA deprecation announcement sparked community criticism over framework recommendations, leading to quick updates acknowledging build tools like Vite as valid alternatives.
Security News
Ransomware payment rates hit an all-time low in 2024 as law enforcement crackdowns, stronger defenses, and shifting policies make attacks riskier and less profitable.