@cdktf/provider-aws
Version:
Prebuilt aws Provider for Terraform CDK (cdktf)
256 lines (255 loc) • 11.3 kB
TypeScript
/**
* Copyright (c) HashiCorp, Inc.
* SPDX-License-Identifier: MPL-2.0
*/
import { Construct } from 'constructs';
import * as cdktf from 'cdktf';
export interface EbsVolumeConfig extends cdktf.TerraformMetaArguments {
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/ebs_volume#availability_zone EbsVolume#availability_zone}
*/
readonly availabilityZone: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/ebs_volume#encrypted EbsVolume#encrypted}
*/
readonly encrypted?: boolean | cdktf.IResolvable;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/ebs_volume#final_snapshot EbsVolume#final_snapshot}
*/
readonly finalSnapshot?: boolean | cdktf.IResolvable;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/ebs_volume#id EbsVolume#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/resources/ebs_volume#iops EbsVolume#iops}
*/
readonly iops?: number;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/ebs_volume#kms_key_id EbsVolume#kms_key_id}
*/
readonly kmsKeyId?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/ebs_volume#multi_attach_enabled EbsVolume#multi_attach_enabled}
*/
readonly multiAttachEnabled?: boolean | cdktf.IResolvable;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/ebs_volume#outpost_arn EbsVolume#outpost_arn}
*/
readonly outpostArn?: 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/resources/ebs_volume#region EbsVolume#region}
*/
readonly region?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/ebs_volume#size EbsVolume#size}
*/
readonly size?: number;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/ebs_volume#snapshot_id EbsVolume#snapshot_id}
*/
readonly snapshotId?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/ebs_volume#tags EbsVolume#tags}
*/
readonly tags?: {
[key: string]: string;
};
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/ebs_volume#tags_all EbsVolume#tags_all}
*/
readonly tagsAll?: {
[key: string]: string;
};
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/ebs_volume#throughput EbsVolume#throughput}
*/
readonly throughput?: number;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/ebs_volume#type EbsVolume#type}
*/
readonly type?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/ebs_volume#volume_initialization_rate EbsVolume#volume_initialization_rate}
*/
readonly volumeInitializationRate?: number;
/**
* timeouts block
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/ebs_volume#timeouts EbsVolume#timeouts}
*/
readonly timeouts?: EbsVolumeTimeouts;
}
export interface EbsVolumeTimeouts {
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/ebs_volume#create EbsVolume#create}
*/
readonly create?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/ebs_volume#delete EbsVolume#delete}
*/
readonly delete?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/ebs_volume#update EbsVolume#update}
*/
readonly update?: string;
}
export declare function ebsVolumeTimeoutsToTerraform(struct?: EbsVolumeTimeouts | cdktf.IResolvable): any;
export declare function ebsVolumeTimeoutsToHclTerraform(struct?: EbsVolumeTimeouts | cdktf.IResolvable): any;
export declare class EbsVolumeTimeoutsOutputReference extends cdktf.ComplexObject {
private isEmptyObject;
private resolvableValue?;
/**
* @param terraformResource The parent resource
* @param terraformAttribute The attribute on the parent resource this class is referencing
*/
constructor(terraformResource: cdktf.IInterpolatingParent, terraformAttribute: string);
get internalValue(): EbsVolumeTimeouts | cdktf.IResolvable | undefined;
set internalValue(value: EbsVolumeTimeouts | cdktf.IResolvable | undefined);
private _create?;
get create(): string;
set create(value: string);
resetCreate(): void;
get createInput(): string | undefined;
private _delete?;
get delete(): string;
set delete(value: string);
resetDelete(): void;
get deleteInput(): string | undefined;
private _update?;
get update(): string;
set update(value: string);
resetUpdate(): void;
get updateInput(): string | undefined;
}
/**
* Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/ebs_volume aws_ebs_volume}
*/
export declare class EbsVolume extends cdktf.TerraformResource {
static readonly tfResourceType = "aws_ebs_volume";
/**
* Generates CDKTF code for importing a EbsVolume 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 EbsVolume to import
* @param importFromId The id of the existing EbsVolume that should be imported. Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/ebs_volume#import import section} in the documentation of this resource for the id to use
* @param provider? Optional instance of the provider where the EbsVolume 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/resources/ebs_volume aws_ebs_volume} Resource
*
* @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 EbsVolumeConfig
*/
constructor(scope: Construct, id: string, config: EbsVolumeConfig);
get arn(): string;
private _availabilityZone?;
get availabilityZone(): string;
set availabilityZone(value: string);
get availabilityZoneInput(): string | undefined;
get createTime(): string;
private _encrypted?;
get encrypted(): boolean | cdktf.IResolvable;
set encrypted(value: boolean | cdktf.IResolvable);
resetEncrypted(): void;
get encryptedInput(): boolean | cdktf.IResolvable | undefined;
private _finalSnapshot?;
get finalSnapshot(): boolean | cdktf.IResolvable;
set finalSnapshot(value: boolean | cdktf.IResolvable);
resetFinalSnapshot(): void;
get finalSnapshotInput(): boolean | cdktf.IResolvable | undefined;
private _id?;
get id(): string;
set id(value: string);
resetId(): void;
get idInput(): string | undefined;
private _iops?;
get iops(): number;
set iops(value: number);
resetIops(): void;
get iopsInput(): number | undefined;
private _kmsKeyId?;
get kmsKeyId(): string;
set kmsKeyId(value: string);
resetKmsKeyId(): void;
get kmsKeyIdInput(): string | undefined;
private _multiAttachEnabled?;
get multiAttachEnabled(): boolean | cdktf.IResolvable;
set multiAttachEnabled(value: boolean | cdktf.IResolvable);
resetMultiAttachEnabled(): void;
get multiAttachEnabledInput(): boolean | cdktf.IResolvable | undefined;
private _outpostArn?;
get outpostArn(): string;
set outpostArn(value: string);
resetOutpostArn(): void;
get outpostArnInput(): string | undefined;
private _region?;
get region(): string;
set region(value: string);
resetRegion(): void;
get regionInput(): string | undefined;
private _size?;
get size(): number;
set size(value: number);
resetSize(): void;
get sizeInput(): number | undefined;
private _snapshotId?;
get snapshotId(): string;
set snapshotId(value: string);
resetSnapshotId(): void;
get snapshotIdInput(): string | undefined;
private _tags?;
get tags(): {
[key: string]: string;
};
set tags(value: {
[key: string]: string;
});
resetTags(): void;
get tagsInput(): {
[key: string]: string;
} | undefined;
private _tagsAll?;
get tagsAll(): {
[key: string]: string;
};
set tagsAll(value: {
[key: string]: string;
});
resetTagsAll(): void;
get tagsAllInput(): {
[key: string]: string;
} | undefined;
private _throughput?;
get throughput(): number;
set throughput(value: number);
resetThroughput(): void;
get throughputInput(): number | undefined;
private _type?;
get type(): string;
set type(value: string);
resetType(): void;
get typeInput(): string | undefined;
private _volumeInitializationRate?;
get volumeInitializationRate(): number;
set volumeInitializationRate(value: number);
resetVolumeInitializationRate(): void;
get volumeInitializationRateInput(): number | undefined;
private _timeouts;
get timeouts(): EbsVolumeTimeoutsOutputReference;
putTimeouts(value: EbsVolumeTimeouts): void;
resetTimeouts(): void;
get timeoutsInput(): cdktf.IResolvable | EbsVolumeTimeouts | undefined;
protected synthesizeAttributes(): {
[name: string]: any;
};
protected synthesizeHclAttributes(): {
[name: string]: any;
};
}