Environment class
Provides an Elastic Beanstalk Environment Resource. Elastic Beanstalk allows you to deploy and manage applications in the AWS cloud without worrying about the infrastructure that runs those applications.
Environments are often things such as development, integration, or
production.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const exampleApplication = new aws.elasticbeanstalk.Application("example", {
name: "tf-test-name",
description: "tf-test-desc",
});
const example = new aws.elasticbeanstalk.Environment("example", {
name: "tf-test-name",
application: exampleApplication.name,
solutionStackName: "64bit Amazon Linux 2015.03 v2.0.3 running Go 1.4",
});
import pulumi
import pulumi_aws as aws
example_application = aws.elasticbeanstalk.Application("example",
name="tf-test-name",
description="tf-test-desc")
example = aws.elasticbeanstalk.Environment("example",
name="tf-test-name",
application=example_application.name,
solution_stack_name="64bit Amazon Linux 2015.03 v2.0.3 running Go 1.4")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var exampleApplication = new Aws.ElasticBeanstalk.Application("example", new()
{
Name = "tf-test-name",
Description = "tf-test-desc",
});
var example = new Aws.ElasticBeanstalk.Environment("example", new()
{
Name = "tf-test-name",
Application = exampleApplication.Name,
SolutionStackName = "64bit Amazon Linux 2015.03 v2.0.3 running Go 1.4",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/elasticbeanstalk"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
exampleApplication, err := elasticbeanstalk.NewApplication(ctx, "example", &elasticbeanstalk.ApplicationArgs{
Name: pulumi.String("tf-test-name"),
Description: pulumi.String("tf-test-desc"),
})
if err != nil {
return err
}
_, err = elasticbeanstalk.NewEnvironment(ctx, "example", &elasticbeanstalk.EnvironmentArgs{
Name: pulumi.String("tf-test-name"),
Application: exampleApplication.Name,
SolutionStackName: pulumi.String("64bit Amazon Linux 2015.03 v2.0.3 running Go 1.4"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_elasticbeanstalk_environment" "example" {
name = "tf-test-name"
application = aws_elasticbeanstalk_application.example.name
solution_stack_name = "64bit Amazon Linux 2015.03 v2.0.3 running Go 1.4"
}
resource "aws_elasticbeanstalk_application" "example" {
name = "tf-test-name"
description = "tf-test-desc"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.elasticbeanstalk.Application;
import com.pulumi.aws.elasticbeanstalk.ApplicationArgs;
import com.pulumi.aws.elasticbeanstalk.Environment;
import com.pulumi.aws.elasticbeanstalk.EnvironmentArgs;
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 exampleApplication = new Application("exampleApplication", ApplicationArgs.builder()
.name("tf-test-name")
.description("tf-test-desc")
.build());
var example = new Environment("example", EnvironmentArgs.builder()
.name("tf-test-name")
.application(exampleApplication.name())
.solutionStackName("64bit Amazon Linux 2015.03 v2.0.3 running Go 1.4")
.build());
}
}
resources:
example:
type: aws:elasticbeanstalk:Environment
properties:
name: tf-test-name
application: ${exampleApplication.name}
solutionStackName: 64bit Amazon Linux 2015.03 v2.0.3 running Go 1.4
exampleApplication:
type: aws:elasticbeanstalk:Application
name: example
properties:
name: tf-test-name
description: tf-test-desc
Import
Using pulumi import, import Elastic Beanstalk Environments using the id. For example:
$ pulumi import aws:elasticbeanstalk/environment:Environment prodenv e-rpqsewtp2j
Constructors
- Environment(String name, {EnvironmentArgs? args, CustomResourceOptions? options})
-
Creates a new Environment.
nameThe Pulumi resource name.argsArguments used to configure this Environment. The set of arguments for Environment.optionsResource options controlling this resource's behavior. - Environment.reference(String urn)
- Creates a typed reference to an existing Environment resource.
Properties
-
allSettings
↔ Output<
List< EnvironmentAllSetting> > -
List of all option settings configured in this Environment. These
are a combination of default settings and their overrides from
settingin the configuration.latefinal -
application
↔ Output<
String> -
Name of the application that contains the version
to be deployed
latefinal
-
arn
↔ Output<
String> -
latefinal
-
autoscalingGroups
↔ Output<
List< String> > -
The autoscaling groups used by this Environment.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
cname
↔ Output<
String> -
Fully qualified DNS name for this Environment.
latefinal
-
cnamePrefix
↔ Output<
String> -
Prefix to use for the fully qualified DNS name of
the Environment.
latefinal
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
description
↔ Output<
String?> -
Short description of the Environment
latefinal
-
endpointUrl
↔ Output<
String> -
The URL to the Load Balancer for this Environment
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
-
instances
↔ Output<
List< String> > -
Instances used by this Environment.
latefinal
- 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
-
launchConfigurations
↔ Output<
List< String> > -
Launch configurations in use by this Environment.
latefinal
-
loadBalancers
↔ Output<
List< String> > -
Elastic load balancers in use by this Environment.
latefinal
-
name
↔ Output<
String> -
A unique name for this Environment. This name is used
in the application URL
latefinal
-
platformArn
↔ Output<
String> -
The ARN of the Elastic Beanstalk Platform
to use in deployment
latefinal
-
pollInterval
↔ Output<
String?> -
The time between polling the AWS API to
check if changes have been applied. Use this to adjust the rate of API calls
for any
createorupdateaction. Minimum10s, maximum180s. Omit this to use the default behavior, which is an exponential backofflatefinal -
queues
↔ Output<
List< String> > -
SQS queues in use by this Environment.
latefinal
-
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
-
settings
↔ Output<
List< EnvironmentSetting> ?> -
Option settings to configure the new Environment. These
override specific values that are set as defaults. The format is detailed
below in Option Settings
latefinal
-
solutionStackName
↔ Output<
String> -
A solution stack to base your environment
off of. Example stacks can be found in the Amazon API documentation
latefinal
-
A set of tags to apply to the Environment. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
A map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.latefinal -
templateName
↔ Output<
String?> -
The name of the Elastic Beanstalk Configuration
template to use in deployment
latefinal
-
tier
↔ Output<
String?> -
Elastic Beanstalk Environment tier. Valid values are
WorkerorWebServer. If tier is left blankWebServerwill be used.latefinal -
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
triggers
↔ Output<
List< String> > -
Autoscaling triggers in use by this Environment.
latefinal
-
urn
↔ Output<
String> -
latefinalinherited
-
version
↔ Output<
String> -
The name of the Elastic Beanstalk Application Version
to use in deployment.
latefinal
-
waitForReadyTimeout
↔ Output<
String?> -
The maximum
duration that this provider should
wait for an Elastic Beanstalk Environment to be in a ready state before timing
out.
latefinal
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, {EnvironmentState? state, CustomResourceOptions? options}) → Environment -
Gets an existing Environment resource's state with the given
nameandid.