

.. _AWS\:\:IAM\:\:Group: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html
.. _AWS CloudFormation User Guide: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide
.. _AWS Resource Types Reference: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html
.. _AWS\:\:IAM\:\:Role: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html
.. _Parameter: http://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html
.. _AWS\:\:IAM\:\:InstanceProfile: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html
.. _AWS\:\:IAM\:\:UserToGroupAddition: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html
.. _Template Anatomy: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html
.. _SNS console: http://console.aws.amazon.com/sns
.. _AWS\:\:IAM\:\:User: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html
.. _AWS\:\:IAM\:\:AccessKey: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html
.. _Updating a Stack: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html
.. _Metadata Attribute: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-metadata.html
.. _AWS\:\:IAM\:\:Policy: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html
.. _Stacks: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/concept-stack.html
.. _Prevent Updates to Stack Resources: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html


**************
CloudFormation
**************

.. contents:: Table of Contents
   :depth: 2


======
Client
======



.. py:class:: CloudFormation.Client

  A low-level client representing AWS CloudFormation::

    
    import boto3
    
    client = boto3.client('cloudformation')

  
  These are the available methods:
  
  *   :py:meth:`can_paginate`

  
  *   :py:meth:`cancel_update_stack`

  
  *   :py:meth:`create_stack`

  
  *   :py:meth:`delete_stack`

  
  *   :py:meth:`describe_stack_events`

  
  *   :py:meth:`describe_stack_resource`

  
  *   :py:meth:`describe_stack_resources`

  
  *   :py:meth:`describe_stacks`

  
  *   :py:meth:`estimate_template_cost`

  
  *   :py:meth:`generate_presigned_url`

  
  *   :py:meth:`get_paginator`

  
  *   :py:meth:`get_stack_policy`

  
  *   :py:meth:`get_template`

  
  *   :py:meth:`get_template_summary`

  
  *   :py:meth:`get_waiter`

  
  *   :py:meth:`list_stack_resources`

  
  *   :py:meth:`list_stacks`

  
  *   :py:meth:`set_stack_policy`

  
  *   :py:meth:`signal_resource`

  
  *   :py:meth:`update_stack`

  
  *   :py:meth:`validate_template`

  

  .. py:method:: can_paginate(operation_name)

        
    Check if an operation can be paginated.
    
    :type operation_name: string
    :param operation_name: The operation name.  This is the same name
        as the method name on the client.  For example, if the
        method name is ``create_foo``, and you'd normally invoke the
        operation as ``client.create_foo(**kwargs)``, if the
        ``create_foo`` operation can be paginated, you can use the
        call ``client.get_paginator("create_foo")``.
    
    :return: ``True`` if the operation can be paginated,
        ``False`` otherwise.


  .. py:method:: cancel_update_stack(**kwargs)

    

    Cancels an update on the specified stack. If the call completes successfully, the stack will roll back the update and revert to the previous stack configuration.

     

    .. note::

      Only stacks that are in the UPDATE_IN_PROGRESS state can be canceled.

    

    **Request Syntax** 
    ::

      response = client.cancel_update_stack(
          StackName='string'
      )
    :type StackName: string
    :param StackName: **[REQUIRED]** 

      The name or the unique stack ID that is associated with the stack.

      

    
    
    :returns: None

  .. py:method:: create_stack(**kwargs)

    

    Creates a stack as specified in the template. After the call completes successfully, the stack creation starts. You can check the status of the stack via the  DescribeStacks API.

    

    **Request Syntax** 
    ::

      response = client.create_stack(
          StackName='string',
          TemplateBody='string',
          TemplateURL='string',
          Parameters=[
              {
                  'ParameterKey': 'string',
                  'ParameterValue': 'string',
                  'UsePreviousValue': True|False
              },
          ],
          DisableRollback=True|False,
          TimeoutInMinutes=123,
          NotificationARNs=[
              'string',
          ],
          Capabilities=[
              'CAPABILITY_IAM',
          ],
          OnFailure='DO_NOTHING'|'ROLLBACK'|'DELETE',
          StackPolicyBody='string',
          StackPolicyURL='string',
          Tags=[
              {
                  'Key': 'string',
                  'Value': 'string'
              },
          ]
      )
    :type StackName: string
    :param StackName: **[REQUIRED]** 

      The name that is associated with the stack. The name must be unique in the region in which you are creating the stack.

       

      .. note::

        A stack name can contain only alphanumeric characters (case sensitive) and hyphens. It must start with an alphabetic character and cannot be longer than 255 characters.

      

    
    :type TemplateBody: string
    :param TemplateBody: 

      Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, go to `Template Anatomy`_ in the AWS CloudFormation User Guide.

       

      Conditional: You must specify either the ``TemplateBody`` or the ``TemplateURL`` parameter, but not both.

      

    
    :type TemplateURL: string
    :param TemplateURL: 

      Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) located in an S3 bucket in the same region as the stack. For more information, go to the `Template Anatomy`_ in the AWS CloudFormation User Guide.

       

      Conditional: You must specify either the ``TemplateBody`` or the ``TemplateURL`` parameter, but not both.

      

    
    :type Parameters: list
    :param Parameters: 

      A list of ``Parameter`` structures that specify input parameters for the stack.

      

    
      - *(dict) --* 

        The Parameter data type.

        

      
        - **ParameterKey** *(string) --* 

          The key associated with the parameter. If you don't specify a key and value for a particular parameter, AWS CloudFormation uses the default value that is specified in your template.

          

        
        - **ParameterValue** *(string) --* 

          The value associated with the parameter.

          

        
        - **UsePreviousValue** *(boolean) --* 

          During a stack update, use the existing parameter value that the stack is using for a given parameter key. If you specify ``true`` , do not specify a parameter value.

          

        
      
  
    :type DisableRollback: boolean
    :param DisableRollback: 

      Set to ``true`` to disable rollback of the stack if stack creation failed. You can specify either ``DisableRollback`` or ``OnFailure`` , but not both.

       

      Default: ``false``  

      

    
    :type TimeoutInMinutes: integer
    :param TimeoutInMinutes: 

      The amount of time that can pass before the stack status becomes CREATE_FAILED; if ``DisableRollback`` is not set or is set to ``false`` , the stack will be rolled back.

      

    
    :type NotificationARNs: list
    :param NotificationARNs: 

      The Simple Notification Service (SNS) topic ARNs to publish stack related events. You can find your SNS topic ARNs using the `SNS console`_ or your Command Line Interface (CLI).

      

    
      - *(string) --* 

      
  
    :type Capabilities: list
    :param Capabilities: 

      A list of capabilities that you must specify before AWS CloudFormation can create or update certain stacks. Some stack templates might include resources that can affect permissions in your AWS account. For those stacks, you must explicitly acknowledge their capabilities by specifying this parameter.

       

      Currently, the only valid value is ``CAPABILITY_IAM`` , which is required for the following resources: `AWS\:\:IAM\:\:AccessKey`_ , `AWS\:\:IAM\:\:Group`_ , `AWS\:\:IAM\:\:InstanceProfile`_ , `AWS\:\:IAM\:\:Policy`_ , `AWS\:\:IAM\:\:Role`_ , `AWS\:\:IAM\:\:User`_ , and `AWS\:\:IAM\:\:UserToGroupAddition`_ . If your stack template contains these resources, we recommend that you review any permissions associated with them. If you don't specify this parameter, this action returns an ``InsufficientCapabilities`` error.

      

    
      - *(string) --* 

      
  
    :type OnFailure: string
    :param OnFailure: 

      Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING, ROLLBACK, or DELETE. You can specify either ``OnFailure`` or ``DisableRollback`` , but not both.

       

      Default: ``ROLLBACK`` 

      

    
    :type StackPolicyBody: string
    :param StackPolicyBody: 

      Structure containing the stack policy body. For more information, go to `Prevent Updates to Stack Resources`_ in the AWS CloudFormation User Guide. You can specify either the ``StackPolicyBody`` or the ``StackPolicyURL`` parameter, but not both.

      

    
    :type StackPolicyURL: string
    :param StackPolicyURL: 

      Location of a file containing the stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same region as the stack. You can specify either the ``StackPolicyBody`` or the ``StackPolicyURL`` parameter, but not both.

      

    
    :type Tags: list
    :param Tags: 

      A set of user-defined ``Tags`` to associate with this stack, represented by key/value pairs. Tags defined for the stack are propagated to EC2 resources that are created as part of the stack. A maximum number of 10 tags can be specified.

      

    
      - *(dict) --* 

        The Tag type is used by ``CreateStack`` in the ``Tags`` parameter. It allows you to specify a key/value pair that can be used to store information related to cost allocation for an AWS CloudFormation stack.

        

      
        - **Key** *(string) --* 

          *Required* . A string used to identify this tag. You can specify a maximum of 128 characters for a tag key. Tags owned by Amazon Web Services (AWS) have the reserved prefix: ``aws:`` .

          

        
        - **Value** *(string) --* 

          *Required* . A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value.

          

        
      
  
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'StackId': 'string'
        }
      **Response Structure** 

      

      - *(dict) --* 

        The output for a  CreateStack action.

        
        

        - **StackId** *(string) --* 

          Unique identifier of the stack.

          
    

  .. py:method:: delete_stack(**kwargs)

    

    Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks do not show up in the  DescribeStacks API if the deletion has been completed successfully.

    

    **Request Syntax** 
    ::

      response = client.delete_stack(
          StackName='string'
      )
    :type StackName: string
    :param StackName: **[REQUIRED]** 

      The name or the unique stack ID that is associated with the stack.

      

    
    
    :returns: None

  .. py:method:: describe_stack_events(**kwargs)

    

    Returns all stack related events for a specified stack. For more information about a stack's event history, go to `Stacks`_ in the AWS CloudFormation User Guide.

     

    .. note::

      You can list events for stacks that have failed to create or have been deleted by specifying the unique stack identifier (stack ID).

    

    **Request Syntax** 
    ::

      response = client.describe_stack_events(
          StackName='string',
          NextToken='string'
      )
    :type StackName: string
    :param StackName: 

      The name or the unique stack ID that is associated with the stack, which are not always interchangeable:

       

       
      * Running stacks: You can specify either the stack's name or its unique stack ID.
       
      * Deleted stacks: You must specify the unique stack ID.
       

       

      Default: There is no default value.

      

    
    :type NextToken: string
    :param NextToken: 

      String that identifies the start of the next list of events, if there is one.

       

      Default: There is no default value.

      

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'StackEvents': [
                {
                    'StackId': 'string',
                    'EventId': 'string',
                    'StackName': 'string',
                    'LogicalResourceId': 'string',
                    'PhysicalResourceId': 'string',
                    'ResourceType': 'string',
                    'Timestamp': datetime(2015, 1, 1),
                    'ResourceStatus': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'CREATE_COMPLETE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'DELETE_SKIPPED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'|'UPDATE_COMPLETE',
                    'ResourceStatusReason': 'string',
                    'ResourceProperties': 'string'
                },
            ],
            'NextToken': 'string'
        }
      **Response Structure** 

      

      - *(dict) --* 

        The output for a  DescribeStackEvents action.

        
        

        - **StackEvents** *(list) --* 

          A list of ``StackEvents`` structures.

          
          

          - *(dict) --* 

            The StackEvent data type.

            
            

            - **StackId** *(string) --* 

              The unique ID name of the instance of the stack.

              
            

            - **EventId** *(string) --* 

              The unique ID of this event.

              
            

            - **StackName** *(string) --* 

              The name associated with a stack.

              
            

            - **LogicalResourceId** *(string) --* 

              The logical name of the resource specified in the template.

              
            

            - **PhysicalResourceId** *(string) --* 

              The name or unique identifier associated with the physical instance of the resource.

              
            

            - **ResourceType** *(string) --* 

              Type of resource. (For more information, go to `AWS Resource Types Reference`_ in the AWS CloudFormation User Guide.)

              
            

            - **Timestamp** *(datetime) --* 

              Time the status was updated.

              
            

            - **ResourceStatus** *(string) --* 

              Current status of the resource.

              
            

            - **ResourceStatusReason** *(string) --* 

              Success/failure message associated with the resource.

              
            

            - **ResourceProperties** *(string) --* 

              BLOB of the properties used to create the resource.

              
        
      
        

        - **NextToken** *(string) --* 

          String that identifies the start of the next list of events, if there is one.

          
    

  .. py:method:: describe_stack_resource(**kwargs)

    

    Returns a description of the specified resource in the specified stack.

     

    For deleted stacks, DescribeStackResource returns resource information for up to 90 days after the stack has been deleted.

    

    **Request Syntax** 
    ::

      response = client.describe_stack_resource(
          StackName='string',
          LogicalResourceId='string'
      )
    :type StackName: string
    :param StackName: **[REQUIRED]** 

      The name or the unique stack ID that is associated with the stack, which are not always interchangeable:

       

       
      * Running stacks: You can specify either the stack's name or its unique stack ID.
       
      * Deleted stacks: You must specify the unique stack ID.
       

       

      Default: There is no default value.

      

    
    :type LogicalResourceId: string
    :param LogicalResourceId: **[REQUIRED]** 

      The logical name of the resource as specified in the template.

       

      Default: There is no default value.

      

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'StackResourceDetail': {
                'StackName': 'string',
                'StackId': 'string',
                'LogicalResourceId': 'string',
                'PhysicalResourceId': 'string',
                'ResourceType': 'string',
                'LastUpdatedTimestamp': datetime(2015, 1, 1),
                'ResourceStatus': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'CREATE_COMPLETE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'DELETE_SKIPPED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'|'UPDATE_COMPLETE',
                'ResourceStatusReason': 'string',
                'Description': 'string',
                'Metadata': 'string'
            }
        }
      **Response Structure** 

      

      - *(dict) --* 

        The output for a  DescribeStackResource action.

        
        

        - **StackResourceDetail** *(dict) --* 

          A ``StackResourceDetail`` structure containing the description of the specified resource in the specified stack.

          
          

          - **StackName** *(string) --* 

            The name associated with the stack.

            
          

          - **StackId** *(string) --* 

            Unique identifier of the stack.

            
          

          - **LogicalResourceId** *(string) --* 

            The logical name of the resource specified in the template.

            
          

          - **PhysicalResourceId** *(string) --* 

            The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.

            
          

          - **ResourceType** *(string) --* 

            Type of resource. ((For more information, go to `AWS Resource Types Reference`_ in the AWS CloudFormation User Guide.)

            
          

          - **LastUpdatedTimestamp** *(datetime) --* 

            Time the status was updated.

            
          

          - **ResourceStatus** *(string) --* 

            Current status of the resource.

            
          

          - **ResourceStatusReason** *(string) --* 

            Success/failure message associated with the resource.

            
          

          - **Description** *(string) --* 

            User defined description associated with the resource.

            
          

          - **Metadata** *(string) --* 

            The JSON format content of the ``Metadata`` attribute declared for the resource. For more information, see `Metadata Attribute`_ in the AWS CloudFormation User Guide.

            
      
    

  .. py:method:: describe_stack_resources(**kwargs)

    

    Returns AWS resource descriptions for running and deleted stacks. If ``StackName`` is specified, all the associated resources that are part of the stack are returned. If ``PhysicalResourceId`` is specified, the associated resources of the stack that the resource belongs to are returned.

     

    .. note::

      Only the first 100 resources will be returned. If your stack has more resources than this, you should use ``ListStackResources`` instead.

     

    For deleted stacks, ``DescribeStackResources`` returns resource information for up to 90 days after the stack has been deleted.

     

    You must specify either ``StackName`` or ``PhysicalResourceId`` , but not both. In addition, you can specify ``LogicalResourceId`` to filter the returned result. For more information about resources, the ``LogicalResourceId`` and ``PhysicalResourceId`` , go to the `AWS CloudFormation User Guide`_ .

     

    .. note::

      A ``ValidationError`` is returned if you specify both ``StackName`` and ``PhysicalResourceId`` in the same request.

    

    **Request Syntax** 
    ::

      response = client.describe_stack_resources(
          StackName='string',
          LogicalResourceId='string',
          PhysicalResourceId='string'
      )
    :type StackName: string
    :param StackName: 

      The name or the unique stack ID that is associated with the stack, which are not always interchangeable:

       

       
      * Running stacks: You can specify either the stack's name or its unique stack ID.
       
      * Deleted stacks: You must specify the unique stack ID.
       

       

      Default: There is no default value.

       

      Required: Conditional. If you do not specify ``StackName`` , you must specify ``PhysicalResourceId`` .

      

    
    :type LogicalResourceId: string
    :param LogicalResourceId: 

      The logical name of the resource as specified in the template.

       

      Default: There is no default value.

      

    
    :type PhysicalResourceId: string
    :param PhysicalResourceId: 

      The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.

       

      For example, for an Amazon Elastic Compute Cloud (EC2) instance, ``PhysicalResourceId`` corresponds to the ``InstanceId`` . You can pass the EC2 ``InstanceId`` to ``DescribeStackResources`` to find which stack the instance belongs to and what other resources are part of the stack.

       

      Required: Conditional. If you do not specify ``PhysicalResourceId`` , you must specify ``StackName`` .

       

      Default: There is no default value.

      

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'StackResources': [
                {
                    'StackName': 'string',
                    'StackId': 'string',
                    'LogicalResourceId': 'string',
                    'PhysicalResourceId': 'string',
                    'ResourceType': 'string',
                    'Timestamp': datetime(2015, 1, 1),
                    'ResourceStatus': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'CREATE_COMPLETE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'DELETE_SKIPPED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'|'UPDATE_COMPLETE',
                    'ResourceStatusReason': 'string',
                    'Description': 'string'
                },
            ]
        }
      **Response Structure** 

      

      - *(dict) --* 

        The output for a  DescribeStackResources action.

        
        

        - **StackResources** *(list) --* 

          A list of ``StackResource`` structures.

          
          

          - *(dict) --* 

            The StackResource data type.

            
            

            - **StackName** *(string) --* 

              The name associated with the stack.

              
            

            - **StackId** *(string) --* 

              Unique identifier of the stack.

              
            

            - **LogicalResourceId** *(string) --* 

              The logical name of the resource specified in the template.

              
            

            - **PhysicalResourceId** *(string) --* 

              The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.

              
            

            - **ResourceType** *(string) --* 

              Type of resource. (For more information, go to `AWS Resource Types Reference`_ in the AWS CloudFormation User Guide.)

              
            

            - **Timestamp** *(datetime) --* 

              Time the status was updated.

              
            

            - **ResourceStatus** *(string) --* 

              Current status of the resource.

              
            

            - **ResourceStatusReason** *(string) --* 

              Success/failure message associated with the resource.

              
            

            - **Description** *(string) --* 

              User defined description associated with the resource.

              
        
      
    

  .. py:method:: describe_stacks(**kwargs)

    

    Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created.

    

    **Request Syntax** 
    ::

      response = client.describe_stacks(
          StackName='string',
          NextToken='string'
      )
    :type StackName: string
    :param StackName: 

      The name or the unique stack ID that is associated with the stack, which are not always interchangeable:

       

       
      * Running stacks: You can specify either the stack's name or its unique stack ID.
       
      * Deleted stacks: You must specify the unique stack ID.
       

       

      Default: There is no default value.

      

    
    :type NextToken: string
    :param NextToken: String that identifies the start of the next list of stacks, if there is one.

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'Stacks': [
                {
                    'StackId': 'string',
                    'StackName': 'string',
                    'Description': 'string',
                    'Parameters': [
                        {
                            'ParameterKey': 'string',
                            'ParameterValue': 'string',
                            'UsePreviousValue': True|False
                        },
                    ],
                    'CreationTime': datetime(2015, 1, 1),
                    'LastUpdatedTime': datetime(2015, 1, 1),
                    'StackStatus': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'CREATE_COMPLETE'|'ROLLBACK_IN_PROGRESS'|'ROLLBACK_FAILED'|'ROLLBACK_COMPLETE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'UPDATE_IN_PROGRESS'|'UPDATE_COMPLETE_CLEANUP_IN_PROGRESS'|'UPDATE_COMPLETE'|'UPDATE_ROLLBACK_IN_PROGRESS'|'UPDATE_ROLLBACK_FAILED'|'UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS'|'UPDATE_ROLLBACK_COMPLETE',
                    'StackStatusReason': 'string',
                    'DisableRollback': True|False,
                    'NotificationARNs': [
                        'string',
                    ],
                    'TimeoutInMinutes': 123,
                    'Capabilities': [
                        'CAPABILITY_IAM',
                    ],
                    'Outputs': [
                        {
                            'OutputKey': 'string',
                            'OutputValue': 'string',
                            'Description': 'string'
                        },
                    ],
                    'Tags': [
                        {
                            'Key': 'string',
                            'Value': 'string'
                        },
                    ]
                },
            ],
            'NextToken': 'string'
        }
      **Response Structure** 

      

      - *(dict) --* 

        The output for a  DescribeStacks action.

        
        

        - **Stacks** *(list) --* 

          A list of stack structures.

          
          

          - *(dict) --* 

            The Stack data type.

            
            

            - **StackId** *(string) --* 

              Unique identifier of the stack.

              
            

            - **StackName** *(string) --* 

              The name associated with the stack.

              
            

            - **Description** *(string) --* 

              User defined description associated with the stack.

              
            

            - **Parameters** *(list) --* 

              A list of ``Parameter`` structures.

              
              

              - *(dict) --* 

                The Parameter data type.

                
                

                - **ParameterKey** *(string) --* 

                  The key associated with the parameter. If you don't specify a key and value for a particular parameter, AWS CloudFormation uses the default value that is specified in your template.

                  
                

                - **ParameterValue** *(string) --* 

                  The value associated with the parameter.

                  
                

                - **UsePreviousValue** *(boolean) --* 

                  During a stack update, use the existing parameter value that the stack is using for a given parameter key. If you specify ``true`` , do not specify a parameter value.

                  
            
          
            

            - **CreationTime** *(datetime) --* 

              Time at which the stack was created.

              
            

            - **LastUpdatedTime** *(datetime) --* 

              The time the stack was last updated. This field will only be returned if the stack has been updated at least once.

              
            

            - **StackStatus** *(string) --* 

              Current status of the stack.

              
            

            - **StackStatusReason** *(string) --* 

              Success/failure message associated with the stack status.

              
            

            - **DisableRollback** *(boolean) --* 

              Boolean to enable or disable rollback on stack creation failures:

               

               

               
              *  ``true`` : disable rollback
               
              *  ``false`` : enable rollback
               

               

              
            

            - **NotificationARNs** *(list) --* 

              SNS topic ARNs to which stack related events are published.

              
              

              - *(string) --* 
          
            

            - **TimeoutInMinutes** *(integer) --* 

              The amount of time within which stack creation should complete.

              
            

            - **Capabilities** *(list) --* 

              The capabilities allowed in the stack.

              
              

              - *(string) --* 
          
            

            - **Outputs** *(list) --* 

              A list of output structures.

              
              

              - *(dict) --* 

                The Output data type.

                
                

                - **OutputKey** *(string) --* 

                  The key associated with the output.

                  
                

                - **OutputValue** *(string) --* 

                  The value associated with the output.

                  
                

                - **Description** *(string) --* 

                  User defined description associated with the output.

                  
            
          
            

            - **Tags** *(list) --* 

              A list of ``Tag`` s that specify cost allocation information for the stack.

              
              

              - *(dict) --* 

                The Tag type is used by ``CreateStack`` in the ``Tags`` parameter. It allows you to specify a key/value pair that can be used to store information related to cost allocation for an AWS CloudFormation stack.

                
                

                - **Key** *(string) --* 

                  *Required* . A string used to identify this tag. You can specify a maximum of 128 characters for a tag key. Tags owned by Amazon Web Services (AWS) have the reserved prefix: ``aws:`` .

                  
                

                - **Value** *(string) --* 

                  *Required* . A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value.

                  
            
          
        
      
        

        - **NextToken** *(string) --* String that identifies the start of the next list of stacks, if there is one.
    

  .. py:method:: estimate_template_cost(**kwargs)

    

    Returns the estimated monthly cost of a template. The return value is an AWS Simple Monthly Calculator URL with a query string that describes the resources required to run the template.

    

    **Request Syntax** 
    ::

      response = client.estimate_template_cost(
          TemplateBody='string',
          TemplateURL='string',
          Parameters=[
              {
                  'ParameterKey': 'string',
                  'ParameterValue': 'string',
                  'UsePreviousValue': True|False
              },
          ]
      )
    :type TemplateBody: string
    :param TemplateBody: 

      Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. (For more information, go to `Template Anatomy`_ in the AWS CloudFormation User Guide.)

       

      Conditional: You must pass ``TemplateBody`` or ``TemplateURL`` . If both are passed, only ``TemplateBody`` is used.

      

    
    :type TemplateURL: string
    :param TemplateURL: 

      Location of file containing the template body. The URL must point to a template located in an S3 bucket in the same region as the stack. For more information, go to `Template Anatomy`_ in the AWS CloudFormation User Guide.

       

      Conditional: You must pass ``TemplateURL`` or ``TemplateBody`` . If both are passed, only ``TemplateBody`` is used.

      

    
    :type Parameters: list
    :param Parameters: 

      A list of ``Parameter`` structures that specify input parameters.

      

    
      - *(dict) --* 

        The Parameter data type.

        

      
        - **ParameterKey** *(string) --* 

          The key associated with the parameter. If you don't specify a key and value for a particular parameter, AWS CloudFormation uses the default value that is specified in your template.

          

        
        - **ParameterValue** *(string) --* 

          The value associated with the parameter.

          

        
        - **UsePreviousValue** *(boolean) --* 

          During a stack update, use the existing parameter value that the stack is using for a given parameter key. If you specify ``true`` , do not specify a parameter value.

          

        
      
  
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'Url': 'string'
        }
      **Response Structure** 

      

      - *(dict) --* 

        The output for a  EstimateTemplateCost action.

        
        

        - **Url** *(string) --* 

          An AWS Simple Monthly Calculator URL with a query string that describes the resources required to run the template.

          
    

  .. py:method:: generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

        
    Generate a presigned url given a client, its method, and arguments
    
    :type ClientMethod: string
    :param ClientMethod: The client method to presign for
    
    :type Params: dict
    :param Params: The parameters normally passed to
        ``ClientMethod``.
    
    :type ExpiresIn: int
    :param ExpiresIn: The number of seconds the presigned url is valid
        for. By default it expires in an hour (3600 seconds)
    
    :type HttpMethod: string
    :param HttpMethod: The http method to use on the generated url. By
        default, the http method is whatever is used in the method's model.
    
    :returns: The presigned url


  .. py:method:: get_paginator(operation_name)

        
    Create a paginator for an operation.
    
    :type operation_name: string
    :param operation_name: The operation name.  This is the same name
        as the method name on the client.  For example, if the
        method name is ``create_foo``, and you'd normally invoke the
        operation as ``client.create_foo(**kwargs)``, if the
        ``create_foo`` operation can be paginated, you can use the
        call ``client.get_paginator("create_foo")``.
    
    :raise OperationNotPageableError: Raised if the operation is not
        pageable.  You can use the ``client.can_paginate`` method to
        check if an operation is pageable.
    
    :rtype: L{botocore.paginate.Paginator}
    :return: A paginator object.


  .. py:method:: get_stack_policy(**kwargs)

    

    Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned.

    

    **Request Syntax** 
    ::

      response = client.get_stack_policy(
          StackName='string'
      )
    :type StackName: string
    :param StackName: **[REQUIRED]** 

      The name or unique stack ID that is associated with the stack whose policy you want to get.

      

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'StackPolicyBody': 'string'
        }
      **Response Structure** 

      

      - *(dict) --* 

        The output for the  GetStackPolicy action.

        
        

        - **StackPolicyBody** *(string) --* 

          Structure containing the stack policy body. (For more information, go to `Prevent Updates to Stack Resources`_ in the AWS CloudFormation User Guide.)

          
    

  .. py:method:: get_template(**kwargs)

    

    Returns the template body for a specified stack. You can get the template for running or deleted stacks.

     

    For deleted stacks, GetTemplate returns the template for up to 90 days after the stack has been deleted.

     

    .. note::

      If the template does not exist, a ``ValidationError`` is returned. 

    

    **Request Syntax** 
    ::

      response = client.get_template(
          StackName='string'
      )
    :type StackName: string
    :param StackName: **[REQUIRED]** 

      The name or the unique stack ID that is associated with the stack, which are not always interchangeable:

       

       
      * Running stacks: You can specify either the stack's name or its unique stack ID.
       
      * Deleted stacks: You must specify the unique stack ID.
       

       

      Default: There is no default value.

      

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'TemplateBody': 'string'
        }
      **Response Structure** 

      

      - *(dict) --* 

        The output for  GetTemplate action.

        
        

        - **TemplateBody** *(string) --* 

          Structure containing the template body. (For more information, go to `Template Anatomy`_ in the AWS CloudFormation User Guide.)

          
    

  .. py:method:: get_template_summary(**kwargs)

    

    Returns information about a new or existing template. The ``GetTemplateSummary`` action is useful for viewing parameter information, such as default parameter values and parameter types, before you create or update a stack.

     

    You can use the ``GetTemplateSummary`` action when you submit a template, or you can get template information for a running or deleted stack.

     

    For deleted stacks, ``GetTemplateSummary`` returns the template information for up to 90 days after the stack has been deleted. If the template does not exist, a ``ValidationError`` is returned.

    

    **Request Syntax** 
    ::

      response = client.get_template_summary(
          TemplateBody='string',
          TemplateURL='string',
          StackName='string'
      )
    :type TemplateBody: string
    :param TemplateBody: 

      Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information about templates, see `Template Anatomy`_ in the AWS CloudFormation User Guide.

       

      Conditional: You must specify only one of the following parameters: ``StackName`` , ``TemplateBody`` , or ``TemplateURL`` .

      

    
    :type TemplateURL: string
    :param TemplateURL: 

      Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) located in an Amazon S3 bucket. For more information about templates, see `Template Anatomy`_ in the AWS CloudFormation User Guide.

       

      Conditional: You must specify only one of the following parameters: ``StackName`` , ``TemplateBody`` , or ``TemplateURL`` .

      

    
    :type StackName: string
    :param StackName: 

      The name or the stack ID that is associated with the stack, which are not always interchangeable. For running stacks, you can specify either the stack's name or its unique stack ID. For deleted stack, you must specify the unique stack ID.

       

      Conditional: You must specify only one of the following parameters: ``StackName`` , ``TemplateBody`` , or ``TemplateURL`` .

      

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'Parameters': [
                {
                    'ParameterKey': 'string',
                    'DefaultValue': 'string',
                    'ParameterType': 'string',
                    'NoEcho': True|False,
                    'Description': 'string',
                    'ParameterConstraints': {
                        'AllowedValues': [
                            'string',
                        ]
                    }
                },
            ],
            'Description': 'string',
            'Capabilities': [
                'CAPABILITY_IAM',
            ],
            'CapabilitiesReason': 'string',
            'Version': 'string',
            'Metadata': 'string'
        }
      **Response Structure** 

      

      - *(dict) --* 

        The output for the  GetTemplateSummary action.

        
        

        - **Parameters** *(list) --* 

          A list of parameter declarations that describe various properties for each parameter.

          
          

          - *(dict) --* 

            The ParameterDeclaration data type.

            
            

            - **ParameterKey** *(string) --* 

              The name that is associated with the parameter.

              
            

            - **DefaultValue** *(string) --* 

              The default value of the parameter.

              
            

            - **ParameterType** *(string) --* 

              The type of parameter.

              
            

            - **NoEcho** *(boolean) --* 

              Flag that indicates whether the parameter value is shown as plain text in logs and in the AWS Management Console.

              
            

            - **Description** *(string) --* 

              The description that is associate with the parameter.

              
            

            - **ParameterConstraints** *(dict) --* 

              The criteria that AWS CloudFormation uses to validate parameter values.

              
              

              - **AllowedValues** *(list) --* 

                A list of values that are permitted for a parameter.

                
                

                - *(string) --* 
            
          
        
      
        

        - **Description** *(string) --* 

          The value that is defined in the ``Description`` property of the template.

          
        

        - **Capabilities** *(list) --* 

          The capabilities found within the template. Currently, AWS CloudFormation supports only the CAPABILITY_IAM capability. If your template contains IAM resources, you must specify the CAPABILITY_IAM value for this parameter when you use the  CreateStack or  UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error.

          
          

          - *(string) --* 
      
        

        - **CapabilitiesReason** *(string) --* 

          The list of resources that generated the values in the ``Capabilities`` response element.

          
        

        - **Version** *(string) --* 

          The AWS template format version, which identifies the capabilities of the template.

          
        

        - **Metadata** *(string) --* 

          The value that is defined for the ``Metadata`` property of the template.

          
    

  .. py:method:: get_waiter(waiter_name)

        


  .. py:method:: list_stack_resources(**kwargs)

    

    Returns descriptions of all resources of the specified stack.

     

    For deleted stacks, ListStackResources returns resource information for up to 90 days after the stack has been deleted.

    

    **Request Syntax** 
    ::

      response = client.list_stack_resources(
          StackName='string',
          NextToken='string'
      )
    :type StackName: string
    :param StackName: **[REQUIRED]** 

      The name or the unique stack ID that is associated with the stack, which are not always interchangeable:

       

       
      * Running stacks: You can specify either the stack's name or its unique stack ID.
       
      * Deleted stacks: You must specify the unique stack ID.
       

       

      Default: There is no default value.

      

    
    :type NextToken: string
    :param NextToken: 

      String that identifies the start of the next list of stack resource summaries, if there is one.

       

      Default: There is no default value.

      

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'StackResourceSummaries': [
                {
                    'LogicalResourceId': 'string',
                    'PhysicalResourceId': 'string',
                    'ResourceType': 'string',
                    'LastUpdatedTimestamp': datetime(2015, 1, 1),
                    'ResourceStatus': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'CREATE_COMPLETE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'DELETE_SKIPPED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'|'UPDATE_COMPLETE',
                    'ResourceStatusReason': 'string'
                },
            ],
            'NextToken': 'string'
        }
      **Response Structure** 

      

      - *(dict) --* 

        The output for a  ListStackResources action.

        
        

        - **StackResourceSummaries** *(list) --* 

          A list of ``StackResourceSummary`` structures.

          
          

          - *(dict) --* 

            Contains high-level information about the specified stack resource.

            
            

            - **LogicalResourceId** *(string) --* 

              The logical name of the resource specified in the template.

              
            

            - **PhysicalResourceId** *(string) --* 

              The name or unique identifier that corresponds to a physical instance ID of the resource.

              
            

            - **ResourceType** *(string) --* 

              Type of resource. (For more information, go to `AWS Resource Types Reference`_ in the AWS CloudFormation User Guide.)

              
            

            - **LastUpdatedTimestamp** *(datetime) --* 

              Time the status was updated.

              
            

            - **ResourceStatus** *(string) --* 

              Current status of the resource.

              
            

            - **ResourceStatusReason** *(string) --* 

              Success/failure message associated with the resource.

              
        
      
        

        - **NextToken** *(string) --* 

          String that identifies the start of the next list of stack resources, if there is one.

          
    

  .. py:method:: list_stacks(**kwargs)

    

    Returns the summary information for stacks whose status matches the specified StackStatusFilter. Summary information for stacks that have been deleted is kept for 90 days after the stack is deleted. If no StackStatusFilter is specified, summary information for all stacks is returned (including existing stacks and stacks that have been deleted).

    

    **Request Syntax** 
    ::

      response = client.list_stacks(
          NextToken='string',
          StackStatusFilter=[
              'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'CREATE_COMPLETE'|'ROLLBACK_IN_PROGRESS'|'ROLLBACK_FAILED'|'ROLLBACK_COMPLETE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'UPDATE_IN_PROGRESS'|'UPDATE_COMPLETE_CLEANUP_IN_PROGRESS'|'UPDATE_COMPLETE'|'UPDATE_ROLLBACK_IN_PROGRESS'|'UPDATE_ROLLBACK_FAILED'|'UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS'|'UPDATE_ROLLBACK_COMPLETE',
          ]
      )
    :type NextToken: string
    :param NextToken: 

      String that identifies the start of the next list of stacks, if there is one.

       

      Default: There is no default value.

      

    
    :type StackStatusFilter: list
    :param StackStatusFilter: 

      Stack status to use as a filter. Specify one or more stack status codes to list only stacks with the specified status codes. For a complete list of stack status codes, see the ``StackStatus`` parameter of the  Stack data type.

      

    
      - *(string) --* 

      
  
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'StackSummaries': [
                {
                    'StackId': 'string',
                    'StackName': 'string',
                    'TemplateDescription': 'string',
                    'CreationTime': datetime(2015, 1, 1),
                    'LastUpdatedTime': datetime(2015, 1, 1),
                    'DeletionTime': datetime(2015, 1, 1),
                    'StackStatus': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'CREATE_COMPLETE'|'ROLLBACK_IN_PROGRESS'|'ROLLBACK_FAILED'|'ROLLBACK_COMPLETE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'UPDATE_IN_PROGRESS'|'UPDATE_COMPLETE_CLEANUP_IN_PROGRESS'|'UPDATE_COMPLETE'|'UPDATE_ROLLBACK_IN_PROGRESS'|'UPDATE_ROLLBACK_FAILED'|'UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS'|'UPDATE_ROLLBACK_COMPLETE',
                    'StackStatusReason': 'string'
                },
            ],
            'NextToken': 'string'
        }
      **Response Structure** 

      

      - *(dict) --* 

        The output for  ListStacks action.

        
        

        - **StackSummaries** *(list) --* 

          A list of ``StackSummary`` structures containing information about the specified stacks.

          
          

          - *(dict) --* 

            The StackSummary Data Type

            
            

            - **StackId** *(string) --* 

              Unique stack identifier.

              
            

            - **StackName** *(string) --* 

              The name associated with the stack.

              
            

            - **TemplateDescription** *(string) --* 

              The template description of the template used to create the stack.

              
            

            - **CreationTime** *(datetime) --* 

              The time the stack was created.

              
            

            - **LastUpdatedTime** *(datetime) --* 

              The time the stack was last updated. This field will only be returned if the stack has been updated at least once.

              
            

            - **DeletionTime** *(datetime) --* 

              The time the stack was deleted.

              
            

            - **StackStatus** *(string) --* 

              The current status of the stack.

              
            

            - **StackStatusReason** *(string) --* 

              Success/Failure message associated with the stack status.

              
        
      
        

        - **NextToken** *(string) --* 

          String that identifies the start of the next list of stacks, if there is one.

          
    

  .. py:method:: set_stack_policy(**kwargs)

    

    Sets a stack policy for a specified stack.

    

    **Request Syntax** 
    ::

      response = client.set_stack_policy(
          StackName='string',
          StackPolicyBody='string',
          StackPolicyURL='string'
      )
    :type StackName: string
    :param StackName: **[REQUIRED]** 

      The name or unique stack ID that you want to associate a policy with.

      

    
    :type StackPolicyBody: string
    :param StackPolicyBody: 

      Structure containing the stack policy body. For more information, go to `Prevent Updates to Stack Resources`_ in the AWS CloudFormation User Guide. You can specify either the ``StackPolicyBody`` or the ``StackPolicyURL`` parameter, but not both.

      

    
    :type StackPolicyURL: string
    :param StackPolicyURL: 

      Location of a file containing the stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same region as the stack. You can specify either the ``StackPolicyBody`` or the ``StackPolicyURL`` parameter, but not both.

      

    
    
    :returns: None

  .. py:method:: signal_resource(**kwargs)

    

    Sends a signal to the specified resource with a success or failure status. You can use the SignalResource API in conjunction with a creation policy or update policy. AWS CloudFormation doesn't proceed with a stack creation or update until resources receive the required number of signals or the timeout period is exceeded. The SignalResource API is useful in cases where you want to send signals from anywhere other than an Amazon EC2 instance.

    

    **Request Syntax** 
    ::

      response = client.signal_resource(
          StackName='string',
          LogicalResourceId='string',
          UniqueId='string',
          Status='SUCCESS'|'FAILURE'
      )
    :type StackName: string
    :param StackName: **[REQUIRED]** 

      The stack name or unique stack ID that includes the resource that you want to signal.

      

    
    :type LogicalResourceId: string
    :param LogicalResourceId: **[REQUIRED]** 

      The logical ID of the resource that you want to signal. The logical ID is the name of the resource that given in the template.

      

    
    :type UniqueId: string
    :param UniqueId: **[REQUIRED]** 

      A unique ID of the signal. When you signal Amazon EC2 instances or Auto Scaling groups, specify the instance ID that you are signaling as the unique ID. If you send multiple signals to a single resource (such as signaling a wait condition), each signal requires a different unique ID.

      

    
    :type Status: string
    :param Status: **[REQUIRED]** 

      The status of the signal, which is either success or failure. A failure signal causes AWS CloudFormation to immediately fail the stack creation or update.

      

    
    
    :returns: None

  .. py:method:: update_stack(**kwargs)

    

    Updates a stack as specified in the template. After the call completes successfully, the stack update starts. You can check the status of the stack via the  DescribeStacks action.

     

    To get a copy of the template for an existing stack, you can use the  GetTemplate action.

     

    Tags that were associated with this stack during creation time will still be associated with the stack after an ``UpdateStack`` operation.

     

    For more information about creating an update template, updating a stack, and monitoring the progress of the update, see `Updating a Stack`_ .

    

    **Request Syntax** 
    ::

      response = client.update_stack(
          StackName='string',
          TemplateBody='string',
          TemplateURL='string',
          UsePreviousTemplate=True|False,
          StackPolicyDuringUpdateBody='string',
          StackPolicyDuringUpdateURL='string',
          Parameters=[
              {
                  'ParameterKey': 'string',
                  'ParameterValue': 'string',
                  'UsePreviousValue': True|False
              },
          ],
          Capabilities=[
              'CAPABILITY_IAM',
          ],
          StackPolicyBody='string',
          StackPolicyURL='string',
          NotificationARNs=[
              'string',
          ]
      )
    :type StackName: string
    :param StackName: **[REQUIRED]** 

      The name or unique stack ID of the stack to update.

      

    
    :type TemplateBody: string
    :param TemplateBody: 

      Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. (For more information, go to `Template Anatomy`_ in the AWS CloudFormation User Guide.)

       

      Conditional: You must specify either the ``TemplateBody`` or the ``TemplateURL`` parameter, but not both.

      

    
    :type TemplateURL: string
    :param TemplateURL: 

      Location of file containing the template body. The URL must point to a template located in an S3 bucket in the same region as the stack. For more information, go to `Template Anatomy`_ in the AWS CloudFormation User Guide.

       

      Conditional: You must specify either the ``TemplateBody`` or the ``TemplateURL`` parameter, but not both.

      

    
    :type UsePreviousTemplate: boolean
    :param UsePreviousTemplate: 

      Reuse the existing template that is associated with the stack that you are updating.

      

    
    :type StackPolicyDuringUpdateBody: string
    :param StackPolicyDuringUpdateBody: 

      Structure containing the temporary overriding stack policy body. You can specify either the ``StackPolicyDuringUpdateBody`` or the ``StackPolicyDuringUpdateURL`` parameter, but not both.

       

      If you want to update protected resources, specify a temporary overriding stack policy during this update. If you do not specify a stack policy, the current policy that is associated with the stack will be used.

      

    
    :type StackPolicyDuringUpdateURL: string
    :param StackPolicyDuringUpdateURL: 

      Location of a file containing the temporary overriding stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same region as the stack. You can specify either the ``StackPolicyDuringUpdateBody`` or the ``StackPolicyDuringUpdateURL`` parameter, but not both.

       

      If you want to update protected resources, specify a temporary overriding stack policy during this update. If you do not specify a stack policy, the current policy that is associated with the stack will be used.

      

    
    :type Parameters: list
    :param Parameters: 

      A list of ``Parameter`` structures that specify input parameters for the stack. For more information, see the `Parameter`_ data type.

      

    
      - *(dict) --* 

        The Parameter data type.

        

      
        - **ParameterKey** *(string) --* 

          The key associated with the parameter. If you don't specify a key and value for a particular parameter, AWS CloudFormation uses the default value that is specified in your template.

          

        
        - **ParameterValue** *(string) --* 

          The value associated with the parameter.

          

        
        - **UsePreviousValue** *(boolean) --* 

          During a stack update, use the existing parameter value that the stack is using for a given parameter key. If you specify ``true`` , do not specify a parameter value.

          

        
      
  
    :type Capabilities: list
    :param Capabilities: 

      A list of capabilities that you must specify before AWS CloudFormation can create or update certain stacks. Some stack templates might include resources that can affect permissions in your AWS account. For those stacks, you must explicitly acknowledge their capabilities by specifying this parameter. Currently, the only valid value is ``CAPABILITY_IAM`` , which is required for the following resources: `AWS\:\:IAM\:\:AccessKey`_ , `AWS\:\:IAM\:\:Group`_ , `AWS\:\:IAM\:\:InstanceProfile`_ , `AWS\:\:IAM\:\:Policy`_ , `AWS\:\:IAM\:\:Role`_ , `AWS\:\:IAM\:\:User`_ , and `AWS\:\:IAM\:\:UserToGroupAddition`_ . If your stack template contains these resources, we recommend that you review any permissions associated with them. If you don't specify this parameter, this action returns an InsufficientCapabilities error.

      

    
      - *(string) --* 

      
  
    :type StackPolicyBody: string
    :param StackPolicyBody: 

      Structure containing a new stack policy body. You can specify either the ``StackPolicyBody`` or the ``StackPolicyURL`` parameter, but not both.

       

      You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you do not specify a stack policy, the current policy that is associated with the stack is unchanged.

      

    
    :type StackPolicyURL: string
    :param StackPolicyURL: 

      Location of a file containing the updated stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same region as the stack. You can specify either the ``StackPolicyBody`` or the ``StackPolicyURL`` parameter, but not both.

       

      You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you do not specify a stack policy, the current policy that is associated with the stack is unchanged.

      

    
    :type NotificationARNs: list
    :param NotificationARNs: 

      Update the ARNs for the Amazon SNS topics that are associated with the stack.

      

    
      - *(string) --* 

      
  
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'StackId': 'string'
        }
      **Response Structure** 

      

      - *(dict) --* 

        The output for a  UpdateStack action.

        
        

        - **StackId** *(string) --* 

          Unique identifier of the stack.

          
    

  .. py:method:: validate_template(**kwargs)

    

    Validates a specified template.

    

    **Request Syntax** 
    ::

      response = client.validate_template(
          TemplateBody='string',
          TemplateURL='string'
      )
    :type TemplateBody: string
    :param TemplateBody: 

      Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, go to `Template Anatomy`_ in the AWS CloudFormation User Guide.

       

      Conditional: You must pass ``TemplateURL`` or ``TemplateBody`` . If both are passed, only ``TemplateBody`` is used.

      

    
    :type TemplateURL: string
    :param TemplateURL: 

      Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) located in an S3 bucket in the same region as the stack. For more information, go to `Template Anatomy`_ in the AWS CloudFormation User Guide.

       

      Conditional: You must pass ``TemplateURL`` or ``TemplateBody`` . If both are passed, only ``TemplateBody`` is used.

      

    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'Parameters': [
                {
                    'ParameterKey': 'string',
                    'DefaultValue': 'string',
                    'NoEcho': True|False,
                    'Description': 'string'
                },
            ],
            'Description': 'string',
            'Capabilities': [
                'CAPABILITY_IAM',
            ],
            'CapabilitiesReason': 'string'
        }
      **Response Structure** 

      

      - *(dict) --* 

        The output for  ValidateTemplate action.

        
        

        - **Parameters** *(list) --* 

          A list of ``TemplateParameter`` structures.

          
          

          - *(dict) --* 

            The TemplateParameter data type.

            
            

            - **ParameterKey** *(string) --* 

              The name associated with the parameter.

              
            

            - **DefaultValue** *(string) --* 

              The default value associated with the parameter.

              
            

            - **NoEcho** *(boolean) --* 

              Flag indicating whether the parameter should be displayed as plain text in logs and UIs.

              
            

            - **Description** *(string) --* 

              User defined description associated with the parameter.

              
        
      
        

        - **Description** *(string) --* 

          The description found within the template.

          
        

        - **Capabilities** *(list) --* 

          The capabilities found within the template. Currently, AWS CloudFormation supports only the CAPABILITY_IAM capability. If your template contains IAM resources, you must specify the CAPABILITY_IAM value for this parameter when you use the  CreateStack or  UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error.

          
          

          - *(string) --* 
      
        

        - **CapabilitiesReason** *(string) --* 

          The list of resources that generated the values in the ``Capabilities`` response element.

          
    

