AWS Classic
BackendEnvironment
Provides an Amplify Backend Environment resource.
Example Usage
using Pulumi;
using Aws = Pulumi.Aws;
class MyStack : Stack
{
public MyStack()
{
var exampleApp = new Aws.Amplify.App("exampleApp", new Aws.Amplify.AppArgs
{
});
var exampleBackendEnvironment = new Aws.Amplify.BackendEnvironment("exampleBackendEnvironment", new Aws.Amplify.BackendEnvironmentArgs
{
AppId = exampleApp.Id,
EnvironmentName = "example",
DeploymentArtifacts = "app-example-deployment",
StackName = "amplify-app-example",
});
}
}
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/amplify"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
exampleApp, err := amplify.NewApp(ctx, "exampleApp", nil)
if err != nil {
return err
}
_, err = amplify.NewBackendEnvironment(ctx, "exampleBackendEnvironment", &lify.BackendEnvironmentArgs{
AppId: exampleApp.ID(),
EnvironmentName: pulumi.String("example"),
DeploymentArtifacts: pulumi.String("app-example-deployment"),
StackName: pulumi.String("amplify-app-example"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var exampleApp = new App("exampleApp");
var exampleBackendEnvironment = new BackendEnvironment("exampleBackendEnvironment", BackendEnvironmentArgs.builder()
.appId(exampleApp.id())
.environmentName("example")
.deploymentArtifacts("app-example-deployment")
.stackName("amplify-app-example")
.build());
}
}
import pulumi
import pulumi_aws as aws
example_app = aws.amplify.App("exampleApp")
example_backend_environment = aws.amplify.BackendEnvironment("exampleBackendEnvironment",
app_id=example_app.id,
environment_name="example",
deployment_artifacts="app-example-deployment",
stack_name="amplify-app-example")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const exampleApp = new aws.amplify.App("exampleApp", {});
const exampleBackendEnvironment = new aws.amplify.BackendEnvironment("exampleBackendEnvironment", {
appId: exampleApp.id,
environmentName: "example",
deploymentArtifacts: "app-example-deployment",
stackName: "amplify-app-example",
});
resources:
exampleApp:
type: aws:amplify:App
exampleBackendEnvironment:
type: aws:amplify:BackendEnvironment
properties:
appId: ${exampleApp.id}
environmentName: example
deploymentArtifacts: app-example-deployment
stackName: amplify-app-example
Create a BackendEnvironment Resource
new BackendEnvironment(name: string, args: BackendEnvironmentArgs, opts?: CustomResourceOptions);
@overload
def BackendEnvironment(resource_name: str,
opts: Optional[ResourceOptions] = None,
app_id: Optional[str] = None,
deployment_artifacts: Optional[str] = None,
environment_name: Optional[str] = None,
stack_name: Optional[str] = None)
@overload
def BackendEnvironment(resource_name: str,
args: BackendEnvironmentArgs,
opts: Optional[ResourceOptions] = None)
func NewBackendEnvironment(ctx *Context, name string, args BackendEnvironmentArgs, opts ...ResourceOption) (*BackendEnvironment, error)
public BackendEnvironment(string name, BackendEnvironmentArgs args, CustomResourceOptions? opts = null)
public BackendEnvironment(String name, BackendEnvironmentArgs args)
public BackendEnvironment(String name, BackendEnvironmentArgs args, CustomResourceOptions options)
type: aws:amplify:BackendEnvironment
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args BackendEnvironmentArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args BackendEnvironmentArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args BackendEnvironmentArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args BackendEnvironmentArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args BackendEnvironmentArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
BackendEnvironment Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The BackendEnvironment resource accepts the following input properties:
- App
Id string The unique ID for an Amplify app.
- Environment
Name string The name for the backend environment.
- Deployment
Artifacts string The name of deployment artifacts.
- Stack
Name string The AWS CloudFormation stack name of a backend environment.
- App
Id string The unique ID for an Amplify app.
- Environment
Name string The name for the backend environment.
- Deployment
Artifacts string The name of deployment artifacts.
- Stack
Name string The AWS CloudFormation stack name of a backend environment.
- app
Id String The unique ID for an Amplify app.
- environment
Name String The name for the backend environment.
- deployment
Artifacts String The name of deployment artifacts.
- stack
Name String The AWS CloudFormation stack name of a backend environment.
- app
Id string The unique ID for an Amplify app.
- environment
Name string The name for the backend environment.
- deployment
Artifacts string The name of deployment artifacts.
- stack
Name string The AWS CloudFormation stack name of a backend environment.
- app_
id str The unique ID for an Amplify app.
- environment_
name str The name for the backend environment.
- deployment_
artifacts str The name of deployment artifacts.
- stack_
name str The AWS CloudFormation stack name of a backend environment.
- app
Id String The unique ID for an Amplify app.
- environment
Name String The name for the backend environment.
- deployment
Artifacts String The name of deployment artifacts.
- stack
Name String The AWS CloudFormation stack name of a backend environment.
Outputs
All input properties are implicitly available as output properties. Additionally, the BackendEnvironment resource produces the following output properties:
Look up an Existing BackendEnvironment Resource
Get an existing BackendEnvironment resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: BackendEnvironmentState, opts?: CustomResourceOptions): BackendEnvironment
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
app_id: Optional[str] = None,
arn: Optional[str] = None,
deployment_artifacts: Optional[str] = None,
environment_name: Optional[str] = None,
stack_name: Optional[str] = None) -> BackendEnvironment
func GetBackendEnvironment(ctx *Context, name string, id IDInput, state *BackendEnvironmentState, opts ...ResourceOption) (*BackendEnvironment, error)
public static BackendEnvironment Get(string name, Input<string> id, BackendEnvironmentState? state, CustomResourceOptions? opts = null)
public static BackendEnvironment get(String name, Output<String> id, BackendEnvironmentState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- App
Id string The unique ID for an Amplify app.
- Arn string
The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
- Deployment
Artifacts string The name of deployment artifacts.
- Environment
Name string The name for the backend environment.
- Stack
Name string The AWS CloudFormation stack name of a backend environment.
- App
Id string The unique ID for an Amplify app.
- Arn string
The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
- Deployment
Artifacts string The name of deployment artifacts.
- Environment
Name string The name for the backend environment.
- Stack
Name string The AWS CloudFormation stack name of a backend environment.
- app
Id String The unique ID for an Amplify app.
- arn String
The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
- deployment
Artifacts String The name of deployment artifacts.
- environment
Name String The name for the backend environment.
- stack
Name String The AWS CloudFormation stack name of a backend environment.
- app
Id string The unique ID for an Amplify app.
- arn string
The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
- deployment
Artifacts string The name of deployment artifacts.
- environment
Name string The name for the backend environment.
- stack
Name string The AWS CloudFormation stack name of a backend environment.
- app_
id str The unique ID for an Amplify app.
- arn str
The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
- deployment_
artifacts str The name of deployment artifacts.
- environment_
name str The name for the backend environment.
- stack_
name str The AWS CloudFormation stack name of a backend environment.
- app
Id String The unique ID for an Amplify app.
- arn String
The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
- deployment
Artifacts String The name of deployment artifacts.
- environment
Name String The name for the backend environment.
- stack
Name String The AWS CloudFormation stack name of a backend environment.
Import
Amplify backend environment can be imported using app_id
and environment_name
, e.g.,
$ pulumi import aws:amplify/backendEnvironment:BackendEnvironment example d2ypk4k47z8u6/example
Package Details
- Repository
- https://github.com/pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
aws
Terraform Provider.