com.pulumi.aws.amplify.BackendEnvironment Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws Show documentation
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
There is a newer version: 6.60.0-alpha.1731982519
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***

package com.pulumi.aws.amplify;

import com.pulumi.aws.Utilities;
import com.pulumi.aws.amplify.BackendEnvironmentArgs;
import com.pulumi.aws.amplify.inputs.BackendEnvironmentState;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Export;
import com.pulumi.core.annotations.ResourceType;
import com.pulumi.core.internal.Codegen;
import java.lang.String;
import javax.annotation.Nullable;

/**
 * Provides an Amplify Backend Environment resource.
 * 
 * ## Example Usage
 * 
 * <!--Start PulumiCodeChooser -->
 *  * {@code
 * 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.List;
 * import java.util.ArrayList;
 * 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());
 * 
 *     }
 * }
 * }
 * 
 * <!--End PulumiCodeChooser -->
 * 
 * ## Import
 * 
 * Using `pulumi import`, import Amplify backend environment using `app_id` and `environment_name`. For example:
 * 
 * ```sh
 * $ pulumi import aws:amplify/backendEnvironment:BackendEnvironment example d2ypk4k47z8u6/example
 * ```
 * 
 */
@ResourceType(type="aws:amplify/backendEnvironment:BackendEnvironment")
public class BackendEnvironment extends com.pulumi.resources.CustomResource {
    /**
     * Unique ID for an Amplify app.
     * 
     */
    @Export(name="appId", refs={String.class}, tree="[0]")
    private Output appId;

    /**
     * @return Unique ID for an Amplify app.
     * 
     */
    public Output appId() {
        return this.appId;
    }
    /**
     * ARN for a backend environment that is part of an Amplify app.
     * 
     */
    @Export(name="arn", refs={String.class}, tree="[0]")
    private Output arn;

    /**
     * @return ARN for a backend environment that is part of an Amplify app.
     * 
     */
    public Output arn() {
        return this.arn;
    }
    /**
     * Name of deployment artifacts.
     * 
     */
    @Export(name="deploymentArtifacts", refs={String.class}, tree="[0]")
    private Output deploymentArtifacts;

    /**
     * @return Name of deployment artifacts.
     * 
     */
    public Output deploymentArtifacts() {
        return this.deploymentArtifacts;
    }
    /**
     * Name for the backend environment.
     * 
     */
    @Export(name="environmentName", refs={String.class}, tree="[0]")
    private Output environmentName;

    /**
     * @return Name for the backend environment.
     * 
     */
    public Output environmentName() {
        return this.environmentName;
    }
    /**
     * AWS CloudFormation stack name of a backend environment.
     * 
     */
    @Export(name="stackName", refs={String.class}, tree="[0]")
    private Output stackName;

    /**
     * @return AWS CloudFormation stack name of a backend environment.
     * 
     */
    public Output stackName() {
        return this.stackName;
    }

    /**
     *
     * @param name The _unique_ name of the resulting resource.
     */
    public BackendEnvironment(java.lang.String name) {
        this(name, BackendEnvironmentArgs.Empty);
    }
    /**
     *
     * @param name The _unique_ name of the resulting resource.
     * @param args The arguments to use to populate this resource's properties.
     */
    public BackendEnvironment(java.lang.String name, BackendEnvironmentArgs args) {
        this(name, args, null);
    }
    /**
     *
     * @param name The _unique_ name of the resulting resource.
     * @param args The arguments to use to populate this resource's properties.
     * @param options A bag of options that control this resource's behavior.
     */
    public BackendEnvironment(java.lang.String name, BackendEnvironmentArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
        super("aws:amplify/backendEnvironment:BackendEnvironment", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()), false);
    }

    private BackendEnvironment(java.lang.String name, Output id, @Nullable BackendEnvironmentState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
        super("aws:amplify/backendEnvironment:BackendEnvironment", name, state, makeResourceOptions(options, id), false);
    }

    private static BackendEnvironmentArgs makeArgs(BackendEnvironmentArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
        if (options != null && options.getUrn().isPresent()) {
            return null;
        }
        return args == null ? BackendEnvironmentArgs.Empty : args;
    }

    private static com.pulumi.resources.CustomResourceOptions makeResourceOptions(@Nullable com.pulumi.resources.CustomResourceOptions options, @Nullable Output id) {
        var defaultOptions = com.pulumi.resources.CustomResourceOptions.builder()
            .version(Utilities.getVersion())
            .build();
        return com.pulumi.resources.CustomResourceOptions.merge(defaultOptions, options, id);
    }

    /**
     * Get an existing Host resource's state with the given name, ID, and optional extra
     * properties used to qualify the lookup.
     *
     * @param name The _unique_ name of the resulting resource.
     * @param id The _unique_ provider ID of the resource to lookup.
     * @param state
     * @param options Optional settings to control the behavior of the CustomResource.
     */
    public static BackendEnvironment get(java.lang.String name, Output id, @Nullable BackendEnvironmentState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
        return new BackendEnvironment(name, id, state, options);
    }
}