==========
Paginators
==========


The available paginators are:

* :py:class:`CloudFormation.Paginator.describe_stack_events`


* :py:class:`CloudFormation.Paginator.describe_stacks`


* :py:class:`CloudFormation.Paginator.list_stack_resources`


* :py:class:`CloudFormation.Paginator.list_stacks`



.. py:class:: CloudFormation.Paginator.describe_stack_events

  ::

    
    paginator = client.get_paginator('describe_stack_events')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`CloudFormation.Client.describe_stack_events`.

    **Request Syntax** 
    ::

      response_iterator = paginator.paginate(
          StackName='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
    :type StackName: string
    :param StackName: 

      The name or the unique stack ID that is associated with the stack, which are not always interchangeable:

       

       
      * Running stacks: You can specify either the stack's name or its unique stack ID.
       
      * Deleted stacks: You must specify the unique stack ID.
       

       

      Default: There is no default value.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'StackEvents': [
                {
                    'StackId': 'string',
                    'EventId': 'string',
                    'StackName': 'string',
                    'LogicalResourceId': 'string',
                    'PhysicalResourceId': 'string',
                    'ResourceType': 'string',
                    'Timestamp': datetime(2015, 1, 1),
                    'ResourceStatus': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'CREATE_COMPLETE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'DELETE_SKIPPED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'|'UPDATE_COMPLETE',
                    'ResourceStatusReason': 'string',
                    'ResourceProperties': 'string'
                },
            ],
            
        }
      **Response Structure** 

      

      - *(dict) --* 

        The output for a  DescribeStackEvents action.

        
        

        - **StackEvents** *(list) --* 

          A list of ``StackEvents`` structures.

          
          

          - *(dict) --* 

            The StackEvent data type.

            
            

            - **StackId** *(string) --* 

              The unique ID name of the instance of the stack.

              
            

            - **EventId** *(string) --* 

              The unique ID of this event.

              
            

            - **StackName** *(string) --* 

              The name associated with a stack.

              
            

            - **LogicalResourceId** *(string) --* 

              The logical name of the resource specified in the template.

              
            

            - **PhysicalResourceId** *(string) --* 

              The name or unique identifier associated with the physical instance of the resource.

              
            

            - **ResourceType** *(string) --* 

              Type of resource. (For more information, go to `AWS Resource Types Reference`_ in the AWS CloudFormation User Guide.)

              
            

            - **Timestamp** *(datetime) --* 

              Time the status was updated.

              
            

            - **ResourceStatus** *(string) --* 

              Current status of the resource.

              
            

            - **ResourceStatusReason** *(string) --* 

              Success/failure message associated with the resource.

              
            

            - **ResourceProperties** *(string) --* 

              BLOB of the properties used to create the resource.

              
        
      
    

