CloudIDSEndpoint

Property Value
Google Cloud Service Name Cloud Intrusion Detection System Endpoint
Google Cloud Service Documentation /intrusion-detection-system/docs/
Google Cloud REST Resource Name v1.projects.locations.endpoints
Google Cloud REST Resource Documentation /intrusion-detection-system/docs/configuring-ids#api
Config Connector Resource Short Names gcpcloudidsendpoint
gcpcloudidsendpoints
cloudidsendpoint
Config Connector Service Name ids.googleapis.com
Config Connector Resource Fully Qualified Name cloudidsendpoints.cloudids.cnrm.cloud.google.com
Config Connector Default Average Reconcile Interval In Seconds 600

Custom Resource Definition Properties

Spec

Schema

description: string
location: string
networkRef:
  external: string
  name: string
  namespace: string
projectRef:
  external: string
  name: string
  namespace: string
resourceID: string
severity: string
threatExceptions:
- string
Fields

description

Optional

string

Immutable. An optional description of the endpoint.

location

Required

string

Immutable. The location for the endpoint.

networkRef

Required

object

Immutable. Name of the VPC network that is connected to the IDS endpoint. This can either contain the VPC network name itself (like "src-net") or the full URL to the network (like "projects/{project_id}/global/networks/src-net").

networkRef.external

Optional

string

Allowed value: The `name` field of a `ComputeNetwork` resource.

networkRef.name

Optional

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

networkRef.namespace

Optional

string

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

projectRef

Required

object

The project that this resource belongs to.

projectRef.external

Optional

string

Allowed value: The `name` field of a `Project` resource.

projectRef.name

Optional

string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

projectRef.namespace

Optional

string

Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

resourceID

Optional

string

Immutable. Optional. The name of the resource. Used for creation and acquisition. When unset, the value of `metadata.name` is used as the default.

severity

Required

string

Immutable. The minimum alert severity level that is reported by the endpoint. Possible values: ["INFORMATIONAL", "LOW", "MEDIUM", "HIGH", "CRITICAL"].

threatExceptions

Optional

list (string)

Configuration for threat IDs excluded from generating alerts. Limit: 99 IDs.

threatExceptions[]

Optional

string

Status

Schema

conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
observedGeneration: integer
observedState:
  createTime: string
  endpointForwardingRule: string
  endpointIP: string
  updateTime: string
Fields
conditions

list (object)

Conditions represent the latest available observation of the resource's current state.
conditions[]

object
conditions[].lastTransitionTime

string

Last time the condition transitioned from one status to another.
conditions[].message

string

Human-readable message indicating details about last transition.
conditions[].reason

string

Unique, one-word, CamelCase reason for the condition's last transition.
conditions[].status

string

Status is the status of the condition. Can be True, False, Unknown.
conditions[].type

string

Type is the type of the condition.
observedGeneration

integer

ObservedGeneration is the generation of the resource that was most recently observed by the Config Connector controller. If this is equal to metadata.generation, then that means that the current reported status reflects the most recent desired state of the resource.
observedState

object

The observed state of the underlying GCP resource.
observedState.createTime

string

Creation timestamp in RFC 3339 text format.
observedState.endpointForwardingRule

string

URL of the endpoint's network address to which traffic is to be sent by Packet Mirroring.
observedState.endpointIP

string

Internal IP address of the endpoint's network entry point.
observedState.updateTime

string

Last update timestamp in RFC 3339 text format.

Sample YAML(s)

Typical Use Case

# Copyright 2024 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

apiVersion: cloudids.cnrm.cloud.google.com/v1beta1
kind: CloudIDSEndpoint
metadata:
  name: cloudidsendpoint-sample
spec:
  networkRef:
    name: cloudidsendpoint-dep
  severity: INFORMATIONAL
  location: us-west2-a
  projectRef:
    external: ${PROJECT_ID?}
---
apiVersion: compute.cnrm.cloud.google.com/v1beta1
kind: ComputeAddress
metadata:
  name: cloudidsendpoint-dep
spec:
  location: global
  addressType: INTERNAL
  networkRef:
    name: cloudidsendpoint-dep
  prefixLength: 16
  purpose: VPC_PEERING
---
apiVersion: compute.cnrm.cloud.google.com/v1beta1
kind: ComputeNetwork
metadata:
  name: cloudidsendpoint-dep
spec:
  autoCreateSubnetworks: false
---
apiVersion: servicenetworking.cnrm.cloud.google.com/v1beta1
kind: ServiceNetworkingConnection
metadata:
  name: cloudidsendpoint-dep
spec:
  networkRef:
    name: cloudidsendpoint-dep
  reservedPeeringRanges:
  - name: cloudidsendpoint-dep
  service: servicenetworking.googleapis.com