Skip to main content

@swamp/aws/cloudformation

v2026.04.23.3

AWS CLOUDFORMATION infrastructure models

Repository

https://github.com/systeminit/swamp-extensions

Labels

awscloudformationcloudinfrastructure

Contents

Quality score

Verified by Swamp

How well-documented and verifiable this extension is.

100%

Grade A

  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types1/1earned
  • Has description1/1earned
  • At least one platform tag (or universal)1/1earned
  • Two or more platform tags (or universal)1/1earned
  • License declared1/1earned
  • Verified public repository2/2earned

Install

$ swamp extension pull @swamp/aws/cloudformation

@swamp/aws/cloudformation/guard-hookv2026.04.23.2guard_hook.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
RuleLocationobjectS3 Source Location for the Guard files.
LogBucket?stringS3 Bucket where the guard validate report will be uploaded to
HookStatusenumAttribute to specify which stacks this hook applies to or should get invoked for
TargetOperationsarrayWhich operations should this Hook run against? Resource changes, stacks or change sets.
FailureModeenumAttribute to specify CloudFormation behavior on hook failure.
TargetFilters?stringAttribute to specify which targets should invoke the hook
StackFilters?objectFilters to allow hooks to target specific stack attributes
AliasstringThe typename alias for the hook.
ExecutionRolestringThe execution role ARN assumed by hooks to read Guard rules from S3 and write Guard outputs to S3.
createCreate a CloudFormation GuardHook
getGet a CloudFormation GuardHook
ArgumentTypeDescription
identifierstringThe primary identifier of the CloudFormation GuardHook
updateUpdate a CloudFormation GuardHook
deleteDelete a CloudFormation GuardHook
ArgumentTypeDescription
identifierstringThe primary identifier of the CloudFormation GuardHook
syncSync CloudFormation GuardHook state from AWS

Resources

state(infinite)— CloudFormation GuardHook resource state
@swamp/aws/cloudformation/hook-default-versionv2026.04.23.2hook_default_version.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
TypeVersionArn?stringThe Amazon Resource Name (ARN) of the type version.
TypeName?stringThe name of the type being registered. We recommend that type names adhere to the following pattern: company_or_organization::service::type.
VersionId?stringThe ID of an existing version of the hook to set as the default.
createCreate a CloudFormation HookDefaultVersion
getGet a CloudFormation HookDefaultVersion
ArgumentTypeDescription
identifierstringThe primary identifier of the CloudFormation HookDefaultVersion
updateUpdate a CloudFormation HookDefaultVersion
deleteDelete a CloudFormation HookDefaultVersion
ArgumentTypeDescription
identifierstringThe primary identifier of the CloudFormation HookDefaultVersion
syncSync CloudFormation HookDefaultVersion state from AWS

Resources

state(infinite)— CloudFormation HookDefaultVersion resource state
@swamp/aws/cloudformation/hook-type-configv2026.04.23.2hook_type_config.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
TypeArn?stringThe Amazon Resource Name (ARN) of the type without version number.
TypeName?stringThe name of the type being registered. We recommend that type names adhere to the following pattern: company_or_organization::service::type.
Configuration?stringThe configuration data for the extension, in this account and region.
ConfigurationAlias?enumAn alias by which to refer to this extension configuration data.
createCreate a CloudFormation HookTypeConfig
getGet a CloudFormation HookTypeConfig
ArgumentTypeDescription
identifierstringThe primary identifier of the CloudFormation HookTypeConfig
updateUpdate a CloudFormation HookTypeConfig
deleteDelete a CloudFormation HookTypeConfig
ArgumentTypeDescription
identifierstringThe primary identifier of the CloudFormation HookTypeConfig
syncSync CloudFormation HookTypeConfig state from AWS

Resources