.. py:class:: CloudFormation.Paginator.describe_stacks

  ::

    
    paginator = client.get_paginator('describe_stacks')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`CloudFormation.Client.describe_stacks`.

    **Request Syntax** 
    ::

      response_iterator = paginator.paginate(
          StackName='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
    :type StackName: string
    :param StackName: 

      The name or the unique stack ID that is associated with the stack, which are not always interchangeable:

       

       
      * Running stacks: You can specify either the stack's name or its unique stack ID.
       
      * Deleted stacks: You must specify the unique stack ID.
       

       

      Default: There is no default value.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'Stacks': [
                {
                    'StackId': 'string',
                    'StackName': 'string',
                    'Description': 'string',
                    'Parameters': [
                        {
                            'ParameterKey': 'string',
                            'ParameterValue': 'string',
                            'UsePreviousValue': True|False
                        },
                    ],
                    'CreationTime': datetime(2015, 1, 1),
                    'LastUpdatedTime': datetime(2015, 1, 1),
                    'StackStatus': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'CREATE_COMPLETE'|'ROLLBACK_IN_PROGRESS'|'ROLLBACK_FAILED'|'ROLLBACK_COMPLETE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'UPDATE_IN_PROGRESS'|'UPDATE_COMPLETE_CLEANUP_IN_PROGRESS'|'UPDATE_COMPLETE'|'UPDATE_ROLLBACK_IN_PROGRESS'|'UPDATE_ROLLBACK_FAILED'|'UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS'|'UPDATE_ROLLBACK_COMPLETE',
                    'StackStatusReason': 'string',
                    'DisableRollback': True|False,
                    'NotificationARNs': [
                        'string',
                    ],
                    'TimeoutInMinutes': 123,
                    'Capabilities': [
                        'CAPABILITY_IAM',
                    ],
                    'Outputs': [
                        {
                            'OutputKey': 'string',
                            'OutputValue': 'string',
                            'Description': 'string'
                        },
                    ],
                    'Tags': [
                        {
                            'Key': 'string',
                            'Value': 'string'
                        },
                    ]
                },
            ],
            
        }
      **Response Structure** 

      

      - *(dict) --* 

        The output for a  DescribeStacks action.

        
        

        - **Stacks** *(list) --* 

          A list of stack structures.

          
          

          - *(dict) --* 

            The Stack data type.

            
            

            - **StackId** *(string) --* 

              Unique identifier of the stack.

              
            

            - **StackName** *(string) --* 

              The name associated with the stack.

              
            

            - **Description** *(string) --* 

              User defined description associated with the stack.

              
            

            - **Parameters** *(list) --* 

              A list of ``Parameter`` structures.

              
              

              - *(dict) --* 

                The Parameter data type.

                
                

                - **ParameterKey** *(string) --* 

                  The key associated with the parameter. If you don't specify a key and value for a particular parameter, AWS CloudFormation uses the default value that is specified in your template.

                  
                

                - **ParameterValue** *(string) --* 

                  The value associated with the parameter.

                  
                

                - **UsePreviousValue** *(boolean) --* 

                  During a stack update, use the existing parameter value that the stack is using for a given parameter key. If you specify ``true`` , do not specify a parameter value.

                  
            
          
            

            - **CreationTime** *(datetime) --* 

              Time at which the stack was created.

              
            

            - **LastUpdatedTime** *(datetime) --* 

              The time the stack was last updated. This field will only be returned if the stack has been updated at least once.

              
            

            - **StackStatus** *(string) --* 

              Current status of the stack.

              
            

            - **StackStatusReason** *(string) --* 

              Success/failure message associated with the stack status.

              
            

            - **DisableRollback** *(boolean) --* 

              Boolean to enable or disable rollback on stack creation failures:

               

               

               
              *  ``true`` : disable rollback
               
              *  ``false`` : enable rollback
               

               

              
            

            - **NotificationARNs** *(list) --* 

              SNS topic ARNs to which stack related events are published.

              
              

              - *(string) --* 
          
            

            - **TimeoutInMinutes** *(integer) --* 

              The amount of time within which stack creation should complete.

              
            

            - **Capabilities** *(list) --* 

              The capabilities allowed in the stack.

              
              

              - *(string) --* 
          
            

            - **Outputs** *(list) --* 

              A list of output structures.

              
              

              - *(dict) --* 

                The Output data type.

                
                

                - **OutputKey** *(string) --* 

                  The key associated with the output.

                  
                

                - **OutputValue** *(string) --* 

                  The value associated with the output.

                  
                

                - **Description** *(string) --* 

                  User defined description associated with the output.

                  
            
          
            

            - **Tags** *(list) --* 

              A list of ``Tag`` s that specify cost allocation information for the stack.

              
              

              - *(dict) --* 

                The Tag type is used by ``CreateStack`` in the ``Tags`` parameter. It allows you to specify a key/value pair that can be used to store information related to cost allocation for an AWS CloudFormation stack.

                
                

                - **Key** *(string) --* 

                  *Required* . A string used to identify this tag. You can specify a maximum of 128 characters for a tag key. Tags owned by Amazon Web Services (AWS) have the reserved prefix: ``aws:`` .

                  
                

                - **Value** *(string) --* 

                  *Required* . A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value.

                  
            
          
        
      
    

