Gateway

• Implements: IGateway

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)

scope^Required

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

id^Required

• Type: string

props^Required

• Type: GatewayProps

enableResourcePropertyConstraint^Optional

• Type: boolean

Methods

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

fetchCondition

public fetchCondition(): RosCondition

fetchDependency

public fetchDependency(): string[]

fetchResourceDesc

public fetchResourceDesc(): string

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

isConstruct

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

Return whether the given object is a Construct.

x^Required

• Type: any

Properties

node^Required

public readonly node: ConstructNode;

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

The construct tree node associated with this construct.

env^Required

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.

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

attrCreateTime^Required

public readonly attrCreateTime: string | IResolvable;

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

Attribute CreateTime: The creation timestamp.

Unit: milliseconds.

attrEnvironments^Required

public readonly attrEnvironments: string | IResolvable;

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

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

attrExpireTime^Required

public readonly attrExpireTime: string | IResolvable;

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

Attribute ExpireTime: Package year and package month expiration timestamp.

Unit: milliseconds.

attrGatewayId^Required

public readonly attrGatewayId: string | IResolvable;

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

Attribute GatewayId: The ID of the Gateway.

attrGatewayName^Required

public readonly attrGatewayName: string | IResolvable;

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

Attribute GatewayName: The name of the resource.

attrGatewayType^Required

public readonly attrGatewayType: string | IResolvable;

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

Attribute GatewayType: The type of the gateway.

attrLoadBalancers^Required

public readonly attrLoadBalancers: string | IResolvable;

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

Attribute LoadBalancers: The list of Gateway ingress addresses.

attrPaymentType^Required

public readonly attrPaymentType: string | IResolvable;

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

Attribute PaymentType: The payment type of the gateway.

attrResourceGroupId^Required

public readonly attrResourceGroupId: string | IResolvable;

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

Attribute ResourceGroupId: The ID of the resource group.

attrSecurityGroup^Required

public readonly attrSecurityGroup: string | IResolvable;

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

Attribute SecurityGroup: The Security Group of the Gateway.

attrSpec^Required

public readonly attrSpec: string | IResolvable;

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

Attribute Spec: Gateway instance specifications.

attrTags^Required

public readonly attrTags: string | IResolvable;

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

Attribute Tags: The tags of the Gateway.

attrUpdateTime^Required

public readonly attrUpdateTime: string | IResolvable;

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

Attribute UpdateTime: Update the timestamp.

Unit: milliseconds.

attrVersion^Required

public readonly attrVersion: string | IResolvable;

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

Attribute Version: The gateway version.

attrVpc^Required

public readonly attrVpc: string | IResolvable;

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

Attribute Vpc: The VPC associated with the Gateway.

attrVSwitch^Required

public readonly attrVSwitch: string | IResolvable;

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

Attribute VSwitch: The virtual switch associated with the Gateway.

attrZones^Required

public readonly attrZones: string | IResolvable;

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

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

props^Required

public readonly props: GatewayProps;

• Type: GatewayProps