Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(kinesis): remove linter exclusions #6758

Merged
merged 1 commit into from
Mar 17, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions packages/@aws-cdk/aws-kinesis/lib/stream.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ import * as kms from '@aws-cdk/aws-kms';
import { Construct, IResource, Resource, Stack } from '@aws-cdk/core';
import { CfnStream } from './kinesis.generated';

/**
* A Kinesis Stream
*/
export interface IStream extends IResource {
/**
* The ARN of the stream.
Expand Down Expand Up @@ -64,6 +67,8 @@ export interface StreamAttributes {

/**
* The KMS key securing the contents of the stream if encryption is enabled.
*
* @default - No encryption
*/
readonly encryptionKey?: kms.IKey;
}
Expand Down Expand Up @@ -168,6 +173,9 @@ abstract class StreamBase extends Resource implements IStream {
}
}

/**
* Properties for a Kinesis Stream
*/
export interface StreamProps {
/**
* Enforces a particular physical stream name.
Expand Down Expand Up @@ -213,6 +221,13 @@ export interface StreamProps {
*/
export class Stream extends StreamBase {

/**
* Import an existing Kinesis Stream provided an ARN
*
* @param scope The parent creating construct (usually `this`).
* @param id The construct's name
* @param streamArn Stream ARN (i.e. arn:aws:kinesis:<region>:<account-id>:stream/Foo)
*/
public static fromStreamArn(scope: Construct, id: string, streamArn: string): IStream {
return Stream.fromStreamAttributes(scope, id, { streamArn });
}
Expand Down
4 changes: 0 additions & 4 deletions packages/@aws-cdk/aws-kinesis/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -87,10 +87,6 @@
"stability": "experimental",
"awslint": {
"exclude": [
"docs-public-apis:@aws-cdk/aws-kinesis.Stream.fromStreamArn",
"docs-public-apis:@aws-cdk/aws-kinesis.IStream",
"props-default-doc:@aws-cdk/aws-kinesis.StreamAttributes.encryptionKey",
"docs-public-apis:@aws-cdk/aws-kinesis.StreamProps"
]
}
}