.. py:class:: CloudFormation.Paginator.list_stack_resources

  ::

    
    paginator = client.get_paginator('list_stack_resources')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`CloudFormation.Client.list_stack_resources`.

    **Request Syntax** 
    ::

      response_iterator = paginator.paginate(
          StackName='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
    :type StackName: string
    :param StackName: **[REQUIRED]** 

      The name or the unique stack ID that is associated with the stack, which are not always interchangeable:

       

       
      * Running stacks: You can specify either the stack's name or its unique stack ID.
       
      * Deleted stacks: You must specify the unique stack ID.
       

       

      Default: There is no default value.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'StackResourceSummaries': [
                {
                    'LogicalResourceId': 'string',
                    'PhysicalResourceId': 'string',
                    'ResourceType': 'string',
                    'LastUpdatedTimestamp': datetime(2015, 1, 1),
                    'ResourceStatus': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'CREATE_COMPLETE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'DELETE_SKIPPED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'|'UPDATE_COMPLETE',
                    'ResourceStatusReason': 'string'
                },
            ],
            
        }
      **Response Structure** 

      

      - *(dict) --* 

        The output for a  ListStackResources action.

        
        

        - **StackResourceSummaries** *(list) --* 

          A list of ``StackResourceSummary`` structures.

          
          

          - *(dict) --* 

            Contains high-level information about the specified stack resource.

            
            

            - **LogicalResourceId** *(string) --* 

              The logical name of the resource specified in the template.

              
            

            - **PhysicalResourceId** *(string) --* 

              The name or unique identifier that corresponds to a physical instance ID of the resource.

              
            

            - **ResourceType** *(string) --* 

              Type of resource. (For more information, go to `AWS Resource Types Reference`_ in the AWS CloudFormation User Guide.)

              
            

            - **LastUpdatedTimestamp** *(datetime) --* 

              Time the status was updated.

              
            

            - **ResourceStatus** *(string) --* 

              Current status of the resource.

              
            

            - **ResourceStatusReason** *(string) --* 

              Success/failure message associated with the resource.

              
        
      
    

