Rule
- Implements: github.com/alibabacloud-go/ros-cdk/alicloudroscdkslb.datasource.IRule
This class encapsulates and extends the ROS resource type DATASOURCE::SLB::Rule, which is used to query the configuration details of a forwarding rule.
Initializers
import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkslb/datasource"
datasource.NewRule(scope Construct, id *string, props RuleProps, enableResourcePropertyConstraint *bool) Rule
| Name | Type | Description |
|---|---|---|
scope | github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Construct | No description. |
id | *string | No description. |
props | RuleProps | No description. |
enableResourcePropertyConstraint | *bool | No description. |
scopeRequired
- Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Construct
idRequired
- Type: *string
propsRequired
- Type: RuleProps
enableResourcePropertyConstraintOptional
- Type: *bool
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. |
FetchCondition | No description. |
FetchDependency | No description. |
FetchResourceDesc | No description. |
GetAtt | No description. |
SetMetadata | No description. |
ToString
func ToString() *string
Returns a string representation of this construct.
Synthesize
func Synthesize(session ISynthesisSession)
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: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.ISynthesisSession
The synthesis session.
AddCondition
func AddCondition(condition RosCondition)
- Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RosCondition
AddCount
func AddCount(count interface{})
- Type: interface{}
AddDependency
func AddDependency(resource Resource)
- Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Resource
AddResourceDesc
func AddResourceDesc(desc *string)
- Type: *string
ApplyRemovalPolicy
func ApplyRemovalPolicy(policy RemovalPolicy)
- Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RemovalPolicy
FetchCondition
func FetchCondition() RosCondition
FetchDependency
func FetchDependency() *[]*string
FetchResourceDesc
func FetchResourceDesc() *string
GetAtt
func GetAtt(name *string) IResolvable
- Type: *string
SetMetadata
func SetMetadata(key *string, value interface{})
- Type: *string
- Type: interface{}
Static Functions
| Name | Description |
|---|---|
IsConstruct | Return whether the given object is a Construct. |
IsConstruct
import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkslb/datasource"
datasource.Rule_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct.
- Type: interface{}
Properties
| Name | Type | Description |
|---|---|---|
Node | github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.ConstructNode | The construct tree node associated with this construct. |
Env | github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.IResourceEnvironment | The environment this resource belongs to. |
Ref | *string | No description. |
Stack | github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Stack | The stack in which this resource is defined. |
Resource | github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RosResource | No description. |
AttrCookie | interface{} | Attribute Cookie: The cookie to be configured on the backend server. |
AttrCookieTimeout | interface{} | Attribute CookieTimeout: The timeout period of a cookie. |
AttrDomain | interface{} | Attribute Domain: The domain name that is configured in the forwarding rule. |
AttrHealthCheck | interface{} | Attribute HealthCheck: Specifies whether to enable health checks. |
AttrHealthCheckConnectPort | interface{} | Attribute HealthCheckConnectPort: The port of the backend server that is used for health checks. |
AttrHealthCheckDomain | interface{} | Attribute HealthCheckDomain: The domain name that is used for health checks. |
AttrHealthCheckHttpCode | interface{} | Attribute HealthCheckHttpCode: The HTTP status code that indicates a successful health check. |
AttrHealthCheckInterval | interface{} | Attribute HealthCheckInterval: The time interval between two consecutive health checks. |
AttrHealthCheckTimeout | interface{} | Attribute HealthCheckTimeout: The timeout period of a health check response. |
AttrHealthCheckUri | interface{} | Attribute HealthCheckUri: The URI that is used for health checks. |
AttrHealthyThreshold | interface{} | Attribute HealthyThreshold: The number of consecutive successful health checks that must occur before an unhealthy backend server is declared healthy. |
AttrListenerPort | interface{} | Attribute ListenerPort: The listener port that is used by the SLB instance. |
AttrListenerSync | interface{} | Attribute ListenerSync: Indicates whether the forwarding rule uses the scheduling algorithm, session persistence, and health check configurations of the listener. |
AttrLoadBalancerId | interface{} | Attribute LoadBalancerId: The ID of the SLB instance. |
AttrRuleId | interface{} | Attribute RuleId: The ID of the forwarding rule. |
AttrRuleName | interface{} | Attribute RuleName: The name of the forwarding rule. |
AttrScheduler | interface{} | Attribute Scheduler: The scheduling algorithm. |
AttrStickySession | interface{} | Attribute StickySession: Indicates whether session persistence is enabled. |
AttrStickySessionType | interface{} | Attribute StickySessionType: The method that is used to handle a cookie. |
AttrUnhealthyThreshold | interface{} | Attribute UnhealthyThreshold: The number of consecutive failed health checks that must occur before a healthy backend server is declared unhealthy. |
AttrUrl | interface{} | Attribute Url: The URL that is configured in the forwarding rule. |
AttrVserverGroupId | interface{} | Attribute VserverGroupId: The ID of the vServer group that is associated with the forwarding rule. |
Props | RuleProps | No description. |
NodeRequired
func Node() ConstructNode
- Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.ConstructNode
The construct tree node associated with this construct.
EnvRequired
func Env() IResourceEnvironment
- Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.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.
RefRequired
func Ref() *string
- Type: *string
StackRequired
func Stack() Stack
- Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.Stack
The stack in which this resource is defined.
ResourceOptional
func Resource() RosResource
- Type: github.com/alibabacloud-go/ros-cdk/alicloudroscdkcore.RosResource
AttrCookieRequired
func AttrCookie() interface{}
- Type: interface{}
Attribute Cookie: The cookie to be configured on the backend server.
AttrCookieTimeoutRequired
func AttrCookieTimeout() interface{}
- Type: interface{}
Attribute CookieTimeout: The timeout period of a cookie.
AttrDomainRequired
func AttrDomain() interface{}
- Type: interface{}
Attribute Domain: The domain name that is configured in the forwarding rule.
AttrHealthCheckRequired
func AttrHealthCheck() interface{}
- Type: interface{}
Attribute HealthCheck: Specifies whether to enable health checks.
AttrHealthCheckConnectPortRequired
func AttrHealthCheckConnectPort() interface{}
- Type: interface{}
Attribute HealthCheckConnectPort: The port of the backend server that is used for health checks.
Valid values: 1 to 65535.
AttrHealthCheckDomainRequired
func AttrHealthCheckDomain() interface{}
- Type: interface{}
Attribute HealthCheckDomain: The domain name that is used for health checks.
Valid values: $_ip: The private IP address of the backend server. If the $_ip parameter is set or the HealthCheckDomain parameter is not set, SLB uses the private IP addresses of backend servers as the domain names for health checks. domain: The domain name must be 1 to 80 characters in length. It can contain only letters, digits, periods (.),and hyphens (-).
AttrHealthCheckHttpCodeRequired
func AttrHealthCheckHttpCode() interface{}
- Type: interface{}
Attribute HealthCheckHttpCode: The HTTP status code that indicates a successful health check.
Separate multiple HTTP status codes with commas (,). Default value: http_2xx.
AttrHealthCheckIntervalRequired
func AttrHealthCheckInterval() interface{}
- Type: interface{}
Attribute HealthCheckInterval: The time interval between two consecutive health checks.
AttrHealthCheckTimeoutRequired
func AttrHealthCheckTimeout() interface{}
- Type: interface{}
Attribute HealthCheckTimeout: The timeout period of a health check response.
If a backend ECS instance does not send an expected response within the specified period of time, the ECS instance is considered unhealthy.
AttrHealthCheckUriRequired
func AttrHealthCheckUri() interface{}
- Type: interface{}
Attribute HealthCheckUri: The URI that is used for health checks.
AttrHealthyThresholdRequired
func AttrHealthyThreshold() interface{}
- Type: interface{}
Attribute HealthyThreshold: The number of consecutive successful health checks that must occur before an unhealthy backend server is declared healthy.
In this case, the health check state is changed from fail to success.
AttrListenerPortRequired
func AttrListenerPort() interface{}
- Type: interface{}
Attribute ListenerPort: The listener port that is used by the SLB instance.
AttrListenerSyncRequired
func AttrListenerSync() interface{}
- Type: interface{}
Attribute ListenerSync: Indicates whether the forwarding rule uses the scheduling algorithm, session persistence, and health check configurations of the listener.
AttrLoadBalancerIdRequired
func AttrLoadBalancerId() interface{}
- Type: interface{}
Attribute LoadBalancerId: The ID of the SLB instance.
AttrRuleIdRequired
func AttrRuleId() interface{}
- Type: interface{}
Attribute RuleId: The ID of the forwarding rule.
AttrRuleNameRequired
func AttrRuleName() interface{}
- Type: interface{}
Attribute RuleName: The name of the forwarding rule.
AttrSchedulerRequired
func AttrScheduler() interface{}
- Type: interface{}
Attribute Scheduler: The scheduling algorithm.
AttrStickySessionRequired
func AttrStickySession() interface{}
- Type: interface{}
Attribute StickySession: Indicates whether session persistence is enabled.
Valid values: on and off.
AttrStickySessionTypeRequired
func AttrStickySessionType() interface{}
- Type: interface{}
Attribute StickySessionType: The method that is used to handle a cookie.
AttrUnhealthyThresholdRequired
func AttrUnhealthyThreshold() interface{}
- Type: interface{}
Attribute UnhealthyThreshold: The number of consecutive failed health checks that must occur before a healthy backend server is declared unhealthy.
In this case, the health check state is changed from success to fail.
AttrUrlRequired
func AttrUrl() interface{}
- Type: interface{}
Attribute Url: The URL that is configured in the forwarding rule.
AttrVserverGroupIdRequired
func AttrVserverGroupId() interface{}
- Type: interface{}
Attribute VserverGroupId: The ID of the vServer group that is associated with the forwarding rule.
PropsRequired
func Props() RuleProps
- Type: RuleProps