CloudFormation module#
Index > CloudFormation
Auto-generated documentation for CloudFormation type annotations stubs module mypy-boto3-cloudformation.
How to install#
Generate locally (recommended)#
You can generate type annotations for boto3
package locally with mypy-boto3-builder
.
Use uv for build isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'boto3==1.36.26' mypy-boto3-builder
- Select
boto3-stubs
AWS SDK. - Add
CloudFormation
service. - Use provided commands to install generated packages.
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#
Add 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
List all available 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"))
- DescribeAccountLimitsPaginator
- DescribeChangeSetPaginator
- DescribeStackEventsPaginator
- DescribeStacksPaginator
- ListChangeSetsPaginator
- ListExportsPaginator
- ListGeneratedTemplatesPaginator
- ListImportsPaginator
- ListResourceScanRelatedResourcesPaginator
- ListResourceScanResourcesPaginator
- ListResourceScansPaginator
- ListStackInstancesPaginator
- ListStackRefactorActionsPaginator
- ListStackRefactorsPaginator
- ListStackResourcesPaginator
- ListStackSetOperationResultsPaginator
- ListStackSetOperationsPaginator
- ListStackSetsPaginator
- ListStacksPaginator
- ListTypesPaginator
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")
- ChangeSetCreateCompleteWaiter
- StackCreateCompleteWaiter
- StackDeleteCompleteWaiter
- StackExistsWaiter
- StackImportCompleteWaiter
- StackRefactorCreateCompleteWaiter
- StackRefactorExecuteCompleteWaiter
- StackRollbackCompleteWaiter
- StackUpdateCompleteWaiter
- TypeRegistrationCompleteWaiter
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 session.resource("cloudformation").*
.
# Event usage example
from mypy_boto3_cloudformation.service_resource import Event
def get_resource() -> Event:
return resource.Event(...)
Literals#
Type annotations for literals used in methods and schema.
# AccountFilterTypeType usage example
from mypy_boto3_cloudformation.literals import AccountFilterTypeType
def get_value() -> AccountFilterTypeType:
return "DIFFERENCE"
- AccountFilterTypeType
- AccountGateStatusType
- AttributeChangeTypeType
- CallAsType
- CapabilityType
- CategoryType
- ChangeActionType
- ChangeSetCreateCompleteWaiterName
- ChangeSetHooksStatusType
- ChangeSetStatusType
- ChangeSetTypeType
- ChangeSourceType
- ChangeTypeType
- ConcurrencyModeType
- DeletionModeType
- DeprecatedStatusType
- DescribeAccountLimitsPaginatorName
- DescribeChangeSetPaginatorName
- DescribeStackEventsPaginatorName
- DescribeStacksPaginatorName
- DetailedStatusType
- DifferenceTypeType
- EvaluationTypeType
- ExecutionStatusType
- GeneratedTemplateDeletionPolicyType
- GeneratedTemplateResourceStatusType
- GeneratedTemplateStatusType
- GeneratedTemplateUpdateReplacePolicyType
- HandlerErrorCodeType
- HookFailureModeType
- HookInvocationPointType
- HookStatusType
- HookTargetTypeType
- IdentityProviderType
- ListChangeSetsPaginatorName
- ListExportsPaginatorName
- ListGeneratedTemplatesPaginatorName
- ListHookResultsTargetTypeType
- ListImportsPaginatorName
- ListResourceScanRelatedResourcesPaginatorName
- ListResourceScanResourcesPaginatorName
- ListResourceScansPaginatorName
- ListStackInstancesPaginatorName
- ListStackRefactorActionsPaginatorName
- ListStackRefactorsPaginatorName
- ListStackResourcesPaginatorName
- ListStackSetOperationResultsPaginatorName
- ListStackSetOperationsPaginatorName
- ListStackSetsPaginatorName
- ListStacksPaginatorName
- ListTypesPaginatorName
- OnFailureType
- OnStackFailureType
- OperationResultFilterNameType
- OperationStatusType
- OrganizationStatusType
- PermissionModelsType
- PolicyActionType
- ProvisioningTypeType
- PublisherStatusType
- RegionConcurrencyTypeType
- RegistrationStatusType
- RegistryTypeType
- ReplacementType
- RequiresRecreationType
- ResourceAttributeType
- ResourceScanStatusType
- ResourceSignalStatusType
- ResourceStatusType
- StackCreateCompleteWaiterName
- StackDeleteCompleteWaiterName
- StackDriftDetectionStatusType
- StackDriftStatusType
- StackExistsWaiterName
- StackImportCompleteWaiterName
- StackInstanceDetailedStatusType
- StackInstanceFilterNameType
- StackInstanceStatusType
- StackRefactorActionEntityType
- StackRefactorActionTypeType
- StackRefactorCreateCompleteWaiterName
- StackRefactorDetectionType
- StackRefactorExecuteCompleteWaiterName
- StackRefactorExecutionStatusType
- StackRefactorStatusType
- StackResourceDriftStatusType
- StackRollbackCompleteWaiterName
- StackSetDriftDetectionStatusType
- StackSetDriftStatusType
- StackSetOperationActionType
- StackSetOperationResultStatusType
- StackSetOperationStatusType
- StackSetStatusType
- StackStatusType
- StackUpdateCompleteWaiterName
- TemplateFormatType
- TemplateStageType
- ThirdPartyTypeType
- TypeRegistrationCompleteWaiterName
- TypeTestsStatusType
- VersionBumpType
- VisibilityType
- WarningTypeType
- CloudFormationServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- WaiterName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.
- AccountGateResultTypeDef
- AccountLimitTypeDef
- LoggingConfigTypeDef
- ResponseMetadataTypeDef
- AutoDeploymentTypeDef
- TypeConfigurationIdentifierTypeDef
- TypeConfigurationDetailsTypeDef
- CancelUpdateStackInputStackCancelUpdateTypeDef
- CancelUpdateStackInputTypeDef
- ChangeSetHookResourceTargetDetailsTypeDef
- ChangeSetSummaryTypeDef
- ContinueUpdateRollbackInputTypeDef
- ParameterTypeDef
- ResourceToImportTypeDef
- TagTypeDef
- ResourceDefinitionTypeDef
- TemplateConfigurationTypeDef
- StackDefinitionTypeDef
- ManagedExecutionTypeDef
- DeactivateTypeInputTypeDef
- DeleteChangeSetInputTypeDef
- DeleteGeneratedTemplateInputTypeDef
- DeleteStackInputStackDeleteTypeDef
- DeleteStackInputTypeDef
- DeleteStackSetInputTypeDef
- DeploymentTargetsOutputTypeDef
- DeploymentTargetsTypeDef
- DeregisterTypeInputTypeDef
- PaginatorConfigTypeDef
- DescribeAccountLimitsInputTypeDef
- DescribeChangeSetHooksInputTypeDef
- DescribeChangeSetInputTypeDef
- WaiterConfigTypeDef
- DescribeGeneratedTemplateInputTypeDef
- TemplateProgressTypeDef
- DescribeOrganizationsAccessInputTypeDef
- DescribePublisherInputTypeDef
- DescribeResourceScanInputTypeDef
- DescribeStackDriftDetectionStatusInputTypeDef
- DescribeStackEventsInputTypeDef
- StackEventTypeDef
- DescribeStackInstanceInputTypeDef
- DescribeStackRefactorInputTypeDef
- DescribeStackResourceDriftsInputTypeDef
- DescribeStackResourceInputTypeDef
- DescribeStackResourcesInputTypeDef
- DescribeStackSetInputTypeDef
- DescribeStackSetOperationInputTypeDef
- DescribeStacksInputTypeDef
- DescribeTypeInputTypeDef
- RequiredActivatedTypeTypeDef
- DescribeTypeRegistrationInputTypeDef
- DetectStackDriftInputTypeDef
- DetectStackResourceDriftInputTypeDef
- ExecuteChangeSetInputTypeDef
- ExecuteStackRefactorInputTypeDef
- ExportTypeDef
- GetGeneratedTemplateInputTypeDef
- GetStackPolicyInputTypeDef
- GetTemplateInputTypeDef
- TemplateSummaryConfigTypeDef
- ResourceIdentifierSummaryTypeDef
- WarningsTypeDef
- HookResultSummaryTypeDef
- ListChangeSetsInputTypeDef
- ListExportsInputTypeDef
- ListGeneratedTemplatesInputTypeDef
- TemplateSummaryTypeDef
- ListHookResultsInputTypeDef
- ListImportsInputTypeDef
- ScannedResourceIdentifierTypeDef
- ScannedResourceTypeDef
- ListResourceScanResourcesInputTypeDef
- ListResourceScansInputTypeDef
- ResourceScanSummaryTypeDef
- ListStackInstanceResourceDriftsInputTypeDef
- StackInstanceFilterTypeDef
- ListStackRefactorActionsInputTypeDef
- ListStackRefactorsInputTypeDef
- StackRefactorSummaryTypeDef
- ListStackResourcesInputTypeDef
- ListStackSetAutoDeploymentTargetsInputTypeDef
- StackSetAutoDeploymentTargetSummaryTypeDef
- OperationResultFilterTypeDef
- ListStackSetOperationsInputTypeDef
- ListStackSetsInputTypeDef
- ListStacksInputTypeDef
- ListTypeRegistrationsInputTypeDef
- ListTypeVersionsInputTypeDef
- TypeVersionSummaryTypeDef
- TypeFiltersTypeDef
- TypeSummaryTypeDef
- ModuleInfoTypeDef
- OutputTypeDef
- ParameterConstraintsTypeDef
- PhysicalResourceIdContextKeyValuePairTypeDef
- PropertyDifferenceTypeDef
- PublishTypeInputTypeDef
- RecordHandlerProgressInputTypeDef
- RegisterPublisherInputTypeDef
- ResourceTargetDefinitionTypeDef
- ResourceLocationTypeDef
- RollbackTriggerTypeDef
- RollbackStackInputTypeDef
- SetStackPolicyInputTypeDef
- SetTypeConfigurationInputTypeDef
- SetTypeDefaultVersionInputTypeDef
- SignalResourceInputTypeDef
- StackDriftInformationSummaryTypeDef
- StackDriftInformationTypeDef
- StackInstanceComprehensiveStatusTypeDef
- StackResourceDriftInformationTypeDef
- StackResourceDriftInformationSummaryTypeDef
- StackSetDriftDetectionDetailsTypeDef
- StackSetOperationPreferencesOutputTypeDef
- StackSetOperationPreferencesTypeDef
- StackSetOperationStatusDetailsTypeDef
- StartResourceScanInputTypeDef
- StopStackSetOperationInputTypeDef
- TemplateParameterTypeDef
- TestTypeInputTypeDef
- UpdateTerminationProtectionInputTypeDef
- ValidateTemplateInputTypeDef
- WarningPropertyTypeDef
- StackSetOperationResultSummaryTypeDef
- ActivateTypeInputTypeDef
- RegisterTypeInputTypeDef
- ActivateTypeOutputTypeDef
- CreateChangeSetOutputTypeDef
- CreateGeneratedTemplateOutputTypeDef
- CreateStackInstancesOutputTypeDef
- CreateStackOutputTypeDef
- CreateStackRefactorOutputTypeDef
- CreateStackSetOutputTypeDef
- DeleteStackInstancesOutputTypeDef
- DescribeAccountLimitsOutputTypeDef
- DescribeOrganizationsAccessOutputTypeDef
- DescribePublisherOutputTypeDef
- DescribeResourceScanOutputTypeDef
- DescribeStackDriftDetectionStatusOutputTypeDef
- DescribeStackRefactorOutputTypeDef
- DescribeTypeRegistrationOutputTypeDef
- DetectStackDriftOutputTypeDef
- DetectStackSetDriftOutputTypeDef
- EmptyResponseMetadataTypeDef
- EstimateTemplateCostOutputTypeDef
- GetGeneratedTemplateOutputTypeDef
- GetStackPolicyOutputTypeDef
- GetTemplateOutputTypeDef
- ImportStacksToStackSetOutputTypeDef
- ListImportsOutputTypeDef
- ListTypeRegistrationsOutputTypeDef
- PublishTypeOutputTypeDef
- RegisterPublisherOutputTypeDef
- RegisterTypeOutputTypeDef
- RollbackStackOutputTypeDef
- SetTypeConfigurationOutputTypeDef
- StartResourceScanOutputTypeDef
- TestTypeOutputTypeDef
- UpdateGeneratedTemplateOutputTypeDef
- UpdateStackInstancesOutputTypeDef
- UpdateStackOutputTypeDef
- UpdateStackSetOutputTypeDef
- UpdateTerminationProtectionOutputTypeDef
- BatchDescribeTypeConfigurationsErrorTypeDef
- BatchDescribeTypeConfigurationsInputTypeDef
- ChangeSetHookTargetDetailsTypeDef
- ListChangeSetsOutputTypeDef
- EstimateTemplateCostInputTypeDef
- CreateGeneratedTemplateInputTypeDef
- UpdateGeneratedTemplateInputTypeDef
- CreateStackSetInputTypeDef
- StackSetSummaryTypeDef
- DeploymentTargetsUnionTypeDef
- DescribeAccountLimitsInputPaginateTypeDef
- DescribeChangeSetInputPaginateTypeDef
- DescribeStackEventsInputPaginateTypeDef
- DescribeStacksInputPaginateTypeDef
- ListChangeSetsInputPaginateTypeDef
- ListExportsInputPaginateTypeDef
- ListGeneratedTemplatesInputPaginateTypeDef
- ListImportsInputPaginateTypeDef
- ListResourceScanResourcesInputPaginateTypeDef
- ListResourceScansInputPaginateTypeDef
- ListStackRefactorActionsInputPaginateTypeDef
- ListStackRefactorsInputPaginateTypeDef
- ListStackResourcesInputPaginateTypeDef
- ListStackSetOperationsInputPaginateTypeDef
- ListStackSetsInputPaginateTypeDef
- ListStacksInputPaginateTypeDef
- DescribeChangeSetInputWaitTypeDef
- DescribeStackRefactorInputWaitExtraTypeDef
- DescribeStackRefactorInputWaitTypeDef
- DescribeStacksInputWaitExtraExtraExtraExtraExtraTypeDef
- DescribeStacksInputWaitExtraExtraExtraExtraTypeDef
- DescribeStacksInputWaitExtraExtraExtraTypeDef
- DescribeStacksInputWaitExtraExtraTypeDef
- DescribeStacksInputWaitExtraTypeDef
- DescribeStacksInputWaitTypeDef
- DescribeTypeRegistrationInputWaitTypeDef
- DescribeStackEventsOutputTypeDef
- DescribeTypeOutputTypeDef
- ListExportsOutputTypeDef
- GetTemplateSummaryInputTypeDef
- ListHookResultsOutputTypeDef
- ListGeneratedTemplatesOutputTypeDef
- ListResourceScanRelatedResourcesInputPaginateTypeDef
- ListResourceScanRelatedResourcesInputTypeDef
- ListResourceScanRelatedResourcesOutputTypeDef
- ListResourceScanResourcesOutputTypeDef
- ListResourceScansOutputTypeDef
- ListStackInstancesInputPaginateTypeDef
- ListStackInstancesInputTypeDef
- ListStackRefactorsOutputTypeDef
- ListStackSetAutoDeploymentTargetsOutputTypeDef
- ListStackSetOperationResultsInputPaginateTypeDef
- ListStackSetOperationResultsInputTypeDef
- ListTypeVersionsOutputTypeDef
- ListTypesInputPaginateTypeDef
- ListTypesInputTypeDef
- ListTypesOutputTypeDef
- ParameterDeclarationTypeDef
- StackInstanceResourceDriftsSummaryTypeDef
- StackResourceDriftTypeDef
- ResourceChangeDetailTypeDef
- ResourceMappingTypeDef
- RollbackConfigurationOutputTypeDef
- RollbackConfigurationTypeDef
- StackSummaryTypeDef
- StackInstanceSummaryTypeDef
- StackInstanceTypeDef
- StackResourceDetailTypeDef
- StackResourceTypeDef
- StackResourceSummaryTypeDef
- StackSetTypeDef
- StackSetOperationPreferencesUnionTypeDef
- StackSetOperationSummaryTypeDef
- StackSetOperationTypeDef
- ValidateTemplateOutputTypeDef
- WarningDetailTypeDef
- ListStackSetOperationResultsOutputTypeDef
- BatchDescribeTypeConfigurationsOutputTypeDef
- ChangeSetHookTypeDef
- ListStackSetsOutputTypeDef
- GetTemplateSummaryOutputTypeDef
- ListStackInstanceResourceDriftsOutputTypeDef
- DescribeStackResourceDriftsOutputTypeDef
- DetectStackResourceDriftOutputTypeDef
- ResourceChangeTypeDef
- CreateStackRefactorInputTypeDef
- StackRefactorActionTypeDef
- StackTypeDef
- RollbackConfigurationUnionTypeDef
- ListStacksOutputTypeDef
- ListStackInstancesOutputTypeDef
- DescribeStackInstanceOutputTypeDef
- DescribeStackResourceOutputTypeDef
- DescribeStackResourcesOutputTypeDef
- ListStackResourcesOutputTypeDef
- DescribeStackSetOutputTypeDef
- CreateStackInstancesInputTypeDef
- DeleteStackInstancesInputTypeDef
- DetectStackSetDriftInputTypeDef
- ImportStacksToStackSetInputTypeDef
- UpdateStackInstancesInputTypeDef
- UpdateStackSetInputTypeDef
- ListStackSetOperationsOutputTypeDef
- DescribeStackSetOperationOutputTypeDef
- ResourceDetailTypeDef
- DescribeChangeSetHooksOutputTypeDef
- ChangeTypeDef
- ListStackRefactorActionsOutputTypeDef
- DescribeStacksOutputTypeDef
- CreateChangeSetInputTypeDef
- CreateStackInputServiceResourceCreateStackTypeDef
- CreateStackInputTypeDef
- UpdateStackInputStackUpdateTypeDef
- UpdateStackInputTypeDef
- DescribeGeneratedTemplateOutputTypeDef
- DescribeChangeSetOutputTypeDef