.. py:class:: CloudFormation.Paginator.list_stacks

  ::

    
    paginator = client.get_paginator('list_stacks')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`CloudFormation.Client.list_stacks`.

    **Request Syntax** 
    ::

      response_iterator = paginator.paginate(
          StackStatusFilter=[
              'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'CREATE_COMPLETE'|'ROLLBACK_IN_PROGRESS'|'ROLLBACK_FAILED'|'ROLLBACK_COMPLETE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'UPDATE_IN_PROGRESS'|'UPDATE_COMPLETE_CLEANUP_IN_PROGRESS'|'UPDATE_COMPLETE'|'UPDATE_ROLLBACK_IN_PROGRESS'|'UPDATE_ROLLBACK_FAILED'|'UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS'|'UPDATE_ROLLBACK_COMPLETE',
          ],
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
    :type StackStatusFilter: list
    :param StackStatusFilter: 

      Stack status to use as a filter. Specify one or more stack status codes to list only stacks with the specified status codes. For a complete list of stack status codes, see the ``StackStatus`` parameter of the  Stack data type.

      

    
      - *(string) --* 

      
  
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'StackSummaries': [
                {
                    'StackId': 'string',
                    'StackName': 'string',
                    'TemplateDescription': 'string',
                    'CreationTime': datetime(2015, 1, 1),
                    'LastUpdatedTime': datetime(2015, 1, 1),
                    'DeletionTime': datetime(2015, 1, 1),
                    'StackStatus': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'CREATE_COMPLETE'|'ROLLBACK_IN_PROGRESS'|'ROLLBACK_FAILED'|'ROLLBACK_COMPLETE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETE_COMPLETE'|'UPDATE_IN_PROGRESS'|'UPDATE_COMPLETE_CLEANUP_IN_PROGRESS'|'UPDATE_COMPLETE'|'UPDATE_ROLLBACK_IN_PROGRESS'|'UPDATE_ROLLBACK_FAILED'|'UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS'|'UPDATE_ROLLBACK_COMPLETE',
                    'StackStatusReason': 'string'
                },
            ],
            
        }
      **Response Structure** 

      

      - *(dict) --* 

        The output for  ListStacks action.

        
        

        - **StackSummaries** *(list) --* 

          A list of ``StackSummary`` structures containing information about the specified stacks.

          
          

          - *(dict) --* 

            The StackSummary Data Type

            
            

            - **StackId** *(string) --* 

              Unique stack identifier.

              
            

            - **StackName** *(string) --* 

              The name associated with the stack.

              
            

            - **TemplateDescription** *(string) --* 

              The template description of the template used to create the stack.

              
            

            - **CreationTime** *(datetime) --* 

              The time the stack was created.

              
            

            - **LastUpdatedTime** *(datetime) --* 

              The time the stack was last updated. This field will only be returned if the stack has been updated at least once.

              
            

            - **DeletionTime** *(datetime) --* 

              The time the stack was deleted.

              
            

            - **StackStatus** *(string) --* 

              The current status of the stack.

              
            

            - **StackStatusReason** *(string) --* 

              Success/Failure message associated with the stack status.

              
        
      
    

