@cdktf/provider-aws
Version:
Prebuilt aws Provider for Terraform CDK (cdktf)
254 lines (253 loc) • 12.1 kB
TypeScript
/**
* Copyright (c) HashiCorp, Inc.
* SPDX-License-Identifier: MPL-2.0
*/
import { Construct } from 'constructs';
import * as cdktf from 'cdktf';
export interface DxPrivateVirtualInterfaceConfig extends cdktf.TerraformMetaArguments {
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/dx_private_virtual_interface#address_family DxPrivateVirtualInterface#address_family}
*/
readonly addressFamily: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/dx_private_virtual_interface#amazon_address DxPrivateVirtualInterface#amazon_address}
*/
readonly amazonAddress?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/dx_private_virtual_interface#bgp_asn DxPrivateVirtualInterface#bgp_asn}
*/
readonly bgpAsn: number;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/dx_private_virtual_interface#bgp_auth_key DxPrivateVirtualInterface#bgp_auth_key}
*/
readonly bgpAuthKey?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/dx_private_virtual_interface#connection_id DxPrivateVirtualInterface#connection_id}
*/
readonly connectionId: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/dx_private_virtual_interface#customer_address DxPrivateVirtualInterface#customer_address}
*/
readonly customerAddress?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/dx_private_virtual_interface#dx_gateway_id DxPrivateVirtualInterface#dx_gateway_id}
*/
readonly dxGatewayId?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/dx_private_virtual_interface#id DxPrivateVirtualInterface#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/dx_private_virtual_interface#mtu DxPrivateVirtualInterface#mtu}
*/
readonly mtu?: number;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/dx_private_virtual_interface#name DxPrivateVirtualInterface#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/resources/dx_private_virtual_interface#region DxPrivateVirtualInterface#region}
*/
readonly region?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/dx_private_virtual_interface#sitelink_enabled DxPrivateVirtualInterface#sitelink_enabled}
*/
readonly sitelinkEnabled?: boolean | cdktf.IResolvable;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/dx_private_virtual_interface#tags DxPrivateVirtualInterface#tags}
*/
readonly tags?: {
[key: string]: string;
};
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/dx_private_virtual_interface#tags_all DxPrivateVirtualInterface#tags_all}
*/
readonly tagsAll?: {
[key: string]: string;
};
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/dx_private_virtual_interface#vlan DxPrivateVirtualInterface#vlan}
*/
readonly vlan: number;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/dx_private_virtual_interface#vpn_gateway_id DxPrivateVirtualInterface#vpn_gateway_id}
*/
readonly vpnGatewayId?: string;
/**
* timeouts block
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/dx_private_virtual_interface#timeouts DxPrivateVirtualInterface#timeouts}
*/
readonly timeouts?: DxPrivateVirtualInterfaceTimeouts;
}
export interface DxPrivateVirtualInterfaceTimeouts {
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/dx_private_virtual_interface#create DxPrivateVirtualInterface#create}
*/
readonly create?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/dx_private_virtual_interface#delete DxPrivateVirtualInterface#delete}
*/
readonly delete?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/dx_private_virtual_interface#update DxPrivateVirtualInterface#update}
*/
readonly update?: string;
}
export declare function dxPrivateVirtualInterfaceTimeoutsToTerraform(struct?: DxPrivateVirtualInterfaceTimeouts | cdktf.IResolvable): any;
export declare function dxPrivateVirtualInterfaceTimeoutsToHclTerraform(struct?: DxPrivateVirtualInterfaceTimeouts | cdktf.IResolvable): any;
export declare class DxPrivateVirtualInterfaceTimeoutsOutputReference 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(): DxPrivateVirtualInterfaceTimeouts | cdktf.IResolvable | undefined;
set internalValue(value: DxPrivateVirtualInterfaceTimeouts | 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/dx_private_virtual_interface aws_dx_private_virtual_interface}
*/
export declare class DxPrivateVirtualInterface extends cdktf.TerraformResource {
static readonly tfResourceType = "aws_dx_private_virtual_interface";
/**
* Generates CDKTF code for importing a DxPrivateVirtualInterface 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 DxPrivateVirtualInterface to import
* @param importFromId The id of the existing DxPrivateVirtualInterface that should be imported. Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/dx_private_virtual_interface#import import section} in the documentation of this resource for the id to use
* @param provider? Optional instance of the provider where the DxPrivateVirtualInterface 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/dx_private_virtual_interface aws_dx_private_virtual_interface} 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 DxPrivateVirtualInterfaceConfig
*/
constructor(scope: Construct, id: string, config: DxPrivateVirtualInterfaceConfig);
private _addressFamily?;
get addressFamily(): string;
set addressFamily(value: string);
get addressFamilyInput(): string | undefined;
private _amazonAddress?;
get amazonAddress(): string;
set amazonAddress(value: string);
resetAmazonAddress(): void;
get amazonAddressInput(): string | undefined;
get amazonSideAsn(): string;
get arn(): string;
get awsDevice(): string;
private _bgpAsn?;
get bgpAsn(): number;
set bgpAsn(value: number);
get bgpAsnInput(): number | undefined;
private _bgpAuthKey?;
get bgpAuthKey(): string;
set bgpAuthKey(value: string);
resetBgpAuthKey(): void;
get bgpAuthKeyInput(): string | undefined;
private _connectionId?;
get connectionId(): string;
set connectionId(value: string);
get connectionIdInput(): string | undefined;
private _customerAddress?;
get customerAddress(): string;
set customerAddress(value: string);
resetCustomerAddress(): void;
get customerAddressInput(): string | undefined;
private _dxGatewayId?;
get dxGatewayId(): string;
set dxGatewayId(value: string);
resetDxGatewayId(): void;
get dxGatewayIdInput(): string | undefined;
private _id?;
get id(): string;
set id(value: string);
resetId(): void;
get idInput(): string | undefined;
get jumboFrameCapable(): cdktf.IResolvable;
private _mtu?;
get mtu(): number;
set mtu(value: number);
resetMtu(): void;
get mtuInput(): number | undefined;
private _name?;
get name(): string;
set name(value: string);
get nameInput(): string | undefined;
private _region?;
get region(): string;
set region(value: string);
resetRegion(): void;
get regionInput(): string | undefined;
private _sitelinkEnabled?;
get sitelinkEnabled(): boolean | cdktf.IResolvable;
set sitelinkEnabled(value: boolean | cdktf.IResolvable);
resetSitelinkEnabled(): void;
get sitelinkEnabledInput(): boolean | cdktf.IResolvable | 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 _vlan?;
get vlan(): number;
set vlan(value: number);
get vlanInput(): number | undefined;
private _vpnGatewayId?;
get vpnGatewayId(): string;
set vpnGatewayId(value: string);
resetVpnGatewayId(): void;
get vpnGatewayIdInput(): string | undefined;
private _timeouts;
get timeouts(): DxPrivateVirtualInterfaceTimeoutsOutputReference;
putTimeouts(value: DxPrivateVirtualInterfaceTimeouts): void;
resetTimeouts(): void;
get timeoutsInput(): cdktf.IResolvable | DxPrivateVirtualInterfaceTimeouts | undefined;
protected synthesizeAttributes(): {
[name: string]: any;
};
protected synthesizeHclAttributes(): {
[name: string]: any;
};
}