Skip to content

VpnGateway

This class encapsulates and extends the ROS resource type ALIYUN::VPC::VpnGatewayThe , which resource creates a vpn gateway.

Initializers

import { VpnGateway } from '@alicloud/ros-cdk-vpc'
new VpnGateway(scope: Construct, id: string, props: VpnGatewayProps, enableResourcePropertyConstraint?: boolean)
Name Type Description
scope @alicloud/ros-cdk-core.Construct No description.
id string No description.
props VpnGatewayProps No description.
enableResourcePropertyConstraint boolean No description.

scopeRequired

  • Type: @alicloud/ros-cdk-core.Construct

idRequired

  • Type: string

propsRequired


enableResourcePropertyConstraintOptional

  • Type: boolean

Methods

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
fetchCondition No description.
fetchDependency No description.
fetchResourceDesc No description.
getAtt No description.
setMetadata No description.

toString

public toString(): string

Returns a string representation of this construct.

synthesize

public synthesize(session: ISynthesisSession): void

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

sessionRequired

  • Type: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.


addCondition

public addCondition(condition: RosCondition): void

conditionRequired

  • Type: @alicloud/ros-cdk-core.RosCondition

addCount

public addCount(count: number | IResolvable): void

countRequired

  • Type: number | @alicloud/ros-cdk-core.IResolvable

addDependency

public addDependency(resource: Resource): void

resourceRequired

  • Type: @alicloud/ros-cdk-core.Resource

addResourceDesc

public addResourceDesc(desc: string): void

descRequired

  • Type: string

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

policyRequired

  • Type: @alicloud/ros-cdk-core.RemovalPolicy

fetchCondition

public fetchCondition(): RosCondition

fetchDependency

public fetchDependency(): string[]

fetchResourceDesc

public fetchResourceDesc(): string

getAtt

public getAtt(name: string): IResolvable

nameRequired

  • Type: string

setMetadata

public setMetadata(key: string, value: any): void

keyRequired

  • Type: string

valueRequired

  • Type: any

Static Functions

Name Description
isConstruct Return whether the given object is a Construct.

isConstruct

import { VpnGateway } from '@alicloud/ros-cdk-vpc'
VpnGateway.isConstruct(x: any)

Return whether the given object is a Construct.

xRequired

  • Type: any

Properties

Name Type Description
node @alicloud/ros-cdk-core.ConstructNode The construct tree node associated with this construct.
env @alicloud/ros-cdk-core.IResourceEnvironment The environment this resource belongs to.
ref string No description.
stack @alicloud/ros-cdk-core.Stack The stack in which this resource is defined.
resource @alicloud/ros-cdk-core.RosResource No description.
attrArn string | @alicloud/ros-cdk-core.IResolvable Attribute Arn: The Alibaba Cloud Resource Name (ARN).
attrDisasterRecoveryInternetIp string | @alicloud/ros-cdk-core.IResolvable Attribute DisasterRecoveryInternetIp: The second IP address assigned by the system to create an IPsec-VPN connection.This attribute is returned only when the VPN gateway supports the dual-tunnel mode.
attrDisasterRecoveryVSwitchId string | @alicloud/ros-cdk-core.IResolvable Attribute DisasterRecoveryVSwitchId: The ID of the second vSwitch associated with the VPN gateway.This attribute is returned only when the VPN gateway supports the dual-tunnel mode.
attrInternetIp string | @alicloud/ros-cdk-core.IResolvable Attribute InternetIp: The public IP address of the VPN gateway.
attrOrderId string | @alicloud/ros-cdk-core.IResolvable Attribute OrderId: The order ID.
attrSpec string | @alicloud/ros-cdk-core.IResolvable Attribute Spec: The specification of the VPN gateway.
attrSslMaxConnections string | @alicloud/ros-cdk-core.IResolvable Attribute SslMaxConnections: The maximum number of concurrent SSL-VPN connections.
attrSslVpnInternetIp string | @alicloud/ros-cdk-core.IResolvable Attribute SslVpnInternetIp: The IP address of the SSL-VPN connection.This attribute is returned only when the VPN gateway is a public VPN gateway and supports only the single-tunnel mode. In addition, the VPN gateway must have the SSL-VPN feature enabled.
attrVpcId string | @alicloud/ros-cdk-core.IResolvable Attribute VpcId: The ID of the virtual private cloud (VPC) to which the VPN gateway belongs.
attrVpnGatewayId string | @alicloud/ros-cdk-core.IResolvable Attribute VpnGatewayId: ID of the VPN gateway.
attrVpnType string | @alicloud/ros-cdk-core.IResolvable Attribute VpnType: The type of the VPN gateway.
attrVSwitchId string | @alicloud/ros-cdk-core.IResolvable Attribute VSwitchId: The ID of the vSwitch to which the VPN gateway belongs.
props VpnGatewayProps No description.

nodeRequired

public readonly node: ConstructNode;
  • Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.


envRequired

public readonly env: IResourceEnvironment;
  • Type: @alicloud/ros-cdk-core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.


refRequired

public readonly ref: string;
  • Type: string

stackRequired

public readonly stack: Stack;
  • Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.


resourceOptional

public readonly resource: RosResource;
  • Type: @alicloud/ros-cdk-core.RosResource

attrArnRequired

public readonly attrArn: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute Arn: The Alibaba Cloud Resource Name (ARN).


attrDisasterRecoveryInternetIpRequired

public readonly attrDisasterRecoveryInternetIp: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute DisasterRecoveryInternetIp: The second IP address assigned by the system to create an IPsec-VPN connection.This attribute is returned only when the VPN gateway supports the dual-tunnel mode.


attrDisasterRecoveryVSwitchIdRequired

public readonly attrDisasterRecoveryVSwitchId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute DisasterRecoveryVSwitchId: The ID of the second vSwitch associated with the VPN gateway.This attribute is returned only when the VPN gateway supports the dual-tunnel mode.


attrInternetIpRequired

public readonly attrInternetIp: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute InternetIp: The public IP address of the VPN gateway.


attrOrderIdRequired

public readonly attrOrderId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute OrderId: The order ID.


attrSpecRequired

public readonly attrSpec: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute Spec: The specification of the VPN gateway.


attrSslMaxConnectionsRequired

public readonly attrSslMaxConnections: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute SslMaxConnections: The maximum number of concurrent SSL-VPN connections.


attrSslVpnInternetIpRequired

public readonly attrSslVpnInternetIp: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute SslVpnInternetIp: The IP address of the SSL-VPN connection.This attribute is returned only when the VPN gateway is a public VPN gateway and supports only the single-tunnel mode. In addition, the VPN gateway must have the SSL-VPN feature enabled.


attrVpcIdRequired

public readonly attrVpcId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute VpcId: The ID of the virtual private cloud (VPC) to which the VPN gateway belongs.


attrVpnGatewayIdRequired

public readonly attrVpnGatewayId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute VpnGatewayId: ID of the VPN gateway.


attrVpnTypeRequired

public readonly attrVpnType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute VpnType: The type of the VPN gateway.


attrVSwitchIdRequired

public readonly attrVSwitchId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Attribute VSwitchId: The ID of the vSwitch to which the VPN gateway belongs.


propsRequired

public readonly props: VpnGatewayProps;