================
Service Resource
================



.. py:class:: CloudFormation.ServiceResource()

  A resource representing AWS CloudFormation::

    
    import boto3
    
    cloudformation = boto3.resource('cloudformation')

  
  These are the resource's available actions:
  
  *   :py:meth:`create_stack()`

  
  These are the resource's available sub-resources:
  
  *   :py:meth:`Event()`

  
  *   :py:meth:`Stack()`

  
  *   :py:meth:`StackResource()`

  
  *   :py:meth:`StackResourceSummary()`

  
  These are the resource's available collections:
  
  *   :py:attr:`stacks`

  
  .. rst-class:: admonition-title
  
  Actions
  
  Actions call operations on resources.  They may automatically handle the passing in of arguments set from identifiers and some attributes.
  For more information about actions refer to the :ref:`Resources Introduction Guide<actions_intro>`.
  

  .. py:method:: create_stack(**kwargs)

    

    Creates a stack as specified in the template. After the call completes successfully, the stack creation starts. You can check the status of the stack via the  DescribeStacks API.

    

    **Request Syntax** 
    ::

      stack = cloudformation.create_stack(
          StackName='string',
          TemplateBody='string',
          TemplateURL='string',
          Parameters=[
              {
                  'ParameterKey': 'string',
                  'ParameterValue': 'string',
                  'UsePreviousValue': True|False
              },
          ],
          DisableRollback=True|False,
          TimeoutInMinutes=123,
          NotificationARNs=[
              'string',
          ],
          Capabilities=[
              'CAPABILITY_IAM',
          ],
          OnFailure='DO_NOTHING'|'ROLLBACK'|'DELETE',
          StackPolicyBody='string',
          StackPolicyURL='string',
          Tags=[
              {
                  'Key': 'string',
                  'Value': 'string'
              },
          ]
      )
    :type StackName: string
    :param StackName: **[REQUIRED]** 

      The name that is associated with the stack. The name must be unique in the region in which you are creating the stack.

       

      .. note::

        A stack name can contain only alphanumeric characters (case sensitive) and hyphens. It must start with an alphabetic character and cannot be longer than 255 characters.

      

    
    :type TemplateBody: string
    :param TemplateBody: 

      Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, go to `Template Anatomy`_ in the AWS CloudFormation User Guide.

       

      Conditional: You must specify either the ``TemplateBody`` or the ``TemplateURL`` parameter, but not both.

      

    
    :type TemplateURL: string
    :param TemplateURL: 

      Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) located in an S3 bucket in the same region as the stack. For more information, go to the `Template Anatomy`_ in the AWS CloudFormation User Guide.

       

      Conditional: You must specify either the ``TemplateBody`` or the ``TemplateURL`` parameter, but not both.

      

    
    :type Parameters: list
    :param Parameters: 

      A list of ``Parameter`` structures that specify input parameters for the stack.

      

    
      - *(dict) --* 

        The Parameter data type.

        

      
        - **ParameterKey** *(string) --* 

          The key associated with the parameter. If you don't specify a key and value for a particular parameter, AWS CloudFormation uses the default value that is specified in your template.

          

        
        - **ParameterValue** *(string) --* 

          The value associated with the parameter.

          

        
        - **UsePreviousValue** *(boolean) --* 

          During a stack update, use the existing parameter value that the stack is using for a given parameter key. If you specify ``true`` , do not specify a parameter value.

          

        
      
  
    :type DisableRollback: boolean
    :param DisableRollback: 

      Set to ``true`` to disable rollback of the stack if stack creation failed. You can specify either ``DisableRollback`` or ``OnFailure`` , but not both.

       

      Default: ``false``  

      

    
    :type TimeoutInMinutes: integer
    :param TimeoutInMinutes: 

      The amount of time that can pass before the stack status becomes CREATE_FAILED; if ``DisableRollback`` is not set or is set to ``false`` , the stack will be rolled back.

      

    
    :type NotificationARNs: list
    :param NotificationARNs: 

      The Simple Notification Service (SNS) topic ARNs to publish stack related events. You can find your SNS topic ARNs using the `SNS console`_ or your Command Line Interface (CLI).

      

    
      - *(string) --* 

      
  
    :type Capabilities: list
    :param Capabilities: 

      A list of capabilities that you must specify before AWS CloudFormation can create or update certain stacks. Some stack templates might include resources that can affect permissions in your AWS account. For those stacks, you must explicitly acknowledge their capabilities by specifying this parameter.

       

      Currently, the only valid value is ``CAPABILITY_IAM`` , which is required for the following resources: `AWS\:\:IAM\:\:AccessKey`_ , `AWS\:\:IAM\:\:Group`_ , `AWS\:\:IAM\:\:InstanceProfile`_ , `AWS\:\:IAM\:\:Policy`_ , `AWS\:\:IAM\:\:Role`_ , `AWS\:\:IAM\:\:User`_ , and `AWS\:\:IAM\:\:UserToGroupAddition`_ . If your stack template contains these resources, we recommend that you review any permissions associated with them. If you don't specify this parameter, this action returns an ``InsufficientCapabilities`` error.

      

    
      - *(string) --* 

      
  
    :type OnFailure: string
    :param OnFailure: 

      Determines what action will be taken if stack creation fails. This must be one of: DO_NOTHING, ROLLBACK, or DELETE. You can specify either ``OnFailure`` or ``DisableRollback`` , but not both.

       

      Default: ``ROLLBACK`` 

      

    
    :type StackPolicyBody: string
    :param StackPolicyBody: 

      Structure containing the stack policy body. For more information, go to `Prevent Updates to Stack Resources`_ in the AWS CloudFormation User Guide. You can specify either the ``StackPolicyBody`` or the ``StackPolicyURL`` parameter, but not both.

      

    
    :type StackPolicyURL: string
    :param StackPolicyURL: 

      Location of a file containing the stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same region as the stack. You can specify either the ``StackPolicyBody`` or the ``StackPolicyURL`` parameter, but not both.

      

    
    :type Tags: list
    :param Tags: 

      A set of user-defined ``Tags`` to associate with this stack, represented by key/value pairs. Tags defined for the stack are propagated to EC2 resources that are created as part of the stack. A maximum number of 10 tags can be specified.

      

    
      - *(dict) --* 

        The Tag type is used by ``CreateStack`` in the ``Tags`` parameter. It allows you to specify a key/value pair that can be used to store information related to cost allocation for an AWS CloudFormation stack.

        

      
        - **Key** *(string) --* 

          *Required* . A string used to identify this tag. You can specify a maximum of 128 characters for a tag key. Tags owned by Amazon Web Services (AWS) have the reserved prefix: ``aws:`` .

          

        
        - **Value** *(string) --* 

          *Required* . A string containing the value for this tag. You can specify a maximum of 256 characters for a tag value.

          

        
      
  
    
    :rtype: :py:class:`cloudformation.Stack`
    :returns: A Stack resource
    
  .. rst-class:: admonition-title
  
  Sub-resources
  
  Sub-resources are methods that create a new instance of a child resource. This resource's identifiers get passed along to the child.
  For more information about sub-resources refer to the :ref:`Resources Introduction Guide<subresources_intro>`.
  

  .. py:method:: Event(id)

    Creates a Event resource.::

      event = cloudformation.Event('id')

    :type id: string
    :param id: The Event's id identifier. This **must** be set.
    
    :rtype: :py:class:`CloudFormation.Event`
    :returns: A Event resource
    

  .. py:method:: Stack(name)

    Creates a Stack resource.::

      stack = cloudformation.Stack('name')

    :type name: string
    :param name: The Stack's name identifier. This **must** be set.
    
    :rtype: :py:class:`CloudFormation.Stack`
    :returns: A Stack resource
    

  .. py:method:: StackResource(stack_name,logical_id)

    Creates a StackResource resource.::

      stack_resource = cloudformation.StackResource('stack_name','logical_id')

    :type stack_name: string
    :param stack_name: The StackResource's stack_name identifier. This **must** be set.
    :type logical_id: string
    :param logical_id: The StackResource's logical_id identifier. This **must** be set.
    
    :rtype: :py:class:`CloudFormation.StackResource`
    :returns: A StackResource resource
    

  .. py:method:: StackResourceSummary(stack_name,logical_id)

    Creates a StackResourceSummary resource.::

      stack_resource_summary = cloudformation.StackResourceSummary('stack_name','logical_id')

    :type stack_name: string
    :param stack_name: The StackResourceSummary's stack_name identifier. This **must** be set.
    :type logical_id: string
    :param logical_id: The StackResourceSummary's logical_id identifier. This **must** be set.
    
    :rtype: :py:class:`CloudFormation.StackResourceSummary`
    :returns: A StackResourceSummary resource
    
  .. rst-class:: admonition-title
  
  Collections
  
  Collections provide an interface to iterate over and manipulate groups of resources. 
  For more information about collections refer to the :ref:`Resources Introduction Guide<guide_collections>`.
  

  .. py:attribute:: stacks

    

    .. py:method:: all()

      Creates an iterable of all Stack resources in the collection.

      **Request Syntax** 
      ::

        stack_iterator = cloudformation.stacks.all()
        
      
      :rtype: :py:class:`cloudformation.Stack`
      :returns: A Stack resource
      

    .. py:method:: filter(**kwargs)

      Creates an iterable of all Stack resources in the collection filtered by kwargs passed to method.

      **Request Syntax** 
      ::

        stack_iterator = cloudformation.stacks.filter(
            StackName='string',
            NextToken='string'
        )
      :type StackName: string
      :param StackName: 

        The name or the unique stack ID that is associated with the stack, which are not always interchangeable:

         

         
        * Running stacks: You can specify either the stack's name or its unique stack ID.
         
        * Deleted stacks: You must specify the unique stack ID.
         

         

        Default: There is no default value.

        

      
      :type NextToken: string
      :param NextToken: String that identifies the start of the next list of stacks, if there is one.

      
      
      :rtype: :py:class:`cloudformation.Stack`
      :returns: A Stack resource
      

    .. py:method:: limit(**kwargs)

      Creates an iterable up to a specified amount of Stack resources in the collection.

      **Request Syntax** 
      ::

        stack_iterator = cloudformation.stacks.limit(
            count=123
        )
      :type count: integer
      :param count: The limit to the number of resources in the iterable.

      
      
      :rtype: :py:class:`cloudformation.Stack`
      :returns: A Stack resource
      

    .. py:method:: page_size(**kwargs)

      Creates an iterable of all Stack resources in the collection, but limits the number of items returned by each service call by the specified amount.

      **Request Syntax** 
      ::

        stack_iterator = cloudformation.stacks.page_size(
            count=123
        )
      :type count: integer
      :param count: The number of items returned by each service call

      
      
      :rtype: :py:class:`cloudformation.Stack`
      :returns: A Stack resource
      

