AWS Classic v5.41.0, May 15 23
AWS Classic v5.41.0, May 15 23
aws.elasticbeanstalk.Environment
Explore with Pulumi AI
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
.
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 resourcename
- name of the configuration optionvalue
- value for the configuration optionresource
- (Optional) resource name for scheduled action
Example With Options
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const tftest = new aws.elasticbeanstalk.Application("tftest", {description: "tf-test-desc"});
const tfenvtest = new aws.elasticbeanstalk.Environment("tfenvtest", {
application: tftest.name,
solutionStackName: "64bit Amazon Linux 2015.03 v2.0.3 running Go 1.4",
settings: [
{
namespace: "aws:ec2:vpc",
name: "VPCId",
value: "vpc-xxxxxxxx",
},
{
namespace: "aws:ec2:vpc",
name: "Subnets",
value: "subnet-xxxxxxxx",
},
],
});
import pulumi
import pulumi_aws as aws
tftest = aws.elasticbeanstalk.Application("tftest", description="tf-test-desc")
tfenvtest = aws.elasticbeanstalk.Environment("tfenvtest",
application=tftest.name,
solution_stack_name="64bit Amazon Linux 2015.03 v2.0.3 running Go 1.4",
settings=[
aws.elasticbeanstalk.EnvironmentSettingArgs(
namespace="aws:ec2:vpc",
name="VPCId",
value="vpc-xxxxxxxx",
),
aws.elasticbeanstalk.EnvironmentSettingArgs(
namespace="aws:ec2:vpc",
name="Subnets",
value="subnet-xxxxxxxx",
),
])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var tftest = new Aws.ElasticBeanstalk.Application("tftest", new()
{
Description = "tf-test-desc",
});
var tfenvtest = new Aws.ElasticBeanstalk.Environment("tfenvtest", new()
{
Application = tftest.Name,
SolutionStackName = "64bit Amazon Linux 2015.03 v2.0.3 running Go 1.4",
Settings = new[]
{
new Aws.ElasticBeanstalk.Inputs.EnvironmentSettingArgs
{
Namespace = "aws:ec2:vpc",
Name = "VPCId",
Value = "vpc-xxxxxxxx",
},
new Aws.ElasticBeanstalk.Inputs.EnvironmentSettingArgs
{
Namespace = "aws:ec2:vpc",
Name = "Subnets",
Value = "subnet-xxxxxxxx",
},
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/elasticbeanstalk"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
tftest, err := elasticbeanstalk.NewApplication(ctx, "tftest", &elasticbeanstalk.ApplicationArgs{
Description: pulumi.String("tf-test-desc"),
})
if err != nil {
return err
}
_, err = elasticbeanstalk.NewEnvironment(ctx, "tfenvtest", &elasticbeanstalk.EnvironmentArgs{
Application: tftest.Name,
SolutionStackName: pulumi.String("64bit Amazon Linux 2015.03 v2.0.3 running Go 1.4"),
Settings: elasticbeanstalk.EnvironmentSettingArray{
&elasticbeanstalk.EnvironmentSettingArgs{
Namespace: pulumi.String("aws:ec2:vpc"),
Name: pulumi.String("VPCId"),
Value: pulumi.String("vpc-xxxxxxxx"),
},
&elasticbeanstalk.EnvironmentSettingArgs{
Namespace: pulumi.String("aws:ec2:vpc"),
Name: pulumi.String("Subnets"),
Value: pulumi.String("subnet-xxxxxxxx"),
},
},
})
if err != nil {
return err
}
return nil
})
}
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 com.pulumi.aws.elasticbeanstalk.inputs.EnvironmentSettingArgs;
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 tftest = new Application("tftest", ApplicationArgs.builder()
.description("tf-test-desc")
.build());
var tfenvtest = new Environment("tfenvtest", EnvironmentArgs.builder()
.application(tftest.name())
.solutionStackName("64bit Amazon Linux 2015.03 v2.0.3 running Go 1.4")
.settings(
EnvironmentSettingArgs.builder()
.namespace("aws:ec2:vpc")
.name("VPCId")
.value("vpc-xxxxxxxx")
.build(),
EnvironmentSettingArgs.builder()
.namespace("aws:ec2:vpc")
.name("Subnets")
.value("subnet-xxxxxxxx")
.build())
.build());
}
}
resources:
tftest:
type: aws:elasticbeanstalk:Application
properties:
description: tf-test-desc
tfenvtest:
type: aws:elasticbeanstalk:Environment
properties:
application: ${tftest.name}
solutionStackName: 64bit Amazon Linux 2015.03 v2.0.3 running Go 1.4
settings:
- namespace: aws:ec2:vpc
name: VPCId
value: vpc-xxxxxxxx
- namespace: aws:ec2:vpc
name: Subnets
value: subnet-xxxxxxxx
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var tftest = new Aws.ElasticBeanstalk.Application("tftest", new()
{
Description = "tf-test-desc",
});
var tfenvtest = new Aws.ElasticBeanstalk.Environment("tfenvtest", new()
{
Application = tftest.Name,
SolutionStackName = "64bit Amazon Linux 2015.03 v2.0.3 running Go 1.4",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/elasticbeanstalk"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
tftest, err := elasticbeanstalk.NewApplication(ctx, "tftest", &elasticbeanstalk.ApplicationArgs{
Description: pulumi.String("tf-test-desc"),
})
if err != nil {
return err
}
_, err = elasticbeanstalk.NewEnvironment(ctx, "tfenvtest", &elasticbeanstalk.EnvironmentArgs{
Application: tftest.Name,
SolutionStackName: pulumi.String("64bit Amazon Linux 2015.03 v2.0.3 running Go 1.4"),
})
if err != nil {
return err
}
return nil
})
}
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.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 tftest = new Application("tftest", ApplicationArgs.builder()
.description("tf-test-desc")
.build());
var tfenvtest = new Environment("tfenvtest", EnvironmentArgs.builder()
.application(tftest.name())
.solutionStackName("64bit Amazon Linux 2015.03 v2.0.3 running Go 1.4")
.build());
}
}
import pulumi
import pulumi_aws as aws
tftest = aws.elasticbeanstalk.Application("tftest", description="tf-test-desc")
tfenvtest = aws.elasticbeanstalk.Environment("tfenvtest",
application=tftest.name,
solution_stack_name="64bit Amazon Linux 2015.03 v2.0.3 running Go 1.4")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const tftest = new aws.elasticbeanstalk.Application("tftest", {description: "tf-test-desc"});
const tfenvtest = new aws.elasticbeanstalk.Environment("tfenvtest", {
application: tftest.name,
solutionStackName: "64bit Amazon Linux 2015.03 v2.0.3 running Go 1.4",
});
resources:
tftest:
type: aws:elasticbeanstalk:Application
properties:
description: tf-test-desc
tfenvtest:
type: aws:elasticbeanstalk:Environment
properties:
application: ${tftest.name}
solutionStackName: 64bit Amazon Linux 2015.03 v2.0.3 running Go 1.4
Example With Options
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var tftest = new Aws.ElasticBeanstalk.Application("tftest", new()
{
Description = "tf-test-desc",
});
var tfenvtest = new Aws.ElasticBeanstalk.Environment("tfenvtest", new()
{
Application = tftest.Name,
SolutionStackName = "64bit Amazon Linux 2015.03 v2.0.3 running Go 1.4",
Settings = new[]
{
new Aws.ElasticBeanstalk.Inputs.EnvironmentSettingArgs
{
Namespace = "aws:ec2:vpc",
Name = "VPCId",
Value = "vpc-xxxxxxxx",
},
new Aws.ElasticBeanstalk.Inputs.EnvironmentSettingArgs
{
Namespace = "aws:ec2:vpc",
Name = "Subnets",
Value = "subnet-xxxxxxxx",
},
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/elasticbeanstalk"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
tftest, err := elasticbeanstalk.NewApplication(ctx, "tftest", &elasticbeanstalk.ApplicationArgs{
Description: pulumi.String("tf-test-desc"),
})
if err != nil {
return err
}
_, err = elasticbeanstalk.NewEnvironment(ctx, "tfenvtest", &elasticbeanstalk.EnvironmentArgs{
Application: tftest.Name,
SolutionStackName: pulumi.String("64bit Amazon Linux 2015.03 v2.0.3 running Go 1.4"),
Settings: elasticbeanstalk.EnvironmentSettingArray{
&elasticbeanstalk.EnvironmentSettingArgs{
Namespace: pulumi.String("aws:ec2:vpc"),
Name: pulumi.String("VPCId"),
Value: pulumi.String("vpc-xxxxxxxx"),
},
&elasticbeanstalk.EnvironmentSettingArgs{
Namespace: pulumi.String("aws:ec2:vpc"),
Name: pulumi.String("Subnets"),
Value: pulumi.String("subnet-xxxxxxxx"),
},
},
})
if err != nil {
return err
}
return nil
})
}
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 com.pulumi.aws.elasticbeanstalk.inputs.EnvironmentSettingArgs;
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 tftest = new Application("tftest", ApplicationArgs.builder()
.description("tf-test-desc")
.build());
var tfenvtest = new Environment("tfenvtest", EnvironmentArgs.builder()
.application(tftest.name())
.solutionStackName("64bit Amazon Linux 2015.03 v2.0.3 running Go 1.4")
.settings(
EnvironmentSettingArgs.builder()
.namespace("aws:ec2:vpc")
.name("VPCId")
.value("vpc-xxxxxxxx")
.build(),
EnvironmentSettingArgs.builder()
.namespace("aws:ec2:vpc")
.name("Subnets")
.value("subnet-xxxxxxxx")
.build())
.build());
}
}
import pulumi
import pulumi_aws as aws
tftest = aws.elasticbeanstalk.Application("tftest", description="tf-test-desc")
tfenvtest = aws.elasticbeanstalk.Environment("tfenvtest",
application=tftest.name,
solution_stack_name="64bit Amazon Linux 2015.03 v2.0.3 running Go 1.4",
settings=[
aws.elasticbeanstalk.EnvironmentSettingArgs(
namespace="aws:ec2:vpc",
name="VPCId",
value="vpc-xxxxxxxx",
),
aws.elasticbeanstalk.EnvironmentSettingArgs(
namespace="aws:ec2:vpc",
name="Subnets",
value="subnet-xxxxxxxx",
),
])
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const tftest = new aws.elasticbeanstalk.Application("tftest", {description: "tf-test-desc"});
const tfenvtest = new aws.elasticbeanstalk.Environment("tfenvtest", {
application: tftest.name,
solutionStackName: "64bit Amazon Linux 2015.03 v2.0.3 running Go 1.4",
settings: [
{
namespace: "aws:ec2:vpc",
name: "VPCId",
value: "vpc-xxxxxxxx",
},
{
namespace: "aws:ec2:vpc",
name: "Subnets",
value: "subnet-xxxxxxxx",
},
],
});
resources:
tftest:
type: aws:elasticbeanstalk:Application
properties:
description: tf-test-desc
tfenvtest:
type: aws:elasticbeanstalk:Environment
properties:
application: ${tftest.name}
solutionStackName: 64bit Amazon Linux 2015.03 v2.0.3 running Go 1.4
settings:
- namespace: aws:ec2:vpc
name: VPCId
value: vpc-xxxxxxxx
- namespace: aws:ec2:vpc
name: Subnets
value: subnet-xxxxxxxx
Create Environment Resource
new Environment(name: string, args: EnvironmentArgs, opts?: CustomResourceOptions);
@overload
def Environment(resource_name: str,
opts: Optional[ResourceOptions] = None,
application: Optional[str] = None,
cname_prefix: Optional[str] = None,
description: Optional[str] = None,
name: Optional[str] = None,
platform_arn: Optional[str] = None,
poll_interval: Optional[str] = None,
settings: Optional[Sequence[EnvironmentSettingArgs]] = None,
solution_stack_name: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
template_name: Optional[str] = None,
tier: Optional[str] = None,
version: Optional[str] = None,
wait_for_ready_timeout: Optional[str] = None)
@overload
def Environment(resource_name: str,
args: EnvironmentArgs,
opts: Optional[ResourceOptions] = None)
func NewEnvironment(ctx *Context, name string, args EnvironmentArgs, opts ...ResourceOption) (*Environment, error)
public Environment(string name, EnvironmentArgs args, CustomResourceOptions? opts = null)
public Environment(String name, EnvironmentArgs args)
public Environment(String name, EnvironmentArgs args, CustomResourceOptions options)
type: aws:elasticbeanstalk:Environment
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args EnvironmentArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args EnvironmentArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args EnvironmentArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args EnvironmentArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args EnvironmentArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Environment Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Environment resource accepts the following input properties:
- Application string | string
Name of the application that contains the version to be deployed
- Cname
Prefix string Prefix to use for the fully qualified DNS name of the Environment.
- Description string
Short description of the Environment
- Name string
A unique name for this Environment. This name is used in the application URL
- Platform
Arn string The ARN of the Elastic Beanstalk Platform to use in deployment
- Poll
Interval 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
create
orupdate
action. Minimum10s
, maximum180s
. Omit this to use the default behavior, which is an exponential backoff- Settings
List<Environment
Setting Args> Option settings to configure the new Environment. These override specific values that are set as defaults. The format is detailed below in Option Settings
- Solution
Stack stringName A solution stack to base your environment off of. Example stacks can be found in the Amazon API documentation
- Dictionary<string, string>
A set of tags to apply to the Environment. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.- Template
Name string The name of the Elastic Beanstalk Configuration template to use in deployment
- Tier string
Elastic Beanstalk Environment tier. Valid values are
Worker
orWebServer
. If tier is left blankWebServer
will be used.- Version string
The name of the Elastic Beanstalk Application Version to use in deployment.
- Wait
For stringReady Timeout The maximum duration that this provider should wait for an Elastic Beanstalk Environment to be in a ready state before timing out.
- Application string | string
Name of the application that contains the version to be deployed
- Cname
Prefix string Prefix to use for the fully qualified DNS name of the Environment.
- Description string
Short description of the Environment
- Name string
A unique name for this Environment. This name is used in the application URL
- Platform
Arn string The ARN of the Elastic Beanstalk Platform to use in deployment
- Poll
Interval 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
create
orupdate
action. Minimum10s
, maximum180s
. Omit this to use the default behavior, which is an exponential backoff- Settings
[]Environment
Setting Args Option settings to configure the new Environment. These override specific values that are set as defaults. The format is detailed below in Option Settings
- Solution
Stack stringName A solution stack to base your environment off of. Example stacks can be found in the Amazon API documentation
- map[string]string
A set of tags to apply to the Environment. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.- Template
Name string The name of the Elastic Beanstalk Configuration template to use in deployment
- Tier string
Elastic Beanstalk Environment tier. Valid values are
Worker
orWebServer
. If tier is left blankWebServer
will be used.- Version string
The name of the Elastic Beanstalk Application Version to use in deployment.
- Wait
For stringReady Timeout The maximum duration that this provider should wait for an Elastic Beanstalk Environment to be in a ready state before timing out.
- application String | String
Name of the application that contains the version to be deployed
- cname
Prefix String Prefix to use for the fully qualified DNS name of the Environment.
- description String
Short description of the Environment
- name String
A unique name for this Environment. This name is used in the application URL
- platform
Arn String The ARN of the Elastic Beanstalk Platform to use in deployment
- poll
Interval 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
create
orupdate
action. Minimum10s
, maximum180s
. Omit this to use the default behavior, which is an exponential backoff- settings
List<Environment
Setting Args> Option settings to configure the new Environment. These override specific values that are set as defaults. The format is detailed below in Option Settings
- solution
Stack StringName A solution stack to base your environment off of. Example stacks can be found in the Amazon API documentation
- Map<String,String>
A set of tags to apply to the Environment. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.- template
Name String The name of the Elastic Beanstalk Configuration template to use in deployment
- tier String
Elastic Beanstalk Environment tier. Valid values are
Worker
orWebServer
. If tier is left blankWebServer
will be used.- version String
The name of the Elastic Beanstalk Application Version to use in deployment.
- wait
For StringReady Timeout The maximum duration that this provider should wait for an Elastic Beanstalk Environment to be in a ready state before timing out.
- application string | Application
Name of the application that contains the version to be deployed
- cname
Prefix string Prefix to use for the fully qualified DNS name of the Environment.
- description string
Short description of the Environment
- name string
A unique name for this Environment. This name is used in the application URL
- platform
Arn string The ARN of the Elastic Beanstalk Platform to use in deployment
- poll
Interval 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
create
orupdate
action. Minimum10s
, maximum180s
. Omit this to use the default behavior, which is an exponential backoff- settings
Environment
Setting Args[] Option settings to configure the new Environment. These override specific values that are set as defaults. The format is detailed below in Option Settings
- solution
Stack stringName A solution stack to base your environment off of. Example stacks can be found in the Amazon API documentation
- {[key: string]: string}
A set of tags to apply to the Environment. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.- template
Name string The name of the Elastic Beanstalk Configuration template to use in deployment
- tier string
Elastic Beanstalk Environment tier. Valid values are
Worker
orWebServer
. If tier is left blankWebServer
will be used.- version
Application
Version The name of the Elastic Beanstalk Application Version to use in deployment.
- wait
For stringReady Timeout The maximum duration that this provider should wait for an Elastic Beanstalk Environment to be in a ready state before timing out.
- application str | str
Name of the application that contains the version to be deployed
- cname_
prefix str Prefix to use for the fully qualified DNS name of the Environment.
- description str
Short description of the Environment
- name str
A unique name for this Environment. This name is used in the application URL
- platform_
arn str The ARN of the Elastic Beanstalk Platform to use in deployment
- poll_
interval str 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
orupdate
action. Minimum10s
, maximum180s
. Omit this to use the default behavior, which is an exponential backoff- settings
Sequence[Environment
Setting Args] Option settings to configure the new Environment. These override specific values that are set as defaults. The format is detailed below in Option Settings
- solution_
stack_ strname A solution stack to base your environment off of. Example stacks can be found in the Amazon API documentation
- Mapping[str, str]
A set of tags to apply to the Environment. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.- template_
name str The name of the Elastic Beanstalk Configuration template to use in deployment
- tier str
Elastic Beanstalk Environment tier. Valid values are
Worker
orWebServer
. If tier is left blankWebServer
will be used.- version str
The name of the Elastic Beanstalk Application Version to use in deployment.
- wait_
for_ strready_ timeout The maximum duration that this provider should wait for an Elastic Beanstalk Environment to be in a ready state before timing out.
- application String |
Name of the application that contains the version to be deployed
- cname
Prefix String Prefix to use for the fully qualified DNS name of the Environment.
- description String
Short description of the Environment
- name String
A unique name for this Environment. This name is used in the application URL
- platform
Arn String The ARN of the Elastic Beanstalk Platform to use in deployment
- poll
Interval 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
create
orupdate
action. Minimum10s
, maximum180s
. Omit this to use the default behavior, which is an exponential backoff- settings List<Property Map>
Option settings to configure the new Environment. These override specific values that are set as defaults. The format is detailed below in Option Settings
- solution
Stack StringName A solution stack to base your environment off of. Example stacks can be found in the Amazon API documentation
- Map<String>
A set of tags to apply to the Environment. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.- template
Name String The name of the Elastic Beanstalk Configuration template to use in deployment
- tier String
Elastic Beanstalk Environment tier. Valid values are
Worker
orWebServer
. If tier is left blankWebServer
will be used.- version
The name of the Elastic Beanstalk Application Version to use in deployment.
- wait
For StringReady Timeout The maximum duration that this provider should wait for an Elastic Beanstalk Environment to be in a ready state before timing out.
Outputs
All input properties are implicitly available as output properties. Additionally, the Environment resource produces the following output properties:
- All
Settings List<EnvironmentAll Setting> List of all option settings configured in this Environment. These are a combination of default settings and their overrides from
setting
in the configuration.- Arn string
- Autoscaling
Groups List<string> The autoscaling groups used by this Environment.
- Cname string
Fully qualified DNS name for this Environment.
- Endpoint
Url string The URL to the Load Balancer for this Environment
- Id string
The provider-assigned unique ID for this managed resource.
- Instances List<string>
Instances used by this Environment.
- Launch
Configurations List<string> Launch configurations in use by this Environment.
- Load
Balancers List<string> Elastic load balancers in use by this Environment.
- Queues List<string>
SQS queues in use by this Environment.
- Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- Triggers List<string>
Autoscaling triggers in use by this Environment.
- All
Settings []EnvironmentAll Setting List of all option settings configured in this Environment. These are a combination of default settings and their overrides from
setting
in the configuration.- Arn string
- Autoscaling
Groups []string The autoscaling groups used by this Environment.
- Cname string
Fully qualified DNS name for this Environment.
- Endpoint
Url string The URL to the Load Balancer for this Environment
- Id string
The provider-assigned unique ID for this managed resource.
- Instances []string
Instances used by this Environment.
- Launch
Configurations []string Launch configurations in use by this Environment.
- Load
Balancers []string Elastic load balancers in use by this Environment.
- Queues []string
SQS queues in use by this Environment.
- map[string]string
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- Triggers []string
Autoscaling triggers in use by this Environment.
- all
Settings List<EnvironmentAll Setting> List of all option settings configured in this Environment. These are a combination of default settings and their overrides from
setting
in the configuration.- arn String
- autoscaling
Groups List<String> The autoscaling groups used by this Environment.
- cname String
Fully qualified DNS name for this Environment.
- endpoint
Url String The URL to the Load Balancer for this Environment
- id String
The provider-assigned unique ID for this managed resource.
- instances List<String>
Instances used by this Environment.
- launch
Configurations List<String> Launch configurations in use by this Environment.
- load
Balancers List<String> Elastic load balancers in use by this Environment.
- queues List<String>
SQS queues in use by this Environment.
- Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- triggers List<String>
Autoscaling triggers in use by this Environment.
- all
Settings EnvironmentAll Setting[] List of all option settings configured in this Environment. These are a combination of default settings and their overrides from
setting
in the configuration.- arn string
- autoscaling
Groups string[] The autoscaling groups used by this Environment.
- cname string
Fully qualified DNS name for this Environment.
- endpoint
Url string The URL to the Load Balancer for this Environment
- id string
The provider-assigned unique ID for this managed resource.
- instances string[]
Instances used by this Environment.
- launch
Configurations string[] Launch configurations in use by this Environment.
- load
Balancers string[] Elastic load balancers in use by this Environment.
- queues string[]
SQS queues in use by this Environment.
- {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- triggers string[]
Autoscaling triggers in use by this Environment.
- all_
settings Sequence[EnvironmentAll Setting] List of all option settings configured in this Environment. These are a combination of default settings and their overrides from
setting
in the configuration.- arn str
- autoscaling_
groups Sequence[str] The autoscaling groups used by this Environment.
- cname str
Fully qualified DNS name for this Environment.
- endpoint_
url str The URL to the Load Balancer for this Environment
- id str
The provider-assigned unique ID for this managed resource.
- instances Sequence[str]
Instances used by this Environment.
- launch_
configurations Sequence[str] Launch configurations in use by this Environment.
- load_
balancers Sequence[str] Elastic load balancers in use by this Environment.
- queues Sequence[str]
SQS queues in use by this Environment.
- Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- triggers Sequence[str]
Autoscaling triggers in use by this Environment.
- all
Settings List<Property Map> List of all option settings configured in this Environment. These are a combination of default settings and their overrides from
setting
in the configuration.- arn String
- autoscaling
Groups List<String> The autoscaling groups used by this Environment.
- cname String
Fully qualified DNS name for this Environment.
- endpoint
Url String The URL to the Load Balancer for this Environment
- id String
The provider-assigned unique ID for this managed resource.
- instances List<String>
Instances used by this Environment.
- launch
Configurations List<String> Launch configurations in use by this Environment.
- load
Balancers List<String> Elastic load balancers in use by this Environment.
- queues List<String>
SQS queues in use by this Environment.
- Map<String>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- triggers List<String>
Autoscaling triggers in use by this Environment.
Look up Existing Environment Resource
Get an existing Environment resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: EnvironmentState, opts?: CustomResourceOptions): Environment
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
all_settings: Optional[Sequence[EnvironmentAllSettingArgs]] = None,
application: Optional[str] = None,
arn: Optional[str] = None,
autoscaling_groups: Optional[Sequence[str]] = None,
cname: Optional[str] = None,
cname_prefix: Optional[str] = None,
description: Optional[str] = None,
endpoint_url: Optional[str] = None,
instances: Optional[Sequence[str]] = None,
launch_configurations: Optional[Sequence[str]] = None,
load_balancers: Optional[Sequence[str]] = None,
name: Optional[str] = None,
platform_arn: Optional[str] = None,
poll_interval: Optional[str] = None,
queues: Optional[Sequence[str]] = None,
settings: Optional[Sequence[EnvironmentSettingArgs]] = None,
solution_stack_name: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
tags_all: Optional[Mapping[str, str]] = None,
template_name: Optional[str] = None,
tier: Optional[str] = None,
triggers: Optional[Sequence[str]] = None,
version: Optional[str] = None,
wait_for_ready_timeout: Optional[str] = None) -> Environment
func GetEnvironment(ctx *Context, name string, id IDInput, state *EnvironmentState, opts ...ResourceOption) (*Environment, error)
public static Environment Get(string name, Input<string> id, EnvironmentState? state, CustomResourceOptions? opts = null)
public static Environment get(String name, Output<String> id, EnvironmentState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- All
Settings List<EnvironmentAll Setting Args> List of all option settings configured in this Environment. These are a combination of default settings and their overrides from
setting
in the configuration.- Application string | string
Name of the application that contains the version to be deployed
- Arn string
- Autoscaling
Groups List<string> The autoscaling groups used by this Environment.
- Cname string
Fully qualified DNS name for this Environment.
- Cname
Prefix string Prefix to use for the fully qualified DNS name of the Environment.
- Description string
Short description of the Environment
- Endpoint
Url string The URL to the Load Balancer for this Environment
- Instances List<string>
Instances used by this Environment.
- Launch
Configurations List<string> Launch configurations in use by this Environment.
- Load
Balancers List<string> Elastic load balancers in use by this Environment.
- Name string
A unique name for this Environment. This name is used in the application URL
- Platform
Arn string The ARN of the Elastic Beanstalk Platform to use in deployment
- Poll
Interval 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
create
orupdate
action. Minimum10s
, maximum180s
. Omit this to use the default behavior, which is an exponential backoff- Queues List<string>
SQS queues in use by this Environment.
- Settings
List<Environment
Setting Args> Option settings to configure the new Environment. These override specific values that are set as defaults. The format is detailed below in Option Settings
- Solution
Stack stringName A solution stack to base your environment off of. Example stacks can be found in the Amazon API documentation
- Dictionary<string, string>
A set of tags to apply to the Environment. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.- Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- Template
Name string The name of the Elastic Beanstalk Configuration template to use in deployment
- Tier string
Elastic Beanstalk Environment tier. Valid values are
Worker
orWebServer
. If tier is left blankWebServer
will be used.- Triggers List<string>
Autoscaling triggers in use by this Environment.
- Version string
The name of the Elastic Beanstalk Application Version to use in deployment.
- Wait
For stringReady Timeout The maximum duration that this provider should wait for an Elastic Beanstalk Environment to be in a ready state before timing out.
- All
Settings []EnvironmentAll Setting Args List of all option settings configured in this Environment. These are a combination of default settings and their overrides from
setting
in the configuration.- Application string | string
Name of the application that contains the version to be deployed
- Arn string
- Autoscaling
Groups []string The autoscaling groups used by this Environment.
- Cname string
Fully qualified DNS name for this Environment.
- Cname
Prefix string Prefix to use for the fully qualified DNS name of the Environment.
- Description string
Short description of the Environment
- Endpoint
Url string The URL to the Load Balancer for this Environment
- Instances []string
Instances used by this Environment.
- Launch
Configurations []string Launch configurations in use by this Environment.
- Load
Balancers []string Elastic load balancers in use by this Environment.
- Name string
A unique name for this Environment. This name is used in the application URL
- Platform
Arn string The ARN of the Elastic Beanstalk Platform to use in deployment
- Poll
Interval 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
create
orupdate
action. Minimum10s
, maximum180s
. Omit this to use the default behavior, which is an exponential backoff- Queues []string
SQS queues in use by this Environment.
- Settings
[]Environment
Setting Args Option settings to configure the new Environment. These override specific values that are set as defaults. The format is detailed below in Option Settings
- Solution
Stack stringName A solution stack to base your environment off of. Example stacks can be found in the Amazon API documentation
- map[string]string
A set of tags to apply to the Environment. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.- map[string]string
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- Template
Name string The name of the Elastic Beanstalk Configuration template to use in deployment
- Tier string
Elastic Beanstalk Environment tier. Valid values are
Worker
orWebServer
. If tier is left blankWebServer
will be used.- Triggers []string
Autoscaling triggers in use by this Environment.
- Version string
The name of the Elastic Beanstalk Application Version to use in deployment.
- Wait
For stringReady Timeout The maximum duration that this provider should wait for an Elastic Beanstalk Environment to be in a ready state before timing out.
- all
Settings List<EnvironmentAll Setting Args> List of all option settings configured in this Environment. These are a combination of default settings and their overrides from
setting
in the configuration.- application String | String
Name of the application that contains the version to be deployed
- arn String
- autoscaling
Groups List<String> The autoscaling groups used by this Environment.
- cname String
Fully qualified DNS name for this Environment.
- cname
Prefix String Prefix to use for the fully qualified DNS name of the Environment.
- description String
Short description of the Environment
- endpoint
Url String The URL to the Load Balancer for this Environment
- instances List<String>
Instances used by this Environment.
- launch
Configurations List<String> Launch configurations in use by this Environment.
- load
Balancers List<String> Elastic load balancers in use by this Environment.
- name String
A unique name for this Environment. This name is used in the application URL
- platform
Arn String The ARN of the Elastic Beanstalk Platform to use in deployment
- poll
Interval 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
create
orupdate
action. Minimum10s
, maximum180s
. Omit this to use the default behavior, which is an exponential backoff- queues List<String>
SQS queues in use by this Environment.
- settings
List<Environment
Setting Args> Option settings to configure the new Environment. These override specific values that are set as defaults. The format is detailed below in Option Settings
- solution
Stack StringName A solution stack to base your environment off of. Example stacks can be found in the Amazon API documentation
- Map<String,String>
A set of tags to apply to the Environment. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.- Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- template
Name String The name of the Elastic Beanstalk Configuration template to use in deployment
- tier String
Elastic Beanstalk Environment tier. Valid values are
Worker
orWebServer
. If tier is left blankWebServer
will be used.- triggers List<String>
Autoscaling triggers in use by this Environment.
- version String
The name of the Elastic Beanstalk Application Version to use in deployment.
- wait
For StringReady Timeout The maximum duration that this provider should wait for an Elastic Beanstalk Environment to be in a ready state before timing out.
- all
Settings EnvironmentAll Setting Args[] List of all option settings configured in this Environment. These are a combination of default settings and their overrides from
setting
in the configuration.- application string | Application
Name of the application that contains the version to be deployed
- arn string
- autoscaling
Groups string[] The autoscaling groups used by this Environment.
- cname string
Fully qualified DNS name for this Environment.
- cname
Prefix string Prefix to use for the fully qualified DNS name of the Environment.
- description string
Short description of the Environment
- endpoint
Url string The URL to the Load Balancer for this Environment
- instances string[]
Instances used by this Environment.
- launch
Configurations string[] Launch configurations in use by this Environment.
- load
Balancers string[] Elastic load balancers in use by this Environment.
- name string
A unique name for this Environment. This name is used in the application URL
- platform
Arn string The ARN of the Elastic Beanstalk Platform to use in deployment
- poll
Interval 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
create
orupdate
action. Minimum10s
, maximum180s
. Omit this to use the default behavior, which is an exponential backoff- queues string[]
SQS queues in use by this Environment.
- settings
Environment
Setting Args[] Option settings to configure the new Environment. These override specific values that are set as defaults. The format is detailed below in Option Settings
- solution
Stack stringName A solution stack to base your environment off of. Example stacks can be found in the Amazon API documentation
- {[key: string]: string}
A set of tags to apply to the Environment. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.- {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- template
Name string The name of the Elastic Beanstalk Configuration template to use in deployment
- tier string
Elastic Beanstalk Environment tier. Valid values are
Worker
orWebServer
. If tier is left blankWebServer
will be used.- triggers string[]
Autoscaling triggers in use by this Environment.
- version
Application
Version The name of the Elastic Beanstalk Application Version to use in deployment.
- wait
For stringReady Timeout The maximum duration that this provider should wait for an Elastic Beanstalk Environment to be in a ready state before timing out.
- all_
settings Sequence[EnvironmentAll Setting Args] List of all option settings configured in this Environment. These are a combination of default settings and their overrides from
setting
in the configuration.- application str | str
Name of the application that contains the version to be deployed
- arn str
- autoscaling_
groups Sequence[str] The autoscaling groups used by this Environment.
- cname str
Fully qualified DNS name for this Environment.
- cname_
prefix str Prefix to use for the fully qualified DNS name of the Environment.
- description str
Short description of the Environment
- endpoint_
url str The URL to the Load Balancer for this Environment
- instances Sequence[str]
Instances used by this Environment.
- launch_
configurations Sequence[str] Launch configurations in use by this Environment.
- load_
balancers Sequence[str] Elastic load balancers in use by this Environment.
- name str
A unique name for this Environment. This name is used in the application URL
- platform_
arn str The ARN of the Elastic Beanstalk Platform to use in deployment
- poll_
interval str 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
orupdate
action. Minimum10s
, maximum180s
. Omit this to use the default behavior, which is an exponential backoff- queues Sequence[str]
SQS queues in use by this Environment.
- settings
Sequence[Environment
Setting Args] Option settings to configure the new Environment. These override specific values that are set as defaults. The format is detailed below in Option Settings
- solution_
stack_ strname A solution stack to base your environment off of. Example stacks can be found in the Amazon API documentation
- Mapping[str, str]
A set of tags to apply to the Environment. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.- Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- template_
name str The name of the Elastic Beanstalk Configuration template to use in deployment
- tier str
Elastic Beanstalk Environment tier. Valid values are
Worker
orWebServer
. If tier is left blankWebServer
will be used.- triggers Sequence[str]
Autoscaling triggers in use by this Environment.
- version str
The name of the Elastic Beanstalk Application Version to use in deployment.
- wait_
for_ strready_ timeout The maximum duration that this provider should wait for an Elastic Beanstalk Environment to be in a ready state before timing out.
- all
Settings List<Property Map> List of all option settings configured in this Environment. These are a combination of default settings and their overrides from
setting
in the configuration.- application String |
Name of the application that contains the version to be deployed
- arn String
- autoscaling
Groups List<String> The autoscaling groups used by this Environment.
- cname String
Fully qualified DNS name for this Environment.
- cname
Prefix String Prefix to use for the fully qualified DNS name of the Environment.
- description String
Short description of the Environment
- endpoint
Url String The URL to the Load Balancer for this Environment
- instances List<String>
Instances used by this Environment.
- launch
Configurations List<String> Launch configurations in use by this Environment.
- load
Balancers List<String> Elastic load balancers in use by this Environment.
- name String
A unique name for this Environment. This name is used in the application URL
- platform
Arn String The ARN of the Elastic Beanstalk Platform to use in deployment
- poll
Interval 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
create
orupdate
action. Minimum10s
, maximum180s
. Omit this to use the default behavior, which is an exponential backoff- queues List<String>
SQS queues in use by this Environment.
- settings List<Property Map>
Option settings to configure the new Environment. These override specific values that are set as defaults. The format is detailed below in Option Settings
- solution
Stack StringName A solution stack to base your environment off of. Example stacks can be found in the Amazon API documentation
- Map<String>
A set of tags to apply to the Environment. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.- Map<String>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.- template
Name String The name of the Elastic Beanstalk Configuration template to use in deployment
- tier String
Elastic Beanstalk Environment tier. Valid values are
Worker
orWebServer
. If tier is left blankWebServer
will be used.- triggers List<String>
Autoscaling triggers in use by this Environment.
- version
The name of the Elastic Beanstalk Application Version to use in deployment.
- wait
For StringReady Timeout The maximum duration that this provider should wait for an Elastic Beanstalk Environment to be in a ready state before timing out.
Supporting Types
EnvironmentAllSetting
EnvironmentSetting
Import
Elastic Beanstalk Environments can be imported using the id
, e.g.,
$ pulumi import aws:elasticbeanstalk/environment:Environment prodenv e-rpqsewtp2j
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
aws
Terraform Provider.