Resource: awsAmplifyBackendEnvironment
Provides an Amplify Backend Environment resource.
Example Usage
/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
const awsAmplifyAppExample = new aws.amplifyApp.AmplifyApp(this, "example", {
name: "example",
});
const awsAmplifyBackendEnvironmentExample =
new aws.amplifyBackendEnvironment.AmplifyBackendEnvironment(
this,
"example_1",
{
appId: awsAmplifyAppExample.id,
deploymentArtifacts: "app-example-deployment",
environmentName: "example",
stackName: "amplify-app-example",
}
);
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
awsAmplifyBackendEnvironmentExample.overrideLogicalId("example");
Argument Reference
The following arguments are supported:
appId
- (Required) Unique ID for an Amplify app.environmentName
- (Required) Name for the backend environment.deploymentArtifacts
- (Optional) Name of deployment artifacts.stackName
- (Optional) AWS CloudFormation stack name of a backend environment.
Attributes Reference
In addition to all arguments above, the following attributes are exported:
arn
- ARN for a backend environment that is part of an Amplify app.id
- Unique ID of the Amplify backend environment.
Import
Amplify backend environment can be imported using appId
and environmentName
, e.g.,