state(infinite)— CloudFormation HookTypeConfig resource state
@swamp/aws/cloudformation/hook-versionv2026.04.23.2hook_version.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
ExecutionRoleArn?stringThe Amazon Resource Name (ARN) of the IAM execution role to use to register the type. If your resource type calls AWS APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those AWS APIs, and provision that execution role in your account. CloudFormation then assumes that execution role to provide your resource type with the appropriate credentials.
LoggingConfig?objectSpecifies logging configuration information for a type.
SchemaHandlerPackagestringA url to the S3 bucket containing the schema handler package that contains the schema, event handlers, and associated files for the type you want to register. For information on generating a schema handler package for the type you want to register, see submit in the CloudFormation CLI User Guide.
TypeNamestringThe name of the type being registered. We recommend that type names adhere to the following pattern: company_or_organization::service::type.
createCreate a CloudFormation HookVersion
getGet a CloudFormation HookVersion
ArgumentTypeDescription
identifierstringThe primary identifier of the CloudFormation HookVersion
deleteDelete a CloudFormation HookVersion
ArgumentTypeDescription
identifierstringThe primary identifier of the CloudFormation HookVersion
syncSync CloudFormation HookVersion state from AWS

Resources

state(infinite)— CloudFormation HookVersion resource state
@swamp/aws/cloudformation/lambda-hookv2026.04.23.2lambda_hook.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
LambdaFunctionstringAmazon Resource Name (ARN), Partial ARN, name, version, or alias of the Lambda function to invoke with this hook.
HookStatusenumAttribute to specify which stacks this hook applies to or should get invoked for
TargetOperationsarrayWhich operations should this Hook run against? Resource changes, stacks or change sets.
FailureModeenumAttribute to specify CloudFormation behavior on hook failure.
TargetFilters?stringAttribute to specify which targets should invoke the hook
StackFilters?objectFilters to allow hooks to target specific stack attributes
AliasstringThe typename alias for the hook.
ExecutionRolestringThe execution role ARN assumed by Hooks to invoke Lambda.
createCreate a CloudFormation LambdaHook
getGet a CloudFormation LambdaHook
ArgumentTypeDescription
identifierstringThe primary identifier of the CloudFormation LambdaHook
updateUpdate a CloudFormation LambdaHook
deleteDelete a CloudFormation LambdaHook
ArgumentTypeDescription
identifierstringThe primary identifier of the CloudFormation LambdaHook
syncSync CloudFormation LambdaHook state from AWS

Resources

state(infinite)— CloudFormation LambdaHook resource state
@swamp/aws/cloudformation/module-default-versionv2026.04.23.2module_default_version.ts

Global Arguments

ArgumentTypeDescription
Arn?stringThe Amazon Resource Name (ARN) of the module version to set as the default version.
ModuleName?stringThe name of a module existing in the registry.
VersionId?stringThe ID of an existing version of the named module to set as the default.
createCreate a CloudFormation ModuleDefaultVersion
getGet a CloudFormation ModuleDefaultVersion
ArgumentTypeDescription
identifierstringThe primary identifier of the CloudFormation ModuleDefaultVersion
deleteDelete a CloudFormation ModuleDefaultVersion
ArgumentTypeDescription
identifierstringThe primary identifier of the CloudFormation ModuleDefaultVersion
syncSync CloudFormation ModuleDefaultVersion state from AWS

Resources

state(infinite)— CloudFormation ModuleDefaultVersion resource state
@swamp/aws/cloudformation/module-versionv2026.04.23.2module_version.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
ModuleNamestringThe name of the module being registered. Recommended module naming pattern: company_or_organization::service::type::MODULE.
ModulePackagestringThe url to the S3 bucket containing the schema and template fragment for the module you want to register.
createCreate a CloudFormation ModuleVersion
getGet a CloudFormation ModuleVersion
ArgumentTypeDescription
identifierstringThe primary identifier of the CloudFormation ModuleVersion
deleteDelete a CloudFormation ModuleVersion
ArgumentTypeDescription
identifierstringThe primary identifier of the CloudFormation ModuleVersion
syncSync CloudFormation ModuleVersion state from AWS

Resources

state(infinite)— CloudFormation ModuleVersion resource state
@swamp/aws/cloudformation/public-type-versionv2026.04.23.2public_type_version.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
Arn?stringThe Amazon Resource Number (ARN) of the extension.
PublicVersionNumber?stringThe version number of a public third-party extension
TypeName?stringThe name of the type being registered. We recommend that type names adhere to the following pattern: company_or_organization::service::type.
LogDeliveryBucket?stringA url to the S3 bucket where logs for the testType run will be available
Type?enumThe kind of extension
createCreate a CloudFormation PublicTypeVersion
getGet a CloudFormation PublicTypeVersion
ArgumentTypeDescription
identifierstringThe primary identifier of the CloudFormation PublicTypeVersion
deleteDelete a CloudFormation PublicTypeVersion
ArgumentTypeDescription
identifierstringThe primary identifier of the CloudFormation PublicTypeVersion
syncSync CloudFormation PublicTypeVersion state from AWS

