Documentation
¶
Index ¶
- func NewVpnGatewayAvailabilityZonesOutputReference_Override(v VpnGatewayAvailabilityZonesOutputReference, ...)
- func NewVpnGatewayBgpOutputReference_Override(v VpnGatewayBgpOutputReference, terraformResource cdktf.IInterpolatingParent, ...)
- func NewVpnGateway_Override(v VpnGateway, scope constructs.Construct, id *string, config *VpnGatewayConfig)
- func VpnGateway_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, ...) cdktf.ImportableResource
- func VpnGateway_IsConstruct(x interface{}) *bool
- func VpnGateway_IsTerraformElement(x interface{}) *bool
- func VpnGateway_IsTerraformResource(x interface{}) *bool
- func VpnGateway_TfResourceType() *string
- type VpnGateway
- type VpnGatewayAvailabilityZones
- type VpnGatewayAvailabilityZonesOutputReference
- type VpnGatewayBgp
- type VpnGatewayBgpOutputReference
- type VpnGatewayConfig
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewVpnGatewayAvailabilityZonesOutputReference_Override ¶
func NewVpnGatewayAvailabilityZonesOutputReference_Override(v VpnGatewayAvailabilityZonesOutputReference, terraformResource cdktf.IInterpolatingParent, terraformAttribute *string)
func NewVpnGatewayBgpOutputReference_Override ¶
func NewVpnGatewayBgpOutputReference_Override(v VpnGatewayBgpOutputReference, terraformResource cdktf.IInterpolatingParent, terraformAttribute *string)
func NewVpnGateway_Override ¶
func NewVpnGateway_Override(v VpnGateway, scope constructs.Construct, id *string, config *VpnGatewayConfig)
Create a new {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.101.0/docs/resources/vpn_gateway stackit_vpn_gateway} Resource.
func VpnGateway_GenerateConfigForImport ¶
func VpnGateway_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, provider cdktf.TerraformProvider) cdktf.ImportableResource
Generates CDKTF code for importing a VpnGateway resource upon running "cdktf plan <stack-name>".
func VpnGateway_IsConstruct ¶
func VpnGateway_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func VpnGateway_IsTerraformElement ¶
func VpnGateway_IsTerraformElement(x interface{}) *bool
Experimental.
func VpnGateway_IsTerraformResource ¶
func VpnGateway_IsTerraformResource(x interface{}) *bool
Experimental.
func VpnGateway_TfResourceType ¶
func VpnGateway_TfResourceType() *string
Types ¶
type VpnGateway ¶
type VpnGateway interface {
cdktf.TerraformResource
AvailabilityZones() VpnGatewayAvailabilityZonesOutputReference
AvailabilityZonesInput() interface{}
Bgp() VpnGatewayBgpOutputReference
BgpInput() interface{}
// Experimental.
CdktfStack() cdktf.TerraformStack
// Experimental.
Connection() interface{}
// Experimental.
SetConnection(val interface{})
// Experimental.
ConstructNodeMetadata() *map[string]interface{}
// Experimental.
Count() interface{}
// Experimental.
SetCount(val interface{})
// Experimental.
DependsOn() *[]*string
// Experimental.
SetDependsOn(val *[]*string)
DisplayName() *string
SetDisplayName(val *string)
DisplayNameInput() *string
// Experimental.
ForEach() cdktf.ITerraformIterator
// Experimental.
SetForEach(val cdktf.ITerraformIterator)
// Experimental.
Fqn() *string
// Experimental.
FriendlyUniqueId() *string
GatewayId() *string
Id() *string
Labels() *map[string]*string
SetLabels(val *map[string]*string)
LabelsInput() *map[string]*string
// Experimental.
Lifecycle() *cdktf.TerraformResourceLifecycle
// Experimental.
SetLifecycle(val *cdktf.TerraformResourceLifecycle)
// The tree node.
Node() constructs.Node
PlanId() *string
SetPlanId(val *string)
PlanIdInput() *string
ProjectId() *string
SetProjectId(val *string)
ProjectIdInput() *string
// Experimental.
Provider() cdktf.TerraformProvider
// Experimental.
SetProvider(val cdktf.TerraformProvider)
// Experimental.
Provisioners() *[]interface{}
// Experimental.
SetProvisioners(val *[]interface{})
// Experimental.
RawOverrides() interface{}
Region() *string
SetRegion(val *string)
RegionInput() *string
RoutingType() *string
SetRoutingType(val *string)
RoutingTypeInput() *string
// Experimental.
TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
// Experimental.
TerraformMetaArguments() *map[string]interface{}
// Experimental.
TerraformResourceType() *string
// Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
// Experimental.
AddMoveTarget(moveTarget *string)
// Experimental.
AddOverride(path *string, value interface{})
// Experimental.
GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
// Experimental.
GetBooleanAttribute(terraformAttribute *string) cdktf.IResolvable
// Experimental.
GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
// Experimental.
GetListAttribute(terraformAttribute *string) *[]*string
// Experimental.
GetNumberAttribute(terraformAttribute *string) *float64
// Experimental.
GetNumberListAttribute(terraformAttribute *string) *[]*float64
// Experimental.
GetNumberMapAttribute(terraformAttribute *string) *map[string]*float64
// Experimental.
GetStringAttribute(terraformAttribute *string) *string
// Experimental.
GetStringMapAttribute(terraformAttribute *string) *map[string]*string
// Experimental.
HasResourceMove() interface{}
// Experimental.
ImportFrom(id *string, provider cdktf.TerraformProvider)
// Experimental.
InterpolationForAttribute(terraformAttribute *string) cdktf.IResolvable
// Move the resource corresponding to "id" to this resource.
//
// Note that the resource being moved from must be marked as moved using it's instance function.
// Experimental.
MoveFromId(id *string)
// Moves this resource to the target resource given by moveTarget.
// Experimental.
MoveTo(moveTarget *string, index interface{})
// Moves this resource to the resource corresponding to "id".
// Experimental.
MoveToId(id *string)
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
PutAvailabilityZones(value *VpnGatewayAvailabilityZones)
PutBgp(value *VpnGatewayBgp)
ResetBgp()
ResetLabels()
// Resets a previously passed logical Id to use the auto-generated logical id again.
// Experimental.
ResetOverrideLogicalId()
ResetRegion()
SynthesizeAttributes() *map[string]interface{}
SynthesizeHclAttributes() *map[string]interface{}
// Experimental.
ToHclTerraform() interface{}
// Experimental.
ToMetadata() interface{}
// Returns a string representation of this construct.
ToString() *string
// Adds this resource to the terraform JSON output.
// Experimental.
ToTerraform() interface{}
}
Represents a {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.101.0/docs/resources/vpn_gateway stackit_vpn_gateway}.
func NewVpnGateway ¶
func NewVpnGateway(scope constructs.Construct, id *string, config *VpnGatewayConfig) VpnGateway
Create a new {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.101.0/docs/resources/vpn_gateway stackit_vpn_gateway} Resource.
type VpnGatewayAvailabilityZones ¶
type VpnGatewayAvailabilityZones struct {
// Availability zone for tunnel 1.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.101.0/docs/resources/vpn_gateway#tunnel1 VpnGateway#tunnel1}
Tunnel1 *string `field:"required" json:"tunnel1" yaml:"tunnel1"`
// Availability zone for tunnel 2.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.101.0/docs/resources/vpn_gateway#tunnel2 VpnGateway#tunnel2}
Tunnel2 *string `field:"required" json:"tunnel2" yaml:"tunnel2"`
}
type VpnGatewayAvailabilityZonesOutputReference ¶
type VpnGatewayAvailabilityZonesOutputReference interface {
cdktf.ComplexObject
// the index of the complex object in a list.
// Experimental.
ComplexObjectIndex() interface{}
// Experimental.
SetComplexObjectIndex(val interface{})
// set to true if this item is from inside a set and needs tolist() for accessing it set to "0" for single list items.
// Experimental.
ComplexObjectIsFromSet() *bool
// Experimental.
SetComplexObjectIsFromSet(val *bool)
// The creation stack of this resolvable which will be appended to errors thrown during resolution.
//
// If this returns an empty array the stack will not be attached.
// Experimental.
CreationStack() *[]*string
// Experimental.
Fqn() *string
InternalValue() interface{}
SetInternalValue(val interface{})
// Experimental.
TerraformAttribute() *string
// Experimental.
SetTerraformAttribute(val *string)
// Experimental.
TerraformResource() cdktf.IInterpolatingParent
// Experimental.
SetTerraformResource(val cdktf.IInterpolatingParent)
Tunnel1() *string
SetTunnel1(val *string)
Tunnel1Input() *string
Tunnel2() *string
SetTunnel2(val *string)
Tunnel2Input() *string
// Experimental.
ComputeFqn() *string
// Experimental.
GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
// Experimental.
GetBooleanAttribute(terraformAttribute *string) cdktf.IResolvable
// Experimental.
GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
// Experimental.
GetListAttribute(terraformAttribute *string) *[]*string
// Experimental.
GetNumberAttribute(terraformAttribute *string) *float64
// Experimental.
GetNumberListAttribute(terraformAttribute *string) *[]*float64
// Experimental.
GetNumberMapAttribute(terraformAttribute *string) *map[string]*float64
// Experimental.
GetStringAttribute(terraformAttribute *string) *string
// Experimental.
GetStringMapAttribute(terraformAttribute *string) *map[string]*string
// Experimental.
InterpolationAsList() cdktf.IResolvable
// Experimental.
InterpolationForAttribute(property *string) cdktf.IResolvable
// Produce the Token's value at resolution time.
// Experimental.
Resolve(_context cdktf.IResolveContext) interface{}
// Return a string representation of this resolvable object.
//
// Returns a reversible string representation.
// Experimental.
ToString() *string
}
func NewVpnGatewayAvailabilityZonesOutputReference ¶
func NewVpnGatewayAvailabilityZonesOutputReference(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string) VpnGatewayAvailabilityZonesOutputReference
type VpnGatewayBgp ¶
type VpnGatewayBgp struct {
// Local ASN for BGP (private ASN range, 64512-4294967294).
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.101.0/docs/resources/vpn_gateway#local_asn VpnGateway#local_asn}
LocalAsn *float64 `field:"required" json:"localAsn" yaml:"localAsn"`
// List of IPv4 CIDRs to advertise via BGP. If omitted, SNA network ranges are advertised.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.101.0/docs/resources/vpn_gateway#override_advertised_routes VpnGateway#override_advertised_routes}
OverrideAdvertisedRoutes *[]*string `field:"optional" json:"overrideAdvertisedRoutes" yaml:"overrideAdvertisedRoutes"`
}
type VpnGatewayBgpOutputReference ¶
type VpnGatewayBgpOutputReference interface {
cdktf.ComplexObject
// the index of the complex object in a list.
// Experimental.
ComplexObjectIndex() interface{}
// Experimental.
SetComplexObjectIndex(val interface{})
// set to true if this item is from inside a set and needs tolist() for accessing it set to "0" for single list items.
// Experimental.
ComplexObjectIsFromSet() *bool
// Experimental.
SetComplexObjectIsFromSet(val *bool)
// The creation stack of this resolvable which will be appended to errors thrown during resolution.
//
// If this returns an empty array the stack will not be attached.
// Experimental.
CreationStack() *[]*string
// Experimental.
Fqn() *string
InternalValue() interface{}
SetInternalValue(val interface{})
LocalAsn() *float64
SetLocalAsn(val *float64)
LocalAsnInput() *float64
OverrideAdvertisedRoutes() *[]*string
SetOverrideAdvertisedRoutes(val *[]*string)
OverrideAdvertisedRoutesInput() *[]*string
// Experimental.
TerraformAttribute() *string
// Experimental.
SetTerraformAttribute(val *string)
// Experimental.
TerraformResource() cdktf.IInterpolatingParent
// Experimental.
SetTerraformResource(val cdktf.IInterpolatingParent)
// Experimental.
ComputeFqn() *string
// Experimental.
GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
// Experimental.
GetBooleanAttribute(terraformAttribute *string) cdktf.IResolvable
// Experimental.
GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
// Experimental.
GetListAttribute(terraformAttribute *string) *[]*string
// Experimental.
GetNumberAttribute(terraformAttribute *string) *float64
// Experimental.
GetNumberListAttribute(terraformAttribute *string) *[]*float64
// Experimental.
GetNumberMapAttribute(terraformAttribute *string) *map[string]*float64
// Experimental.
GetStringAttribute(terraformAttribute *string) *string
// Experimental.
GetStringMapAttribute(terraformAttribute *string) *map[string]*string
// Experimental.
InterpolationAsList() cdktf.IResolvable
// Experimental.
InterpolationForAttribute(property *string) cdktf.IResolvable
ResetOverrideAdvertisedRoutes()
// Produce the Token's value at resolution time.
// Experimental.
Resolve(_context cdktf.IResolveContext) interface{}
// Return a string representation of this resolvable object.
//
// Returns a reversible string representation.
// Experimental.
ToString() *string
}
func NewVpnGatewayBgpOutputReference ¶
func NewVpnGatewayBgpOutputReference(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string) VpnGatewayBgpOutputReference
type VpnGatewayConfig ¶
type VpnGatewayConfig struct {
// Experimental.
Connection interface{} `field:"optional" json:"connection" yaml:"connection"`
// Experimental.
Count interface{} `field:"optional" json:"count" yaml:"count"`
// Experimental.
DependsOn *[]cdktf.ITerraformDependable `field:"optional" json:"dependsOn" yaml:"dependsOn"`
// Experimental.
ForEach cdktf.ITerraformIterator `field:"optional" json:"forEach" yaml:"forEach"`
// Experimental.
Lifecycle *cdktf.TerraformResourceLifecycle `field:"optional" json:"lifecycle" yaml:"lifecycle"`
// Experimental.
Provider cdktf.TerraformProvider `field:"optional" json:"provider" yaml:"provider"`
// Experimental.
Provisioners *[]interface{} `field:"optional" json:"provisioners" yaml:"provisioners"`
// Availability zones for the two tunnel endpoints.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.101.0/docs/resources/vpn_gateway#availability_zones VpnGateway#availability_zones}
AvailabilityZones *VpnGatewayAvailabilityZones `field:"required" json:"availabilityZones" yaml:"availabilityZones"`
// A user-friendly name for the VPN gateway.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.101.0/docs/resources/vpn_gateway#display_name VpnGateway#display_name}
DisplayName *string `field:"required" json:"displayName" yaml:"displayName"`
// The service plan identifier (e.g. `p500`). For guidance on finding available plans, see [List available service plans](https://docs.stackit.cloud/products/network/connectivity-hybrid-multi-cloud/vpn/getting-started/gateway-create/#list-available-service-plans).
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.101.0/docs/resources/vpn_gateway#plan_id VpnGateway#plan_id}
PlanId *string `field:"required" json:"planId" yaml:"planId"`
// STACKIT project ID associated with the VPN gateway.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.101.0/docs/resources/vpn_gateway#project_id VpnGateway#project_id}
ProjectId *string `field:"required" json:"projectId" yaml:"projectId"`
// Routing architecture. Possible values are: `POLICY_BASED`, `ROUTE_BASED`, `BGP_ROUTE_BASED`.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.101.0/docs/resources/vpn_gateway#routing_type VpnGateway#routing_type}
RoutingType *string `field:"required" json:"routingType" yaml:"routingType"`
// BGP configuration. Only applicable when routing_type is BGP_ROUTE_BASED.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.101.0/docs/resources/vpn_gateway#bgp VpnGateway#bgp}
Bgp *VpnGatewayBgp `field:"optional" json:"bgp" yaml:"bgp"`
// Map of custom labels (key-value string pairs).
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.101.0/docs/resources/vpn_gateway#labels VpnGateway#labels}
Labels *map[string]*string `field:"optional" json:"labels" yaml:"labels"`
// STACKIT region name the resource is located in. If not defined, the provider region is used.
//
// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/stackitcloud/stackit/0.101.0/docs/resources/vpn_gateway#region VpnGateway#region}
Region *string `field:"optional" json:"region" yaml:"region"`
}