AllowRule¶

class oci.load_balancer.models.AllowRule(**kwargs)¶

Bases: Rule

An object that represents the action of configuring an access control rule. Access control rules permit access to application resources based on user-specified match conditions. This rule applies only to HTTP listeners.

NOTES: * If you do not specify any access control rules, the default rule is to allow all traffic. * If you add access control rules, the load balancer denies any traffic that does not match the rules. * Maximum of two match conditions can be specified in a rule. * You can specify this rule only with the following RuleCondition combinations: * SOURCE_IP_ADDRESS * SOURCE_VCN_ID * SOURCE_VCN_ID”, “SOURCE_VCN_IP_ADDRESS

Attributes:

`ACTION_ADD_HTTP_REQUEST_HEADER`	A constant which can be used with the action property of a Rule.
`ACTION_ADD_HTTP_RESPONSE_HEADER`	A constant which can be used with the action property of a Rule.
`ACTION_ALLOW`	A constant which can be used with the action property of a Rule.
`ACTION_CONTROL_ACCESS_USING_HTTP_METHODS`	A constant which can be used with the action property of a Rule.
`ACTION_EXTEND_HTTP_REQUEST_HEADER_VALUE`	A constant which can be used with the action property of a Rule.
`ACTION_EXTEND_HTTP_RESPONSE_HEADER_VALUE`	A constant which can be used with the action property of a Rule.
`ACTION_HTTP_HEADER`	A constant which can be used with the action property of a Rule.
`ACTION_IP_BASED_MAX_CONNECTIONS`	A constant which can be used with the action property of a Rule.
`ACTION_REDIRECT`	A constant which can be used with the action property of a Rule.
`ACTION_REMOVE_HTTP_REQUEST_HEADER`	A constant which can be used with the action property of a Rule.
`ACTION_REMOVE_HTTP_RESPONSE_HEADER`	A constant which can be used with the action property of a Rule.
`action`	[Required] Gets the action of this Rule.
`conditions`	[Required] Gets the conditions of this AllowRule.
`description`	Gets the description of this AllowRule.

Methods:

`__init__`(**kwargs)	Initializes a new AllowRule object with values from keyword arguments.
`get_subtype`(object_dictionary)	Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

ACTION_ADD_HTTP_REQUEST_HEADER = 'ADD_HTTP_REQUEST_HEADER'¶: A constant which can be used with the action property of a Rule. This constant has a value of “ADD_HTTP_REQUEST_HEADER”

ACTION_ADD_HTTP_RESPONSE_HEADER = 'ADD_HTTP_RESPONSE_HEADER'¶: A constant which can be used with the action property of a Rule. This constant has a value of “ADD_HTTP_RESPONSE_HEADER”

ACTION_ALLOW = 'ALLOW'¶: A constant which can be used with the action property of a Rule. This constant has a value of “ALLOW”

ACTION_CONTROL_ACCESS_USING_HTTP_METHODS = 'CONTROL_ACCESS_USING_HTTP_METHODS'¶: A constant which can be used with the action property of a Rule. This constant has a value of “CONTROL_ACCESS_USING_HTTP_METHODS”

ACTION_EXTEND_HTTP_REQUEST_HEADER_VALUE = 'EXTEND_HTTP_REQUEST_HEADER_VALUE'¶: A constant which can be used with the action property of a Rule. This constant has a value of “EXTEND_HTTP_REQUEST_HEADER_VALUE”

ACTION_EXTEND_HTTP_RESPONSE_HEADER_VALUE = 'EXTEND_HTTP_RESPONSE_HEADER_VALUE'¶: A constant which can be used with the action property of a Rule. This constant has a value of “EXTEND_HTTP_RESPONSE_HEADER_VALUE”

ACTION_HTTP_HEADER = 'HTTP_HEADER'¶: A constant which can be used with the action property of a Rule. This constant has a value of “HTTP_HEADER”

ACTION_IP_BASED_MAX_CONNECTIONS = 'IP_BASED_MAX_CONNECTIONS'¶: A constant which can be used with the action property of a Rule. This constant has a value of “IP_BASED_MAX_CONNECTIONS”

ACTION_REDIRECT = 'REDIRECT'¶: A constant which can be used with the action property of a Rule. This constant has a value of “REDIRECT”

ACTION_REMOVE_HTTP_REQUEST_HEADER = 'REMOVE_HTTP_REQUEST_HEADER'¶: A constant which can be used with the action property of a Rule. This constant has a value of “REMOVE_HTTP_REQUEST_HEADER”

ACTION_REMOVE_HTTP_RESPONSE_HEADER = 'REMOVE_HTTP_RESPONSE_HEADER'¶: A constant which can be used with the action property of a Rule. This constant has a value of “REMOVE_HTTP_RESPONSE_HEADER”

__init__(**kwargs)¶

Initializes a new AllowRule object with values from keyword arguments. The default value of the action attribute of this class is ALLOW and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters

action (str) – The value to assign to the action property of this AllowRule. Allowed values for this property are: “ADD_HTTP_REQUEST_HEADER”, “EXTEND_HTTP_REQUEST_HEADER_VALUE”, “REMOVE_HTTP_REQUEST_HEADER”, “ADD_HTTP_RESPONSE_HEADER”, “EXTEND_HTTP_RESPONSE_HEADER_VALUE”, “REMOVE_HTTP_RESPONSE_HEADER”, “ALLOW”, “CONTROL_ACCESS_USING_HTTP_METHODS”, “REDIRECT”, “HTTP_HEADER”, “IP_BASED_MAX_CONNECTIONS”
conditions (list[oci.load_balancer.models.RuleCondition]) – The value to assign to the conditions property of this AllowRule.
description (str) – The value to assign to the description property of this AllowRule.

property action¶

[Required] Gets the action of this Rule. Allowed values for this property are: “ADD_HTTP_REQUEST_HEADER”, “EXTEND_HTTP_REQUEST_HEADER_VALUE”, “REMOVE_HTTP_REQUEST_HEADER”, “ADD_HTTP_RESPONSE_HEADER”, “EXTEND_HTTP_RESPONSE_HEADER_VALUE”, “REMOVE_HTTP_RESPONSE_HEADER”, “ALLOW”, “CONTROL_ACCESS_USING_HTTP_METHODS”, “REDIRECT”, “HTTP_HEADER”, “IP_BASED_MAX_CONNECTIONS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns: The action of this Rule.
Return type: str

property conditions¶

[Required] Gets the conditions of this AllowRule.

Returns: The conditions of this AllowRule.
Return type: list[oci.load_balancer.models.RuleCondition]

property description¶

Gets the description of this AllowRule. A brief description of the access control rule. Avoid entering confidential information.

example: 192.168.0.0/16 and 2001:db8::/32 are trusted clients. Whitelist them.

Returns: The description of this AllowRule.
Return type: str

static get_subtype(object_dictionary)¶: Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.