models_v2.create_aws_snapshot_manager_protection_group_request_body module

class models_v2.create_aws_snapshot_manager_protection_group_request_body.CreateAWSSnapshotManagerProtectionGroupRequestBody(objects=None, exclude_object_ids=None, vm_tag_ids=None, exclude_vm_tag_ids=None, create_ami=None, ami_creation_frequency=None, source_id=None, source_name=None)

Bases: object

Implementation of the ‘Create AWS Snapshot Manager Protection Group Request Body’ model.

Specifies the parameters which are specific to AWS related Protection Groups using AWS native snapshot orchestration with snapshot manager. Atlease one of tags or objects must be specified.

Attributes:

objects (list of AWSSnapshotManagerProtectionGroupObjectParams):

Specifies the objects to be included in the Protection Group.

exclude_object_ids (list of long|int): Specifies the objects to be

excluded in the Protection Group.

vm_tag_ids (list of long|int): Array of Array of VM Tag Ids that

Specify VMs to Protect. Optionally specify a list of VMs to protect by listing Protection Source ids of VM Tags in this two dimensional array. Using this two dimensional array of Tag ids, the Cluster generates a list of VMs to protect which are derived from intersections of the inner arrays and union of the outer array, as shown by the following example. To protect only ‘Eng’ VMs in the East and all the VMs in the West, specify the following tag id array: [ [1101, 2221], [3031] ], where 1101 is the ‘Eng’ VM Tag id, 2221 is the ‘East’ VM Tag id and 3031 is the ‘West’ VM Tag id. The inner array [1101, 2221] produces a list of VMs that are both tagged with ‘Eng’ and ‘East’ (an intersection). The outer array combines the list from the inner array with list of VMs tagged with ‘West’ (a union). The list of resulting VMs are protected by this Protection Group.

exclude_vm_tag_ids (list of long|int): Array of Arrays of VM Tag Ids

that Specify VMs to Exclude. Optionally specify a list of VMs to exclude from protecting by listing Protection Source ids of VM Tags in this two dimensional array. Using this two dimensional array of Tag ids, the Cluster generates a list of VMs to exclude from protecting, which are derived from intersections of the inner arrays and union of the outer array, as shown by the following example. For example a Datacenter is selected to be protected but you want to exclude all the ‘Former Employees’ VMs in the East and West but keep all the VMs for ‘Former Employees’ in the South which are also stored in this Datacenter, by specifying the following tag id array: [ [1000, 2221], [1000, 3031] ], where 1000 is the ‘Former Employee’ VM Tag id, 2221 is the ‘East’ VM Tag id and 3031 is the ‘West’ VM Tag id. The first inner array [1000, 2221] produces a list of VMs that are both tagged with ‘Former Employees’ and ‘East’ (an intersection). The second inner array [1000, 3031] produces a list of VMs that are both tagged with ‘Former Employees’ and ‘West’ (an intersection). The outer array combines the list of VMs from the two inner arrays. The list of resulting VMs are excluded from being protected this Job.

create_ami (bool): Specifies whether AMI should be created after

taking snapshots of the instance.

ami_creation_frequency (int): The frequency of AMI creation. This

should be set if the option to create AMI is set. A value of n creates an AMI from the snapshots after every n runs. eg. n = 2 implies every alternate backup run starting from the first will create an AMI.

source_id (long|int): Specifies the id of the parent of the objects. source_name (string): Specifies the name of the parent of the

objects.

classmethod from_dictionary(dictionary)

Creates an instance of this model from a dictionary

Args:

dictionary (dictionary): A dictionary representation of the object as obtained from the deserialization of the server’s response. The keys MUST match property names in the API description.

Returns:

object: An instance of this structure class.