Class: OCI::Bastion::Models::CreateBastionDetails
- Inherits:
-
Object
- Object
- OCI::Bastion::Models::CreateBastionDetails
- Defined in:
- lib/oci/bastion/models/create_bastion_details.rb
Overview
The configuration details for a new bastion. A bastion provides secured, public access to target resources in the cloud that you cannot otherwise reach from the internet. A bastion resides in a public subnet and establishes the network infrastructure needed to connect a user to a target resource in a private subnet.
Constant Summary collapse
- DNS_PROXY_STATUS_ENUM =
[ DNS_PROXY_STATUS_DISABLED = 'DISABLED'.freeze, DNS_PROXY_STATUS_ENABLED = 'ENABLED'.freeze ].freeze
Instance Attribute Summary collapse
-
#bastion_type ⇒ String
[Required] The type of bastion.
-
#client_cidr_block_allow_list ⇒ Array<String>
A list of address ranges in CIDR notation that you want to allow to connect to sessions hosted by this bastion.
-
#compartment_id ⇒ String
[Required] The unique identifier (OCID) of the compartment where the bastion is located.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource.
-
#dns_proxy_status ⇒ String
The desired dns proxy status of the bastion.
-
#freeform_tags ⇒ Hash<String, String>
Simple key-value pair that is applied without any predefined name, type or scope.
-
#max_session_ttl_in_seconds ⇒ Integer
The maximum amount of time that any session on the bastion can remain active.
-
#name ⇒ String
The name of the bastion, which can't be changed after creation.
-
#phone_book_entry ⇒ String
The phonebook entry of the customer's team, which can't be changed after creation.
-
#static_jump_host_ip_addresses ⇒ Array<String>
A list of IP addresses of the hosts that the bastion has access to.
-
#target_subnet_id ⇒ String
[Required] The unique identifier (OCID) of the subnet that the bastion connects 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 = {}) ⇒ CreateBastionDetails
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 = {}) ⇒ CreateBastionDetails
Initializes the object
122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 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 |
# File 'lib/oci/bastion/models/create_bastion_details.rb', line 122 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.bastion_type = attributes[:'bastionType'] if attributes[:'bastionType'] raise 'You cannot provide both :bastionType and :bastion_type' if attributes.key?(:'bastionType') && attributes.key?(:'bastion_type') self.bastion_type = attributes[:'bastion_type'] if attributes[:'bastion_type'] self.name = attributes[:'name'] if attributes[:'name'] 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.target_subnet_id = attributes[:'targetSubnetId'] if attributes[:'targetSubnetId'] raise 'You cannot provide both :targetSubnetId and :target_subnet_id' if attributes.key?(:'targetSubnetId') && attributes.key?(:'target_subnet_id') self.target_subnet_id = attributes[:'target_subnet_id'] if attributes[:'target_subnet_id'] self.phone_book_entry = attributes[:'phoneBookEntry'] if attributes[:'phoneBookEntry'] raise 'You cannot provide both :phoneBookEntry and :phone_book_entry' if attributes.key?(:'phoneBookEntry') && attributes.key?(:'phone_book_entry') self.phone_book_entry = attributes[:'phone_book_entry'] if attributes[:'phone_book_entry'] self.static_jump_host_ip_addresses = attributes[:'staticJumpHostIpAddresses'] if attributes[:'staticJumpHostIpAddresses'] raise 'You cannot provide both :staticJumpHostIpAddresses and :static_jump_host_ip_addresses' if attributes.key?(:'staticJumpHostIpAddresses') && attributes.key?(:'static_jump_host_ip_addresses') self.static_jump_host_ip_addresses = attributes[:'static_jump_host_ip_addresses'] if attributes[:'static_jump_host_ip_addresses'] self.client_cidr_block_allow_list = attributes[:'clientCidrBlockAllowList'] if attributes[:'clientCidrBlockAllowList'] raise 'You cannot provide both :clientCidrBlockAllowList and :client_cidr_block_allow_list' if attributes.key?(:'clientCidrBlockAllowList') && attributes.key?(:'client_cidr_block_allow_list') self.client_cidr_block_allow_list = attributes[:'client_cidr_block_allow_list'] if attributes[:'client_cidr_block_allow_list'] self.max_session_ttl_in_seconds = attributes[:'maxSessionTtlInSeconds'] if attributes[:'maxSessionTtlInSeconds'] raise 'You cannot provide both :maxSessionTtlInSeconds and :max_session_ttl_in_seconds' if attributes.key?(:'maxSessionTtlInSeconds') && attributes.key?(:'max_session_ttl_in_seconds') self.max_session_ttl_in_seconds = attributes[:'max_session_ttl_in_seconds'] if attributes[:'max_session_ttl_in_seconds'] self.dns_proxy_status = attributes[:'dnsProxyStatus'] if attributes[:'dnsProxyStatus'] raise 'You cannot provide both :dnsProxyStatus and :dns_proxy_status' if attributes.key?(:'dnsProxyStatus') && attributes.key?(:'dns_proxy_status') self.dns_proxy_status = attributes[:'dns_proxy_status'] if attributes[:'dns_proxy_status'] 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. = 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'] end |
Instance Attribute Details
#bastion_type ⇒ String
[Required] The type of bastion. Use standard
.
19 20 21 |
# File 'lib/oci/bastion/models/create_bastion_details.rb', line 19 def bastion_type @bastion_type end |
#client_cidr_block_allow_list ⇒ Array<String>
A list of address ranges in CIDR notation that you want to allow to connect to sessions hosted by this bastion.
45 46 47 |
# File 'lib/oci/bastion/models/create_bastion_details.rb', line 45 def client_cidr_block_allow_list @client_cidr_block_allow_list end |
#compartment_id ⇒ String
[Required] The unique identifier (OCID) of the compartment where the bastion is located.
27 28 29 |
# File 'lib/oci/bastion/models/create_bastion_details.rb', line 27 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. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}
65 66 67 |
# File 'lib/oci/bastion/models/create_bastion_details.rb', line 65 def @defined_tags end |
#dns_proxy_status ⇒ String
The desired dns proxy status of the bastion.
53 54 55 |
# File 'lib/oci/bastion/models/create_bastion_details.rb', line 53 def dns_proxy_status @dns_proxy_status end |
#freeform_tags ⇒ Hash<String, String>
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}
59 60 61 |
# File 'lib/oci/bastion/models/create_bastion_details.rb', line 59 def @freeform_tags end |
#max_session_ttl_in_seconds ⇒ Integer
The maximum amount of time that any session on the bastion can remain active.
49 50 51 |
# File 'lib/oci/bastion/models/create_bastion_details.rb', line 49 def max_session_ttl_in_seconds @max_session_ttl_in_seconds end |
#name ⇒ String
The name of the bastion, which can't be changed after creation.
23 24 25 |
# File 'lib/oci/bastion/models/create_bastion_details.rb', line 23 def name @name end |
#phone_book_entry ⇒ String
The phonebook entry of the customer's team, which can't be changed after creation. Not applicable to standard
bastions.
36 37 38 |
# File 'lib/oci/bastion/models/create_bastion_details.rb', line 36 def phone_book_entry @phone_book_entry end |
#static_jump_host_ip_addresses ⇒ Array<String>
A list of IP addresses of the hosts that the bastion has access to. Not applicable to standard
bastions.
41 42 43 |
# File 'lib/oci/bastion/models/create_bastion_details.rb', line 41 def static_jump_host_ip_addresses @static_jump_host_ip_addresses end |
#target_subnet_id ⇒ String
[Required] The unique identifier (OCID) of the subnet that the bastion connects to.
31 32 33 |
# File 'lib/oci/bastion/models/create_bastion_details.rb', line 31 def target_subnet_id @target_subnet_id end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 |
# File 'lib/oci/bastion/models/create_bastion_details.rb', line 68 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'bastion_type': :'bastionType', 'name': :'name', 'compartment_id': :'compartmentId', 'target_subnet_id': :'targetSubnetId', 'phone_book_entry': :'phoneBookEntry', 'static_jump_host_ip_addresses': :'staticJumpHostIpAddresses', 'client_cidr_block_allow_list': :'clientCidrBlockAllowList', 'max_session_ttl_in_seconds': :'maxSessionTtlInSeconds', 'dns_proxy_status': :'dnsProxyStatus', 'freeform_tags': :'freeformTags', 'defined_tags': :'definedTags' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 |
# File 'lib/oci/bastion/models/create_bastion_details.rb', line 87 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'bastion_type': :'String', 'name': :'String', 'compartment_id': :'String', 'target_subnet_id': :'String', 'phone_book_entry': :'String', 'static_jump_host_ip_addresses': :'Array<String>', 'client_cidr_block_allow_list': :'Array<String>', 'max_session_ttl_in_seconds': :'Integer', 'dns_proxy_status': :'String', 'freeform_tags': :'Hash<String, String>', 'defined_tags': :'Hash<String, Hash<String, Object>>' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 |
# File 'lib/oci/bastion/models/create_bastion_details.rb', line 206 def ==(other) return true if equal?(other) self.class == other.class && bastion_type == other.bastion_type && name == other.name && compartment_id == other.compartment_id && target_subnet_id == other.target_subnet_id && phone_book_entry == other.phone_book_entry && static_jump_host_ip_addresses == other.static_jump_host_ip_addresses && client_cidr_block_allow_list == other.client_cidr_block_allow_list && max_session_ttl_in_seconds == other.max_session_ttl_in_seconds && dns_proxy_status == other.dns_proxy_status && == other. && == other. end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 |
# File 'lib/oci/bastion/models/create_bastion_details.rb', line 246 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
226 227 228 |
# File 'lib/oci/bastion/models/create_bastion_details.rb', line 226 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
235 236 237 |
# File 'lib/oci/bastion/models/create_bastion_details.rb', line 235 def hash [bastion_type, name, compartment_id, target_subnet_id, phone_book_entry, static_jump_host_ip_addresses, client_cidr_block_allow_list, max_session_ttl_in_seconds, dns_proxy_status, , ].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
279 280 281 282 283 284 285 286 287 288 |
# File 'lib/oci/bastion/models/create_bastion_details.rb', line 279 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
273 274 275 |
# File 'lib/oci/bastion/models/create_bastion_details.rb', line 273 def to_s to_hash.to_s end |