Skip to main content

Aws/cloudformation

@swamp/aws/cloudformationv2026.06.08.2· 6d agoMODELS
01README

AWS CLOUDFORMATION infrastructure models

02Release Notes
  • Updated: guard_hook, hook_default_version, hook_type_config, hook_version, lambda_hook, module_default_version, module_version, public_type_version, publisher, resource_default_version, resource_version, stack, stack_set, type_activation
03Models14
@swamp/aws/cloudformation/guard-hookv2026.06.08.1guard_hook.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION environment variable. Defaults to us-east-1.
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?recordAttribute 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.
fn create()
Create a CloudFormation GuardHook
fn get(identifier: string)
Get a CloudFormation GuardHook
ArgumentTypeDescription
identifierstringThe primary identifier of the CloudFormation GuardHook
fn update()
Update a CloudFormation GuardHook
fn delete(identifier: string)
Delete a CloudFormation GuardHook
ArgumentTypeDescription
identifierstringThe primary identifier of the CloudFormation GuardHook
fn sync()
Sync CloudFormation GuardHook state from AWS

Resources

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

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION environment variable. Defaults to us-east-1.
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.
fn create()
Create a CloudFormation HookDefaultVersion
fn get(identifier: string)
Get a CloudFormation HookDefaultVersion
ArgumentTypeDescription
identifierstringThe primary identifier of the CloudFormation HookDefaultVersion
fn update()
Update a CloudFormation HookDefaultVersion
fn delete(identifier: string)
Delete a CloudFormation HookDefaultVersion
ArgumentTypeDescription
identifierstringThe primary identifier of the CloudFormation HookDefaultVersion
fn sync()
Sync CloudFormation HookDefaultVersion state from AWS

Resources

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

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION environment variable. Defaults to us-east-1.
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.
fn create()
Create a CloudFormation HookTypeConfig
fn get(identifier: string)
Get a CloudFormation HookTypeConfig
ArgumentTypeDescription
identifierstringThe primary identifier of the CloudFormation HookTypeConfig
fn update()
Update a CloudFormation HookTypeConfig
fn delete(identifier: string)
Delete a CloudFormation HookTypeConfig
ArgumentTypeDescription
identifierstringThe primary identifier of the CloudFormation HookTypeConfig
fn sync()
Sync CloudFormation HookTypeConfig state from AWS

Resources

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

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION environment variable. Defaults to us-east-1.
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.
fn create()
Create a CloudFormation HookVersion
fn get(identifier: string)
Get a CloudFormation HookVersion
ArgumentTypeDescription
identifierstringThe primary identifier of the CloudFormation HookVersion
fn delete(identifier: string)
Delete a CloudFormation HookVersion
ArgumentTypeDescription
identifierstringThe primary identifier of the CloudFormation HookVersion
fn sync()
Sync CloudFormation HookVersion state from AWS

Resources

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

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION environment variable. Defaults to us-east-1.
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?recordAttribute 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.
fn create()
Create a CloudFormation LambdaHook
fn get(identifier: string)
Get a CloudFormation LambdaHook
ArgumentTypeDescription
identifierstringThe primary identifier of the CloudFormation LambdaHook
fn update()
Update a CloudFormation LambdaHook
fn delete(identifier: string)
Delete a CloudFormation LambdaHook
ArgumentTypeDescription
identifierstringThe primary identifier of the CloudFormation LambdaHook
fn sync()
Sync CloudFormation LambdaHook state from AWS

Resources

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

Global Arguments

ArgumentTypeDescription
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION environment variable. Defaults to us-east-1.
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.
fn create()
Create a CloudFormation ModuleDefaultVersion
fn get(identifier: string)
Get a CloudFormation ModuleDefaultVersion
ArgumentTypeDescription
identifierstringThe primary identifier of the CloudFormation ModuleDefaultVersion
fn delete(identifier: string)
Delete a CloudFormation ModuleDefaultVersion
ArgumentTypeDescription
identifierstringThe primary identifier of the CloudFormation ModuleDefaultVersion
fn sync()
Sync CloudFormation ModuleDefaultVersion state from AWS

Resources

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

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION environment variable. Defaults to us-east-1.
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.
fn create()
Create a CloudFormation ModuleVersion
fn get(identifier: string)
Get a CloudFormation ModuleVersion
ArgumentTypeDescription
identifierstringThe primary identifier of the CloudFormation ModuleVersion
fn delete(identifier: string)
Delete a CloudFormation ModuleVersion
ArgumentTypeDescription
identifierstringThe primary identifier of the CloudFormation ModuleVersion
fn sync()
Sync CloudFormation ModuleVersion state from AWS

Resources

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

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION environment variable. Defaults to us-east-1.
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
fn create()
Create a CloudFormation PublicTypeVersion
fn get(identifier: string)
Get a CloudFormation PublicTypeVersion
ArgumentTypeDescription
identifierstringThe primary identifier of the CloudFormation PublicTypeVersion
fn delete(identifier: string)
Delete a CloudFormation PublicTypeVersion
ArgumentTypeDescription
identifierstringThe primary identifier of the CloudFormation PublicTypeVersion
fn sync()
Sync CloudFormation PublicTypeVersion state from AWS

Resources

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

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION environment variable. Defaults to us-east-1.
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.
fn create()
Create a CloudFormation Publisher
fn get(identifier: string)
Get a CloudFormation Publisher
ArgumentTypeDescription
identifierstringThe primary identifier of the CloudFormation Publisher
fn delete(identifier: string)
Delete a CloudFormation Publisher
ArgumentTypeDescription
identifierstringThe primary identifier of the CloudFormation Publisher
fn sync()
Sync CloudFormation Publisher state from AWS

