Network Security V1 API - Class Google::Cloud::NetworkSecurity::V1::BackendAuthenticationConfig (v0.1.0)

Reference documentation and code samples for the Network Security V1 API class Google::Cloud::NetworkSecurity::V1::BackendAuthenticationConfig.

BackendAuthenticationConfig message groups the TrustConfig together with other settings that control how the load balancer authenticates, and expresses its identity to, the backend:

  • trustConfig is the attached TrustConfig.

  • wellKnownRoots indicates whether the load balance should trust backend server certificates that are issued by public certificate authorities, in addition to certificates trusted by the TrustConfig.

  • clientCertificate is a client certificate that the load balancer uses to express its identity to the backend, if the connection to the backend uses mTLS.

You can attach the BackendAuthenticationConfig to the load balancer's BackendService directly determining how that BackendService negotiates TLS.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#client_certificate

def client_certificate() -> ::String
Returns
  • (::String) — Optional. A reference to a certificatemanager.googleapis.com.Certificate resource. This is a relative resource path following the form "projects/{project}/locations/{location}/certificates/{certificate}".

    Used by a BackendService to negotiate mTLS when the backend connection uses TLS and the backend requests a client certificate. Must have a CLIENT_AUTH scope.

#client_certificate=

def client_certificate=(value) -> ::String
Parameter
  • value (::String) — Optional. A reference to a certificatemanager.googleapis.com.Certificate resource. This is a relative resource path following the form "projects/{project}/locations/{location}/certificates/{certificate}".

    Used by a BackendService to negotiate mTLS when the backend connection uses TLS and the backend requests a client certificate. Must have a CLIENT_AUTH scope.

Returns
  • (::String) — Optional. A reference to a certificatemanager.googleapis.com.Certificate resource. This is a relative resource path following the form "projects/{project}/locations/{location}/certificates/{certificate}".

    Used by a BackendService to negotiate mTLS when the backend connection uses TLS and the backend requests a client certificate. Must have a CLIENT_AUTH scope.

#create_time

def create_time() -> ::Google::Protobuf::Timestamp
Returns

#description

def description() -> ::String
Returns
  • (::String) — Optional. Free-text description of the resource.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — Optional. Free-text description of the resource.
Returns
  • (::String) — Optional. Free-text description of the resource.

#etag

def etag() -> ::String
Returns
  • (::String) — Output only. Etag of the resource.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Set of label tags associated with the resource.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — Set of label tags associated with the resource.
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Set of label tags associated with the resource.

#name

def name() -> ::String
Returns
  • (::String) — Required. Name of the BackendAuthenticationConfig resource. It matches the pattern projects/*/locations/{location}/backendAuthenticationConfigs/{backend_authentication_config}

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Required. Name of the BackendAuthenticationConfig resource. It matches the pattern projects/*/locations/{location}/backendAuthenticationConfigs/{backend_authentication_config}
Returns
  • (::String) — Required. Name of the BackendAuthenticationConfig resource. It matches the pattern projects/*/locations/{location}/backendAuthenticationConfigs/{backend_authentication_config}

#trust_config

def trust_config() -> ::String
Returns
  • (::String) — Optional. A reference to a TrustConfig resource from the certificatemanager.googleapis.com namespace. This is a relative resource path following the form "projects/{project}/locations/{location}/trustConfigs/{trust_config}".

    A BackendService uses the chain of trust represented by this TrustConfig, if specified, to validate the server certificates presented by the backend. Required unless wellKnownRoots is set to PUBLIC_ROOTS.

#trust_config=

def trust_config=(value) -> ::String
Parameter
  • value (::String) — Optional. A reference to a TrustConfig resource from the certificatemanager.googleapis.com namespace. This is a relative resource path following the form "projects/{project}/locations/{location}/trustConfigs/{trust_config}".

    A BackendService uses the chain of trust represented by this TrustConfig, if specified, to validate the server certificates presented by the backend. Required unless wellKnownRoots is set to PUBLIC_ROOTS.

Returns
  • (::String) — Optional. A reference to a TrustConfig resource from the certificatemanager.googleapis.com namespace. This is a relative resource path following the form "projects/{project}/locations/{location}/trustConfigs/{trust_config}".

    A BackendService uses the chain of trust represented by this TrustConfig, if specified, to validate the server certificates presented by the backend. Required unless wellKnownRoots is set to PUBLIC_ROOTS.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns

#well_known_roots

def well_known_roots() -> ::Google::Cloud::NetworkSecurity::V1::BackendAuthenticationConfig::WellKnownRoots
Returns

#well_known_roots=

def well_known_roots=(value) -> ::Google::Cloud::NetworkSecurity::V1::BackendAuthenticationConfig::WellKnownRoots
Parameter
Returns