Skip to content

CloudFormation module#

Index > CloudFormation

Auto-generated documentation for CloudFormation type annotations stubs module mypy-boto3-cloudformation.

How to install#

VSCode extension#

Add AWS Boto3 extension to your VSCode and run AWS boto3: Quick Start command.

Click Modify and select boto3 common and CloudFormation.

From PyPI with pip#

Install boto3-stubs for CloudFormation service.

# install with boto3 type annotations
python -m pip install 'boto3-stubs[cloudformation]'


# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[cloudformation]'


# standalone installation
python -m pip install mypy-boto3-cloudformation

From conda-forge#

Installing mypy-boto3-cloudformation from the conda-forge channel can be achieved by adding conda-forge to your channels with:

conda config --add channels conda-forge
conda config --set channel_priority strict

Once the conda-forge channel has been enabled, mypy-boto3-cloudformation can be installed with:

conda install mypy-boto3-cloudformation

It is possible to list all of the versions of mypy-boto3-cloudformation available on your platform with:

conda search mypy-boto3-cloudformation --channel conda-forge

How to uninstall#

python -m pip uninstall -y mypy-boto3-cloudformation

Usage#

Code samples can be found in Examples.

CloudFormationClient#

Type annotations and code completion for boto3.client("cloudformation") as CloudFormationClient boto3 documentation

# CloudFormationClient usage example

from boto3.session import Session

from mypy_boto3_cloudformation.client import CloudFormationClient

def get_client() -> CloudFormationClient:
    return Session().client("cloudformation")

Paginators#

Type annotations and code completion for paginators from boto3.client("cloudformation").get_paginator("...").

# DescribeAccountLimitsPaginator usage example

from boto3.session import Session

from mypy_boto3_cloudformation.paginator import DescribeAccountLimitsPaginator

def get_describe_account_limits_paginator() -> DescribeAccountLimitsPaginator:
    return Session().client("cloudformation").get_paginator("describe_account_limits"))

Waiters#

Type annotations and code completion for waiters from boto3.client("cloudformation").get_waiter("...").

# ChangeSetCreateCompleteWaiter usage example

from boto3.session import Session

from mypy_boto3_cloudformation.waiter import ChangeSetCreateCompleteWaiter

def get_change_set_create_complete_waiter() -> ChangeSetCreateCompleteWaiter:
    return Session().client("cloudformation").get_waiter("change_set_create_complete")

CloudFormationServiceResource#

Type annotations and code completion for boto3.resource("cloudformation") as CloudFormationServiceResource boto3 documentation

# CloudFormationServiceResource usage example

from boto3.session import Session

from mypy_boto3_cloudformation.service_resource import CloudFormationServiceResource

def get_cloudformation_resource() -> CloudFormationServiceResource:
    return Session().resource("cloudformation")

Collections#

Type annotations and code completion for collections from boto3.resource("cloudformation").*.

# ServiceResourceStacksCollection usage example

from boto3.session import Session

from mypy_boto3_cloudformation.service_resource import ServiceResourceStacksCollection

def get_collection() -> ServiceResourceStacksCollection:
    return Session().resource("cloudformation").stacks

Resources#

Type annotations and code completion for additional resources from boto3.resource("cloudformation").*.

# Event usage example

from boto3.session import Session

from mypy_boto3_cloudformation.service_resource import Event

def get_resource() -> Event:
    return Session().resource("cloudformation").Event(...)

Literals#

Type annotations for literals used in methods and schemas.

# AccountFilterTypeType usage example

from mypy_boto3_cloudformation.literals import AccountFilterTypeType

def get_value() -> AccountFilterTypeType:
    return "DIFFERENCE"

Typed dictionaries#

Type annotations for typed dictionaries used in methods and schema.

# AccountGateResultTypeDef usage example

from mypy_boto3_cloudformation.type_defs import AccountGateResultTypeDef

def get_value() -> AccountGateResultTypeDef:
    return {
        "Status": ...,
    }