Skip to content

Gateway

This class encapsulates and extends the ROS resource type ALIYUN::APIG::Gateway.

Initializers 

import { Gateway } from '@alicloud/ros-cdk-apig'
new Gateway(scope: Construct, id: string, props: GatewayProps, enableResourcePropertyConstraint?: boolean)
Name Type Description
scope @alicloud/ros-cdk-core.Construct No description.
id string No description.
props GatewayProps 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.
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

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 { Gateway } from '@alicloud/ros-cdk-apig'
Gateway.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.
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.
attrCreateTime @alicloud/ros-cdk-core.IResolvable Attribute CreateTime: The creation timestamp.
attrEnvironments @alicloud/ros-cdk-core.IResolvable Attribute Environments: The list of environments associated with the Gateway.
attrExpireTime @alicloud/ros-cdk-core.IResolvable Attribute ExpireTime: Package year and package month expiration timestamp.
attrGatewayId @alicloud/ros-cdk-core.IResolvable Attribute GatewayId: The ID of the Gateway.
attrGatewayName @alicloud/ros-cdk-core.IResolvable Attribute GatewayName: The name of the resource.
attrLoadBalancers @alicloud/ros-cdk-core.IResolvable Attribute LoadBalancers: The list of Gateway ingress addresses.
attrPaymentType @alicloud/ros-cdk-core.IResolvable Attribute PaymentType: The payment type of the gateway.
attrSecurityGroup @alicloud/ros-cdk-core.IResolvable Attribute SecurityGroup: The Security Group of the Gateway.
attrSpec @alicloud/ros-cdk-core.IResolvable Attribute Spec: Gateway instance specifications.
attrUpdateTime @alicloud/ros-cdk-core.IResolvable Attribute UpdateTime: Update the timestamp.
attrVersion @alicloud/ros-cdk-core.IResolvable Attribute Version: The gateway version.
attrVpc @alicloud/ros-cdk-core.IResolvable Attribute Vpc: The VPC associated with the Gateway.
attrVSwitch @alicloud/ros-cdk-core.IResolvable Attribute VSwitch: The virtual switch associated with the Gateway.
attrZones @alicloud/ros-cdk-core.IResolvable Attribute Zones: The List of zones associated with the Gateway.

nodeRequired 

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

The construct tree node associated with this construct.

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

attrCreateTimeRequired 

public readonly attrCreateTime: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute CreateTime: The creation timestamp.

Unit: milliseconds.

attrEnvironmentsRequired 

public readonly attrEnvironments: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Environments: The list of environments associated with the Gateway.

attrExpireTimeRequired 

public readonly attrExpireTime: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ExpireTime: Package year and package month expiration timestamp.

Unit: milliseconds.

attrGatewayIdRequired 

public readonly attrGatewayId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute GatewayId: The ID of the Gateway.

attrGatewayNameRequired 

public readonly attrGatewayName: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute GatewayName: The name of the resource.

attrLoadBalancersRequired 

public readonly attrLoadBalancers: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute LoadBalancers: The list of Gateway ingress addresses.

attrPaymentTypeRequired 

public readonly attrPaymentType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute PaymentType: The payment type of the gateway.

attrSecurityGroupRequired 

public readonly attrSecurityGroup: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute SecurityGroup: The Security Group of the Gateway.

attrSpecRequired 

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

Attribute Spec: Gateway instance specifications.

attrUpdateTimeRequired 

public readonly attrUpdateTime: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute UpdateTime: Update the timestamp.

Unit: milliseconds.

attrVersionRequired 

public readonly attrVersion: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Version: The gateway version.

attrVpcRequired 

public readonly attrVpc: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Vpc: The VPC associated with the Gateway.

attrVSwitchRequired 

public readonly attrVSwitch: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute VSwitch: The virtual switch associated with the Gateway.

attrZonesRequired 

public readonly attrZones: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Zones: The List of zones associated with the Gateway.