Resources

state(infinite)— CloudFormation PublicTypeVersion resource state
@swamp/aws/cloudformation/publisherv2026.04.23.2publisher.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
AcceptTermsAndConditionsbooleanWhether you accept the terms and conditions for publishing extensions in the CloudFormation registry. You must accept the terms and conditions in order to publish public extensions to the CloudFormation registry. The terms and conditions can be found at https://cloudformation-registry-documents.s3.amazonaws.com/Terms_and_Conditions_for_AWS_CloudFormation_Registry_Publishers.pdf
ConnectionArn?stringIf you are using a Bitbucket or GitHub account for identity verification, the Amazon Resource Name (ARN) for your connection to that account.
createCreate a CloudFormation Publisher
getGet a CloudFormation Publisher
ArgumentTypeDescription
identifierstringThe primary identifier of the CloudFormation Publisher
deleteDelete a CloudFormation Publisher
ArgumentTypeDescription
identifierstringThe primary identifier of the CloudFormation Publisher
syncSync CloudFormation Publisher state from AWS

Resources

state(infinite)— CloudFormation Publisher resource state
@swamp/aws/cloudformation/resource-default-versionv2026.04.23.2resource_default_version.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
VersionId?stringThe ID of an existing version of the resource to set as the default.
TypeName?stringThe name of the type being registered. We recommend that type names adhere to the following pattern: company_or_organization::service::type.
TypeVersionArn?stringThe Amazon Resource Name (ARN) of the type version.
createCreate a CloudFormation ResourceDefaultVersion
getGet a CloudFormation ResourceDefaultVersion
ArgumentTypeDescription
identifierstringThe primary identifier of the CloudFormation ResourceDefaultVersion
updateUpdate a CloudFormation ResourceDefaultVersion
deleteDelete a CloudFormation ResourceDefaultVersion
ArgumentTypeDescription
identifierstringThe primary identifier of the CloudFormation ResourceDefaultVersion
syncSync CloudFormation ResourceDefaultVersion state from AWS

Resources

state(infinite)— CloudFormation ResourceDefaultVersion resource state
@swamp/aws/cloudformation/resource-versionv2026.04.23.2resource_version.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
ExecutionRoleArn?stringThe Amazon Resource Name (ARN) of the IAM execution role to use to register the type. If your resource type calls AWS APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those AWS APIs, and provision that execution role in your account. CloudFormation then assumes that execution role to provide your resource type with the appropriate credentials.
LoggingConfig?objectSpecifies logging configuration information for a type.
SchemaHandlerPackagestringA url to the S3 bucket containing the schema handler package that contains the schema, event handlers, and associated files for the type you want to register. For information on generating a schema handler package for the type you want to register, see submit in the CloudFormation CLI User Guide.
TypeNamestringThe name of the type being registered. We recommend that type names adhere to the following pattern: company_or_organization::service::type.
createCreate a CloudFormation ResourceVersion
getGet a CloudFormation ResourceVersion
ArgumentTypeDescription
identifierstringThe primary identifier of the CloudFormation ResourceVersion
deleteDelete a CloudFormation ResourceVersion
ArgumentTypeDescription
identifierstringThe primary identifier of the CloudFormation ResourceVersion
syncSync CloudFormation ResourceVersion state from AWS

Resources

state(infinite)— CloudFormation ResourceVersion resource state
@swamp/aws/cloudformation/stackv2026.04.23.2stack.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
Capabilities?array
RoleARN?string
Description?string
DisableRollback?boolean
EnableTerminationProtection?boolean
NotificationARNs?array
Parameters?record
StackNamestring
StackPolicyBody?string
StackPolicyURL?string
StackStatusReason?string
Tags?array
TemplateBody?string
TemplateURL?string
TimeoutInMinutes?number
createCreate a CloudFormation Stack
getGet a CloudFormation Stack
ArgumentTypeDescription
identifierstringThe primary identifier of the CloudFormation Stack
updateUpdate a CloudFormation Stack
deleteDelete a CloudFormation Stack
ArgumentTypeDescription
identifierstringThe primary identifier of the CloudFormation Stack
syncSync CloudFormation Stack state from AWS

