Class: Google::Apis::SqladminV1::IpConfiguration
- Inherits:
 - 
      Object
      
        
- Object
 - Google::Apis::SqladminV1::IpConfiguration
 
 
- Includes:
 - Core::Hashable, Core::JsonObjectSupport
 
- Defined in:
 - lib/google/apis/sqladmin_v1/classes.rb,
lib/google/apis/sqladmin_v1/representations.rb,
lib/google/apis/sqladmin_v1/representations.rb 
Overview
IP Management configuration.
Instance Attribute Summary collapse
- 
  
    
      #allocated_ip_range  ⇒ String 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
The name of the allocated ip range for the private ip Cloud SQL instance.
 - 
  
    
      #authorized_networks  ⇒ Array<Google::Apis::SqladminV1::AclEntry> 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
The list of external networks that are allowed to connect to the instance using the IP.
 - 
  
    
      #enable_private_path_for_google_cloud_services  ⇒ Boolean 
    
    
      (also: #enable_private_path_for_google_cloud_services?)
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Controls connectivity to private IP instances from Google services, such as BigQuery.
 - 
  
    
      #ipv4_enabled  ⇒ Boolean 
    
    
      (also: #ipv4_enabled?)
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Whether the instance is assigned a public IP address or not.
 - 
  
    
      #private_network  ⇒ String 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
The resource link for the VPC network from which the Cloud SQL instance is accessible for private IP.
 - 
  
    
      #psc_config  ⇒ Google::Apis::SqladminV1::PscConfig 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
PSC settings for a Cloud SQL instance.
 - 
  
    
      #require_ssl  ⇒ Boolean 
    
    
      (also: #require_ssl?)
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Use
ssl_modeinstead. - 
  
    
      #server_ca_mode  ⇒ String 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Specify what type of CA is used for the server certificate.
 - 
  
    
      #ssl_mode  ⇒ String 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    
Specify how SSL/TLS is enforced in database connections.
 
Instance Method Summary collapse
- 
  
    
      #initialize(**args)  ⇒ IpConfiguration 
    
    
  
  
  
    constructor
  
  
  
  
  
  
  
    
A new instance of IpConfiguration.
 - 
  
    
      #update!(**args)  ⇒ Object 
    
    
  
  
  
  
  
  
  
  
  
    
Update properties of this object.
 
Constructor Details
#initialize(**args) ⇒ IpConfiguration
Returns a new instance of IpConfiguration.
      2794 2795 2796  | 
    
      # File 'lib/google/apis/sqladmin_v1/classes.rb', line 2794 def initialize(**args) update!(**args) end  | 
  
Instance Attribute Details
#allocated_ip_range ⇒ String
The name of the allocated ip range for the private ip Cloud SQL instance. For
example: "google-managed-services-default". If set, the instance ip will be
created in the allocated range. The range name must comply with RFC 1035. Specifically, the name must be 1-63
characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])?.
Corresponds to the JSON property allocatedIpRange
      2725 2726 2727  | 
    
      # File 'lib/google/apis/sqladmin_v1/classes.rb', line 2725 def allocated_ip_range @allocated_ip_range end  | 
  
#authorized_networks ⇒ Array<Google::Apis::SqladminV1::AclEntry>
The list of external networks that are allowed to connect to the instance
using the IP. In 'CIDR' notation, also known as 'slash' notation (for example:
157.197.200.0/24).
Corresponds to the JSON property authorizedNetworks
      2732 2733 2734  | 
    
      # File 'lib/google/apis/sqladmin_v1/classes.rb', line 2732 def @authorized_networks end  | 
  
#enable_private_path_for_google_cloud_services ⇒ Boolean Also known as: enable_private_path_for_google_cloud_services?
Controls connectivity to private IP instances from Google services, such as
BigQuery.
Corresponds to the JSON property enablePrivatePathForGoogleCloudServices
      2738 2739 2740  | 
    
      # File 'lib/google/apis/sqladmin_v1/classes.rb', line 2738 def enable_private_path_for_google_cloud_services @enable_private_path_for_google_cloud_services end  | 
  
#ipv4_enabled ⇒ Boolean Also known as: ipv4_enabled?
Whether the instance is assigned a public IP address or not.
Corresponds to the JSON property ipv4Enabled
      2744 2745 2746  | 
    
      # File 'lib/google/apis/sqladmin_v1/classes.rb', line 2744 def ipv4_enabled @ipv4_enabled end  | 
  
#private_network ⇒ String
The resource link for the VPC network from which the Cloud SQL instance is
accessible for private IP. For example, /projects/myProject/global/networks/
default. This setting can be updated, but it cannot be removed after it is
set.
Corresponds to the JSON property privateNetwork
      2753 2754 2755  | 
    
      # File 'lib/google/apis/sqladmin_v1/classes.rb', line 2753 def private_network @private_network end  | 
  
#psc_config ⇒ Google::Apis::SqladminV1::PscConfig
PSC settings for a Cloud SQL instance.
Corresponds to the JSON property pscConfig
      2758 2759 2760  | 
    
      # File 'lib/google/apis/sqladmin_v1/classes.rb', line 2758 def psc_config @psc_config end  | 
  
#require_ssl ⇒ Boolean Also known as: require_ssl?
Use ssl_mode instead. Whether SSL/TLS connections over IP are enforced. If
set to false, then allow both non-SSL/non-TLS and SSL/TLS connections. For SSL/
TLS connections, the client certificate won't be verified. If set to true,
then only allow connections encrypted with SSL/TLS and with valid client
certificates. If you want to enforce SSL/TLS without enforcing the requirement
for valid client certificates, then use the ssl_mode flag instead of the 
require_ssl flag.
Corresponds to the JSON property requireSsl
      2769 2770 2771  | 
    
      # File 'lib/google/apis/sqladmin_v1/classes.rb', line 2769 def require_ssl @require_ssl end  | 
  
#server_ca_mode ⇒ String
Specify what type of CA is used for the server certificate.
Corresponds to the JSON property serverCaMode
      2775 2776 2777  | 
    
      # File 'lib/google/apis/sqladmin_v1/classes.rb', line 2775 def server_ca_mode @server_ca_mode end  | 
  
#ssl_mode ⇒ String
Specify how SSL/TLS is enforced in database connections. If you must use the 
require_ssl flag for backward compatibility, then only the following value
pairs are valid: For PostgreSQL and MySQL: * ssl_mode=
ALLOW_UNENCRYPTED_AND_ENCRYPTED and require_ssl=false * ssl_mode=
ENCRYPTED_ONLY and require_ssl=false * ssl_mode=
TRUSTED_CLIENT_CERTIFICATE_REQUIRED and require_ssl=true For SQL Server: * 
ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED and require_ssl=false * ssl_mode=
ENCRYPTED_ONLY and require_ssl=true The value of ssl_mode has priority
over the value of require_ssl. For example, for the pair ssl_mode=
ENCRYPTED_ONLY and require_ssl=false, ssl_mode=ENCRYPTED_ONLY means
accept only SSL connections, while require_ssl=false means accept both non-
SSL and SSL connections. In this case, MySQL and PostgreSQL databases respect 
ssl_mode and accepts only SSL connections.
Corresponds to the JSON property sslMode
      2792 2793 2794  | 
    
      # File 'lib/google/apis/sqladmin_v1/classes.rb', line 2792 def ssl_mode @ssl_mode end  | 
  
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
      2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809  | 
    
      # File 'lib/google/apis/sqladmin_v1/classes.rb', line 2799 def update!(**args) @allocated_ip_range = args[:allocated_ip_range] if args.key?(:allocated_ip_range) @authorized_networks = args[:authorized_networks] if args.key?(:authorized_networks) @enable_private_path_for_google_cloud_services = args[:enable_private_path_for_google_cloud_services] if args.key?(:enable_private_path_for_google_cloud_services) @ipv4_enabled = args[:ipv4_enabled] if args.key?(:ipv4_enabled) @private_network = args[:private_network] if args.key?(:private_network) @psc_config = args[:psc_config] if args.key?(:psc_config) @require_ssl = args[:require_ssl] if args.key?(:require_ssl) @server_ca_mode = args[:server_ca_mode] if args.key?(:server_ca_mode) @ssl_mode = args[:ssl_mode] if args.key?(:ssl_mode) end  |