Gateway

• Implements: IGateway

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

Initializers

import com.aliyun.ros.cdk.apig.Gateway;
Gateway.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .gatewayName(java.lang.String)
    .gatewayName(IResolvable)
    .networkAccessConfig(IResolvable)
    .networkAccessConfig(NetworkAccessConfigProperty)
    .paymentType(java.lang.String)
    .paymentType(IResolvable)
    .spec(java.lang.String)
    .spec(IResolvable)
    .zoneConfig(IResolvable)
    .zoneConfig(ZoneConfigProperty)
//  .gatewayType(java.lang.String)
//  .gatewayType(IResolvable)
//  .logConfig(IResolvable)
//  .logConfig(LogConfigProperty)
//  .period(java.lang.Number)
//  .period(IResolvable)
//  .periodUnit(java.lang.String)
//  .periodUnit(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .tags(java.util.List<TagsProperty>)
//  .vpc(IResolvable)
//  .vpc(VpcProperty)
//  .vSwitch(IResolvable)
//  .vSwitch(VSwitchProperty)
    .build();

scope^Required

• Type: com.aliyun.ros.cdk.core.Construct

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

gatewayName^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property gatewayName: The name of the Gateway.

networkAccessConfig^Required

• Type: com.aliyun.ros.cdk.core.IResolvable OR NetworkAccessConfigProperty

Property networkAccessConfig: Network Access Configuration.

paymentType^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property paymentType: The payment type of the gateway.

Valid values:

• PayAsYouGo
• Subscription

spec^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property spec: Gateway instance specifications.

zoneConfig^Required

• Type: com.aliyun.ros.cdk.core.IResolvable OR ZoneConfigProperty

Property zoneConfig: Availability Zone Configuration.

gatewayType^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property gatewayType: Describes the gateway type, which is categorized into the following two types: * API: indicates an API gateway * AI: Indicates an AI gateway.

Default value: API.

logConfig^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR LogConfigProperty

Property logConfig: Log Configuration.

period^Optional

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property period: The purchase time of the gateway.

This parameter is only valid when updating PaymentType from PayAsYouGo to Subscription.

periodUnit^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property periodUnit: The unit of the purchase time of the gateway.

This parameter is only valid when updating PaymentType from PayAsYouGo to Subscription.

resourceGroupId^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property resourceGroupId: The ID of the resource group.

tags^Optional

• Type: java.util.List<TagsProperty>

Property tags: Tags of The tags of the Gateway..

vpc^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR VpcProperty

Property vpc: The VPC associated with the Gateway.

vSwitch^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR VSwitchProperty

Property vSwitch: The virtual switch associated with the Gateway.

Methods

toString

public java.lang.String toString()

Returns a string representation of this construct.

synthesize

public void synthesize(ISynthesisSession session)

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: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition

public void addCondition(RosCondition condition)

condition^Required

• Type: com.aliyun.ros.cdk.core.RosCondition

addCount

public void addCount(java.lang.Number OR IResolvable count)

count^Required

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency

public void addDependency(Resource resource)

resource^Required

• Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

• Type: com.aliyun.ros.cdk.core.RemovalPolicy

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

key^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

Static Functions

isConstruct

import com.aliyun.ros.cdk.apig.Gateway;
Gateway.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

• Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

env^Required

public IResourceEnvironment getEnv();

• Type: com.aliyun.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 java.lang.String getRef();

• Type: java.lang.String

stack^Required

public Stack getStack();

• Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resource^Optional

public RosResource getResource();

• Type: com.aliyun.ros.cdk.core.RosResource

attrCreateTime^Required

public java.lang.Object getAttrCreateTime();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute CreateTime: The creation timestamp.

Unit: milliseconds.

attrEnvironments^Required

public java.lang.Object getAttrEnvironments();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

attrExpireTime^Required

public java.lang.Object getAttrExpireTime();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ExpireTime: Package year and package month expiration timestamp.

Unit: milliseconds.

attrGatewayId^Required

public java.lang.Object getAttrGatewayId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute GatewayId: The ID of the Gateway.

attrGatewayName^Required

public java.lang.Object getAttrGatewayName();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute GatewayName: The name of the resource.

attrGatewayType^Required

public java.lang.Object getAttrGatewayType();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute GatewayType: The type of the gateway.

attrLoadBalancers^Required

public java.lang.Object getAttrLoadBalancers();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute LoadBalancers: The list of Gateway ingress addresses.

attrPaymentType^Required

public java.lang.Object getAttrPaymentType();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute PaymentType: The payment type of the gateway.

attrResourceGroupId^Required

public java.lang.Object getAttrResourceGroupId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ResourceGroupId: The ID of the resource group.

attrSecurityGroup^Required

public java.lang.Object getAttrSecurityGroup();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute SecurityGroup: The Security Group of the Gateway.

attrSpec^Required

public java.lang.Object getAttrSpec();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Spec: Gateway instance specifications.

attrTags^Required

public java.lang.Object getAttrTags();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Tags: The tags of the Gateway.

attrUpdateTime^Required

public java.lang.Object getAttrUpdateTime();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute UpdateTime: Update the timestamp.

Unit: milliseconds.

attrVersion^Required

public java.lang.Object getAttrVersion();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Version: The gateway version.

attrVpc^Required

public java.lang.Object getAttrVpc();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Vpc: The VPC associated with the Gateway.

attrVSwitch^Required

public java.lang.Object getAttrVSwitch();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute VSwitch: The virtual switch associated with the Gateway.

attrZones^Required

public java.lang.Object getAttrZones();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

props^Required

public GatewayProps getProps();

• Type: GatewayProps