View a markdown version of this page

AWS::AmplifyUIBuilder::CodegenJob - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::AmplifyUIBuilder::CodegenJob

Describes the configuration for a code generation job that is associated with an Amplify app.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::AmplifyUIBuilder::CodegenJob",
  "Properties" : {
      "AppId" : String,
      "AutoGenerateForms" : Boolean,
      "EnvironmentName" : String,
      "Features" : CodegenFeatureFlags,
      "RenderConfig" : CodegenJobRenderConfig
    }
}

YAML

Type: AWS::AmplifyUIBuilder::CodegenJob
Properties:
  AppId: String
  AutoGenerateForms: Boolean
  EnvironmentName: String
  Features: 
    CodegenFeatureFlags
  RenderConfig: 
    CodegenJobRenderConfig

Properties

AppId

The ID of the Amplify app associated with the code generation job.

Required: No

Type: String

Pattern: ^d[a-z0-9]+$

Minimum: 1

Maximum: 20

Update requires: Replacement

AutoGenerateForms

Specifies whether to autogenerate forms in the code generation job.

Required: No

Type: Boolean

Update requires: Replacement

EnvironmentName

The name of the backend environment associated with the code generation job.

Required: No

Type: String

Update requires: Replacement

Features

The feature flags for a code generation job.

Required: No

Type: CodegenFeatureFlags

Update requires: Replacement

RenderConfig

The code generation configuration for the codegen job.

Required: Yes

Type: CodegenJobRenderConfig

Update requires: Replacement

Return values

Ref

Fn::GetAtt

Arn

Property description not available.

Id

The unique ID for the code generation job.

Status

The status of the code generation job.

Tags

One or more key-value pairs to use when tagging the code generation job.