Package com.pulumi.aws.amplify

Class BackendEnvironment

  • public class BackendEnvironment
extends com.pulumi.resources.CustomResource
    Provides an Amplify Backend Environment resource. ## Example Usage 
     
 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());
 
     }
 }
    ## Import Using `pulumi import`, import Amplify backend environment using `appId` and `environmentName`. For example: ```sh $ pulumi import aws:amplify/backendEnvironment:BackendEnvironment example d2ypk4k47z8u6/example ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> appId()  
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.lang.String> deploymentArtifacts()  
      com.pulumi.core.Output<java.lang.String> environmentName()  
      static BackendEnvironment get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, BackendEnvironmentState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> stackName()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • BackendEnvironment

        public BackendEnvironment​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • BackendEnvironment

        public BackendEnvironment​(java.lang.String name,
                          BackendEnvironmentArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • BackendEnvironment

        public BackendEnvironment​(java.lang.String name,
                          BackendEnvironmentArgs args,
                          @Nullable
                          com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • appId

        public com.pulumi.core.Output<java.lang.String> appId()
        Returns:
        Unique ID for an Amplify app.

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        ARN for a backend environment that is part of an Amplify app.

      • deploymentArtifacts

        public com.pulumi.core.Output<java.lang.String> deploymentArtifacts()
        Returns:
        Name of deployment artifacts.

      • environmentName

        public com.pulumi.core.Output<java.lang.String> environmentName()
        Returns:
        Name for the backend environment.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • stackName

        public com.pulumi.core.Output<java.lang.String> stackName()
        Returns:
        AWS CloudFormation stack name of a backend environment.

      • get

        public static BackendEnvironment get​(java.lang.String name,
                                     com.pulumi.core.Output<java.lang.String> id,
                                     @Nullable
                                     BackendEnvironmentState state,
                                     @Nullable
                                     com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.