AWS CloudFormation Type

aws_cloudformation_type (Terraform)

The Type in CloudFormation can be configured in Terraform with the resource name aws_cloudformation_type. The following sections describe how to use the resource and its parameters.

Example Usage from GitHub

An example could not be found in GitHub.

Parameters

The following arguments are supported:

• execution_role_arn - (Optional) Amazon Resource Name (ARN) of the IAM Role for CloudFormation to assume when invoking the extension. If your extension 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. When CloudFormation needs to invoke the extension handler, CloudFormation assumes this execution role to create a temporary session token, which it then passes to the extension handler, thereby supplying your extension with the appropriate credentials.
• logging_config - (Optional) Configuration block containing logging configuration.
• schema_handler_package - (Required) URL to the S3 bucket containing the extension project package that contains the necessary files for the extension you want to register. Must begin with s3:// or https://. For example, s3://example-bucket/example-object.
• type - (Optional) CloudFormation Registry Type. For example, RESOURCE or MODULE.
• type_name - (Optional) CloudFormation Type name. For example, ExampleCompany::ExampleService::ExampleResource.

logging_config

The following arguments are supported in the logging_config configuration block:

• log_group_name - (Required) Name of the CloudWatch Log Group where CloudFormation sends error logging information when invoking the type's handlers.
• log_role_arn - (Required) Amazon Resource Name (ARN) of the IAM Role CloudFormation assumes when sending error logging information to CloudWatch Logs.

In addition to all arguments above, the following attributes are exported:

• arn - (Optional) Amazon Resource Name (ARN) of the CloudFormation Type version. See also type_arn.
• default_version_id - Identifier of the CloudFormation Type default version.
• deprecated_status - Deprecation status of the version.
• description - Description of the version.
• documentation_url - URL of the documentation for the CloudFormation Type.
• is_default_version - Whether the CloudFormation Type version is the default version.
• provisioning_type - Provisioning behavior of the CloudFormation Type.
• schema - JSON document of the CloudFormation Type schema.
• source_url - URL of the source code for the CloudFormation Type.
• type_arn - (Optional) Amazon Resource Name (ARN) of the CloudFormation Type. See also arn.
• version_id - (Optional) Identifier of the CloudFormation Type version.
• visibility - Scope of the CloudFormation Type.

Explanation in Terraform Registry

Manages a version of a CloudFormation Type.

NOTE: The destroy operation of this resource marks the version as deprecated. If this was the only LIVE version, the type is marked as deprecated. It is recommended to enable the resource lifecycle configuration block create_before_destroy argument in this resource configuration to properly order redeployments in Terraform.