=====
Event
=====



.. py:class:: CloudFormation.Event(id)

  A resource representing an AWS CloudFormation Event::

    
    import boto3
    
    cloudformation = boto3.resource('cloudformation')
    event = cloudformation.Event('id')

  :type id: string
  :param id: The Event's id identifier. This **must** be set.
  
  These are the resource's available identifiers:
  
  *   :py:attr:`id`

  
  These are the resource's available attributes:
  
  *   :py:attr:`stack_id`

  
  *   :py:attr:`timestamp`

  
  *   :py:attr:`logical_resource_id`

  
  *   :py:attr:`stack_name`

  
  *   :py:attr:`event_id`

  
  *   :py:attr:`resource_status_reason`

  
  *   :py:attr:`resource_status`

  
  *   :py:attr:`physical_resource_id`

  
  *   :py:attr:`resource_properties`

  
  *   :py:attr:`resource_type`

  
  .. rst-class:: admonition-title
  
  Identifiers
  
  Identifiers are properties of a resource that are set upon instantation of the resource.
  For more information about identifiers refer to the :ref:`Resources Introduction Guide<identifiers_attributes_intro>`.
  

  .. py:attribute:: id

    *(string)* The Event's id identifier. This **must** be set.
  .. rst-class:: admonition-title
  
  Attributes
  
  Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the :py:meth:`load` method.
  For more information about attributes refer to the :ref:`Resources Introduction Guide<identifiers_attributes_intro>`.
  

  .. py:attribute:: stack_id

    *(string)* 

    The unique ID name of the instance of the stack.

    

  .. py:attribute:: timestamp

    *(datetime)* 

    Time the status was updated.

    

  .. py:attribute:: logical_resource_id

    *(string)* 

    The logical name of the resource specified in the template.

    

  .. py:attribute:: stack_name

    *(string)* 

    The name associated with a stack.

    

  .. py:attribute:: event_id

    *(string)* 

    The unique ID of this event.

    

  .. py:attribute:: resource_status_reason

    *(string)* 

    Success/failure message associated with the resource.

    

  .. py:attribute:: resource_status

    *(string)* 

    Current status of the resource.

    

  .. py:attribute:: physical_resource_id

    *(string)* 

    The name or unique identifier associated with the physical instance of the resource.

    

  .. py:attribute:: resource_properties

    *(string)* 

    BLOB of the properties used to create the resource.

    

  .. py:attribute:: resource_type

    *(string)* 

    Type of resource. (For more information, go to `AWS Resource Types Reference`_ in the AWS CloudFormation User Guide.)

    

=====
Stack
=====



.. py:class:: CloudFormation.Stack(name)

  A resource representing an AWS CloudFormation Stack::

    
    import boto3
    
    cloudformation = boto3.resource('cloudformation')
    stack = cloudformation.Stack('name')

  :type name: string
  :param name: The Stack's name identifier. This **must** be set.
  
  These are the resource's available identifiers:
  
  *   :py:attr:`name`

  
  These are the resource's available attributes:
  
  *   :py:attr:`disable_rollback`

  
  *   :py:attr:`description`

  
  *   :py:attr:`parameters`

  
  *   :py:attr:`stack_status_reason`

  
  *   :py:attr:`stack_id`

  
  *   :py:attr:`outputs`

  
  *   :py:attr:`tags`

  
  *   :py:attr:`creation_time`

  
  *   :py:attr:`last_updated_time`

  
  *   :py:attr:`capabilities`

  
  *   :py:attr:`stack_name`

  
  *   :py:attr:`stack_status`

  
  *   :py:attr:`timeout_in_minutes`

  
  *   :py:attr:`notification_arns`

  
  These are the resource's available actions:
  
  *   :py:meth:`cancel_update()`

  
  *   :py:meth:`delete()`

  
  *   :py:meth:`load()`

  
  *   :py:meth:`reload()`

  
  *   :py:meth:`update()`

  
  These are the resource's available sub-resources:
  
  *   :py:meth:`Resource()`

  
  These are the resource's available collections:
  
  *   :py:attr:`events`

  
  *   :py:attr:`resource_summaries`

  
  .. rst-class:: admonition-title
  
  Identifiers
  
  Identifiers are properties of a resource that are set upon instantation of the resource.
  For more information about identifiers refer to the :ref:`Resources Introduction Guide<identifiers_attributes_intro>`.
  

  .. py:attribute:: name

    *(string)* The Stack's name identifier. This **must** be set.
  .. rst-class:: admonition-title
  
  Attributes
  
  Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the :py:meth:`load` method.
  For more information about attributes refer to the :ref:`Resources Introduction Guide<identifiers_attributes_intro>`.
  

  .. py:attribute:: disable_rollback

    *(boolean)* 

    Boolean to enable or disable rollback on stack creation failures:

     

     

     
    *  ``true`` : disable rollback
     
    *  ``false`` : enable rollback
     

     

    

  .. py:attribute:: description

    *(string)* 

    User defined description associated with the stack.

    

  .. py:attribute:: parameters

    *(list)* 

    A list of ``Parameter`` structures.

    

  .. py:attribute:: stack_status_reason

    *(string)* 

    Success/failure message associated with the stack status.

    

  .. py:attribute:: stack_id

    *(string)* 

    Unique identifier of the stack.

    

  .. py:attribute:: outputs

    *(list)* 

    A list of output structures.

    

  .. py:attribute:: tags

    *(list)* 

    A list of ``Tag`` s that specify cost allocation information for the stack.

    

  .. py:attribute:: creation_time

    *(datetime)* 

    Time at which the stack was created.

    

  .. py:attribute:: last_updated_time

    *(datetime)* 

    The time the stack was last updated. This field will only be returned if the stack has been updated at least once.

    

  .. py:attribute:: capabilities

    *(list)* 

    The capabilities allowed in the stack.

    

  .. py:attribute:: stack_name

    *(string)* 

    The name associated with the stack.

    

  .. py:attribute:: stack_status

    *(string)* 

    Current status of the stack.

    

  .. py:attribute:: timeout_in_minutes

    *(integer)* 

    The amount of time within which stack creation should complete.

    

  .. py:attribute:: notification_arns

    *(list)* 

    SNS topic ARNs to which stack related events are published.

    
  .. rst-class:: admonition-title
  
  Actions
  
  Actions call operations on resources.  They may automatically handle the passing in of arguments set from identifiers and some attributes.
  For more information about actions refer to the :ref:`Resources Introduction Guide<actions_intro>`.
  

  .. py:method:: cancel_update()

    

    Cancels an update on the specified stack. If the call completes successfully, the stack will roll back the update and revert to the previous stack configuration.

     

    .. note::

      Only stacks that are in the UPDATE_IN_PROGRESS state can be canceled.

    

    **Request Syntax** 
    ::

      response = stack.cancel_update()
      
    
    :returns: None

  .. py:method:: delete()

    

    Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks do not show up in the  DescribeStacks API if the deletion has been completed successfully.

    

    **Request Syntax** 
    ::

      response = stack.delete()
      
    
    :returns: None

  .. py:method:: load()

    Calls :py:meth:`cloudformation.Client.describe_stacks` to update the attributes of the Stack resource

    **Request Syntax** 

    ::

      stack.load()
    :returns: None

  .. py:method:: reload()

    Calls :py:meth:`cloudformation.Client.describe_stacks` to update the attributes of the Stack resource

    **Request Syntax** 

    ::

      stack.reload()
    :returns: None

  .. py:method:: update(**kwargs)

    

    Updates a stack as specified in the template. After the call completes successfully, the stack update starts. You can check the status of the stack via the  DescribeStacks action.

     

    To get a copy of the template for an existing stack, you can use the  GetTemplate action.

     

    Tags that were associated with this stack during creation time will still be associated with the stack after an ``UpdateStack`` operation.

     

    For more information about creating an update template, updating a stack, and monitoring the progress of the update, see `Updating a Stack`_ .

    

    **Request Syntax** 
    ::

      response = stack.update(
          TemplateBody='string',
          TemplateURL='string',
          UsePreviousTemplate=True|False,
          StackPolicyDuringUpdateBody='string',
          StackPolicyDuringUpdateURL='string',
          Parameters=[
              {
                  'ParameterKey': 'string',
                  'ParameterValue': 'string',
                  'UsePreviousValue': True|False
              },
          ],
          Capabilities=[
              'CAPABILITY_IAM',
          ],
          StackPolicyBody='string',
          StackPolicyURL='string',
          NotificationARNs=[
              'string',
          ]
      )
    :type TemplateBody: string
    :param TemplateBody: 

      Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. (For more information, go to `Template Anatomy`_ in the AWS CloudFormation User Guide.)

       

      Conditional: You must specify either the ``TemplateBody`` or the ``TemplateURL`` parameter, but not both.

      

    
    :type TemplateURL: string
    :param TemplateURL: 

      Location of file containing the template body. The URL must point to a template located in an S3 bucket in the same region as the stack. For more information, go to `Template Anatomy`_ in the AWS CloudFormation User Guide.

       

      Conditional: You must specify either the ``TemplateBody`` or the ``TemplateURL`` parameter, but not both.

      

    
    :type UsePreviousTemplate: boolean
    :param UsePreviousTemplate: 

      Reuse the existing template that is associated with the stack that you are updating.

      

    
    :type StackPolicyDuringUpdateBody: string
    :param StackPolicyDuringUpdateBody: 

      Structure containing the temporary overriding stack policy body. You can specify either the ``StackPolicyDuringUpdateBody`` or the ``StackPolicyDuringUpdateURL`` parameter, but not both.

       

      If you want to update protected resources, specify a temporary overriding stack policy during this update. If you do not specify a stack policy, the current policy that is associated with the stack will be used.

      

    
    :type StackPolicyDuringUpdateURL: string
    :param StackPolicyDuringUpdateURL: 

      Location of a file containing the temporary overriding stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same region as the stack. You can specify either the ``StackPolicyDuringUpdateBody`` or the ``StackPolicyDuringUpdateURL`` parameter, but not both.

       

      If you want to update protected resources, specify a temporary overriding stack policy during this update. If you do not specify a stack policy, the current policy that is associated with the stack will be used.

      

    
    :type Parameters: list
    :param Parameters: 

      A list of ``Parameter`` structures that specify input parameters for the stack. For more information, see the `Parameter`_ data type.

      

    
      - *(dict) --* 

        The Parameter data type.

        

      
        - **ParameterKey** *(string) --* 

          The key associated with the parameter. If you don't specify a key and value for a particular parameter, AWS CloudFormation uses the default value that is specified in your template.

          

        
        - **ParameterValue** *(string) --* 

          The value associated with the parameter.

          

        
        - **UsePreviousValue** *(boolean) --* 

          During a stack update, use the existing parameter value that the stack is using for a given parameter key. If you specify ``true`` , do not specify a parameter value.

          

        
      
  
    :type Capabilities: list
    :param Capabilities: 

      A list of capabilities that you must specify before AWS CloudFormation can create or update certain stacks. Some stack templates might include resources that can affect permissions in your AWS account. For those stacks, you must explicitly acknowledge their capabilities by specifying this parameter. Currently, the only valid value is ``CAPABILITY_IAM`` , which is required for the following resources: `AWS\:\:IAM\:\:AccessKey`_ , `AWS\:\:IAM\:\:Group`_ , `AWS\:\:IAM\:\:InstanceProfile`_ , `AWS\:\:IAM\:\:Policy`_ , `AWS\:\:IAM\:\:Role`_ , `AWS\:\:IAM\:\:User`_ , and `AWS\:\:IAM\:\:UserToGroupAddition`_ . If your stack template contains these resources, we recommend that you review any permissions associated with them. If you don't specify this parameter, this action returns an InsufficientCapabilities error.

      

    
      - *(string) --* 

      
  
    :type StackPolicyBody: string
    :param StackPolicyBody: 

      Structure containing a new stack policy body. You can specify either the ``StackPolicyBody`` or the ``StackPolicyURL`` parameter, but not both.

       

      You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you do not specify a stack policy, the current policy that is associated with the stack is unchanged.

      

    
    :type StackPolicyURL: string
    :param StackPolicyURL: 

      Location of a file containing the updated stack policy. The URL must point to a policy (max size: 16KB) located in an S3 bucket in the same region as the stack. You can specify either the ``StackPolicyBody`` or the ``StackPolicyURL`` parameter, but not both.

       

      You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you do not specify a stack policy, the current policy that is associated with the stack is unchanged.

      

    
    :type NotificationARNs: list
    :param NotificationARNs: 

      Update the ARNs for the Amazon SNS topics that are associated with the stack.

      

    
      - *(string) --* 

      
  
    
    :rtype: dict
    :returns: 
      
      **Response Syntax** 

      
      ::

        {
            'StackId': 'string'
        }
      **Response Structure** 

      

      - *(dict) --* 

        The output for a  UpdateStack action.

        
        

        - **StackId** *(string) --* 

          Unique identifier of the stack.

          
    
  .. rst-class:: admonition-title
  
  Sub-resources
  
  Sub-resources are methods that create a new instance of a child resource. This resource's identifiers get passed along to the child.
  For more information about sub-resources refer to the :ref:`Resources Introduction Guide<subresources_intro>`.
  

  .. py:method:: Resource(logical_id)

    Creates a StackResource resource.::

      stack_resource = stack.Resource('logical_id')

    :type logical_id: string
    :param logical_id: The Resource's logical_id identifier. This **must** be set.
    
    :rtype: :py:class:`CloudFormation.StackResource`
    :returns: A StackResource resource
    
  .. rst-class:: admonition-title
  
  Collections
  
  Collections provide an interface to iterate over and manipulate groups of resources. 
  For more information about collections refer to the :ref:`Resources Introduction Guide<guide_collections>`.
  

  .. py:attribute:: events

    

    .. py:method:: all()

      Creates an iterable of all Event resources in the collection.

      **Request Syntax** 
      ::

        event_iterator = stack.events.all()
        
      
      :rtype: :py:class:`cloudformation.Event`
      :returns: A Event resource
      

    .. py:method:: filter(**kwargs)

      Creates an iterable of all Event resources in the collection filtered by kwargs passed to method.

      **Request Syntax** 
      ::

        event_iterator = stack.events.filter(
            NextToken='string'
        )
      :type NextToken: string
      :param NextToken: 

        String that identifies the start of the next list of events, if there is one.

         

        Default: There is no default value.

        

      
      
      :rtype: :py:class:`cloudformation.Event`
      :returns: A Event resource
      

    .. py:method:: limit(**kwargs)

      Creates an iterable up to a specified amount of Event resources in the collection.

      **Request Syntax** 
      ::

        event_iterator = stack.events.limit(
            count=123
        )
      :type count: integer
      :param count: The limit to the number of resources in the iterable.

      
      
      :rtype: :py:class:`cloudformation.Event`
      :returns: A Event resource
      

    .. py:method:: page_size(**kwargs)

      Creates an iterable of all Event resources in the collection, but limits the number of items returned by each service call by the specified amount.

      **Request Syntax** 
      ::

        event_iterator = stack.events.page_size(
            count=123
        )
      :type count: integer
      :param count: The number of items returned by each service call

      
      
      :rtype: :py:class:`cloudformation.Event`
      :returns: A Event resource
      

  .. py:attribute:: resource_summaries

    

    .. py:method:: all()

      Creates an iterable of all StackResourceSummary resources in the collection.

      **Request Syntax** 
      ::

        stack_resource_summary_iterator = stack.resource_summaries.all()
        
      
      :rtype: :py:class:`cloudformation.StackResourceSummary`
      :returns: A StackResourceSummary resource
      

    .. py:method:: filter(**kwargs)

      Creates an iterable of all StackResourceSummary resources in the collection filtered by kwargs passed to method.

      **Request Syntax** 
      ::

        stack_resource_summary_iterator = stack.resource_summaries.filter(
            NextToken='string'
        )
      :type NextToken: string
      :param NextToken: 

        String that identifies the start of the next list of stack resource summaries, if there is one.

         

        Default: There is no default value.

        

      
      
      :rtype: :py:class:`cloudformation.StackResourceSummary`
      :returns: A StackResourceSummary resource
      

    .. py:method:: limit(**kwargs)

      Creates an iterable up to a specified amount of StackResourceSummary resources in the collection.

      **Request Syntax** 
      ::

        stack_resource_summary_iterator = stack.resource_summaries.limit(
            count=123
        )
      :type count: integer
      :param count: The limit to the number of resources in the iterable.

      
      
      :rtype: :py:class:`cloudformation.StackResourceSummary`
      :returns: A StackResourceSummary resource
      

    .. py:method:: page_size(**kwargs)

      Creates an iterable of all StackResourceSummary resources in the collection, but limits the number of items returned by each service call by the specified amount.

      **Request Syntax** 
      ::

        stack_resource_summary_iterator = stack.resource_summaries.page_size(
            count=123
        )
      :type count: integer
      :param count: The number of items returned by each service call

      
      
      :rtype: :py:class:`cloudformation.StackResourceSummary`
      :returns: A StackResourceSummary resource
      

