File: //snap/google-cloud-cli/current/lib/surface/scc/notifications/update.py
# -*- coding: utf-8 -*- #
# Copyright 2023 Google LLC. All Rights Reserved.
#
# 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.
"""Command for updating a Cloud Security Command Center NotificationConfig."""
from __future__ import absolute_import
from __future__ import division
from __future__ import print_function
from __future__ import unicode_literals
from googlecloudsdk.api_lib.scc import securitycenter_client
from googlecloudsdk.calliope import base
from googlecloudsdk.command_lib.scc import flags as scc_flags
from googlecloudsdk.command_lib.scc import util as scc_util
from googlecloudsdk.command_lib.scc.notifications import flags as notifications_flags
from googlecloudsdk.command_lib.scc.notifications import notification_util
from googlecloudsdk.core import log
from googlecloudsdk.core import properties
@base.ReleaseTracks(
base.ReleaseTrack.GA, base.ReleaseTrack.BETA, base.ReleaseTrack.ALPHA
)
@base.DefaultUniverseOnly
class Update(base.UpdateCommand):
"""Update a Security Command Center notification config."""
detailed_help = {
'DESCRIPTION': """\
Update a Security Command Center notification config.
Notification configs that are created with Security Command Center API V2
and later include a `location` attribute. If the `location` attribute is
included in the resource name of a Notification configs, you must specify
it when referencing the Notification config. For example, the following
Notification configs name has `location=eu`:
`organizations/123/locations/eu/notificationConfigs/test-config`.
""",
'EXAMPLES': """\
Update all mutable fields under an organization parent `test-config`
(description + pubsub topic + filter):
$ {command} scc notifications update test-config --organization=123 \
--description="New description" \
--pubsub-topic="projects/22222/topics/newtopic"
Update all mutable fields under a folder parent `test-config`
(description + pubsub topic + filter):
$ {command} scc notifications update test-config --folder=456 \
--description="New description" \
--pubsub-topic="projects/22222/topics/newtopic"
Update all mutable fields under a project parent `test-config`
(description + pubsub topic + filter):
$ {command} scc notifications update test-config --project=789 \
--description="New description" \
--pubsub-topic="projects/22222/topics/newtopic"
Update test-config's description
$ {command} test-config --organization=123 --description="New description"
Update test-config's pubsub-topic
$ {command} test-config --organization=123
--pubsub-topic="projects/22222/topics/newtopic"
Update test-config's filter
$ {command} test-config --organization=123 --filter='state = \\"ACTIVE\\"'
Update all mutable fields for `test-config` with `location=global` under an
organization parent (description + pubsub topic + filter):
$ {command} scc notifications update test-config --organization=123 \
--description="New description" \
--pubsub-topic="projects/22222/topics/newtopic" --location=global
""",
'API REFERENCE': """\
This command uses the Security Command Center API. For more information,
see [Security Command Center API.](https://cloud.google.com/security-command-center/docs/reference/rest)
""",
}
@staticmethod
def Args(parser):
notifications_flags.DESCRIPTION_FLAG.AddToParser(parser)
notifications_flags.FILTER_FLAG_LONG_DESCRIPTION.AddToParser(parser)
notifications_flags.PUBSUB_TOPIC_OPTIONAL_FLAG.AddToParser(parser)
notifications_flags.AddNotificationConfigPositionalArgument(parser)
notifications_flags.AddParentGroup(parser)
scc_flags.API_VERSION_FLAG.AddToParser(parser)
notifications_flags.UPDATE_NOTIFICATION_CONFIG_LOCATION_FLAG.AddToParser(
parser
)
parser.display_info.AddFormat(properties.VALUES.core.default_format.Get())
def Run(self, args):
# Determine what version to call from --location and --api-version. The
# NotificationConfig is a version_specific_existing_resource that may not be
# accesed through v2 if it currently exists in v1, and vice vesra.
version = scc_util.GetVersionFromArguments(
args, args.NOTIFICATIONCONFIGID, version_specific_existing_resource=True
)
messages = securitycenter_client.GetMessages(version)
client = securitycenter_client.GetClient(version)
parent = scc_util.GetParentFromNamedArguments(args)
notification_util.ValidateMutexOnConfigIdAndParent(args, parent)
if version == 'v1':
req = (
messages.SecuritycenterOrganizationsNotificationConfigsPatchRequest()
)
req.name = notification_util.ValidateAndGetNotificationConfigV1Name(args)
endpoint = client.organizations_notificationConfigs
else:
req = (
messages.SecuritycenterOrganizationsLocationsNotificationConfigsPatchRequest()
)
req.name = notification_util.ValidateAndGetNotificationConfigV2Name(args)
endpoint = client.organizations_locations_notificationConfigs
computed_update_mask = []
req.notificationConfig = messages.NotificationConfig()
if args.IsKnownAndSpecified('description'):
computed_update_mask.append('description')
req.notificationConfig.description = args.description
if args.IsKnownAndSpecified('pubsub_topic'):
computed_update_mask.append('pubsubTopic')
req.notificationConfig.pubsubTopic = args.pubsub_topic
if args.IsKnownAndSpecified('filter'):
computed_update_mask.append('streamingConfig.filter')
streaming_config = messages.StreamingConfig()
streaming_config.filter = args.filter
req.notificationConfig.streamingConfig = streaming_config
# User may not supply an updateMask.
req.updateMask = ','.join(computed_update_mask)
# Set the args' filter to None to avoid downstream naming conflicts.
args.filter = None
result = endpoint.Patch(req)
log.status.Print('Updated.')
return result