Ingress
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
)
Name | Type | Description |
---|---|---|
scope |
ros_cdk_core.Construct |
No description. |
id |
str |
No description. |
default_rule |
typing.Union[ros_cdk_core.IResolvable, DefaultRuleProperty] |
Property defaultRule: The default forwarding rule. |
description |
typing.Union[str, ros_cdk_core.IResolvable] |
Property description: The name of the routing rule. |
listener_port |
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] |
Property listenerPort: The listener port of the SLB instance. |
namespace_id |
typing.Union[str, ros_cdk_core.IResolvable] |
Property namespaceId: The ID of the namespace to which the application belongs. |
rules |
typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, RulesProperty]]] |
Property rules: The forwarding rules. |
slb_id |
typing.Union[str, ros_cdk_core.IResolvable] |
Property slbId: The Server Load Balancer (SLB) instance that is used by the routing rule. |
cert_id |
typing.Union[str, ros_cdk_core.IResolvable] |
Property certId: The ID of the certificate that is associated with the Classic Load Balancer (CLB) instance. |
cert_ids |
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 |
typing.Union[str, ros_cdk_core.IResolvable] |
Property listenerProtocol: The protocol that is used to forward requests. |
load_balance_type |
typing.Union[str, ros_cdk_core.IResolvable] |
Property loadBalanceType: The type of the SLB instance based on the processing capabilities. |
enable_resource_property_constraint |
bool |
No description. |
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
Name | Description |
---|---|
to_string |
Returns a string representation of this construct. |
synthesize |
Allows this construct to emit artifacts into the cloud assembly during synthesis. |
add_condition |
No description. |
add_count |
No description. |
add_dependency |
No description. |
add_resource_desc |
No description. |
apply_removal_policy |
No description. |
get_att |
No description. |
set_metadata |
No description. |
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.
- Type: ros_cdk_core.ISynthesisSession
The synthesis session.
add_condition
def add_condition(
condition: RosCondition
) -> None
- Type: ros_cdk_core.RosCondition
add_count
def add_count(
count: typing.Union[typing.Union[int, float], IResolvable]
) -> None
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
add_dependency
def add_dependency(
resource: Resource
) -> None
- Type: ros_cdk_core.Resource
add_resource_desc
def add_resource_desc(
desc: str
) -> None
- Type: str
apply_removal_policy
def apply_removal_policy(
policy: RemovalPolicy
) -> None
- Type: ros_cdk_core.RemovalPolicy
get_att
def get_att(
name: str
) -> IResolvable
- Type: str
set_metadata
def set_metadata(
key: str,
value: typing.Any
) -> None
- Type: str
- Type: typing.Any
Static Functions
Name | Description |
---|---|
is_construct |
Return whether the given object is a Construct. |
is_construct
import ros_cdk_sae
ros_cdk_sae.Ingress.is_construct(
x: typing.Any
)
Return whether the given object is a Construct.
- Type: typing.Any
Properties
Name | Type | Description |
---|---|---|
node |
ros_cdk_core.ConstructNode |
The construct tree node associated with this construct. |
ref |
str |
No description. |
stack |
ros_cdk_core.Stack |
The stack in which this resource is defined. |
resource |
ros_cdk_core.RosResource |
No description. |
attr_ingress_id |
ros_cdk_core.IResolvable |
Attribute IngressId: The ID of the routing rule. |
node
Required
node: ConstructNode
- Type: ros_cdk_core.ConstructNode
The construct tree node associated with this construct.
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: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute IngressId: The ID of the routing rule.