rule_sets

Creates, updates, deletes, gets or lists a rule_sets resource.

Overview

Name	rule_sets
Type	Resource
Id	oci.load_balancer.rule_sets

Fields

The following fields are returned by SELECT queries:

get

The rule set is being retrieved.

Name	Datatype	Description
name	string	The name for this set of rules. It must be unique and it cannot be changed. Avoid entering confidential information. Example: example_rule_set
items	array	An array of rules that compose the rule set.

list

A named set of rules associated with a load balancer. Rules are objects that represent actions to apply to a listener,<br />such as adding, altering, or removing HTTP headers. For more information, see<br />[Managing Rule Sets](/Content/Balance/Tasks/managingrulesets.htm).<br />

Name	Datatype	Description
name	string	The name for this set of rules. It must be unique and it cannot be changed. Avoid entering confidential information. Example: example_rule_set
items	array	An array of rules that compose the rule set.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	loadBalancerId, ruleSetName, region	opc-request-id	Gets the specified set of rules.
list	select	loadBalancerId, region	opc-request-id	Lists all rule sets associated with the specified load balancer.
create	insert	loadBalancerId, region, name, items	opc-request-id, opc-retry-token	Creates a new rule set associated with the specified load balancer. For more information, see<br />[Managing Rule Sets](/Content/Balance/Tasks/managingrulesets.htm).<br />
update	update	loadBalancerId, ruleSetName, region, items	opc-request-id, opc-retry-token	Overwrites an existing set of rules on the specified load balancer. Use this operation to add or alter<br />the rules in a rule set.<br /><br />To add a new rule to a set, the body must include both the new rule to add and the existing rules to retain.<br />
delete	delete	loadBalancerId, ruleSetName, region	opc-request-id	Deletes a rule set from the specified load balancer.<br /><br />To delete a rule from a rule set, use the<br />[UpdateRuleSet](#/en/loadbalancer/20170115/RuleSet/UpdateRuleSet) operation.<br />

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
loadBalancerId	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the specified load balancer.
region	string	OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION)
ruleSetName	string	The name of the rule set to delete. Example: example_rule_set
opc-request-id	string	The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
opc-retry-token	string	A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

SELECT examples

get

Gets the specified set of rules.

SELECT
name,
items
FROM oci.load_balancer.rule_sets
WHERE loadBalancerId = '{{ loadBalancerId }}' -- required
AND ruleSetName = '{{ ruleSetName }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;

list

Lists all rule sets associated with the specified load balancer.

SELECT
name,
items
FROM oci.load_balancer.rule_sets
WHERE loadBalancerId = '{{ loadBalancerId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;

INSERT examples

create

Creates a new rule set associated with the specified load balancer. For more information, see<br />[Managing Rule Sets](/Content/Balance/Tasks/managingrulesets.htm).<br />

INSERT INTO oci.load_balancer.rule_sets (
items,
name,
loadBalancerId,
region,
opc-request-id,
opc-retry-token
)
SELECT 
'{{ items }}' /* required */,
'{{ name }}' /* required */,
'{{ loadBalancerId }}',
'{{ region }}',
'{{ opc-request-id }}',
'{{ opc-retry-token }}'
;

Manifest

# Description fields are for documentation purposes
- name: rule_sets
props:
  - name: loadBalancerId
    value: "{{ loadBalancerId }}"
    description: Required parameter for the rule_sets resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the rule_sets resource.
  - name: items
    description: |
      An array of rules that compose the rule set.
    value:
      - action: "{{ action }}"
  - name: name
    value: "{{ name }}"
    description: |
      The name for this set of rules. It must be unique and it cannot be changed. Avoid entering
      confidential information.
      Example: `example_rule_set`
  - name: opc-request-id
    value: "{{ opc-request-id }}"
    description: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. 
    description: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. 
  - name: opc-retry-token
    value: "{{ opc-retry-token }}"
    description: A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). 
    description: A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). 

UPDATE examples

update

Overwrites an existing set of rules on the specified load balancer. Use this operation to add or alter<br />the rules in a rule set.<br /><br />To add a new rule to a set, the body must include both the new rule to add and the existing rules to retain.<br />

UPDATE oci.load_balancer.rule_sets
SET 
items = '{{ items }}'
WHERE 
loadBalancerId = '{{ loadBalancerId }}' --required
AND ruleSetName = '{{ ruleSetName }}' --required
AND region = '{{ region }}' --required
AND items = '{{ items }}' --required
AND opc-request-id = '{{ opc-request-id}}'
AND opc-retry-token = '{{ opc-retry-token}}';

DELETE examples

delete

Deletes a rule set from the specified load balancer.<br /><br />To delete a rule from a rule set, use the<br />[UpdateRuleSet](#/en/loadbalancer/20170115/RuleSet/UpdateRuleSet) operation.<br />

DELETE FROM oci.load_balancer.rule_sets
WHERE loadBalancerId = '{{ loadBalancerId }}' --required
AND ruleSetName = '{{ ruleSetName }}' --required
AND region = '{{ region }}' --required
AND opc-request-id = '{{ opc-request-id }}'
;