REST Resource: folders.locations.notificationConfigs

Resource: NotificationConfig

Cloud Security Command Center (Cloud SCC) notification configs.

A notification config is a Cloud SCC resource that contains the configuration to send notifications for create/update events of findings, assets and etc.

JSON representation
{
  "name": string,
  "description": string,
  "pubsubTopic": string,
  "serviceAccount": string,
  "updateTime": string,
  "cryptoKeyName": string,
  "deletionNotificationsEnabled": boolean,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "streamingConfig": {
    object (StreamingConfig)
  }
  // End of mutually exclusive fields.
}
Fields
name

string

Identifier. The relative resource name of this notification config. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name The following list shows some examples: + organizations/{organizationId}/locations/{locationId}/notificationConfigs/notify_public_bucket + folders/{folder_id}/locations/{locationId}/notificationConfigs/notify_public_bucket + projects/{projectId}/locations/{locationId}/notificationConfigs/notify_public_bucket

description

string

The description of the notification config (max of 1024 characters).

pubsubTopic

string

The Pub/Sub topic to send notifications to. Its format is "projects/[projectId]/topics/[topic]".

serviceAccount

string

Output only. The service account that needs "pubsub.topics.publish" permission to publish to the Pub/Sub topic.

updateTime

string (Timestamp format)

Output only. The timestamp of when the notification config was last updated.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

cryptoKeyName

string

Output only. The resource name of the Cloud KMS CryptoKey used to protect this configuration's data, if configured during Security Command Center activation.

deletionNotificationsEnabled

boolean

Optional. Indicates whether the notifications will be sent for deleted findings.

The config for triggering notifications. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response:
streamingConfig

object (StreamingConfig)

The config for triggering streaming-based notifications.

End of mutually exclusive fields.

StreamingConfig

The config for streaming-based notifications, which send each event as soon as it is detected.

JSON representation
{
  "filter": string
}
Fields
filter

string

Expression that defines the filter to apply across create/update events of assets or findings as specified by the event type. The expression is a list of zero or more restrictions combined via logical operators AND and OR. Parentheses are supported, and OR has higher precedence than AND.

Restrictions have the form <field> <operator> <value> and may have a - character in front of them to indicate negation. The fields map to those defined in the corresponding resource.

The supported operators are:

  • = for all value types.
  • >, <, >=, <= for integer values.
  • :, meaning substring matching, for strings.

The supported value types are:

  • string literals in quotes.
  • integer literals without quotes.
  • boolean literals true and false without quotes.

Methods

create

Creates a notification config.

delete

Deletes a notification config.

get

Gets a notification config.

list

Lists notification configs.

patch

Updates a notification config.