AWS Amplify Console Backend Environment

This page shows how to write Terraform and CloudFormation for Amplify Console Backend Environment and write them securely.

aws_amplify_backend_environment (Terraform)

The Backend Environment in Amplify Console can be configured in Terraform with the resource name aws_amplify_backend_environment. 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:

  • app_id - (Required) The unique ID for an Amplify app.
  • environment_name - (Required) The name for the backend environment.
  • deployment_artifacts - (Optional) The name of deployment artifacts.
  • stack_name - (Optional) The AWS CloudFormation stack name of a backend environment.

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

  • arn - The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
  • id - The unique ID of the Amplify backend environment.

Explanation in Terraform Registry

Provides an Amplify Backend Environment resource.

AWS::Amplify::App EnvironmentVariable (CloudFormation)

The App EnvironmentVariable in Amplify can be configured in CloudFormation with the resource name AWS::Amplify::App EnvironmentVariable. The following sections describe how to use the resource and its parameters.

Parameters

Name The environment variable name.
Length Constraints: Maximum length of 255.
Pattern: (?s).*
Required: Yes
Type: String
Update requires: No interruption

Value The environment variable value.
Length Constraints: Maximum length of 5500.
Pattern: (?s).*
Required: Yes
Type: String
Update requires: No interruption

Explanation in CloudFormation Registry

Environment variables are key-value pairs that are available at build time. Set environment variables for all branches in your app.

Frequently asked questions

What is AWS Amplify Console Backend Environment?

AWS Amplify Console Backend Environment is a resource for Amplify Console of Amazon Web Service. Settings can be wrote in Terraform and CloudFormation.