Package software.amazon.awscdk.services.cloudformation

Class CfnGeneratedTemplate

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.cloudformation.CfnGeneratedTemplate
All Implemented Interfaces:
IInspectable, IGeneratedTemplateRef, IEnvironmentAware, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.138.0 (build 0ca7ee8)", date="2026-08-10T14:50:58.841Z") @Stability(Stable) public class CfnGeneratedTemplate extends CfnResource implements IInspectable, IGeneratedTemplateRef
Creates a generated template from existing resources using the CloudFormation IaC Generator.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cloudformation.*;
 CfnGeneratedTemplate cfnGeneratedTemplate = CfnGeneratedTemplate.Builder.create(this, "MyCfnGeneratedTemplate")
         .generatedTemplateName("generatedTemplateName")
         // the properties below are optional
         .templateConfiguration(TemplateConfigurationProperty.builder()
                 .deletionPolicy("deletionPolicy")
                 .updateReplacePolicy("updateReplacePolicy")
                 .build())
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnGeneratedTemplate

      protected CfnGeneratedTemplate(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnGeneratedTemplate

      protected CfnGeneratedTemplate(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnGeneratedTemplate

      @Stability(Stable) public CfnGeneratedTemplate(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnGeneratedTemplateProps props)
      Create a new AWS::CloudFormation::GeneratedTemplate.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForGeneratedTemplate

      @Stability(Stable) @NotNull public static String arnForGeneratedTemplate(@NotNull IGeneratedTemplateRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnGeneratedTemplate

      @Stability(Stable) @NotNull public static Boolean isCfnGeneratedTemplate(@NotNull Object x)
      Checks whether the given object is a CfnGeneratedTemplate.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrCreationTime

      @Stability(Stable) @NotNull public String getAttrCreationTime()
      The time the generated template was created.

    • getAttrGeneratedTemplateId

      @Stability(Stable) @NotNull public String getAttrGeneratedTemplateId()
      The Amazon Resource Name (ARN) of the generated template.

    • getAttrLastUpdatedTime

      @Stability(Stable) @NotNull public String getAttrLastUpdatedTime()
      The time the generated template was last updated.

    • getAttrProgress

      @Stability(Stable) @NotNull public IResolvable getAttrProgress()
      A summary of the progress of the template generation.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      The status of the template generation.

    • getAttrTotalWarnings

      @Stability(Stable) @NotNull public Number getAttrTotalWarnings()
      The number of warnings generated for this template.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getCfnPropertyNames

      @Stability(Stable) @NotNull protected Map<String,String> getCfnPropertyNames()
      Overrides:
      getCfnPropertyNames in class CfnResource

    • getGeneratedTemplateRef

      @Stability(Stable) @NotNull public GeneratedTemplateReference getGeneratedTemplateRef()
      A reference to a GeneratedTemplate resource.
      Specified by:
      getGeneratedTemplateRef in interface IGeneratedTemplateRef

    • getGeneratedTemplateName

      @Stability(Stable) @NotNull public String getGeneratedTemplateName()
      The name assigned to the generated template.

    • setGeneratedTemplateName

      @Stability(Stable) public void setGeneratedTemplateName(@NotNull String value)
      The name assigned to the generated template.

    • getTemplateConfiguration

      @Stability(Stable) @Nullable public Object getTemplateConfiguration()
      The configuration details of the generated template.

      Returns union: either IResolvable or CfnGeneratedTemplate.TemplateConfigurationProperty

    • setTemplateConfiguration

      @Stability(Stable) public void setTemplateConfiguration(@Nullable IResolvable value)
      The configuration details of the generated template.

    • setTemplateConfiguration

      @Stability(Stable) public void setTemplateConfiguration(@Nullable CfnGeneratedTemplate.TemplateConfigurationProperty value)
      The configuration details of the generated template.