@cdktf/provider-aws
Version:
Prebuilt aws Provider for Terraform CDK (cdktf)
105 lines (104 loc) • 4.78 kB
TypeScript
/**
* Copyright (c) HashiCorp, Inc.
* SPDX-License-Identifier: MPL-2.0
*/
import { Construct } from 'constructs';
import * as cdktf from 'cdktf';
export interface TransferHostKeyConfig extends cdktf.TerraformMetaArguments {
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/transfer_host_key#description TransferHostKey#description}
*/
readonly description?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/transfer_host_key#host_key_body TransferHostKey#host_key_body}
*/
readonly hostKeyBody?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/transfer_host_key#host_key_body_wo TransferHostKey#host_key_body_wo}
*/
readonly hostKeyBodyWo?: 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/transfer_host_key#region TransferHostKey#region}
*/
readonly region?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/transfer_host_key#server_id TransferHostKey#server_id}
*/
readonly serverId: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/transfer_host_key#tags TransferHostKey#tags}
*/
readonly tags?: {
[key: string]: string;
};
}
/**
* Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/transfer_host_key aws_transfer_host_key}
*/
export declare class TransferHostKey extends cdktf.TerraformResource {
static readonly tfResourceType = "aws_transfer_host_key";
/**
* Generates CDKTF code for importing a TransferHostKey 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 TransferHostKey to import
* @param importFromId The id of the existing TransferHostKey that should be imported. Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/transfer_host_key#import import section} in the documentation of this resource for the id to use
* @param provider? Optional instance of the provider where the TransferHostKey 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/transfer_host_key aws_transfer_host_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 TransferHostKeyConfig
*/
constructor(scope: Construct, id: string, config: TransferHostKeyConfig);
get arn(): string;
private _description?;
get description(): string;
set description(value: string);
resetDescription(): void;
get descriptionInput(): string | undefined;
private _hostKeyBody?;
get hostKeyBody(): string;
set hostKeyBody(value: string);
resetHostKeyBody(): void;
get hostKeyBodyInput(): string | undefined;
private _hostKeyBodyWo?;
get hostKeyBodyWo(): string;
set hostKeyBodyWo(value: string);
resetHostKeyBodyWo(): void;
get hostKeyBodyWoInput(): string | undefined;
get hostKeyFingerprint(): string;
get hostKeyId(): string;
private _region?;
get region(): string;
set region(value: string);
resetRegion(): void;
get regionInput(): string | undefined;
private _serverId?;
get serverId(): string;
set serverId(value: string);
get serverIdInput(): 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(): cdktf.StringMap;
protected synthesizeAttributes(): {
[name: string]: any;
};
protected synthesizeHclAttributes(): {
[name: string]: any;
};
}