Class: MintPress::InfrastructureOci::OCISecurityListRule

Inherits:
OCISecurityRuleCommon show all
Includes:
MintLogger, Mixins::Properties
Defined in:
src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_security_list_rule.rb

Overview

Manage OCI security rules

Properties (Read/Write)

  • #platform ⇒ MintPress::InfrastructureOci::OciPlatform (Default Value: MintPress::InfrastructureOci::OciPlatform.new)
    'This incapsulates all properties required for the OCI provider.'
    Property Attributes
    • default ⇒ MintPress::InfrastructureOci::OciPlatform.new
    

34
    		 
    # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_security_list_rule.rb', line 34

property :platform, type: MintPress::InfrastructureOci::OciPlatform, default: MintPress::InfrastructureOci::OciPlatform.new, description: 'This incapsulates all properties required for the OCI provider.'
  • #compartment_id ⇒ String (Default Value: Proc.new { platform.compartment })

    Property Attributes
    • default ⇒ Proc.new { platform.compartment }
    

36
    		 
    # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_security_list_rule.rb', line 36

property :compartment_id, type: String, default: Proc.new { platform.compartment }
  • #display_name ⇒ String

    Property Attributes 
    

37
    		 
    # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_security_list_rule.rb', line 37

property :display_name, type: String
  • #vcn_id ⇒ String

    Property Attributes 
    

38
    		 
    # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_security_list_rule.rb', line 38

property :vcn_id, type: String
  • #security_list_id ⇒ String
    The security list to update
    Property Attributes
    • required ⇒ true
    

40
    		 
    # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_security_list_rule.rb', line 40

property :security_list_id, type: String, required: true
  • #platform ⇒ MintPress::InfrastructureOci::OciPlatform (Default Value: MintPress::InfrastructureOci::OciPlatform.new)
    'This incapsulates all properties required for the OCI provider.'
    Property Attributes
    • default ⇒ MintPress::InfrastructureOci::OciPlatform.new
    

32
    		 
    # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_security_rule_common.rb', line 32

property :platform, type: MintPress::InfrastructureOci::OciPlatform, default: MintPress::InfrastructureOci::OciPlatform.new, description: 'This incapsulates all properties required for the OCI provider.'
  • #description ⇒ String
    An optional description of your choice for the rule. If specified, and you're updating rules, this is used as a primary key!
    Property Attributes 
    

35
    		 
    # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_security_rule_common.rb', line 35

property :description, type: String
  • #destination_type ⇒ String
    Conceptually, this is the range of IP addresses that a packet originating from the instance can go to.
    Property Attributes
    • allowed_values ⇒ ['CIDR_BLOCK', 'SERVICE_CIDR_BLOCK', 'NETWORK_SECURITY_GROUP']
    

37
    		 
    # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_security_rule_common.rb', line 37

property :destination_type, type: String, allowed_values: ['CIDR_BLOCK', 'SERVICE_CIDR_BLOCK', 'NETWORK_SECURITY_GROUP']
  • #destination ⇒ String
    Type of destination for the rule.
    Property Attributes 
    

39
    		 
    # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_security_rule_common.rb', line 39

property :destination, type: String
  • #direction ⇒ String
    [Required] Direction of the security rule.
    Property Attributes
    • allowed_values ⇒ ['INGRESS', 'EGRESS']
    

41
    		 
    # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_security_rule_common.rb', line 41

property :direction, type: String, allowed_values: ['INGRESS', 'EGRESS']
  • #is_stateless ⇒ [TrueClass, FalseClass] (Default Value: false)
    A stateless rule allows traffic in one direction.
    Property Attributes
    • default ⇒ false
    

43
    		 
    # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_security_rule_common.rb', line 43

property :is_stateless, type: [TrueClass, FalseClass], default: false
  • #protocol ⇒ String
    [Required] The transport protocol. Specify either all or an IPv4 protocol number as defined in Protocol Numbers. Options are supported only for ICMP ("1"), TCP ("6"), UDP ("17"), and ICMPv6 ("58").
    Property Attributes
    • from ⇒ Integer
    

45
    		 
    # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_security_rule_common.rb', line 45

property :protocol, type: String, from: Integer
  • #source ⇒ String
    Conceptually, this is the range of IP addresses that a packet coming into the instance can come from.
    Property Attributes 
    

47
    		 
    # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_security_rule_common.rb', line 47

property :source, type: String
  • #source_type ⇒ String
    Type of source for the rule.
    Property Attributes
    • allowed_values ⇒ ['CIDR_BLOCK', 'SERVICE_CIDR_BLOCK', 'NETWORK_SECURITY_GROUP']
    

