BackendEnvironment class
Provides an Amplify Backend Environment resource.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.amplify.App("example", {name: "example"});
const exampleBackendEnvironment = new aws.amplify.BackendEnvironment("example", {
appId: example.id,
environmentName: "example",
deploymentArtifacts: "app-example-deployment",
stackName: "amplify-app-example",
});
import pulumi
import pulumi_aws as aws
example = aws.amplify.App("example", name="example")
example_backend_environment = aws.amplify.BackendEnvironment("example",
app_id=example.id,
environment_name="example",
deployment_artifacts="app-example-deployment",
stack_name="amplify-app-example")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Amplify.App("example", new()
{
Name = "example",
});
var exampleBackendEnvironment = new Aws.Amplify.BackendEnvironment("example", new()
{
AppId = example.Id,
EnvironmentName = "example",
DeploymentArtifacts = "app-example-deployment",
StackName = "amplify-app-example",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/amplify"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := amplify.NewApp(ctx, "example", &lify.AppArgs{
Name: pulumi.String("example"),
})
if err != nil {
return err
}
_, err = amplify.NewBackendEnvironment(ctx, "example", &lify.BackendEnvironmentArgs{
AppId: example.ID().ToIDOutput().ToStringOutput(),
EnvironmentName: pulumi.String("example"),
DeploymentArtifacts: pulumi.String("app-example-deployment"),
StackName: pulumi.String("amplify-app-example"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_amplify_app" "example" {
name = "example"
}
resource "aws_amplify_backendenvironment" "example" {
app_id = aws_amplify_app.example.id
environment_name = "example"
deployment_artifacts = "app-example-deployment"
stack_name = "amplify-app-example"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.amplify.App;
import com.pulumi.aws.amplify.AppArgs;
import com.pulumi.aws.amplify.BackendEnvironment;
import com.pulumi.aws.amplify.BackendEnvironmentArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new App("example", AppArgs.builder()
.name("example")
.build());
var exampleBackendEnvironment = new BackendEnvironment("exampleBackendEnvironment", BackendEnvironmentArgs.builder()
.appId(example.id())
.environmentName("example")
.deploymentArtifacts("app-example-deployment")
.stackName("amplify-app-example")
.build());
}
}
resources:
example:
type: aws:amplify:App
properties:
name: example
exampleBackendEnvironment:
type: aws:amplify:BackendEnvironment
name: example
properties:
appId: ${example.id}
environmentName: example
deploymentArtifacts: app-example-deployment
stackName: amplify-app-example
Import
Using pulumi import, import Amplify backend environment using appId and environmentName. For example:
$ pulumi import aws:amplify/backendEnvironment:BackendEnvironment example d2ypk4k47z8u6/example
Constructors
- BackendEnvironment(String name, {BackendEnvironmentArgs? args, CustomResourceOptions? options})
-
Creates a new BackendEnvironment.
nameThe Pulumi resource name.argsArguments used to configure this BackendEnvironment. The set of arguments for BackendEnvironment.optionsResource options controlling this resource's behavior. - BackendEnvironment.reference(String urn)
- Creates a typed reference to an existing BackendEnvironment resource.
Properties
-
appId
↔ Output<
String> -
Unique ID for an Amplify app.
latefinal
-
arn
↔ Output<
String> -
ARN for a backend environment that is part of an Amplify app.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
deploymentArtifacts
↔ Output<
String> -
Name of deployment artifacts.
latefinal
-
environmentName
↔ Output<
String> -
Name for the backend environment.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
stackName
↔ Output<
String> -
AWS CloudFormation stack name of a backend environment.
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {BackendEnvironmentState? state, CustomResourceOptions? options}) → BackendEnvironment -
Gets an existing BackendEnvironment resource's state with the given
nameandid.