Resources

state(infinite)— CloudFormation Stack resource state
@swamp/aws/cloudformation/stack-setv2026.04.23.2stack_set.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
StackSetNamestringThe name to associate with the stack set. The name must be unique in the Region where you create your stack set.
AdministrationRoleARN?stringThe Amazon Resource Number (ARN) of the IAM role to use to create this stack set. Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account.
AutoDeployment?objectDescribes whether StackSets automatically deploys to AWS Organizations accounts that are added to the target organization or organizational unit (OU). Specify only if PermissionModel is SERVICE_MANAGED.
Capabilities?arrayIn some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in order for AWS CloudFormation to create the stack set and related stack instances.
Description?stringA description of the stack set. You can use the description to identify the stack set's purpose or other important information.
ExecutionRoleName?stringThe name of the IAM execution role to use to create the stack set. If you do not specify an execution role, AWS CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation.
OperationPreferences?objectThe user-specified preferences for how AWS CloudFormation performs a stack set operation.
StackInstancesGroup?arrayA group of stack instances with parameters in some specific accounts and regions.
Parameters?arrayThe input parameters for the stack set template.
PermissionModelenumDescribes how the IAM roles required for stack set operations are created. By default, SELF-MANAGED is specified.
Tags?arrayThe key-value pairs to associate with this stack set and the stacks created from it. AWS CloudFormation also propagates these tags to supported resources that are created in the stacks. A maximum number of 50 tags can be specified.
TemplateBody?stringThe structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes.
TemplateURL?stringLocation of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket.
CallAs?enumSpecifies the AWS account that you are acting from. By default, SELF is specified. For self-managed permissions, specify SELF; for service-managed permissions, if you are signed in to the organization's management account, specify SELF. If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
ManagedExecution?objectDescribes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations.
createCreate a CloudFormation StackSet
getGet a CloudFormation StackSet
ArgumentTypeDescription
identifierstringThe primary identifier of the CloudFormation StackSet
updateUpdate a CloudFormation StackSet
deleteDelete a CloudFormation StackSet
ArgumentTypeDescription
identifierstringThe primary identifier of the CloudFormation StackSet
syncSync CloudFormation StackSet state from AWS

Resources

state(infinite)— CloudFormation StackSet resource state
@swamp/aws/cloudformation/type-activationv2026.04.23.2type_activation.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
ExecutionRoleArn?stringThe Amazon Resource Name (ARN) of the IAM execution role to use to register the type. If your resource type calls AWS APIs in any of its handlers, you must create an IAM execution role that includes the necessary permissions to call those AWS APIs, and provision that execution role in your account. CloudFormation then assumes that execution role to provide your resource type with the appropriate credentials.
PublisherId?stringThe reserved publisher id for this type, or the publisher id assigned by CloudFormation for publishing in this region.
LoggingConfig?objectSpecifies logging configuration information for a type.
PublicTypeArn?stringThe Amazon Resource Number (ARN) assigned to the public extension upon publication
AutoUpdate?booleanWhether to automatically update the extension in this account and region when a new minor version is published by the extension publisher. Major versions released by the publisher must be manually updated.
TypeNameAlias?stringAn alias to assign to the public extension in this account and region. If you specify an alias for the extension, you must then use the alias to refer to the extension in your templates.
VersionBump?enumManually updates a previously-enabled type to a new major or minor version, if available. You can also use this parameter to update the value of AutoUpdateEnabled
MajorVersion?stringThe Major Version of the type you want to enable
TypeName?stringThe name of the type being registered. We recommend that type names adhere to the following pattern: company_or_organization::service::type.
Type?enumThe kind of extension
createCreate a CloudFormation TypeActivation
getGet a CloudFormation TypeActivation
ArgumentTypeDescription
identifierstringThe primary identifier of the CloudFormation TypeActivation
updateUpdate a CloudFormation TypeActivation
deleteDelete a CloudFormation TypeActivation
ArgumentTypeDescription
identifierstringThe primary identifier of the CloudFormation TypeActivation
syncSync CloudFormation TypeActivation state from AWS

Resources

state(infinite)— CloudFormation TypeActivation resource state