VhF@dZdZdZddlZddlZddlZddlZddlmZ ddl Z ddl m Z ddl m Z ddlmZdd lmZdd lmZdd lmZdd lmZej.d ZddZdZdZdZdZdZddZdZ dZ!ddZ"dZ#e$dk(re#yy#e $rYzwxYw)a --- module: cloudformation version_added: 1.0.0 short_description: Create or delete an AWS CloudFormation stack description: - Launches or updates an AWS CloudFormation stack and waits for it complete. options: stack_name: description: - Name of the CloudFormation stack. required: true type: str disable_rollback: description: - If a stacks fails to form, rollback will remove the stack. default: false type: bool on_create_failure: description: - Action to take upon failure of stack creation. Incompatible with the O(disable_rollback) option. choices: - DO_NOTHING - ROLLBACK - DELETE type: str create_timeout: description: - The amount of time (in minutes) that can pass before the stack status becomes V(CREATE_FAILED). type: int template_parameters: description: - A list of hashes of all the template variables for the stack. The value can be a string or a dict. - Dict can be used to set additional template parameter attributes like UsePreviousValue (see example). default: {} type: dict state: description: - If O(state=present), stack will be created. - If O(state=present) and if stack exists and template has changed, it will be updated. - If O(state=absent), stack will be removed. default: present choices: [ present, absent ] type: str template: description: - The local path of the CloudFormation template. - This must be the full path to the file, relative to the working directory. If using roles this may look like V(roles/cloudformation/files/cloudformation-example.json). - If O(state=present) and the stack does not exist yet, either O(template), O(template_body) or O(template_url) must be specified (but only one of them). - If O(state=present), the stack does exist, and neither O(template), O(template_body) nor O(template_url) are specified, the previous template will be reused. - The O(template) parameter has been deprecated and will be remove in a release after 2026-05-01. It is recommended to use O(template_body) with the P(ansible.builtin.template#lookup) lookup plugin. type: path notification_arns: description: - A comma separated list of Simple Notification Service (SNS) topic ARNs to publish stack related events. type: str stack_policy: description: - The path of the file containing the CloudFormation stack policy. A policy cannot be removed once placed, but it can be modified. for instance, allow all updates U(https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html#d0e9051) type: str stack_policy_body: description: - The CloudFormation stack policy in JSON. A policy cannot be removed once placed, but it can be modified. for instance, allow all updates U(https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html#d0e9051) type: json version_added: 1.5.0 stack_policy_on_update_body: description: - The body of the cloudformation stack policy only applied during this update. type: json version_added: 1.5.0 tags: description: - Dictionary of tags to associate with stack and its resources during stack creation. - Can be updated later, updating tags removes previous entries. type: dict template_url: description: - Location of file containing the template body. The URL must point to a template (max size 307,200 bytes) located in an S3 bucket in the same region as the stack. - If O(state=present) and the stack does not exist yet, either O(template), O(template_body) or O(template_url) must be specified (but only one of them). - If O(state=present), the stack does exist, and neither O(template), O(template_body) nor O(template_url) are specified, the previous template will be reused. type: str create_changeset: description: - If stack already exists create a changeset instead of directly applying changes. See the AWS Change Sets docs U(https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-changesets.html). - B(WARNING:) if the stack does not exist, it will be created without changeset. If O(state=absent), the stack will be deleted immediately with no changeset. type: bool default: false changeset_name: description: - Name given to the changeset when creating a changeset. - Only used when O(create_changeset=true). - By default a name prefixed with Ansible-STACKNAME is generated based on input parameters. See the AWS Change Sets docs for more information U(https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-changesets.html) type: str role_arn: description: - The role that AWS CloudFormation assumes to create the stack. See the AWS CloudFormation Service Role docs U(https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-servicerole.html) type: str termination_protection: description: - Enable or disable termination protection on the stack. type: bool template_body: description: - Template body. Use this to pass in the actual body of the CloudFormation template. - If O(state=present) and the stack does not exist yet, either O(template), O(template_body) or O(template_url) must be specified (but only one of them). - If O(state=present), the stack does exist, and neither O(template), O(template_body) nor O(template_url) are specified, the previous template will be reused. type: str events_limit: description: - Maximum number of CloudFormation events to fetch from a stack when creating or updating it. default: 200 type: int backoff_delay: description: - Number of seconds to wait for the next retry. default: 3 type: int required: False backoff_max_delay: description: - Maximum amount of time to wait between retries. default: 30 type: int required: False backoff_retries: description: - Number of times to retry operation. - AWS API throttling mechanism fails CloudFormation module so we have to retry a couple of times. default: 10 type: int required: False capabilities: description: - Specify capabilities that stack template contains. - Valid values are V(CAPABILITY_IAM), V(CAPABILITY_NAMED_IAM) and V(CAPABILITY_AUTO_EXPAND). type: list elements: str default: [ CAPABILITY_IAM, CAPABILITY_NAMED_IAM ] author: - "James S. Martin (@jsmartin)" extends_documentation_fragment: - amazon.aws.common.modules - amazon.aws.region.modules - amazon.aws.boto3 a - name: create a cloudformation stack amazon.aws.cloudformation: stack_name: "ansible-cloudformation" state: "present" region: "us-east-1" disable_rollback: true # The template parameter has been deprecated, use template_body with lookup instead. # template: "files/cloudformation-example.json" template_body: "{{ lookup('file', 'cloudformation-example.json') }}" template_parameters: KeyName: "jmartin" DiskType: "ephemeral" InstanceType: "m1.small" ClusterSize: 3 tags: Stack: "ansible-cloudformation" # Basic role example - name: create a stack, specify role that cloudformation assumes amazon.aws.cloudformation: stack_name: "ansible-cloudformation" state: "present" region: "us-east-1" disable_rollback: true # The template parameter has been deprecated, use template_body with lookup instead. # template: "roles/cloudformation/files/cloudformation-example.json" template_body: "{{ lookup('file', 'cloudformation-example.json') }}" role_arn: 'arn:aws:iam::123456789012:role/cloudformation-iam-role' - name: delete a stack amazon.aws.cloudformation: stack_name: "ansible-cloudformation-old" state: "absent" # Create a stack, pass in template from a URL, disable rollback if stack creation fails, # pass in some parameters to the template, provide tags for resources created - name: create a stack, pass in the template via an URL amazon.aws.cloudformation: stack_name: "ansible-cloudformation" state: present region: us-east-1 disable_rollback: true template_url: https://s3.amazonaws.com/my-bucket/cloudformation.template template_parameters: KeyName: jmartin DiskType: ephemeral InstanceType: m1.small ClusterSize: 3 tags: Stack: ansible-cloudformation # Create a stack, passing in template body using lookup of Jinja2 template, disable rollback if stack creation fails, # pass in some parameters to the template, provide tags for resources created - name: create a stack, pass in the template body via lookup template amazon.aws.cloudformation: stack_name: "ansible-cloudformation" state: present region: us-east-1 disable_rollback: true template_body: "{{ lookup('template', 'cloudformation.j2') }}" template_parameters: KeyName: jmartin DiskType: ephemeral InstanceType: m1.small ClusterSize: 3 tags: Stack: ansible-cloudformation # Pass a template parameter which uses CloudFormation's UsePreviousValue attribute # When use_previous_value is set to True, the given value will be ignored and # CloudFormation will use the value from a previously submitted template. # If use_previous_value is set to False (default) the given value is used. - amazon.aws.cloudformation: stack_name: "ansible-cloudformation" state: "present" region: "us-east-1" template: "files/cloudformation-example.json" template_parameters: DBSnapshotIdentifier: use_previous_value: true value: arn:aws:rds:es-east-1:123456789012:snapshot:rds:my-db-snapshot DBName: use_previous_value: true tags: Stack: "ansible-cloudformation" # Enable termination protection on a stack. # If the stack already exists, this will update its termination protection - name: enable termination protection during stack creation amazon.aws.cloudformation: stack_name: my_stack state: present template_url: https://s3.amazonaws.com/my-bucket/cloudformation.template termination_protection: true # Configure TimeoutInMinutes before the stack status becomes CREATE_FAILED # In this case, if disable_rollback is not set or is set to false, the stack will be rolled back. - name: enable termination protection during stack creation amazon.aws.cloudformation: stack_name: my_stack state: present template_url: https://s3.amazonaws.com/my-bucket/cloudformation.template create_timeout: 5 # Configure rollback behaviour on the unsuccessful creation of a stack allowing # CloudFormation to clean up, or do nothing in the event of an unsuccessful # deployment # In this case, if on_create_failure is set to "DELETE", it will clean up the stack if # it fails to create - name: create stack which will delete on creation failure amazon.aws.cloudformation: stack_name: my_stack state: present template_url: https://s3.amazonaws.com/my-bucket/cloudformation.template on_create_failure: DELETE aC events: description: Most recent events in CloudFormation's event log. This may be from a previous run in some cases. returned: always type: list sample: [ "StackEvent AWS::CloudFormation::Stack stackname UPDATE_COMPLETE", "StackEvent AWS::CloudFormation::Stack stackname UPDATE_COMPLETE_CLEANUP_IN_PROGRESS" ] log: description: Debugging logs. Useful when modifying or finding an error. returned: always type: list elements: str sample: ["updating stack"] change_set_id: description: The ID of the stack change set when created. returned: when O(state=present) and O(create_changeset=true). type: str sample: "arn:aws:cloudformation:us-east-1:123456789012:changeSet/Ansible-StackName-f4496805bd1b2be824d1e315c6884247ede41eb0" stack_resources: description: AWS stack resources and their status. List of dictionaries, one dict per resource. returned: when O(state=present) type: list elements: dict sample: [ { "last_updated_time": "2016-10-11T19:40:14.979000+00:00", "logical_resource_id": "CFTestSg", "physical_resource_id": "cloudformation2-CFTestSg-16UQ4CYQ57O9F", "resource_type": "AWS::EC2::SecurityGroup", "status": "UPDATE_COMPLETE", "status_reason": null } ] stack_outputs: description: A key:value dictionary of all the stack outputs currently defined. If there are no stack outputs, it is an empty dictionary. returned: When O(state=present) type: dict sample: {"MySg": "AnsibleModuleTestYAML-CFTestSg-C8UVS567B6NS"} N)sha1)to_bytes) to_native)boto_exception)is_boto3_error_message)AnsibleAWSModule)AWSRetry)ansible_dict_to_boto3_tag_listc|jdj|d|i}|t|jdSt|jd|dS)Ndescribe_stack_eventsMaxItems) StackNamePaginationConfigzStackEvents[*]z$StackEvents[?ClientRequestToken == 'z']) get_paginatorpaginatelistsearch)cfn stack_name events_limit token_filterpgs m/home/dcms/DCMS/lib/python3.12/site-packages/ansible_collections/amazon/aws/plugins/modules/cloudformation.py_search_eventsr_si  2 3 < <$l3 = BBII./00  @bQR SSc <ggd} t||||}|D]l}d|dd |d d |d } |d j| |d jd s@|dd |d d |d d|d} |dj| n|S#td$r|djd|cYStjj tjj f$r7}t|}|djdt|z|cYd}~Sd}~wwxYw)z_This event data was never correct, it worked as a side effect. So the v2.3 format is different.)eventslogdoes not existrzStack does not exist.zUnknown error: Nz StackEvent ResourceType LogicalResourceIdResourceStatusrFAILEDz: ResourceStatusReason) rrappendbotocore exceptionsValidationError ClientErrorrstrendswith) rrrrretrerr error_msge eventlinefailures rget_stack_eventsr3ks[ #C Z|L'!!N"3!4Aa8K6L5MQqQaObNcd  H Y'   ' ' 1>*+1Q/B-C,DAaHXFYEZZ\]^_u]v\wxG J  g & ' J' ""2 3 E 12 ++'' #3'  E +c)n<= s#B$D.6D$,DDDc d|vrd|vr|jd|jjd|jd|d<n|jd|d<|jjd |jd |d <|jjd 't|jjd |d < |jdd di|}t |||dd||jdd}s|jd|S#t jjt jjf$r/}|j|d|jdYd}~wd}~wwxYw)N TemplateBody TemplateURLz_Either 'template', 'template_body' or 'template_url' is required when the stack does not exist.msgon_create_failure OnFailuredisable_rollbackDisableRollbackcreate_timeoutTimeoutInMinutestermination_protectionEnableTerminationProtection aws_retryTStackIdCREATEClientRequestTokenzFailed to create stack r empty result) fail_jsonparamsgetbool create_stackstack_operationr'r( BotoCoreErrorr* fail_json_aws)module stack_paramsrrresponseresultr.s rrKrKs\)m<.Oq  }},-9$*MM2E$F [!*0--8J*K &' }})*6+1==9I+J '( }}12>6:6==;L;LMe;f6g 23a#3##CdClC C),h lFVFVWkmqFr  ^, M    - -x/B/B/N/N OaS(? @P@PQ\@]?^&_``as 7D7E>%E99E>c^|jd|}|dDcgc]}|d c}Scc}w)NTrAr Summaries ChangeSetName)list_change_sets)rrrescss rlist_changesetsrZs5    DC*-k*: ;BB  ;; ;s *cd|vrd|vr|jd|jd|jd|d<|jdd t|}||d<t ||d}||vr$d t |d }t d d |d |g}n|jd)ddi|}tjdz} tj| kr |jd|d}  ddk(s| ddk(rtjdn<| ddk(r3d| dvsd| dvr%|jd|dt d d}|Sn-tjdtj| krt!|||dd|}|d|d<d |d!|dd"|dd#g|d$<s|jd(|S#tjj$r} |j| Yd} ~  d} ~ wwxYw#t#d%$rt d d&}Yotjjtjj$f$r} |j| d'Yd} ~ d} ~ wwxYw)*Nr5r6z0Either 'template' or 'template_url' is required.r7changeset_namerVrDrz WARNING: z. pending changeset(s) exist(s) for this stack!Fz ChangeSet z already exists.)changedoutputwarningsrATiXIdrArVStatusCREATE_PENDINGCREATE_IN_PROGRESSr$z0The submitted information didn't contain changes StatusReasonNo updates are to be performedzQThe created Change Set did not contain any changes to this stack and was deleted.r]r^CREATE_CHANGESET change_set_idzCreated changeset named z for stack zRYou can execute it using: aws cloudformation execute-change-set --change-set-name zGNOTE that dependencies on this stack might fail due to pending changes!r_No updates are to be performed.Stack is already up-to-date.zFailed to create change setrErF)rGrHpopbuild_changeset_namerZlendictcreate_change_settimedescribe_change_setr'r(rMrNsleepdelete_change_setrLrr*) rOrPrrr\pending_changesetswarningrRrYtime_endnewcsr.s rcreate_changesetrzs\)m<.OOP }}%&2(. 6F(G _%)40.E-l;(6 _%-S,{2KL / /!#&8"9!::hiG%*^*:+lS^F_E`adeghlemdnoY"F:  ^, ME **88.((--.6 ""C DLe,JK    - -x/B/B/N/N OES&CDDEsVB HG/A H-H>1HG>"G93H9G>>HI16I1I,,I1c (d|vr d|vrd|d<|jd|jd|d<|jd|d< |jdd di|t|||d d ||jd d}s|jd|S#t d $rt dd}Y3t jjt jjf$r/}|j|d|jd Yd}~d}~wwxYw)Nr5r6TUsePreviousTemplatestack_policy_on_update_bodyStackPolicyDuringUpdateBodyr;r<rArUPDATErDrkFrlrhzFailed to update stack r7rErF) rH update_stackrLrIrrpr'r(rMr*rNrG)rOrPrrrRr.s rrrs2\)m<.O.2 *+ }}23?6gets the status of a stack while it is created/updated/deletedT) raise_errorsyesDELETEz Stack DeletedrhzStack Not Found)r]failedr^ exceptionFStack not found.)r]rr^ StackStatusROLLBACK_COMPLETEriz Problem with z. Rollback completeDELETE_COMPLETErCz%Stack create failed. Delete complete. _COMPLETEzStack z complete_ROLLBACK_FAILEDz rollback failed_FAILEDz failed) rr&r'r(rMr*r3update traceback format_excr,rrrt) rOrr operationrop_tokenexistedrr-s rrLrLs4G  #FC$OE NN5 !sJ hG9#8&sJ hO tGH  uHZ[\ = ! * *+> ?IQcDc JJ44]S\R]]pCqr sJ = !%6 69;P JJ44Cjk lJ = ! * *; 7 JJ4VI;i3PQ RJ = ! * *+= > JJ44VI;VfCgh iJ = ! * *9 5 JJ44VI;V]C^_ `J JJqMa ##1183F3F3R3RS 9#8&sJ hO tGH  $"/!*!5!5!7  s E44A$G6G65G6cd|vr|dStj|d}tt|dj }d|dd|S) NrVT) sort_keyssurrogate_or_strict)errorszAnsible-r-)jsondumpsrr hexdigest)rP json_params changeset_shas rrnrnLsY,&O,,**\T:K+6KLMWWYM l;/0- AArcZt||d<|jdd |jdddi|}tdD]6}|j d|d}|d d vrn/t j d 8|jd |d |jd|djd}|d dk(rd|vsd|vrd||dSd||ddS#tjjtjjf$r}|j|Yd}~yd}~wwxYw)zSCreate a change set, describe it and delete it before returning check mode outputs.rVrDNrAT<r`rarb)CREATE_COMPLETEr$rzFailed to create change set r7rfr$zdidn't contain changesrgFr]r8metaChangesrF)rnrmrqrangersrrrtrGrurIr'r(r)r*rN)rOrPr change_set_i descriptionreasonr.s rcheck_mode_changesetrVsP$8$FL!)40"*S**JTJ\J ) aB11DPZ[_P`1aK8$(EE JJqM  a   #? _@]?^!_  ` Jt5}|j|d?<dddnC|jd!|jd!|d?<n!|jd |jd |d@<|jjdr"|jdjdA|dB<ng|dB<|jd.|js"|jd"s|jd|dC<n_|jdP|jsD|jd"s5t|jdd>5}|j|dC<ddd|jd} g|dD<| jD]\} } t| tr_t| E} dF| vrt| dF| dG<dH| vr%t!| dHrd| dI<| j#dGd|dDj | u|dDj | t| dJt|jjd%trt%|jd%|dK<|jjd$r|jd$|dL<i} t'j(|jjd)|jjd,|jjd.M}|j+dN|O}t-|||d=}|jrq|d k(r|r|j/ddPgQnU|d k(r|s|j/ddRgQn9|d k(r|s|j/ddSgQn|j.diit1||||d k(r|s(t3||||jjd'} nd}|jjd"r)t5||||jjd'} d}|jjd&6t7|||d=t!|jjd&| dT<|s't9||||jjd'} t-|||d=}|O| jdUi| dU<|jdVgD]}|dW| dU|dX<g}|j;d|d=Y}|jdZgD]E}|j |d[|jd\d]|d^|d_|d`|jdadbG|| dc<n|d k(r t-|||d=}|sdddde} n~|jdL|j=d|d=Yn|j=d|d=|dLft?|||d=dg|jjd'|jdhd} |j.dii| y#1swY~xYw#1swYxYw#t@jBjDt@jBjFf$r}|jI|Yd}~zd}~wwxYw)jNrT)requiredtemplate_parametersFrp)rtypedefaultstatepresentabsent)rchoicestemplatepathz 2026-05-01z amazon.aws)rrrremoved_at_dateremoved_from_collectionnotification_arns)rr stack_policystack_policy_bodyr)rrrr}r;rJ)rrr9) DO_NOTHINGROLLBACKr)rrrr=int template_url template_bodyrzr\role_arntagsr?rbackoff_retries )rrr backoff_delaybackoff_max_delay capabilitiesrr+CAPABILITY_IAMCAPABILITY_NAMED_IAM)relementsr)rrr) argument_specmutually_exclusivesupports_check_mode)rrCAPABILITY_AUTO_EXPANDz%Specified capabilities are invalid : z3, please check documentation for valid capabilitiesr7) CapabilitiesrDrrr5r6,NotificationARNsStackPolicyBody Parameters) ParameterKeyvalueParameterValueuse_previous_valueUsePreviousValue)rrTagsRoleARN)retriesdelay max_delaycloudformation)retry_decoratorzStack would be deletedrzStack doesn't existzNew stack would be createdr] stack_outputsOutputs OutputValue OutputKeyrTStackResourceSummariesr"PhysicalResourceIdr LastUpdatedTimestampr#r%)logical_resource_idphysical_resource_id resource_typelast_updated_timestatus status_reasonstack_resourcesrrh)rArrrrDrF)%rprrHrIr&rGruuiduuid4openreadsplit check_modeitems isinstancer+rJrmr r jittered_backoffclientr exit_jsonrrKrzrrlist_stack_resources delete_stackrLr'r(rMr*rN)rrOinvalid_capabilitiesuser_capabilitiesuser_caprPr template_fhstack_policy_fhrkvparamrRrrrchangeset_updatedrr^rreslistrXr.s rmainrs & %fbI9y(.CD($0  te<$7te&I%)F$Se&9 teEij!"Du5#$$7%&4%8'(e&9)*D59+,dU3-.$V ,/0 $Dv>12#E234%eD56q5A78E2F9:v@PRh?ij;M@#IL^`sKtu F  )).9%2 _ _ ' ' 1278L7OPCD  *' 5L MM' "E & l ;L }}Z , &-- +S 1 >[+6+;+;+=L ( > >  ' 3'-}}_'E ^$ ~ & 2&,mmN&C ]# }},-+1==9L+M+S+STW+X '(+- '(  )*6!! 01*0--8K*L &' ~ & 26;L;LU[UbUbcuUv &--/ 5 E.=.B.B.DL* + E!--(=>!#L#))+]1 a a(E!|*-aj/&'#q(T!4H2I-J,0() *D1  & - -e 4  & - -qTWXYTZ.[ \]"&--##F+T2=fmmF>ST V }}$"(-- "; Y F// !!"34mm0--##$78O --(/- JC l;.GHJ  H    T/Gb  Q h z   U0EB  O i    T/KRT  U F   O3FL#N O !&,V]]=N=N~=^_F % }}  !34)&,V]]EVEVWeEfg$(!}}  !9:F$ACk!:DARARSkAl >( E Ef##1183F3F3R3RS &   % % &s1+_? ` B`?`  `7a+a&&a+__main__)N)F)% DOCUMENTATIONEXAMPLESRETURNrrrrrhashlibrr' ImportErroransible.module_utils._textrrr!sa Ft l( T   00W_XPfTT8>< ;|4$4EnB">,EP zFC  sBBB