CustomerGateway

This class encapsulates and extends the ROS resource type DATASOURCE::VPC::CustomerGateway, which is used to query the information about a customer gateway.

Initializers

import { datasource } from '@alicloud/ros-cdk-vpc'
new datasource.CustomerGateway(scope: Construct, id: string, props: CustomerGatewayProps, enableResourcePropertyConstraint?: boolean)

Name	Type	Description
scope	@alicloud/ros-cdk-core.Construct	No description.
id	string	No description.
props	CustomerGatewayProps	No description.
enableResourcePropertyConstraint	boolean	No description.

---

scope^Required

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

---

id^Required

• Type: string

---

props^Required

• Type: CustomerGatewayProps

---

enableResourcePropertyConstraint^Optional

• 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.
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.

session^Required

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

The synthesis session.

---

addCondition

public addCondition(condition: RosCondition): void

condition^Required

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

---

addCount

public addCount(count: number | IResolvable): void

count^Required

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

---

addDependency

public addDependency(resource: Resource): void

resource^Required

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

---

addResourceDesc

public addResourceDesc(desc: string): void

desc^Required

• Type: string

---

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

policy^Required

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

---

getAtt

public getAtt(name: string): IResolvable

name^Required

• Type: string

---

setMetadata

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

key^Required

• Type: string

---

value^Required

• Type: any

---

Static Functions

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

---

isConstruct

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

Return whether the given object is a Construct.

x^Required

• Type: any

---

Properties

Name	Type	Description
node	@alicloud/ros-cdk-core.ConstructNode	The construct tree node associated with this construct.
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.
attrAsn	@alicloud/ros-cdk-core.IResolvable	Attribute Asn: Asn.
attrAuthKey	@alicloud/ros-cdk-core.IResolvable	Attribute AuthKey: The authentication key of the local data center gateway device BGP routing protocol.
attrCreateTime	@alicloud/ros-cdk-core.IResolvable	Attribute CreateTime: The time when the customer gateway was created.
attrCustomerGatewayId	@alicloud/ros-cdk-core.IResolvable	Attribute CustomerGatewayId: The ID of the customer gateway.
attrCustomerGatewayName	@alicloud/ros-cdk-core.IResolvable	Attribute CustomerGatewayName: The name of the customer gateway.
attrDescription	@alicloud/ros-cdk-core.IResolvable	Attribute Description: The description of the customer gateway.
attrIpAddress	@alicloud/ros-cdk-core.IResolvable	Attribute IpAddress: The IP address of the customer gateway.

---

node^Required

public readonly node: ConstructNode;

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

The construct tree node associated with this construct.

---

ref^Required

public readonly ref: string;

• Type: string

---

stack^Required

public readonly stack: Stack;

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

The stack in which this resource is defined.

---

resource^Optional

public readonly resource: RosResource;

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

---

attrAsn^Required

public readonly attrAsn: IResolvable;

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

Attribute Asn: Asn.

---

attrAuthKey^Required

public readonly attrAuthKey: IResolvable;

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

Attribute AuthKey: The authentication key of the local data center gateway device BGP routing protocol.

---

attrCreateTime^Required

public readonly attrCreateTime: IResolvable;

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

Attribute CreateTime: The time when the customer gateway was created.

---

attrCustomerGatewayId^Required

public readonly attrCustomerGatewayId: IResolvable;

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

Attribute CustomerGatewayId: The ID of the customer gateway.

---

attrCustomerGatewayName^Required

public readonly attrCustomerGatewayName: IResolvable;

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

Attribute CustomerGatewayName: The name of the customer gateway.

---

attrDescription^Required

public readonly attrDescription: IResolvable;

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

Attribute Description: The description of the customer gateway.

---

attrIpAddress^Required

public readonly attrIpAddress: IResolvable;

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

Attribute IpAddress: The IP address of the customer gateway.

---