CloudFormation¶
Installation¶
To install the CloudFormation client:
Client¶
Bases: AsyncClient[AsyncCloudFormationConfig]
CloudFormation allows you to create and manage Amazon Web Services infrastructure deployments predictably and repeatedly. You can use CloudFormation to leverage Amazon Web Services products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store, Amazon Simple Notification Service, Elastic Load Balancing, and Amazon EC2 Auto Scaling to build highly reliable, highly scalable, cost-effective applications without creating or configuring the underlying Amazon Web Services infrastructure.
With CloudFormation, you declare all your resources and dependencies in a template file. The template defines a collection of resources as a single unit called a stack. CloudFormation creates and deletes all member resources of the stack together and manages all dependencies between the resources for you.
For more information about CloudFormation, see the CloudFormation product page.
CloudFormation makes use of other Amazon Web Services products. If you need additional technical information about a specific Amazon Web Services product, you can find the product's technical documentation at docs.aws.amazon.com.
Operations¶
activate_organizations_accessactivate_typebatch_describe_type_configurationscancel_update_stackcontinue_update_rollbackcreate_change_setcreate_generated_templatecreate_stackcreate_stack_instancescreate_stack_refactorcreate_stack_setdeactivate_organizations_accessdeactivate_typedelete_change_setdelete_generated_templatedelete_stackdelete_stack_instancesdelete_stack_setderegister_typedescribe_account_limitsdescribe_change_setdescribe_change_set_hooksdescribe_eventsdescribe_generated_templatedescribe_organizations_accessdescribe_publisherdescribe_resource_scandescribe_stack_drift_detection_statusdescribe_stack_eventsdescribe_stack_instancedescribe_stack_refactordescribe_stack_resourcedescribe_stack_resource_driftsdescribe_stack_resourcesdescribe_stack_setdescribe_stack_set_operationdescribe_stacksdescribe_typedescribe_type_registrationdetect_stack_driftdetect_stack_resource_driftdetect_stack_set_driftestimate_template_costexecute_change_setexecute_stack_refactorget_generated_templateget_hook_resultget_stack_policyget_templateget_template_summaryimport_stacks_to_stack_setlist_change_setslist_exportslist_generated_templateslist_hook_resultslist_importslist_resource_scan_related_resourceslist_resource_scan_resourceslist_resource_scanslist_stack_instance_resource_driftslist_stack_instanceslist_stack_refactor_actionslist_stack_refactorslist_stack_resourceslist_stack_set_auto_deployment_targetslist_stack_set_operation_resultslist_stack_set_operationslist_stack_setslist_stackslist_type_registrationslist_type_versionslist_typespublish_typerecord_handler_progressregister_publisherregister_typerollback_stackset_stack_policyset_type_configurationset_type_default_versionsignal_resourcestart_resource_scanstop_stack_set_operationtest_typeupdate_generated_templateupdate_stackupdate_stack_instancesupdate_stack_setupdate_termination_protectionvalidate_template
Configuration¶
dataclass
¶
Bases: AsyncAwsConfig
CloudFormation configuration (async-resolved).
Attributes¶
class-attribute
instance-attribute
¶
An auth scheme resolver that determines the auth scheme for each operation.
class-attribute
instance-attribute
¶
A map of auth scheme ids to auth schemes.
class-attribute
instance-attribute
¶
aws_access_key_id: str | None = None
The identifier for a secret access key.
class-attribute
instance-attribute
¶
aws_credentials_identity_resolver: AsyncIdentityResolver[AWSCredentialsIdentity, AWSIdentityProperties] | None = None
Resolves AWS Credentials. Required for operations that use Sigv4 Auth.
class-attribute
instance-attribute
¶
aws_secret_access_key: str | None = None
A secret access key that can be used to sign requests.
class-attribute
instance-attribute
¶
aws_session_token: str | None = None
The session token used with temporary AWS credentials.
class-attribute
instance-attribute
¶
The endpoint resolver used to resolve the final endpoint per-operation based on the configuration.
class-attribute
instance-attribute
¶
The list of interceptors, which are hooks that are called during the execution of a request.
class-attribute
instance-attribute
¶
Pass a protocol class reference from smithy_aws_core.aio.protocols to select the protocol, e.g. protocol=AsyncAwsJson10ClientProtocol. For custom protocols a protocol instance may also be passed.
class-attribute
instance-attribute
¶
region: str | None = None
The AWS region to connect to. The configured region is used to determine the service endpoint.
class-attribute
instance-attribute
¶
sdk_ua_app_id: str | None = None
A unique and opaque application ID that is appended to the User-Agent header.
class-attribute
instance-attribute
¶
use_dualstack_endpoint: bool | None = None
When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.
class-attribute
instance-attribute
¶
use_fips_endpoint: bool | None = None
When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.
class-attribute
instance-attribute
¶
user_agent_extra: str | None = None
Additional suffix to be added to the User-Agent header.
Methods:¶
async
classmethod
¶
resolve(*, profile: str | None = None, fs: AsyncFileSystem | None = None, config_file_path: str | None = None, credentials_file_path: str | None = None, **overrides: Unpack[_AsyncCloudFormationConfigOverrides]) -> Self
Resolve config from environment, config files, defaults, and explicit overrides.
module-attribute
¶
Plugin: TypeAlias = Callable[[AsyncCloudFormationConfig], None]
A callable that customizes a client configuration. Service-level plugins are applied once to the base configuration inherited by every operation. Operation-level plugins apply only to a single operation invocation.
Structures¶
AccountGateResultAccountLimitAnnotationAutoDeploymentBatchDescribeTypeConfigurationsErrorChangeChangeSetHookChangeSetHookResourceTargetDetailsChangeSetHookTargetDetailsChangeSetSummaryDeploymentConfigDeploymentTargetsEventFilterExportHookResultSummaryHookTargetLiveResourceDriftLoggingConfigManagedExecutionModuleInfoOperationEntryOperationEventOperationResultFilterOutputParameterParameterConstraintsParameterDeclarationPhysicalResourceIdContextKeyValuePairPropertyDifferenceRequiredActivatedTypeResourceChangeResourceChangeDetailResourceDefinitionResourceDetailResourceDriftIgnoredAttributeResourceIdentifierSummaryResourceLocationResourceMappingResourceScanSummaryResourceTargetDefinitionResourceToImportRollbackConfigurationRollbackTriggerScanFilterScannedResourceScannedResourceIdentifierStackStackDefinitionStackDriftInformationStackDriftInformationSummaryStackEventStackInstanceStackInstanceComprehensiveStatusStackInstanceFilterStackInstanceResourceDriftsSummaryStackInstanceSummaryStackRefactorActionStackRefactorSummaryStackResourceStackResourceDetailStackResourceDriftStackResourceDriftInformationStackResourceDriftInformationSummaryStackResourceSummaryStackSetStackSetAutoDeploymentTargetSummaryStackSetDriftDetectionDetailsStackSetOperationStackSetOperationPreferencesStackSetOperationResultSummaryStackSetOperationStatusDetailsStackSetOperationSummaryStackSetSummaryStackSummaryTagTemplateConfigurationTemplateParameterTemplateProgressTemplateSummaryTemplateSummaryConfigTypeConfigurationDetailsTypeConfigurationIdentifierTypeFiltersTypeSummaryTypeVersionSummaryWarningDetailWarningPropertyWarnings
Errors¶
AlreadyExistsExceptionCFNRegistryExceptionChangeSetNotFoundExceptionConcurrentResourcesLimitExceededExceptionCreatedButModifiedExceptionGeneratedTemplateNotFoundExceptionHookResultNotFoundExceptionInsufficientCapabilitiesExceptionInvalidChangeSetStatusExceptionInvalidOperationExceptionInvalidStateTransitionExceptionLimitExceededExceptionNameAlreadyExistsExceptionOperationIdAlreadyExistsExceptionOperationInProgressExceptionOperationNotFoundExceptionOperationStatusCheckFailedExceptionResourceScanInProgressExceptionResourceScanLimitExceededExceptionResourceScanNotFoundExceptionServiceErrorStackInstanceNotFoundExceptionStackNotFoundExceptionStackRefactorNotFoundExceptionStackSetNotEmptyExceptionStackSetNotFoundExceptionStaleRequestExceptionTokenAlreadyExistsExceptionTypeConfigurationNotFoundExceptionTypeNotFoundException
Enums¶
AccountFilterTypeAccountGateStatusAfterValueFromAnnotationSeverityLevelAnnotationStatusAttributeChangeTypeBeaconStackOperationStatusBeforeValueFromCallAsCapabilityCategoryChangeActionChangeSetHooksStatusChangeSetStatusChangeSetTypeChangeSourceChangeTypeConcurrencyModeDeletionModeDeploymentConfigModeDeploymentModeDeprecatedStatusDetailedStatusDifferenceTypeDriftIgnoredReasonEvaluationTypeEventTypeExecutionStatusGeneratedTemplateDeletionPolicyGeneratedTemplateResourceStatusGeneratedTemplateStatusGeneratedTemplateUpdateReplacePolicyHandlerErrorCodeHookFailureModeHookInvocationPointHookStatusHookTargetActionHookTargetTypeIdentityProviderListHookResultsTargetTypeOnFailureOnStackFailureOperationResultFilterNameOperationStatusOperationTypeOrganizationStatusPermissionModelsPolicyActionProvisioningTypePublisherStatusRegionConcurrencyTypeRegistrationStatusRegistryTypeReplacementRequiresRecreationResourceAttributeResourceScanStatusResourceSignalStatusResourceStatusScanTypeStackDriftDetectionStatusStackDriftStatusStackInstanceDetailedStatusStackInstanceFilterNameStackInstanceStatusStackRefactorActionEntityStackRefactorActionTypeStackRefactorDetectionStackRefactorExecutionStatusStackRefactorStatusStackResourceDriftStatusStackSetDriftDetectionStatusStackSetDriftStatusStackSetOperationActionStackSetOperationResultStatusStackSetOperationStatusStackSetStatusStackStatusTemplateFormatTemplateStageThirdPartyTypeTypeTestsStatusValidationStatusVersionBumpVisibilityWarningType