File: //snap/google-cloud-cli/current/lib/surface/alloydb/backups/create.py
# -*- coding: utf-8 -*- #
# Copyright 2021 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.
"""Creates a new AlloyDB backup."""
from __future__ import absolute_import
from __future__ import division
from __future__ import unicode_literals
from googlecloudsdk.api_lib.alloydb import api_util
from googlecloudsdk.api_lib.alloydb import backup_operations
from googlecloudsdk.calliope import base
from googlecloudsdk.command_lib.alloydb import flags
from googlecloudsdk.command_lib.kms import resource_args as kms_resource_args
from googlecloudsdk.core import log
from googlecloudsdk.core import properties
from googlecloudsdk.core import resources
def _ParseBackupType(alloydb_messages, backup_type):
if backup_type:
return alloydb_messages.Backup.TypeValueValuesEnum.lookup_by_name(
backup_type.upper())
return None
# TODO: b/312466999 - Change @base.DefaultUniverseOnly to
# @base.UniverseCompatible once b/312466999 is fixed.
# See go/gcloud-cli-running-tpc-tests.
@base.DefaultUniverseOnly
@base.ReleaseTracks(base.ReleaseTrack.GA)
class Create(base.CreateCommand):
"""Creates a new AlloyDB backup within a given project."""
detailed_help = {
'DESCRIPTION': '{description}',
'EXAMPLES': """\
To create a new backup, run:
$ {command} my-backup --cluster=my-cluster --region=us-central1
To create a new cross-region backup, run:
$ {command} projects/my-project/locations/us-west1/backups/my-backup --cluster=my-cluster --region=us-central1
""",
}
@classmethod
def Args(cls, parser):
"""Specifies additional command flags.
Args:
parser: argparse.Parser: Parser object for command line inputs.
"""
base.ASYNC_FLAG.AddToParser(parser)
parser.add_argument(
'--region',
required=True,
type=str,
help='The region of the cluster to backup.',
)
parser.add_argument(
'backup',
type=str,
help=(
'The AlloyDB backup to create. This must either be the backup ID'
' (myBackup) or the full backup path'
' (projects/myProject/locations/us-central1/backups/myBackup). In'
' the first case, the project and location are assumed to be the'
' same as the cluster being backed up. The second form can be'
' used to create cross-region and cross-project backups.'
),
)
flags.AddCluster(parser, False)
flags.AddTags(parser)
kms_resource_args.AddKmsKeyResourceArg(
parser,
'backup',
permission_info=(
"The 'AlloyDB Service Agent' service account must hold permission"
" 'Cloud KMS CryptoKey Encrypter/Decrypter'"
),
)
def ConstructResourceFromArgs(
self, alloydb_messages, cluster_ref, backup_ref, args
):
backup_resource = alloydb_messages.Backup()
backup_resource.name = backup_ref.RelativeName()
backup_resource.type = _ParseBackupType(alloydb_messages, 'ON_DEMAND')
backup_resource.clusterName = cluster_ref.RelativeName()
backup_resource.tags = flags.GetTagsFromArgs(
args, alloydb_messages.Backup.TagsValue)
kms_key = flags.GetAndValidateKmsKeyName(args)
if kms_key:
encryption_config = alloydb_messages.EncryptionConfig()
encryption_config.kmsKeyName = kms_key
backup_resource.encryptionConfig = encryption_config
return backup_resource
def Run(self, args):
"""Constructs and sends request.
Args:
args: argparse.Namespace, An object that contains the values for the
arguments specified in the .Args() method.
Returns:
ProcessHttpResponse of the request made.
"""
client = api_util.AlloyDBClient(self.ReleaseTrack())
alloydb_client = client.alloydb_client
alloydb_messages = client.alloydb_messages
cluster_ref = client.resource_parser.Create(
'alloydb.projects.locations.clusters',
projectsId=properties.VALUES.core.project.GetOrFail,
locationsId=args.region,
clustersId=args.cluster)
backup_ref = client.resource_parser.Parse(
collection='alloydb.projects.locations.backups',
line=args.backup,
params={
'projectsId': properties.VALUES.core.project.GetOrFail,
'locationsId': args.region,
},
)
backup_resource = self.ConstructResourceFromArgs(
alloydb_messages, cluster_ref, backup_ref, args
)
req = alloydb_messages.AlloydbProjectsLocationsBackupsCreateRequest(
backup=backup_resource,
backupId=backup_ref.Name(),
parent=backup_ref.Parent().RelativeName(),
)
op = alloydb_client.projects_locations_backups.Create(req)
op_ref = resources.REGISTRY.ParseRelativeName(
op.name, collection='alloydb.projects.locations.operations')
log.status.Print('Operation ID: {}'.format(op_ref.Name()))
if not args.async_:
backup_operations.Await(op_ref, 'Creating backup', self.ReleaseTrack())
return op
@base.ReleaseTracks(base.ReleaseTrack.BETA)
class CreateBeta(Create):
"""Create a new AlloyDB backup within a given project."""
@classmethod
def Args(cls, parser):
super(CreateBeta, cls).Args(parser)
flags.AddEnforcedRetention(parser)
def ConstructResourceFromArgs(
self, alloydb_messages, cluster_ref, backup_ref, args
):
backup_resource = super(CreateBeta, self).ConstructResourceFromArgs(
alloydb_messages, cluster_ref, backup_ref, args
)
if args.enforced_retention:
backup_resource.enforcedRetention = True
return backup_resource
@base.ReleaseTracks(base.ReleaseTrack.ALPHA)
class CreateAlpha(CreateBeta):
"""Create a new AlloyDB backup within a given project."""
@classmethod
def Args(cls, parser):
super(CreateAlpha, cls).Args(parser)