Skip to content

Gateway

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)
    .paymentType(java.lang.String)
    .paymentType(IResolvable)
    .spec(java.lang.String)
    .spec(IResolvable)
    .zoneConfig(IResolvable)
    .zoneConfig(ZoneConfigProperty)
//  .gatewayName(java.lang.String)
//  .gatewayName(IResolvable)
//  .logConfig(IResolvable)
//  .logConfig(LogConfigProperty)
//  .networkAccessConfig(IResolvable)
//  .networkAccessConfig(NetworkAccessConfigProperty)
//  .vpc(IResolvable)
//  .vpc(VpcProperty)
//  .vSwitch(IResolvable)
//  .vSwitch(VSwitchProperty)
    .build();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
paymentType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property paymentType: The payment type of the gateway.
spec java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property spec: Gateway instance specifications.
zoneConfig com.aliyun.ros.cdk.core.IResolvable OR ZoneConfigProperty Property zoneConfig: Availability Zone Configuration.
gatewayName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property gatewayName: The name of the Gateway.
logConfig com.aliyun.ros.cdk.core.IResolvable OR LogConfigProperty Property logConfig: Log Configuration.
networkAccessConfig com.aliyun.ros.cdk.core.IResolvable OR NetworkAccessConfigProperty Property networkAccessConfig: Network Access Configuration.
vpc com.aliyun.ros.cdk.core.IResolvable OR VpcProperty Property vpc: The VPC associated with the Gateway.
vSwitch com.aliyun.ros.cdk.core.IResolvable OR VSwitchProperty Property vSwitch: The virtual switch associated with the Gateway.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

paymentTypeRequired

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

Property paymentType: The payment type of the gateway.

Valid values:

  • PayAsYouGo
  • Subscription

specRequired

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

Property spec: Gateway instance specifications.

zoneConfigRequired

Property zoneConfig: Availability Zone Configuration.

gatewayNameOptional

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

Property gatewayName: The name of the Gateway.

logConfigOptional

Property logConfig: Log Configuration.

networkAccessConfigOptional

Property networkAccessConfig: Network Access Configuration.

vpcOptional

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

Property vpc: The VPC associated with the Gateway.

vSwitchOptional

Property vSwitch: The virtual switch associated with the Gateway.

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

sessionRequired

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

The synthesis session.

addCondition 

public void addCondition(RosCondition condition)

conditionRequired

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

addCount 

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

countRequired

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

addDependency 

public void addDependency(Resource resource)

resourceRequired

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

addResourceDesc 

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

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

getAtt 

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata 

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

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

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

isConstruct 

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

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
ref java.lang.String No description.
stack com.aliyun.ros.cdk.core.Stack The stack in which this resource is defined.
resource com.aliyun.ros.cdk.core.RosResource No description.
attrCreateTime com.aliyun.ros.cdk.core.IResolvable Attribute CreateTime: The creation timestamp.
attrEnvironments com.aliyun.ros.cdk.core.IResolvable Attribute Environments: The list of environments associated with the Gateway.
attrExpireTime com.aliyun.ros.cdk.core.IResolvable Attribute ExpireTime: Package year and package month expiration timestamp.
attrGatewayId com.aliyun.ros.cdk.core.IResolvable Attribute GatewayId: The ID of the Gateway.
attrGatewayName com.aliyun.ros.cdk.core.IResolvable Attribute GatewayName: The name of the resource.
attrLoadBalancers com.aliyun.ros.cdk.core.IResolvable Attribute LoadBalancers: The list of Gateway ingress addresses.
attrPaymentType com.aliyun.ros.cdk.core.IResolvable Attribute PaymentType: The payment type of the gateway.
attrSecurityGroup com.aliyun.ros.cdk.core.IResolvable Attribute SecurityGroup: The Security Group of the Gateway.
attrSpec com.aliyun.ros.cdk.core.IResolvable Attribute Spec: Gateway instance specifications.
attrUpdateTime com.aliyun.ros.cdk.core.IResolvable Attribute UpdateTime: Update the timestamp.
attrVersion com.aliyun.ros.cdk.core.IResolvable Attribute Version: The gateway version.
attrVpc com.aliyun.ros.cdk.core.IResolvable Attribute Vpc: The VPC associated with the Gateway.
attrVSwitch com.aliyun.ros.cdk.core.IResolvable Attribute VSwitch: The virtual switch associated with the Gateway.
attrZones com.aliyun.ros.cdk.core.IResolvable Attribute Zones: The List of zones associated with the Gateway.

nodeRequired 

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

refRequired 

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired 

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resourceOptional 

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrCreateTimeRequired 

public IResolvable getAttrCreateTime();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute CreateTime: The creation timestamp.

Unit: milliseconds.

attrEnvironmentsRequired 

public IResolvable getAttrEnvironments();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

attrExpireTimeRequired 

public IResolvable getAttrExpireTime();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ExpireTime: Package year and package month expiration timestamp.

Unit: milliseconds.

attrGatewayIdRequired 

public IResolvable getAttrGatewayId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute GatewayId: The ID of the Gateway.

attrGatewayNameRequired 

public IResolvable getAttrGatewayName();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute GatewayName: The name of the resource.

attrLoadBalancersRequired 

public IResolvable getAttrLoadBalancers();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute LoadBalancers: The list of Gateway ingress addresses.

attrPaymentTypeRequired 

public IResolvable getAttrPaymentType();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute PaymentType: The payment type of the gateway.

attrSecurityGroupRequired 

public IResolvable getAttrSecurityGroup();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute SecurityGroup: The Security Group of the Gateway.

attrSpecRequired 

public IResolvable getAttrSpec();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Spec: Gateway instance specifications.

attrUpdateTimeRequired 

public IResolvable getAttrUpdateTime();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute UpdateTime: Update the timestamp.

Unit: milliseconds.

attrVersionRequired 

public IResolvable getAttrVersion();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Version: The gateway version.

attrVpcRequired 

public IResolvable getAttrVpc();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Vpc: The VPC associated with the Gateway.

attrVSwitchRequired 

public IResolvable getAttrVSwitch();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute VSwitch: The virtual switch associated with the Gateway.

attrZonesRequired 

public IResolvable getAttrZones();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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