VhQ dZdZdZddlZddlmZddlmZddlmZddlmZdd l m Z dd l m Z dd l m Z dd l mZdd l mZddl mZddl mZddl mZddl mZddlmZddlmZddlmZddlmZddlmZd)dZdedededeeeffdZdededeeeffdZ dededeeeeeffd Z!d!Z"deddfd"Z#d#Z$dede%fd$Z&deddfd%Z'defd&Z(d'Z)e*d(k(re)yy)*a --- module: ec2_snapshot version_added: 1.0.0 short_description: Creates a snapshot from an existing volume description: - Creates an EC2 snapshot from an existing EBS volume. options: volume_id: description: - Volume from which to take the snapshot. required: false type: str description: description: - Description to be applied to the snapshot. required: false type: str instance_id: description: - Instance that has the required volume to snapshot mounted. required: false type: str device_name: description: - Device name of a mounted volume to be snapshotted. required: false type: str snapshot_tags: description: - A dictionary of tags to add to the snapshot. - If the volume has a V(Name) tag this will be automatically added to the snapshot. type: dict required: false default: {} wait: description: - Wait for the snapshot to be ready. type: bool required: false default: true wait_timeout: description: - How long before wait gives up, in seconds. required: false default: 600 type: int state: description: - Whether to add or create a snapshot. required: false default: present choices: ['absent', 'present'] type: str snapshot_id: description: - Snapshot id to remove. required: false type: str last_snapshot_min_age: description: - If the volume's most recent snapshot has started less than O(last_snapshot_min_age) minutes ago, a new snapshot will not be created. required: false default: 0 type: int modify_create_vol_permission: description: - If set to V(true), ec2 snapshot's createVolumePermissions can be modified. required: false type: bool version_added: 6.1.0 purge_create_vol_permission: description: - Whether unspecified group names or user IDs should be removed from the snapshot createVolumePermission. - Must set O(modify_create_vol_permission) to V(True) for when O(purge_create_vol_permission) is set to V(True). required: False type: bool default: False version_added: 6.1.0 group_names: description: - The group to be added or removed. The possible value is V(all). - Mutually exclusive with O(user_ids). required: false type: list elements: str choices: ["all"] version_added: 6.1.0 user_ids: description: - The account user IDs to be added or removed. - If createVolumePermission on snapshot is currently set to Public i.e. O(group_names=all), providing O(user_ids) will not make createVolumePermission Private unless O(modify_create_vol_permission) is set to V(true). - Mutually exclusive with O(group_names). required: false type: list elements: str version_added: 6.1.0 author: "Will Thames (@willthames)" extends_documentation_fragment: - amazon.aws.common.modules - amazon.aws.region.modules - amazon.aws.boto3 ab # Simple snapshot of volume using volume_id - amazon.aws.ec2_snapshot: volume_id: vol-abcdef12 description: snapshot of /data from DB123 taken 2013/11/28 12:18:32 # Snapshot of volume mounted on device_name attached to instance_id - amazon.aws.ec2_snapshot: instance_id: i-12345678 device_name: /dev/sdb1 description: snapshot of /data from DB123 taken 2013/11/28 12:18:32 # Snapshot of volume with tagging - amazon.aws.ec2_snapshot: instance_id: i-12345678 device_name: /dev/sdb1 snapshot_tags: frequency: hourly source: /data # Remove a snapshot - amazon.aws.ec2_snapshot: snapshot_id: snap-abcd1234 state: absent # Create a snapshot only if the most recent one is older than 1 hour - amazon.aws.ec2_snapshot: volume_id: vol-abcdef12 last_snapshot_min_age: 60 - name: Reset snapshot createVolumePermission (change permission to "Private") amazon.aws.ec2_snapshot: snapshot_id: snap-06a6f641234567890 modify_create_vol_permission: true purge_create_vol_permission: true - name: Modify snapshot createVolmePermission to add user IDs (specify purge_create_vol_permission=true to change permssion to "Private") amazon.aws.ec2_snapshot: snapshot_id: snap-06a6f641234567890 modify_create_vol_permission: true user_ids: - '123456789012' - '098765432109' - name: Modify snapshot createVolmePermission - remove all except specified user_ids amazon.aws.ec2_snapshot: snapshot_id: snap-06a6f641234567890 modify_create_vol_permission: true purge_create_vol_permission: true user_ids: - '123456789012' - name: Replace (purge existing) snapshot createVolmePermission annd add user IDs amazon.aws.ec2_snapshot: snapshot_id: snap-06a6f641234567890 modify_create_vol_permission: true purge_create_vol_permission: true user_ids: - '111111111111' - name: Modify snapshot createVolmePermission - make createVolumePermission "Public" amazon.aws.ec2_snapshot: snapshot_id: snap-06a6f641234567890 modify_create_vol_permission: true purge_create_vol_permission: true group_names: - all a snapshot_id: description: The ID of the snapshot. Each snapshot receives a unique identifier when it is created. type: str returned: always sample: snap-01234567 snapshots: description: List of snapshots. returned: always type: list elements: dict contains: description: description: Description specified by the CreateSnapshotRequest that has been applied to all snapshots. type: str returned: always sample: "" encrypted: description: Indicates whether the snapshot is encrypted. type: bool returned: always sample: false owner_id: description: Account id used when creating this snapshot. type: str returned: always sample: 123456 progress: description: Progress this snapshot has made towards completing. type: str returned: always sample: "" snapshot_id: description: Snapshot id that can be used to describe this snapshot. type: str returned: always sample: snap-1234 start_time: description: Time this snapshot was started. This is the same for all snapshots initiated by the same request. type: str returned: always sample: "2024-05-07T14:29:24.523000+00:00" state: description: Current state of the snapshot. type: str returned: always sample: pending tags: description: Tags associated with this snapshot. type: dict returned: always sample: "{ 'Name': 'instance-name' }" volume_id: description: The ID of the volume that was used to create the snapshot. type: str returned: always sample: vol-01234567 volume_size: description: The size of the volume, in GiB. type: int returned: always sample: 8 tags: description: Any tags assigned to the snapshot. type: dict returned: always sample: "{ 'Name': 'instance-name' }" volume_id: description: The ID of the volume that was used to create the snapshot. type: str returned: always sample: vol-01234567 volume_size: description: The size of the volume, in GiB. type: int returned: always sample: 8 N)Any)Dict)List)Optional)camel_dict_to_snake_dict)AnsibleEC2Error)create_snapshot)delete_snapshot)describe_snapshot_attribute)describe_snapshots)describe_volumes)modify_snapshot_attribute)reset_snapshot_attribute)AnsibleAWSModule)ansible_dict_to_boto3_tag_list)boto3_tag_list_to_ansible_dict)!ansible_dict_to_boto3_filter_list)wait_for_resource_statect|dk(ry|s7tjjtjj}t |d}|d}||z }||j |kDry|S)a3 Gets the most recently created snapshot and optionally filters the result if the snapshot is too old :param snapshots: list of snapshots to search :param max_snapshot_age_secs: filter the result if its older than this :param now: simulate time -- used for unit testing :return: rNc |dS)N StartTime)ss k/home/dcms/DCMS/lib/python3.12/site-packages/ansible_collections/amazon/aws/plugins/modules/ec2_snapshot.pyz+_get_most_recent_snapshot..+s Q{^)keyr)lendatetimenowtimezoneutcmax total_seconds) snapshotsmax_snapshot_age_secsr youngest_snapshotsnapshot_start snapshot_ages r_get_most_recent_snapshotr*s{ 9~ ##H$5$5$9$9:I+CD&{3N'L(  % % '*? ? rmodule device_name instance_idreturnc ||d}t|t|}s|j d|d||d}|S#t$r}|j|dYd}~Bd}~wwxYw)N)zattachment.instance-idzattachment.deviceFiltersFailed to describe Volumemsgz Could not find volume with name z attached to instance r)r rr fail_json_aws fail_json)r+ec2r,r-_filtervolumesevolumes rget_volume_by_instancer<6sA-8{["30QRY0Z[ ? }Lbcnbopq QZF M AQ$?@@As> A$AA$r;c t||g}s|jd||dS#t$r}|j|dYd}~=d}~wwxYw)N) VolumeIdsr2r3zCould not find volume with id r)r rr5r6)r+r7r;r9r:s rget_volume_by_idr?DsiA"36(; =fXFG 1: AQ$?@@As, AA  A volume_idcd|i} t|t|}j dgS#t$r}|j|dYd}~3d}~wwxYw)Nz volume-idr0z(Failed to describe snapshots from volumer3 Snapshots)r rrr5get)r+r7r@r8resultsr:s rget_snapshots_by_volumerEPscI&GP$S2ST[2\] ;;{B '' PQ$NOOPs. AAAc d}d}|jjd}|jjd}|jjd}|jjd}|jjd}|jjd} |jjd} |jjd } |rt||||} | d }n t|||} d | vri| d <| d kDrt |||} | d z} t | | }|t | d }|jd}t}|r||d<| r|j| d |i}|r||d<|rdt|dg|d< |jr|jdd| d | d|jd }t|fd|i|}d}|rt!||dd| dz|dgt |d }t#|}||d<|d|d |d||gd }|jd"d!|i|y#t$r}|j|dYd}~d}~wwxYw)#NFr@ descriptionr-r,wait wait_timeoutlast_snapshot_min_age snapshot_tagsVolumeIdTagsr<)r&Name Descriptionsnapshot) ResourceTyperMTagSpecificationsTz2Would have created a snapshot if not in check modeSize)changedr4r@ volume_sizezFailed to create snapshotr3snapshot_completed SnapshotId)delay max_attempts SnapshotIdstags VolumeSize) snapshot_idr@rVr]r%rUr)paramsrCr<r?rEr*rdictupdater check_mode exit_jsonpopr rr5rr)r+r7rQrUr@rGr-r,rHrIrJrKr;current_snapshots volume_tags volume_name_tagsr`r: _snapshotrDs r_create_snapshotrkZsHG !!+.I--##M2K--##M2K--##M2K ==  V $D==$$^4L"MM--.EFMM%%o6M'[+N:& !&#y9 Vvq 3FCK 5 :,->Vkl4VF^D !oof-  'E&M  LL 'i( $/F= ! %/:5A+F& ' E     L$Z0 &v !  :.I&sJiJ6JH    %*!,/0   +8F+; z4check_user_or_group_update_needed..s Q$488G  % Qs FrTUserId)r r`rCrr5anyset) r+r7existing_create_vol_permissionr:purge_permissionsupplied_group_namessupplied_user_idsrexisting_group_namesexisting_user_idss r!check_user_or_group_update_neededrsRP)D V]]..}=Ia* #*%& }}(()FG!==,,]; ))*5 Q2P QQZj>\>b`bcd 1cc # $,@(A A!E99E>ctttttttddtddtddtdttdd gd td tdd td dtd ddg}ddg}ddg}dg}dg}t|||||d}|S)NboolT)typedefaultintiXrraabsentpresent)choicesr)rFliststr)relementsr)rrr)r@rGr-r_r,rHrIrJrKstatemodify_create_vol_permissionrrqrr)r-r_r@)rrrq)rr)r_)rT)r)r-r,) argument_specmutually_exclusive required_ifrequired_one_ofrequired_togethersupports_check_mode)rar)rrrrrr+s rcreate_snapshot_ansible_modulers&FFFF vt ,uc2"q97Hi0)D%)v%6$(fe$D6E2fuugFM" 4# .PK 4O '#-'+ F Mrct}|jjd}|jjd}|jd}|dk(r t ||y|dur t ||y|dk(r t ||yy)Nrrr7rTr)rr`rCclientrorrk)r+rrr7s rmainrCs} + -F MM  g &E#)==#4#45S#T -- C % % -/< ) % r__main__)NN)+ DOCUMENTATIONEXAMPLESRETURNrtypingrrrr0ansible.module_utils.common.dict_transformationsr7ansible_collections.amazon.aws.plugins.module_utils.ec2rr r r r r rr;ansible_collections.amazon.aws.plugins.module_utils.modulesr;ansible_collections.amazon.aws.plugins.module_utils.taggingrrBansible_collections.amazon.aws.plugins.module_utils.transformationr;ansible_collections.amazon.aws.plugins.module_utils.waitersrr*rr<r?rErkror|rrrrr__name__rrrrsZh TC JM ^USSS_VT]\Xffp_4 #3 s Y\ aefiknfnao  - C DcN ($4(c(hW[\`adfiai\jWkNl(N1b&-&d&&, .>  FW4DWdW@)(8)X &  zFr