@cdktf/provider-aws
Version:
Prebuilt aws Provider for Terraform CDK (cdktf)
187 lines (186 loc) • 8.62 kB
TypeScript
/**
* Copyright (c) HashiCorp, Inc.
* SPDX-License-Identifier: MPL-2.0
*/
import { Construct } from 'constructs';
import * as cdktf from 'cdktf';
export interface KmsExternalKeyConfig extends cdktf.TerraformMetaArguments {
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/kms_external_key#bypass_policy_lockout_safety_check KmsExternalKey#bypass_policy_lockout_safety_check}
*/
readonly bypassPolicyLockoutSafetyCheck?: boolean | cdktf.IResolvable;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/kms_external_key#deletion_window_in_days KmsExternalKey#deletion_window_in_days}
*/
readonly deletionWindowInDays?: number;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/kms_external_key#description KmsExternalKey#description}
*/
readonly description?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/kms_external_key#enabled KmsExternalKey#enabled}
*/
readonly enabled?: boolean | cdktf.IResolvable;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/kms_external_key#id KmsExternalKey#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/kms_external_key#key_material_base64 KmsExternalKey#key_material_base64}
*/
readonly keyMaterialBase64?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/kms_external_key#key_spec KmsExternalKey#key_spec}
*/
readonly keySpec?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/kms_external_key#key_usage KmsExternalKey#key_usage}
*/
readonly keyUsage?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/kms_external_key#multi_region KmsExternalKey#multi_region}
*/
readonly multiRegion?: boolean | cdktf.IResolvable;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/kms_external_key#policy KmsExternalKey#policy}
*/
readonly policy?: 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/kms_external_key#region KmsExternalKey#region}
*/
readonly region?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/kms_external_key#tags KmsExternalKey#tags}
*/
readonly tags?: {
[key: string]: string;
};
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/kms_external_key#tags_all KmsExternalKey#tags_all}
*/
readonly tagsAll?: {
[key: string]: string;
};
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/kms_external_key#valid_to KmsExternalKey#valid_to}
*/
readonly validTo?: string;
}
/**
* Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/kms_external_key aws_kms_external_key}
*/
export declare class KmsExternalKey extends cdktf.TerraformResource {
static readonly tfResourceType = "aws_kms_external_key";
/**
* Generates CDKTF code for importing a KmsExternalKey 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 KmsExternalKey to import
* @param importFromId The id of the existing KmsExternalKey that should be imported. Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/kms_external_key#import import section} in the documentation of this resource for the id to use
* @param provider? Optional instance of the provider where the KmsExternalKey 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/kms_external_key aws_kms_external_key} 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 KmsExternalKeyConfig = {}
*/
constructor(scope: Construct, id: string, config?: KmsExternalKeyConfig);
get arn(): string;
private _bypassPolicyLockoutSafetyCheck?;
get bypassPolicyLockoutSafetyCheck(): boolean | cdktf.IResolvable;
set bypassPolicyLockoutSafetyCheck(value: boolean | cdktf.IResolvable);
resetBypassPolicyLockoutSafetyCheck(): void;
get bypassPolicyLockoutSafetyCheckInput(): boolean | cdktf.IResolvable | undefined;
private _deletionWindowInDays?;
get deletionWindowInDays(): number;
set deletionWindowInDays(value: number);
resetDeletionWindowInDays(): void;
get deletionWindowInDaysInput(): number | undefined;
private _description?;
get description(): string;
set description(value: string);
resetDescription(): void;
get descriptionInput(): string | undefined;
private _enabled?;
get enabled(): boolean | cdktf.IResolvable;
set enabled(value: boolean | cdktf.IResolvable);
resetEnabled(): void;
get enabledInput(): boolean | cdktf.IResolvable | undefined;
get expirationModel(): string;
private _id?;
get id(): string;
set id(value: string);
resetId(): void;
get idInput(): string | undefined;
private _keyMaterialBase64?;
get keyMaterialBase64(): string;
set keyMaterialBase64(value: string);
resetKeyMaterialBase64(): void;
get keyMaterialBase64Input(): string | undefined;
private _keySpec?;
get keySpec(): string;
set keySpec(value: string);
resetKeySpec(): void;
get keySpecInput(): string | undefined;
get keyState(): string;
private _keyUsage?;
get keyUsage(): string;
set keyUsage(value: string);
resetKeyUsage(): void;
get keyUsageInput(): string | undefined;
private _multiRegion?;
get multiRegion(): boolean | cdktf.IResolvable;
set multiRegion(value: boolean | cdktf.IResolvable);
resetMultiRegion(): void;
get multiRegionInput(): boolean | cdktf.IResolvable | undefined;
private _policy?;
get policy(): string;
set policy(value: string);
resetPolicy(): void;
get policyInput(): string | undefined;
private _region?;
get region(): string;
set region(value: string);
resetRegion(): void;
get regionInput(): 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 _validTo?;
get validTo(): string;
set validTo(value: string);
resetValidTo(): void;
get validToInput(): string | undefined;
protected synthesizeAttributes(): {
[name: string]: any;
};
protected synthesizeHclAttributes(): {
[name: string]: any;
};
}