Skip to content

CloudFormation module

Index > CloudFormation

Auto-generated documentation for CloudFormation type annotations stubs module types-aiobotocore-cloudformation.

How to install

From PyPI with pip

Install types-aioboto3 for CloudFormation service.

# install with aioboto3 type annotations
python -m pip install 'types-aioboto3[cloudformation]'


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


# standalone installation
python -m pip install types-aiobotocore-cloudformation

How to uninstall

python -m pip uninstall -y types-aiobotocore-cloudformation

Usage

Code samples can be found in Examples.

CloudFormationClient

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

Usage example
from aioboto3.session import Session

from types_aiobotocore_cloudformation.client import CloudFormationClient


session = Session()
async with session.client("cloudformation") as client:
    client: CloudFormationClient

Paginators

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

Usage example
from types_aiobotocore_cloudformation.paginator import DescribeAccountLimitsPaginator

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

Waiters

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

Usage example
from types_aiobotocore_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 session.resource("cloudformation") as CloudFormationServiceResource boto3 documentation

Usage example
from types_aiobotocore_cloudformation.service_resource import CloudFormationServiceResource

Collections

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

Usage example
from types_aiobotocore_cloudformation.service_resource import ServiceResourceStacksCollection

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

Resources

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

Usage example
from types_aiobotocore_cloudformation.service_resource import Event

def get_resource() -> Event:
    return resource.Event(...)

Literals

Type annotations for literals used in methods and schema.

Usage example
from types_aiobotocore_cloudformation.literals import AccountFilterTypeType

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

Typed dictionaries

Type annotations for typed dictionaries used in methods and schema.

Usage example
from types_aiobotocore_cloudformation.type_defs import AccountGateResultTypeDef

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