Cloud SQL Admin V1 API - Class Google::Cloud::Sql::V1::IpConfiguration (v0.1.0)

Reference documentation and code samples for the Cloud SQL Admin V1 API class Google::Cloud::Sql::V1::IpConfiguration.

IP Management configuration.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#allocated_ip_range

def allocated_ip_range() -> ::String
Returns
  • (::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])?.

#allocated_ip_range=

def allocated_ip_range=(value) -> ::String
Parameter
  • value (::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])?.
Returns
  • (::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])?.

#authorized_networks

def authorized_networks() -> ::Array<::Google::Cloud::Sql::V1::AclEntry>
Returns
  • (::Array<::Google::Cloud::Sql::V1::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).

#authorized_networks=

def authorized_networks=(value) -> ::Array<::Google::Cloud::Sql::V1::AclEntry>
Parameter
  • value (::Array<::Google::Cloud::Sql::V1::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).
Returns
  • (::Array<::Google::Cloud::Sql::V1::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).

#custom_subject_alternative_names

def custom_subject_alternative_names() -> ::Array<::String>
Returns
  • (::Array<::String>) — Optional. Custom Subject Alternative Name(SAN)s for a Cloud SQL instance.

#custom_subject_alternative_names=

def custom_subject_alternative_names=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — Optional. Custom Subject Alternative Name(SAN)s for a Cloud SQL instance.
Returns
  • (::Array<::String>) — Optional. Custom Subject Alternative Name(SAN)s for a Cloud SQL instance.

#enable_private_path_for_google_cloud_services

def enable_private_path_for_google_cloud_services() -> ::Google::Protobuf::BoolValue
Returns

#enable_private_path_for_google_cloud_services=

def enable_private_path_for_google_cloud_services=(value) -> ::Google::Protobuf::BoolValue
Parameter
Returns

#ipv4_enabled

def ipv4_enabled() -> ::Google::Protobuf::BoolValue
Returns

#ipv4_enabled=

def ipv4_enabled=(value) -> ::Google::Protobuf::BoolValue
Parameter
Returns

#private_network

def private_network() -> ::String
Returns
  • (::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.

#private_network=

def private_network=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#psc_config

def psc_config() -> ::Google::Cloud::Sql::V1::PscConfig
Returns

#psc_config=

def psc_config=(value) -> ::Google::Cloud::Sql::V1::PscConfig
Parameter
Returns

#require_ssl

def require_ssl() -> ::Google::Protobuf::BoolValue
Returns
  • (::Google::Protobuf::BoolValue) — 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.

#require_ssl=

def require_ssl=(value) -> ::Google::Protobuf::BoolValue
Parameter
  • value (::Google::Protobuf::BoolValue) — 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.

Returns
  • (::Google::Protobuf::BoolValue) — 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.

#server_ca_mode

def server_ca_mode() -> ::Google::Cloud::Sql::V1::IpConfiguration::CaMode
Returns

#server_ca_mode=

def server_ca_mode=(value) -> ::Google::Cloud::Sql::V1::IpConfiguration::CaMode
Parameter
Returns

#server_ca_pool

def server_ca_pool() -> ::String
Returns
  • (::String) — Optional. The resource name of the server CA pool for an instance with CUSTOMER_MANAGED_CAS_CA as the server_ca_mode. Format: projects/{PROJECT}/locations/{REGION}/caPools/{CA_POOL_ID}

#server_ca_pool=

def server_ca_pool=(value) -> ::String
Parameter
  • value (::String) — Optional. The resource name of the server CA pool for an instance with CUSTOMER_MANAGED_CAS_CA as the server_ca_mode. Format: projects/{PROJECT}/locations/{REGION}/caPools/{CA_POOL_ID}
Returns
  • (::String) — Optional. The resource name of the server CA pool for an instance with CUSTOMER_MANAGED_CAS_CA as the server_ca_mode. Format: projects/{PROJECT}/locations/{REGION}/caPools/{CA_POOL_ID}

#server_certificate_rotation_mode

def server_certificate_rotation_mode() -> ::Google::Cloud::Sql::V1::IpConfiguration::ServerCertificateRotationMode
Returns
  • (::Google::Cloud::Sql::V1::IpConfiguration::ServerCertificateRotationMode) — Optional. Controls the automatic server certificate rotation feature. This feature is disabled by default. When enabled, the server certificate will be automatically rotated during Cloud SQL scheduled maintenance or self-service maintenance updates up to six months before it expires. This setting can only be set if server_ca_mode is either GOOGLE_MANAGED_CAS_CA or CUSTOMER_MANAGED_CAS_CA.

#server_certificate_rotation_mode=

def server_certificate_rotation_mode=(value) -> ::Google::Cloud::Sql::V1::IpConfiguration::ServerCertificateRotationMode
Parameter
  • value (::Google::Cloud::Sql::V1::IpConfiguration::ServerCertificateRotationMode) — Optional. Controls the automatic server certificate rotation feature. This feature is disabled by default. When enabled, the server certificate will be automatically rotated during Cloud SQL scheduled maintenance or self-service maintenance updates up to six months before it expires. This setting can only be set if server_ca_mode is either GOOGLE_MANAGED_CAS_CA or CUSTOMER_MANAGED_CAS_CA.
Returns
  • (::Google::Cloud::Sql::V1::IpConfiguration::ServerCertificateRotationMode) — Optional. Controls the automatic server certificate rotation feature. This feature is disabled by default. When enabled, the server certificate will be automatically rotated during Cloud SQL scheduled maintenance or self-service maintenance updates up to six months before it expires. This setting can only be set if server_ca_mode is either GOOGLE_MANAGED_CAS_CA or CUSTOMER_MANAGED_CAS_CA.

#ssl_mode

def ssl_mode() -> ::Google::Cloud::Sql::V1::IpConfiguration::SslMode
Returns
  • (::Google::Cloud::Sql::V1::IpConfiguration::SslMode) — 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.

#ssl_mode=

def ssl_mode=(value) -> ::Google::Cloud::Sql::V1::IpConfiguration::SslMode
Parameter
  • value (::Google::Cloud::Sql::V1::IpConfiguration::SslMode) — 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.

Returns
  • (::Google::Cloud::Sql::V1::IpConfiguration::SslMode) — 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.