Ingress

• Implements: IIngress

This class encapsulates and extends the ROS resource type ALIYUN::SAE::Ingress, which is used to create a routing rule.

Initializers

import ros_cdk_sae
ros_cdk_sae.Ingress(
  scope: Construct,
  id: str,
  default_rule: typing.Union[IResolvable, DefaultRuleProperty],
  description: typing.Union[str, IResolvable],
  listener_port: typing.Union[typing.Union[int, float], IResolvable],
  namespace_id: typing.Union[str, IResolvable],
  rules: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, RulesProperty]]],
  slb_id: typing.Union[str, IResolvable],
  cert_id: typing.Union[str, IResolvable] = None,
  cert_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  listener_protocol: typing.Union[str, IResolvable] = None,
  load_balance_type: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

default_rule^Required

• Type: typing.Union[ros_cdk_core.IResolvable, DefaultRuleProperty]

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.

description^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property description: The name of the routing rule.

listener_port^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property listenerPort: The listener port of the SLB instance.

You must specify a vacant port.

namespace_id^Required

• Type: typing.Union[str, 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.

rules^Required

• Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, RulesProperty]]]

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.

slb_id^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

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

cert_id^Optional

• Type: typing.Union[str, 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.

cert_ids^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]

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

listener_protocol^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

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

load_balance_type^Optional

• Type: typing.Union[str, 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.

enable_resource_property_constraint^Optional

• Type: bool

Methods

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

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: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

import ros_cdk_sae
ros_cdk_sae.Ingress.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: 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

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_ingress_id^Required

attr_ingress_id: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute IngressId: The ID of the routing rule.

props^Required

props: IngressProps

• Type: IngressProps