49
    		 
    # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_security_rule_common.rb', line 49

property :source_type, type: String, allowed_values: ['CIDR_BLOCK', 'SERVICE_CIDR_BLOCK', 'NETWORK_SECURITY_GROUP']
  • #icmp_code ⇒ Integer
    If this is an ICMP rule, the allowed code
    Property Attributes 
    

52
    		 
    # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_security_rule_common.rb', line 52

property :icmp_code, type: Integer
  • #icmp_type ⇒ Integer
    If this is an ICMP rule, the allowed type
    Property Attributes 
    

54
    		 
    # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_security_rule_common.rb', line 54

property :icmp_type, type: Integer
  • #tcp_dport_range_low ⇒ Integer
    tcp_options
    Property Attributes 
    

57
    		 
    # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_security_rule_common.rb', line 57

property :tcp_dport_range_low, type: Integer
  • #tcp_dport_range_high ⇒ Integer
    tcp_options
    Property Attributes 
    

59
    		 
    # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_security_rule_common.rb', line 59

property :tcp_dport_range_high, type: Integer
  • #tcp_sport_range_low ⇒ Integer
    tcp_options
    Property Attributes 
    

61
    		 
    # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_security_rule_common.rb', line 61

property :tcp_sport_range_low, type: Integer
  • #tcp_sport_range_high ⇒ Integer
    tcp_options
    Property Attributes 
    

63
    		 
    # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_security_rule_common.rb', line 63

property :tcp_sport_range_high, type: Integer
  • #udp_sport_range_low ⇒ Integer
    udp_options
    Property Attributes 
    

65
    		 
    # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_security_rule_common.rb', line 65

property :udp_sport_range_low, type: Integer
  • #udp_sport_range_high ⇒ Integer
    udp_options
    Property Attributes 
    

67
    		 
    # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_security_rule_common.rb', line 67

property :udp_sport_range_high, type: Integer
  • #ocid ⇒ String
    The ocid of this item
    Property Attributes 
    

70
    		 
    # File 'src/mintpress-infrastructure-oci/lib/mintpress-infrastructure-oci/oci_security_rule_common.rb', line 70

property :ocid, type: String

Properties (Read Only)

Constant Summary

Constants included from MintLogger

MintLogger::DEBUG, MintLogger::ERROR, MintLogger::FATAL, MintLogger::INFO, MintLogger::UNKNOWN, MintLogger::VERBOSE, MintLogger::WARN

Instance Attribute Summary

Attributes included from Mixins::Properties

#autopush_set_cache, #dynamic_create, #harvest_on_access, #harvest_undefined_only, #harvested, #tree_root

Instance Method Summary collapse

Methods included from Mixins::Properties

#[], #[]=, #add_validate_report_result, #armour_set_property, #array_contains?, #array_is_a?, #check_autopush, #check_stack_overflow, #clone_property_object, #cloner_handle_single_property, #coerce_single, #contains_as_string?, #display_validate_report_result, #double_initialize?, #dump_to_hash, #find_parent, #find_parent_by_identity, #generate_accessor_functions, #get_canonical_renamed, #get_from_opts, #get_my_name, #get_property, #get_property_item, #has?, included, #initialize_validate_report, #inspect, #is_cloned_object?, #is_mintpress_object?, #is_probably_canonical?, #is_set?, #local_debug, #local_info, #local_verbose, #mintpress_property_definitions, #place_object_by_identity, #process_properties, #prop_set?, #property, #property_definitions, #property_details, #property_is_simple_object?, #push_root!, #require_property, #require_update, #retrieve_docstring, #sanitize, #set_map_dirty, #set_property, #set_property_item, #show_short_array, #strip_defaults!, #synchronize, #uncloned_property_definitions, #update_map, #validate, #validate_generic, #validate_properties, #validate_property, #validate_required, #version_allowed?, #weakref

Methods included from MintLogger::Utils::Common

#boolean_val, #has_value?, #no_value?, #nvl, #path_as_symbol, #ruby_level_to_send

Methods inherited from OCISecurityRuleCommon

#cmp_icmp, #cmp_tcp, #cmp_udp, #compare_class, #fill_class!, #fill_icmp!, #fill_tcp!, #fill_udp!

Constructor Details

#initialize(opts = {}) ⇒ OCISecurityListRule

Returns a new instance of OCISecurityListRule.

Instance Method Details

#create ⇒ Object

#exists? ⇒ Boolean

Returns:

  • (Boolean)

#get_my_ocid ⇒ Object

#remove ⇒ Object