@aws-solutions-constructs/core
Version:
Core CDK Construct for patterns library
43 lines (42 loc) • 1.88 kB
TypeScript
/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance
* with the License. A copy of the License is located at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* or in the 'license' file accompanying this file. This file is distributed on an 'AS IS' BASIS, WITHOUT WARRANTIES
* OR CONDITIONS OF ANY KIND, express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
import * as kinesis from 'aws-cdk-lib/aws-kinesis';
import * as cloudwatch from 'aws-cdk-lib/aws-cloudwatch';
import { Construct } from 'constructs';
export interface BuildKinesisStreamProps {
/**
* Existing instance of Kinesis Stream, providing both this and `kinesisStreamProps` will cause an error.
*
* @default - None
*/
readonly existingStreamObj?: kinesis.Stream;
/**
* Optional user provided props to override the default props for the Kinesis stream.
*
* @default - Default props are used.
*/
readonly kinesisStreamProps?: kinesis.StreamProps;
}
/**
* @internal This is an internal core function and should not be called directly by Solutions Constructs clients.
*/
export declare function buildKinesisStream(scope: Construct, props: BuildKinesisStreamProps): kinesis.Stream;
/**
* @internal This is an internal core function and should not be called directly by Solutions Constructs clients.
*/
export declare function buildKinesisStreamCWAlarms(scope: Construct): cloudwatch.Alarm[];
export interface KinesisStreamProps {
readonly existingStreamObj?: kinesis.Stream;
readonly kinesisStreamProps?: kinesis.StreamProps;
}
export declare function CheckKinesisStreamProps(propsObject: KinesisStreamProps | any): void;