@cdktf/provider-aws
Version:
Prebuilt aws Provider for Terraform CDK (cdktf)
165 lines (164 loc) • 8.79 kB
TypeScript
/**
* Copyright (c) HashiCorp, Inc.
* SPDX-License-Identifier: MPL-2.0
*/
import { Construct } from 'constructs';
import * as cdktf from 'cdktf';
export interface OdbNetworkPeeringConnectionConfig extends cdktf.TerraformMetaArguments {
/**
* Display name of the odb network peering connection. Changing this will force terraform to create new resource
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/odb_network_peering_connection#display_name OdbNetworkPeeringConnection#display_name}
*/
readonly displayName: string;
/**
* Required field. The unique identifier of the ODB network that initiates the peering connection. A sample ID is odbpcx-abcdefgh12345678. Changing this will force terraform to create new resource.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/odb_network_peering_connection#odb_network_id OdbNetworkPeeringConnection#odb_network_id}
*/
readonly odbNetworkId: string;
/**
* Required field. The unique identifier of the ODB peering connection. Changing this will force terraform to create new resource
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/odb_network_peering_connection#peer_network_id OdbNetworkPeeringConnection#peer_network_id}
*/
readonly peerNetworkId: 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/odb_network_peering_connection#region OdbNetworkPeeringConnection#region}
*/
readonly region?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/odb_network_peering_connection#tags OdbNetworkPeeringConnection#tags}
*/
readonly tags?: {
[key: string]: string;
};
/**
* timeouts block
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/odb_network_peering_connection#timeouts OdbNetworkPeeringConnection#timeouts}
*/
readonly timeouts?: OdbNetworkPeeringConnectionTimeouts;
}
export interface OdbNetworkPeeringConnectionTimeouts {
/**
* A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/odb_network_peering_connection#create OdbNetworkPeeringConnection#create}
*/
readonly create?: string;
/**
* A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/odb_network_peering_connection#delete OdbNetworkPeeringConnection#delete}
*/
readonly delete?: string;
/**
* A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/odb_network_peering_connection#update OdbNetworkPeeringConnection#update}
*/
readonly update?: string;
}
export declare function odbNetworkPeeringConnectionTimeoutsToTerraform(struct?: OdbNetworkPeeringConnectionTimeouts | cdktf.IResolvable): any;
export declare function odbNetworkPeeringConnectionTimeoutsToHclTerraform(struct?: OdbNetworkPeeringConnectionTimeouts | cdktf.IResolvable): any;
export declare class OdbNetworkPeeringConnectionTimeoutsOutputReference 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(): OdbNetworkPeeringConnectionTimeouts | cdktf.IResolvable | undefined;
set internalValue(value: OdbNetworkPeeringConnectionTimeouts | 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/odb_network_peering_connection aws_odb_network_peering_connection}
*/
export declare class OdbNetworkPeeringConnection extends cdktf.TerraformResource {
static readonly tfResourceType = "aws_odb_network_peering_connection";
/**
* Generates CDKTF code for importing a OdbNetworkPeeringConnection 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 OdbNetworkPeeringConnection to import
* @param importFromId The id of the existing OdbNetworkPeeringConnection that should be imported. Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/odb_network_peering_connection#import import section} in the documentation of this resource for the id to use
* @param provider? Optional instance of the provider where the OdbNetworkPeeringConnection 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/odb_network_peering_connection aws_odb_network_peering_connection} 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 OdbNetworkPeeringConnectionConfig
*/
constructor(scope: Construct, id: string, config: OdbNetworkPeeringConnectionConfig);
get arn(): string;
get createdAt(): string;
private _displayName?;
get displayName(): string;
set displayName(value: string);
get displayNameInput(): string | undefined;
get id(): string;
get odbNetworkArn(): string;
private _odbNetworkId?;
get odbNetworkId(): string;
set odbNetworkId(value: string);
get odbNetworkIdInput(): string | undefined;
get odbPeeringConnectionType(): string;
get peerNetworkArn(): string;
private _peerNetworkId?;
get peerNetworkId(): string;
set peerNetworkId(value: string);
get peerNetworkIdInput(): string | undefined;
get percentProgress(): number;
private _region?;
get region(): string;
set region(value: string);
resetRegion(): void;
get regionInput(): string | undefined;
get status(): string;
get statusReason(): string;
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;
private _timeouts;
get timeouts(): OdbNetworkPeeringConnectionTimeoutsOutputReference;
putTimeouts(value: OdbNetworkPeeringConnectionTimeouts): void;
resetTimeouts(): void;
get timeoutsInput(): cdktf.IResolvable | OdbNetworkPeeringConnectionTimeouts | undefined;
protected synthesizeAttributes(): {
[name: string]: any;
};
protected synthesizeHclAttributes(): {
[name: string]: any;
};
}