Class Environment

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

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
public MyStack()
{
    var tftest = new Aws.ElasticBeanstalk.Application("tftest", new Aws.ElasticBeanstalk.ApplicationArgs
    {
        Description = "tf-test-desc",
    });
    var tfenvtest = new Aws.ElasticBeanstalk.Environment("tfenvtest", new Aws.ElasticBeanstalk.EnvironmentArgs
    {
        Application = tftest.Name,
        SolutionStackName = "64bit Amazon Linux 2015.03 v2.0.3 running Go 1.4",
    });
}

}

Option Settings

Some options can be stack-specific, check AWS Docs for supported options and examples.

The setting and all_settings mappings support the following format:

  • namespace - unique namespace identifying the option's associated AWS resource
  • name - name of the configuration option
  • value - value for the configuration option
  • resource - (Optional) resource name for scheduled action

Example With Options

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
public MyStack()
{
    var tftest = new Aws.ElasticBeanstalk.Application("tftest", new Aws.ElasticBeanstalk.ApplicationArgs
    {
        Description = "tf-test-desc",
    });
    var tfenvtest = new Aws.ElasticBeanstalk.Environment("tfenvtest", new Aws.ElasticBeanstalk.EnvironmentArgs
    {
        Application = tftest.Name,
        Settings = 
        {
            new Aws.ElasticBeanstalk.Inputs.EnvironmentSettingArgs
            {
                Name = "VPCId",
                Namespace = "aws:ec2:vpc",
                Value = "vpc-xxxxxxxx",
            },
            new Aws.ElasticBeanstalk.Inputs.EnvironmentSettingArgs
            {
                Name = "Subnets",
                Namespace = "aws:ec2:vpc",
                Value = "subnet-xxxxxxxx",
            },
        },
        SolutionStackName = "64bit Amazon Linux 2015.03 v2.0.3 running Go 1.4",
    });
}

}
Inheritance
System.Object
Resource
CustomResource
Environment
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Pulumi.Aws.ElasticBeanstalk
Assembly: Pulumi.Aws.dll
Syntax
public class Environment : CustomResource

Constructors

View Source

Environment(String, EnvironmentArgs, CustomResourceOptions)

Create a Environment resource with the given unique name, arguments, and options.

Declaration
public Environment(string name, EnvironmentArgs args, CustomResourceOptions options = null)
Parameters
Type Name Description
System.String name

The unique name of the resource
EnvironmentArgs args

The arguments used to populate this resource's properties
CustomResourceOptions options

A bag of options that control this resource's behavior

Properties

View Source

AllSettings

List of all option settings configured in this Environment. These are a combination of default settings and their overrides from setting in the configuration.

Declaration
public Output<ImmutableArray<EnvironmentAllSetting>> AllSettings { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableArray<EnvironmentAllSetting>>
View Source

Application

Name of the application that contains the version to be deployed

Declaration
public Output<string> Application { get; }
Property Value
Type Description
Output<System.String>
View Source

Arn

Declaration
public Output<string> Arn { get; }
Property Value
Type Description
Output<System.String>
View Source

AutoscalingGroups

The autoscaling groups used by this Environment.

Declaration
public Output<ImmutableArray<string>> AutoscalingGroups { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>
View Source

Cname

Fully qualified DNS name for this Environment.

Declaration
public Output<string> Cname { get; }
Property Value
Type Description
Output<System.String>
View Source

CnamePrefix

Prefix to use for the fully qualified DNS name of the Environment.

Declaration
public Output<string> CnamePrefix { get; }
Property Value
Type Description
Output<System.String>
View Source

Description

Short description of the Environment

Declaration
public Output<string> Description { get; }
Property Value
Type Description
Output<System.String>
View Source

EndpointUrl

The URL to the Load Balancer for this Environment

Declaration
public Output<string> EndpointUrl { get; }
Property Value
Type Description
Output<System.String>
View Source

Instances

Instances used by this Environment.

Declaration
public Output<ImmutableArray<string>> Instances { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>
View Source

LaunchConfigurations

Launch configurations in use by this Environment.

Declaration
public Output<ImmutableArray<string>> LaunchConfigurations { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>
View Source

LoadBalancers

Elastic load balancers in use by this Environment.

Declaration
public Output<ImmutableArray<string>> LoadBalancers { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>
View Source

Name

A unique name for this Environment. This name is used in the application URL

Declaration
public Output<string> Name { get; }
Property Value
Type Description
Output<System.String>
View Source

PlatformArn

The ARN of the Elastic Beanstalk Platform to use in deployment

Declaration
public Output<string> PlatformArn { get; }
Property Value
Type Description
Output<System.String>
View Source

PollInterval

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 create or update action. Minimum 10s, maximum 180s. Omit this to use the default behavior, which is an exponential backoff

Declaration
public Output<string> PollInterval { get; }
Property Value
Type Description
Output<System.String>
View Source

Queues

SQS queues in use by this Environment.

Declaration
public Output<ImmutableArray<string>> Queues { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>
View Source

Settings

Option settings to configure the new Environment. These override specific values that are set as defaults. The format is detailed below in Option Settings

Declaration
public Output<ImmutableArray<EnvironmentSetting>> Settings { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableArray<EnvironmentSetting>>
View Source

SolutionStackName

A solution stack to base your environment off of. Example stacks can be found in the Amazon API documentation

Declaration
public Output<string> SolutionStackName { get; }
Property Value
Type Description
Output<System.String>
View Source

Tags

A set of tags to apply to the Environment.

Declaration
public Output<ImmutableDictionary<string, object>> Tags { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>
View Source

TemplateName

The name of the Elastic Beanstalk Configuration template to use in deployment

Declaration
public Output<string> TemplateName { get; }
Property Value
Type Description
Output<System.String>
View Source

Tier

Elastic Beanstalk Environment tier. Valid values are Worker or WebServer. If tier is left blank WebServer will be used.

Declaration
public Output<string> Tier { get; }
Property Value
Type Description
Output<System.String>
View Source

Triggers

Autoscaling triggers in use by this Environment.

Declaration
public Output<ImmutableArray<string>> Triggers { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>
View Source

Version

The name of the Elastic Beanstalk Application Version to use in deployment.

Declaration
public Output<string> Version { get; }
Property Value
Type Description
Output<System.String>
View Source

WaitForReadyTimeout

The maximum duration that this provider should wait for an Elastic Beanstalk Environment to be in a ready state before timing out.

Declaration
public Output<string> WaitForReadyTimeout { get; }
Property Value
Type Description
Output<System.String>

Methods

View Source

Get(String, Input<String>, EnvironmentState, CustomResourceOptions)

Get an existing Environment resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration
public static Environment Get(string name, Input<string> id, EnvironmentState state = null, CustomResourceOptions options = null)
Parameters
Type Name Description
System.String name

The unique name of the resulting resource.
Input<System.String> id

The unique provider ID of the resource to lookup.
EnvironmentState state

Any extra arguments used during the lookup.
CustomResourceOptions options

A bag of options that control this resource's behavior
Returns
Type Description
Environment