@cdktf/provider-aws
Version:
Prebuilt aws Provider for Terraform CDK (cdktf)
129 lines (128 loc) • 6.42 kB
TypeScript
/**
* Copyright (c) HashiCorp, Inc.
* SPDX-License-Identifier: MPL-2.0
*/
import { Construct } from 'constructs';
import * as cdktf from 'cdktf';
export interface DataAwsKinesisStreamConfig extends cdktf.TerraformMetaArguments {
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/data-sources/kinesis_stream#id DataAwsKinesisStream#id}
*
* Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2.
* If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.
*/
readonly id?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/data-sources/kinesis_stream#name DataAwsKinesisStream#name}
*/
readonly name: string;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the [provider configuration](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#aws-configuration-reference).
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/data-sources/kinesis_stream#region DataAwsKinesisStream#region}
*/
readonly region?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/data-sources/kinesis_stream#tags DataAwsKinesisStream#tags}
*/
readonly tags?: {
[key: string]: string;
};
}
export interface DataAwsKinesisStreamStreamModeDetails {
}
export declare function dataAwsKinesisStreamStreamModeDetailsToTerraform(struct?: DataAwsKinesisStreamStreamModeDetails): any;
export declare function dataAwsKinesisStreamStreamModeDetailsToHclTerraform(struct?: DataAwsKinesisStreamStreamModeDetails): any;
export declare class DataAwsKinesisStreamStreamModeDetailsOutputReference extends cdktf.ComplexObject {
private isEmptyObject;
/**
* @param terraformResource The parent resource
* @param terraformAttribute The attribute on the parent resource this class is referencing
* @param complexObjectIndex the index of this item in the list
* @param complexObjectIsFromSet whether the list is wrapping a set (will add tolist() to be able to access an item via an index)
*/
constructor(terraformResource: cdktf.IInterpolatingParent, terraformAttribute: string, complexObjectIndex: number, complexObjectIsFromSet: boolean);
get internalValue(): DataAwsKinesisStreamStreamModeDetails | undefined;
set internalValue(value: DataAwsKinesisStreamStreamModeDetails | undefined);
get streamMode(): string;
}
export declare class DataAwsKinesisStreamStreamModeDetailsList extends cdktf.ComplexList {
protected terraformResource: cdktf.IInterpolatingParent;
protected terraformAttribute: string;
protected wrapsSet: boolean;
/**
* @param terraformResource The parent resource
* @param terraformAttribute The attribute on the parent resource this class is referencing
* @param wrapsSet whether the list is wrapping a set (will add tolist() to be able to access an item via an index)
*/
constructor(terraformResource: cdktf.IInterpolatingParent, terraformAttribute: string, wrapsSet: boolean);
/**
* @param index the index of the item to return
*/
get(index: number): DataAwsKinesisStreamStreamModeDetailsOutputReference;
}
/**
* Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/data-sources/kinesis_stream aws_kinesis_stream}
*/
export declare class DataAwsKinesisStream extends cdktf.TerraformDataSource {
static readonly tfResourceType = "aws_kinesis_stream";
/**
* Generates CDKTF code for importing a DataAwsKinesisStream resource upon running "cdktf plan <stack-name>"
* @param scope The scope in which to define this construct
* @param importToId The construct id used in the generated config for the DataAwsKinesisStream to import
* @param importFromId The id of the existing DataAwsKinesisStream that should be imported. Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/data-sources/kinesis_stream#import import section} in the documentation of this resource for the id to use
* @param provider? Optional instance of the provider where the DataAwsKinesisStream to import is found
*/
static generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: cdktf.TerraformProvider): cdktf.ImportableResource;
/**
* Create a new {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/data-sources/kinesis_stream aws_kinesis_stream} Data Source
*
* @param scope The scope in which to define this construct
* @param id The scoped construct ID. Must be unique amongst siblings in the same scope
* @param options DataAwsKinesisStreamConfig
*/
constructor(scope: Construct, id: string, config: DataAwsKinesisStreamConfig);
get arn(): string;
get closedShards(): string[];
get creationTimestamp(): number;
get encryptionType(): string;
private _id?;
get id(): string;
set id(value: string);
resetId(): void;
get idInput(): string | undefined;
get kmsKeyId(): string;
get maxRecordSizeInKib(): number;
private _name?;
get name(): string;
set name(value: string);
get nameInput(): string | undefined;
get openShards(): string[];
private _region?;
get region(): string;
set region(value: string);
resetRegion(): void;
get regionInput(): string | undefined;
get retentionPeriod(): number;
get shardLevelMetrics(): string[];
get status(): string;
private _streamModeDetails;
get streamModeDetails(): DataAwsKinesisStreamStreamModeDetailsList;
private _tags?;
get tags(): {
[key: string]: string;
};
set tags(value: {
[key: string]: string;
});
resetTags(): void;
get tagsInput(): {
[key: string]: string;
} | undefined;
protected synthesizeAttributes(): {
[name: string]: any;
};
protected synthesizeHclAttributes(): {
[name: string]: any;
};
}