=============
StackResource
=============



.. py:class:: CloudFormation.StackResource(stack_name,logical_id)

  A resource representing an AWS CloudFormation StackResource::

    
    import boto3
    
    cloudformation = boto3.resource('cloudformation')
    stack_resource = cloudformation.StackResource('stack_name','logical_id')

  :type stack_name: string
  :param stack_name: The StackResource's stack_name identifier. This **must** be set.
  :type logical_id: string
  :param logical_id: The StackResource's logical_id identifier. This **must** be set.
  
  These are the resource's available identifiers:
  
  *   :py:attr:`stack_name`

  
  *   :py:attr:`logical_id`

  
  These are the resource's available attributes:
  
  *   :py:attr:`description`

  
  *   :py:attr:`last_updated_timestamp`

  
  *   :py:attr:`stack_id`

  
  *   :py:attr:`logical_resource_id`

  
  *   :py:attr:`resource_status`

  
  *   :py:attr:`resource_status_reason`

  
  *   :py:attr:`physical_resource_id`

  
  *   :py:attr:`resource_type`

  
  *   :py:attr:`metadata`

  
  These are the resource's available sub-resources:
  
  *   :py:meth:`Stack()`

  
  .. rst-class:: admonition-title
  
  Identifiers
  
  Identifiers are properties of a resource that are set upon instantation of the resource.
  For more information about identifiers refer to the :ref:`Resources Introduction Guide<identifiers_attributes_intro>`.
  

  .. py:attribute:: stack_name

    *(string)* The StackResource's stack_name identifier. This **must** be set.

  .. py:attribute:: logical_id

    *(string)* The StackResource's logical_id identifier. This **must** be set.
  .. rst-class:: admonition-title
  
  Attributes
  
  Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the :py:meth:`load` method.
  For more information about attributes refer to the :ref:`Resources Introduction Guide<identifiers_attributes_intro>`.
  

  .. py:attribute:: description

    *(string)* 

    User defined description associated with the resource.

    

  .. py:attribute:: last_updated_timestamp

    *(datetime)* 

    Time the status was updated.

    

  .. py:attribute:: stack_id

    *(string)* 

    Unique identifier of the stack.

    

  .. py:attribute:: logical_resource_id

    *(string)* 

    The logical name of the resource specified in the template.

    

  .. py:attribute:: resource_status

    *(string)* 

    Current status of the resource.

    

  .. py:attribute:: resource_status_reason

    *(string)* 

    Success/failure message associated with the resource.

    

  .. py:attribute:: physical_resource_id

    *(string)* 

    The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.

    

  .. py:attribute:: resource_type

    *(string)* 

    Type of resource. ((For more information, go to `AWS Resource Types Reference`_ in the AWS CloudFormation User Guide.)

    

  .. py:attribute:: metadata

    *(string)* 

    The JSON format content of the ``Metadata`` attribute declared for the resource. For more information, see `Metadata Attribute`_ in the AWS CloudFormation User Guide.

    
  .. rst-class:: admonition-title
  
  Sub-resources
  
  Sub-resources are methods that create a new instance of a child resource. This resource's identifiers get passed along to the child.
  For more information about sub-resources refer to the :ref:`Resources Introduction Guide<subresources_intro>`.
  

  .. py:method:: Stack()

    Creates a Stack resource.::

      stack = stack_resource.Stack()

    
    :rtype: :py:class:`CloudFormation.Stack`
    :returns: A Stack resource
    

====================
StackResourceSummary
====================



.. py:class:: CloudFormation.StackResourceSummary(stack_name,logical_id)

  A resource representing an AWS CloudFormation StackResourceSummary::

    
    import boto3
    
    cloudformation = boto3.resource('cloudformation')
    stack_resource_summary = cloudformation.StackResourceSummary('stack_name','logical_id')

  :type stack_name: string
  :param stack_name: The StackResourceSummary's stack_name identifier. This **must** be set.
  :type logical_id: string
  :param logical_id: The StackResourceSummary's logical_id identifier. This **must** be set.
  
  These are the resource's available identifiers:
  
  *   :py:attr:`stack_name`

  
  *   :py:attr:`logical_id`

  
  These are the resource's available attributes:
  
  *   :py:attr:`last_updated_timestamp`

  
  *   :py:attr:`logical_resource_id`

  
  *   :py:attr:`resource_status`

  
  *   :py:attr:`resource_status_reason`

  
  *   :py:attr:`physical_resource_id`

  
  *   :py:attr:`resource_type`

  
  These are the resource's available sub-resources:
  
  *   :py:meth:`Resource()`

  
  .. rst-class:: admonition-title
  
  Identifiers
  
  Identifiers are properties of a resource that are set upon instantation of the resource.
  For more information about identifiers refer to the :ref:`Resources Introduction Guide<identifiers_attributes_intro>`.
  

  .. py:attribute:: stack_name

    *(string)* The StackResourceSummary's stack_name identifier. This **must** be set.

  .. py:attribute:: logical_id

    *(string)* The StackResourceSummary's logical_id identifier. This **must** be set.
  .. rst-class:: admonition-title
  
  Attributes
  
  Attributes provide access to the properties of a resource. Attributes are lazy-loaded the first time one is accessed via the :py:meth:`load` method.
  For more information about attributes refer to the :ref:`Resources Introduction Guide<identifiers_attributes_intro>`.
  

  .. py:attribute:: last_updated_timestamp

    *(datetime)* 

    Time the status was updated.

    

  .. py:attribute:: logical_resource_id

    *(string)* 

    The logical name of the resource specified in the template.

    

  .. py:attribute:: resource_status

    *(string)* 

    Current status of the resource.

    

  .. py:attribute:: resource_status_reason

    *(string)* 

    Success/failure message associated with the resource.

    

  .. py:attribute:: physical_resource_id

    *(string)* 

    The name or unique identifier that corresponds to a physical instance ID of the resource.

    

  .. py:attribute:: resource_type

    *(string)* 

    Type of resource. (For more information, go to `AWS Resource Types Reference`_ in the AWS CloudFormation User Guide.)

    
  .. rst-class:: admonition-title
  
  Sub-resources
  
  Sub-resources are methods that create a new instance of a child resource. This resource's identifiers get passed along to the child.
  For more information about sub-resources refer to the :ref:`Resources Introduction Guide<subresources_intro>`.
  

  .. py:method:: Resource()

    Creates a StackResource resource.::

      stack_resource = stack_resource_summary.Resource()

    
    :rtype: :py:class:`CloudFormation.StackResource`
    :returns: A StackResource resource
    