Resources

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

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION environment variable. Defaults to us-east-1.
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.
fn create()
Create a CloudFormation ResourceDefaultVersion
fn get(identifier: string)
Get a CloudFormation ResourceDefaultVersion
ArgumentTypeDescription
identifierstringThe primary identifier of the CloudFormation ResourceDefaultVersion
fn update()
Update a CloudFormation ResourceDefaultVersion
fn delete(identifier: string)
Delete a CloudFormation ResourceDefaultVersion
ArgumentTypeDescription
identifierstringThe primary identifier of the CloudFormation ResourceDefaultVersion
fn sync()
Sync CloudFormation ResourceDefaultVersion state from AWS

Resources

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

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION environment variable. Defaults to us-east-1.
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.
fn create()
Create a CloudFormation ResourceVersion
fn get(identifier: string)
Get a CloudFormation ResourceVersion
ArgumentTypeDescription
identifierstringThe primary identifier of the CloudFormation ResourceVersion
fn delete(identifier: string)
Delete a CloudFormation ResourceVersion
ArgumentTypeDescription
identifierstringThe primary identifier of the CloudFormation ResourceVersion
fn sync()
Sync CloudFormation ResourceVersion state from AWS

Resources

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

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION environment variable. Defaults to us-east-1.
Capabilities?array
RoleARN?string
Description?string
DisableRollback?boolean
EnableTerminationProtection?boolean
NotificationARNs?array
Parameters?record
StackNamestring
StackPolicyBody?record
StackPolicyURL?string
StackStatusReason?string
Tags?array
TemplateBody?record
TemplateURL?string
TimeoutInMinutes?number
fn create()
Create a CloudFormation Stack
fn get(identifier: string)
Get a CloudFormation Stack
ArgumentTypeDescription
identifierstringThe primary identifier of the CloudFormation Stack
fn update()
Update a CloudFormation Stack
fn delete(identifier: string)
Delete a CloudFormation Stack
ArgumentTypeDescription
identifierstringThe primary identifier of the CloudFormation Stack
fn sync()
Sync CloudFormation Stack state from AWS

Resources

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

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION environment variable. Defaults to us-east-1.
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.
fn create()
Create a CloudFormation StackSet
fn get(identifier: string)
Get a CloudFormation StackSet
ArgumentTypeDescription
identifierstringThe primary identifier of the CloudFormation StackSet
fn update()
Update a CloudFormation StackSet
fn delete(identifier: string)
Delete a CloudFormation StackSet
ArgumentTypeDescription
identifierstringThe primary identifier of the CloudFormation StackSet
fn sync()
Sync CloudFormation StackSet state from AWS

Resources

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

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
accessKeyId?stringAWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault.
secretAccessKey?stringAWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault.
sessionToken?stringAWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
region?stringAWS region; overrides AWS_REGION environment variable. Defaults to us-east-1.
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
fn create()
Create a CloudFormation TypeActivation
fn get(identifier: string)
Get a CloudFormation TypeActivation
ArgumentTypeDescription
identifierstringThe primary identifier of the CloudFormation TypeActivation
fn update()
Update a CloudFormation TypeActivation
fn delete(identifier: string)
Delete a CloudFormation TypeActivation
ArgumentTypeDescription
identifierstringThe primary identifier of the CloudFormation TypeActivation
fn sync()
Sync CloudFormation TypeActivation state from AWS

Resources

state(infinite)— CloudFormation TypeActivation resource state
04Previous Versions9
2026.06.06.1Jun 6, 2026
  • Updated: guard_hook, hook_default_version, hook_type_config, hook_version, lambda_hook, module_default_version, module_version, public_type_version, publisher, resource_default_version, resource_version, stack, stack_set, type_activation
2026.05.27.1May 27, 2026
  • Updated: guard_hook, lambda_hook, stack
2026.05.19.1May 18, 2026
2026.04.23.3Apr 23, 2026
2026.04.23.2Apr 23, 2026
  • Updated: guard_hook, hook_default_version, hook_type_config, hook_version, lambda_hook, module_default_version, module_version, public_type_version, publisher, resource_default_version, resource_version, stack, stack_set, type_activation
2026.04.03.2Apr 3, 2026
  • Updated: guard_hook, hook_default_version, hook_type_config, hook_version, lambda_hook, module_default_version, module_version, public_type_version, publisher, resource_default_version, resource_version, stack, stack_set, type_activation
2026.03.19.1Mar 19, 2026
  • Updated: guard_hook, hook_default_version, hook_type_config, hook_version, lambda_hook, module_default_version, module_version, public_type_version, publisher, resource_default_version, resource_version, stack, stack_set, type_activation
2026.03.16.1Mar 16, 2026
  • Updated: guard_hook, hook_default_version, hook_type_config, hook_version, lambda_hook, module_default_version, module_version, public_type_version, publisher, resource_default_version, resource_version, stack, stack_set, type_activation
2026.03.10.5Mar 10, 2026
05Stats
B
85 / 100
Downloads
12
Archive size
3.2 MB
Verified by Swamp
  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types (deprecated)1/1earned
  • Dependencies pass trust audit0/2missing
  • Has description1/1earned
  • Platform support declared (or universal)2/2earned
  • License declared1/1earned
  • Verified public repository2/2earned
06Platforms
07Labels