Class: OCI::Core::Models::SecurityList
- Inherits:
-
Object
- Object
- OCI::Core::Models::SecurityList
- Defined in:
- lib/oci/core/models/security_list.rb
Overview
A set of virtual firewall rules for your VCN. Security lists are configured at the subnet level, but the rules are applied to the ingress and egress traffic for the individual instances in the subnet. The rules can be stateful or stateless. For more information, see Security Lists. Note: Compare security lists to NetworkSecurityGroups, which let you apply a set of security rules to a specific set of VNICs instead of an entire subnet. Oracle recommends using network security groups instead of security lists, although you can use either or both together.
Important: Oracle Cloud Infrastructure Compute service images automatically include firewall rules (for example, Linux iptables, Windows firewall). If there are issues with some type of access to an instance, make sure both the security lists associated with the instance's subnet and the instance's firewall rules are set correctly.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.
Constant Summary collapse
- LIFECYCLE_STATE_ENUM =
[ LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING'.freeze, LIFECYCLE_STATE_AVAILABLE = 'AVAILABLE'.freeze, LIFECYCLE_STATE_TERMINATING = 'TERMINATING'.freeze, LIFECYCLE_STATE_TERMINATED = 'TERMINATED'.freeze, LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
Instance Attribute Summary collapse
-
#compartment_id ⇒ String
[Required] The OCID of the compartment containing the security list.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource.
-
#display_name ⇒ String
[Required] A user-friendly name.
-
#egress_security_rules ⇒ Array<OCI::Core::Models::EgressSecurityRule>
[Required] Rules for allowing egress IP packets.
-
#freeform_tags ⇒ Hash<String, String>
Free-form tags for this resource.
-
#id ⇒ String
[Required] The security list's Oracle Cloud ID (OCID).
-
#ingress_security_rules ⇒ Array<OCI::Core::Models::IngressSecurityRule>
[Required] Rules for allowing ingress IP packets.
-
#lifecycle_state ⇒ String
[Required] The security list's current state.
-
#time_created ⇒ DateTime
[Required] The date and time the security list was created, in the format defined by RFC3339.
-
#vcn_id ⇒ String
[Required] The OCID of the VCN the security list belongs to.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ SecurityList
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ SecurityList
Initializes the object
142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 |
# File 'lib/oci/core/models/security_list.rb', line 142 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v } self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId'] raise 'You cannot provide both :compartmentId and :compartment_id' if attributes.key?(:'compartmentId') && attributes.key?(:'compartment_id') self.compartment_id = attributes[:'compartment_id'] if attributes[:'compartment_id'] self. = attributes[:'definedTags'] if attributes[:'definedTags'] raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags') self. = attributes[:'defined_tags'] if attributes[:'defined_tags'] self.display_name = attributes[:'displayName'] if attributes[:'displayName'] raise 'You cannot provide both :displayName and :display_name' if attributes.key?(:'displayName') && attributes.key?(:'display_name') self.display_name = attributes[:'display_name'] if attributes[:'display_name'] self.egress_security_rules = attributes[:'egressSecurityRules'] if attributes[:'egressSecurityRules'] raise 'You cannot provide both :egressSecurityRules and :egress_security_rules' if attributes.key?(:'egressSecurityRules') && attributes.key?(:'egress_security_rules') self.egress_security_rules = attributes[:'egress_security_rules'] if attributes[:'egress_security_rules'] self. = attributes[:'freeformTags'] if attributes[:'freeformTags'] raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags') self. = attributes[:'freeform_tags'] if attributes[:'freeform_tags'] self.id = attributes[:'id'] if attributes[:'id'] self.ingress_security_rules = attributes[:'ingressSecurityRules'] if attributes[:'ingressSecurityRules'] raise 'You cannot provide both :ingressSecurityRules and :ingress_security_rules' if attributes.key?(:'ingressSecurityRules') && attributes.key?(:'ingress_security_rules') self.ingress_security_rules = attributes[:'ingress_security_rules'] if attributes[:'ingress_security_rules'] self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState'] raise 'You cannot provide both :lifecycleState and :lifecycle_state' if attributes.key?(:'lifecycleState') && attributes.key?(:'lifecycle_state') self.lifecycle_state = attributes[:'lifecycle_state'] if attributes[:'lifecycle_state'] self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated'] raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created') self.time_created = attributes[:'time_created'] if attributes[:'time_created'] self.vcn_id = attributes[:'vcnId'] if attributes[:'vcnId'] raise 'You cannot provide both :vcnId and :vcn_id' if attributes.key?(:'vcnId') && attributes.key?(:'vcn_id') self.vcn_id = attributes[:'vcn_id'] if attributes[:'vcn_id'] end |
Instance Attribute Details
#compartment_id ⇒ String
[Required] The OCID of the compartment containing the security list.
39 40 41 |
# File 'lib/oci/core/models/security_list.rb', line 39 def compartment_id @compartment_id end |
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: {\"Operations\": {\"CostCenter\": \"42\"}}
47 48 49 |
# File 'lib/oci/core/models/security_list.rb', line 47 def @defined_tags end |
#display_name ⇒ String
[Required] A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
53 54 55 |
# File 'lib/oci/core/models/security_list.rb', line 53 def display_name @display_name end |
#egress_security_rules ⇒ Array<OCI::Core::Models::EgressSecurityRule>
[Required] Rules for allowing egress IP packets.
57 58 59 |
# File 'lib/oci/core/models/security_list.rb', line 57 def egress_security_rules @egress_security_rules end |
#freeform_tags ⇒ Hash<String, String>
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.
Example: {\"Department\": \"Finance\"}
65 66 67 |
# File 'lib/oci/core/models/security_list.rb', line 65 def @freeform_tags end |
#id ⇒ String
[Required] The security list's Oracle Cloud ID (OCID).
69 70 71 |
# File 'lib/oci/core/models/security_list.rb', line 69 def id @id end |
#ingress_security_rules ⇒ Array<OCI::Core::Models::IngressSecurityRule>
[Required] Rules for allowing ingress IP packets.
73 74 75 |
# File 'lib/oci/core/models/security_list.rb', line 73 def ingress_security_rules @ingress_security_rules end |
#lifecycle_state ⇒ String
[Required] The security list's current state.
77 78 79 |
# File 'lib/oci/core/models/security_list.rb', line 77 def lifecycle_state @lifecycle_state end |
#time_created ⇒ DateTime
[Required] The date and time the security list was created, in the format defined by RFC3339.
Example: 2016-08-25T21:10:29.600Z
84 85 86 |
# File 'lib/oci/core/models/security_list.rb', line 84 def time_created @time_created end |
#vcn_id ⇒ String
[Required] The OCID of the VCN the security list belongs to.
88 89 90 |
# File 'lib/oci/core/models/security_list.rb', line 88 def vcn_id @vcn_id end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 |
# File 'lib/oci/core/models/security_list.rb', line 91 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'compartment_id': :'compartmentId', 'defined_tags': :'definedTags', 'display_name': :'displayName', 'egress_security_rules': :'egressSecurityRules', 'freeform_tags': :'freeformTags', 'id': :'id', 'ingress_security_rules': :'ingressSecurityRules', 'lifecycle_state': :'lifecycleState', 'time_created': :'timeCreated', 'vcn_id': :'vcnId' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 |
# File 'lib/oci/core/models/security_list.rb', line 109 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'compartment_id': :'String', 'defined_tags': :'Hash<String, Hash<String, Object>>', 'display_name': :'String', 'egress_security_rules': :'Array<OCI::Core::Models::EgressSecurityRule>', 'freeform_tags': :'Hash<String, String>', 'id': :'String', 'ingress_security_rules': :'Array<OCI::Core::Models::IngressSecurityRule>', 'lifecycle_state': :'String', 'time_created': :'DateTime', 'vcn_id': :'String' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 |
# File 'lib/oci/core/models/security_list.rb', line 225 def ==(other) return true if equal?(other) self.class == other.class && compartment_id == other.compartment_id && == other. && display_name == other.display_name && egress_security_rules == other.egress_security_rules && == other. && id == other.id && ingress_security_rules == other.ingress_security_rules && lifecycle_state == other.lifecycle_state && time_created == other.time_created && vcn_id == other.vcn_id end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 |
# File 'lib/oci/core/models/security_list.rb', line 264 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if type =~ /^Array<(.*)>/i # check to ensure the input is an array given that the the attribute # is documented as an array but the input is not if attributes[self.class.attribute_map[key]].is_a?(Array) public_method("#{key}=").call( attributes[self.class.attribute_map[key]] .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) } ) end elsif !attributes[self.class.attribute_map[key]].nil? public_method("#{key}=").call( OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]]) ) end # or else data not found in attributes(hash), not an issue as the data can be optional end self end |
#eql?(other) ⇒ Boolean
244 245 246 |
# File 'lib/oci/core/models/security_list.rb', line 244 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
253 254 255 |
# File 'lib/oci/core/models/security_list.rb', line 253 def hash [compartment_id, , display_name, egress_security_rules, , id, ingress_security_rules, lifecycle_state, time_created, vcn_id].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
297 298 299 300 301 302 303 304 305 306 |
# File 'lib/oci/core/models/security_list.rb', line 297 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = public_method(attr).call next if value.nil? && !instance_variable_defined?("@#{attr}") hash[param] = _to_hash(value) end hash end |
#to_s ⇒ String
Returns the string representation of the object
291 292 293 |
# File 'lib/oci/core/models/security_list.rb', line 291 def to_s to_hash.to_s end |