Skip to content

Ingress

This class encapsulates and extends the ROS resource type ALIYUN::SAE::Ingress.

Initializers

import com.aliyun.ros.cdk.sae.Ingress;
Ingress.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .defaultRule(IResolvable)
    .defaultRule(DefaultRuleProperty)
    .description(java.lang.String)
    .description(IResolvable)
    .listenerPort(java.lang.Number)
    .listenerPort(IResolvable)
    .namespaceId(java.lang.String)
    .namespaceId(IResolvable)
    .rules(IResolvable)
    .rules(java.util.List<IResolvable)
    .rules(RulesProperty>)
    .slbId(java.lang.String)
    .slbId(IResolvable)
//  .certId(java.lang.String)
//  .certId(IResolvable)
//  .certIds(IResolvable)
//  .certIds(java.util.List<java.lang.String)
//  .certIds(IResolvable>)
//  .listenerProtocol(java.lang.String)
//  .listenerProtocol(IResolvable)
//  .loadBalanceType(java.lang.String)
//  .loadBalanceType(IResolvable)
    .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.
defaultRule com.aliyun.ros.cdk.core.IResolvable OR DefaultRuleProperty Property defaultRule: The default forwarding rule.
description java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property description: The name of the routing rule.
listenerPort java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property listenerPort: The listener port of the SLB instance.
namespaceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property namespaceId: The ID of the namespace to which the application belongs.
rules com.aliyun.ros.cdk.core.IResolvable OR java.util.ListRulesProperty> Property rules: The forwarding rules.
slbId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property slbId: The Server Load Balancer (SLB) instance that is used by the routing rule.
certId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property certId: The ID of the certificate that is associated with the Classic Load Balancer (CLB) instance.
certIds com.aliyun.ros.cdk.core.IResolvable OR java.util.List Property certIds: The IDs of the certificates that are associated with the Application Load Balancer (ALB) instance.
listenerProtocol java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property listenerProtocol: The protocol that is used to forward requests.
loadBalanceType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property loadBalanceType: The type of the SLB instance based on the processing capabilities.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

defaultRuleRequired

Property defaultRule: The default forwarding rule.

You can specify a port and an application in the default forwarding rule to forward traffic based on the IP address of the application.


descriptionRequired

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

Property description: The name of the routing rule.


listenerPortRequired

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

Property listenerPort: The listener port of the SLB instance.

You must specify a vacant port.


namespaceIdRequired

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

Property namespaceId: The ID of the namespace to which the application belongs.

You can specify only one namespace ID each time you call this operation.


rulesRequired

  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListRulesProperty>

Property rules: The forwarding rules.

You can specify a port and an application in a forwarding rule to forward traffic based on the specified domain name and request path.


slbIdRequired

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

Property slbId: The Server Load Balancer (SLB) instance that is used by the routing rule.


certIdOptional

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

Property certId: The ID of the certificate that is associated with the Classic Load Balancer (CLB) instance.

If LoadBalanceType is set to clb, specify this parameter to configure a certificate for the HTTP listener.


certIdsOptional

  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

Property certIds: The IDs of the certificates that are associated with the Application Load Balancer (ALB) instance.


listenerProtocolOptional

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

Property listenerProtocol: The protocol that is used to forward requests.


loadBalanceTypeOptional

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

Property loadBalanceType: The type of the SLB instance based on the processing capabilities.

The instance type can be specified only when you create a routing rule. You cannot change the instance type when you update the routing rule.


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.sae.Ingress;
Ingress.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.
attrIngressId com.aliyun.ros.cdk.core.IResolvable Attribute IngressId: The ID of the routing rule.

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

attrIngressIdRequired

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

Attribute IngressId: The ID of the routing rule.