1. Packages
  2. AWS Classic
  3. API Docs
  4. elasticbeanstalk
  5. Environment

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.40.0 published on Wednesday, Jun 12, 2024 by Pulumi

aws.elasticbeanstalk.Environment

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.40.0 published on Wednesday, Jun 12, 2024 by Pulumi

    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 tftest = new aws.elasticbeanstalk.Application("tftest", {
        name: "tf-test-name",
        description: "tf-test-desc",
    });
    const tfenvtest = new aws.elasticbeanstalk.Environment("tfenvtest", {
        name: "tf-test-name",
        application: tftest.name,
        solutionStackName: "64bit Amazon Linux 2015.03 v2.0.3 running Go 1.4",
    });
    
    import pulumi
    import pulumi_aws as aws
    
    tftest = aws.elasticbeanstalk.Application("tftest",
        name="tf-test-name",
        description="tf-test-desc")
    tfenvtest = aws.elasticbeanstalk.Environment("tfenvtest",
        name="tf-test-name",
        application=tftest.name,
        solution_stack_name="64bit Amazon Linux 2015.03 v2.0.3 running Go 1.4")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/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{
    			Name:        pulumi.String("tf-test-name"),
    			Description: pulumi.String("tf-test-desc"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = elasticbeanstalk.NewEnvironment(ctx, "tfenvtest", &elasticbeanstalk.EnvironmentArgs{
    			Name:              pulumi.String("tf-test-name"),
    			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
    	})
    }
    
    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()
        {
            Name = "tf-test-name",
            Description = "tf-test-desc",
        });
    
        var tfenvtest = new Aws.ElasticBeanstalk.Environment("tfenvtest", new()
        {
            Name = "tf-test-name",
            Application = tftest.Name,
            SolutionStackName = "64bit Amazon Linux 2015.03 v2.0.3 running Go 1.4",
        });
    
    });
    
    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()
                .name("tf-test-name")
                .description("tf-test-desc")
                .build());
    
            var tfenvtest = new Environment("tfenvtest", EnvironmentArgs.builder()
                .name("tf-test-name")
                .application(tftest.name())
                .solutionStackName("64bit Amazon Linux 2015.03 v2.0.3 running Go 1.4")
                .build());
    
        }
    }
    
    resources:
      tftest:
        type: aws:elasticbeanstalk:Application
        properties:
          name: tf-test-name
          description: tf-test-desc
      tfenvtest:
        type: aws:elasticbeanstalk:Environment
        properties:
          name: tf-test-name
          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

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const tftest = new aws.elasticbeanstalk.Application("tftest", {
        name: "tf-test-name",
        description: "tf-test-desc",
    });
    const tfenvtest = new aws.elasticbeanstalk.Environment("tfenvtest", {
        name: "tf-test-name",
        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",
        name="tf-test-name",
        description="tf-test-desc")
    tfenvtest = aws.elasticbeanstalk.Environment("tfenvtest",
        name="tf-test-name",
        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",
            ),
        ])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/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{
    			Name:        pulumi.String("tf-test-name"),
    			Description: pulumi.String("tf-test-desc"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = elasticbeanstalk.NewEnvironment(ctx, "tfenvtest", &elasticbeanstalk.EnvironmentArgs{
    			Name:              pulumi.String("tf-test-name"),
    			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
    	})
    }
    
    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()
        {
            Name = "tf-test-name",
            Description = "tf-test-desc",
        });
    
        var tfenvtest = new Aws.ElasticBeanstalk.Environment("tfenvtest", new()
        {
            Name = "tf-test-name",
            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 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()
                .name("tf-test-name")
                .description("tf-test-desc")
                .build());
    
            var tfenvtest = new Environment("tfenvtest", EnvironmentArgs.builder()
                .name("tf-test-name")
                .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:
          name: tf-test-name
          description: tf-test-desc
      tfenvtest:
        type: aws:elasticbeanstalk:Environment
        properties:
          name: tf-test-name
          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

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Environment(name: string, args: EnvironmentArgs, opts?: CustomResourceOptions);
    @overload
    def Environment(resource_name: str,
                    args: EnvironmentArgs,
                    opts: Optional[ResourceOptions] = None)
    
    @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)
    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.
    
    

    Parameters

    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.

    Example

    The following reference example uses placeholder values for all input properties.

    var awsEnvironmentResource = new Aws.ElasticBeanstalk.Environment("awsEnvironmentResource", new()
    {
        Application = "string",
        CnamePrefix = "string",
        Description = "string",
        Name = "string",
        PlatformArn = "string",
        PollInterval = "string",
        Settings = new[]
        {
            new Aws.ElasticBeanstalk.Inputs.EnvironmentSettingArgs
            {
                Name = "string",
                Namespace = "string",
                Value = "string",
                Resource = "string",
            },
        },
        SolutionStackName = "string",
        Tags = 
        {
            { "string", "string" },
        },
        TemplateName = "string",
        Tier = "string",
        Version = "string",
        WaitForReadyTimeout = "string",
    });
    
    example, err := elasticbeanstalk.NewEnvironment(ctx, "awsEnvironmentResource", &elasticbeanstalk.EnvironmentArgs{
    	Application:  pulumi.Any("string"),
    	CnamePrefix:  pulumi.String("string"),
    	Description:  pulumi.String("string"),
    	Name:         pulumi.String("string"),
    	PlatformArn:  pulumi.String("string"),
    	PollInterval: pulumi.String("string"),
    	Settings: elasticbeanstalk.EnvironmentSettingArray{
    		&elasticbeanstalk.EnvironmentSettingArgs{
    			Name:      pulumi.String("string"),
    			Namespace: pulumi.String("string"),
    			Value:     pulumi.String("string"),
    			Resource:  pulumi.String("string"),
    		},
    	},
    	SolutionStackName: pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	TemplateName:        pulumi.String("string"),
    	Tier:                pulumi.String("string"),
    	Version:             pulumi.String("string"),
    	WaitForReadyTimeout: pulumi.String("string"),
    })
    
    var awsEnvironmentResource = new Environment("awsEnvironmentResource", EnvironmentArgs.builder()
        .application("string")
        .cnamePrefix("string")
        .description("string")
        .name("string")
        .platformArn("string")
        .pollInterval("string")
        .settings(EnvironmentSettingArgs.builder()
            .name("string")
            .namespace("string")
            .value("string")
            .resource("string")
            .build())
        .solutionStackName("string")
        .tags(Map.of("string", "string"))
        .templateName("string")
        .tier("string")
        .version("string")
        .waitForReadyTimeout("string")
        .build());
    
    aws_environment_resource = aws.elasticbeanstalk.Environment("awsEnvironmentResource",
        application="string",
        cname_prefix="string",
        description="string",
        name="string",
        platform_arn="string",
        poll_interval="string",
        settings=[aws.elasticbeanstalk.EnvironmentSettingArgs(
            name="string",
            namespace="string",
            value="string",
            resource="string",
        )],
        solution_stack_name="string",
        tags={
            "string": "string",
        },
        template_name="string",
        tier="string",
        version="string",
        wait_for_ready_timeout="string")
    
    const awsEnvironmentResource = new aws.elasticbeanstalk.Environment("awsEnvironmentResource", {
        application: "string",
        cnamePrefix: "string",
        description: "string",
        name: "string",
        platformArn: "string",
        pollInterval: "string",
        settings: [{
            name: "string",
            namespace: "string",
            value: "string",
            resource: "string",
        }],
        solutionStackName: "string",
        tags: {
            string: "string",
        },
        templateName: "string",
        tier: "string",
        version: "string",
        waitForReadyTimeout: "string",
    });
    
    type: aws:elasticbeanstalk:Environment
    properties:
        application: string
        cnamePrefix: string
        description: string
        name: string
        platformArn: string
        pollInterval: string
        settings:
            - name: string
              namespace: string
              resource: string
              value: string
        solutionStackName: string
        tags:
            string: string
        templateName: string
        tier: string
        version: string
        waitForReadyTimeout: string
    

    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
    CnamePrefix 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
    PlatformArn string
    The ARN of the Elastic Beanstalk Platform to use in deployment
    PollInterval 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 or update action. Minimum 10s, maximum 180s. Omit this to use the default behavior, which is an exponential backoff
    Settings 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
    SolutionStackName string
    A solution stack to base your environment off of. Example stacks can be found in the Amazon API documentation
    Tags 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.
    TemplateName string
    The name of the Elastic Beanstalk Configuration template to use in deployment
    Tier string
    Elastic Beanstalk Environment tier. Valid values are Worker or WebServer. If tier is left blank WebServer will be used.
    Version string
    The name of the Elastic Beanstalk Application Version to use in deployment.
    WaitForReadyTimeout string
    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
    CnamePrefix 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
    PlatformArn string
    The ARN of the Elastic Beanstalk Platform to use in deployment
    PollInterval 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 or update action. Minimum 10s, maximum 180s. Omit this to use the default behavior, which is an exponential backoff
    Settings []EnvironmentSettingArgs
    Option settings to configure the new Environment. These override specific values that are set as defaults. The format is detailed below in Option Settings
    SolutionStackName string
    A solution stack to base your environment off of. Example stacks can be found in the Amazon API documentation
    Tags 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.
    TemplateName string
    The name of the Elastic Beanstalk Configuration template to use in deployment
    Tier string
    Elastic Beanstalk Environment tier. Valid values are Worker or WebServer. If tier is left blank WebServer will be used.
    Version string
    The name of the Elastic Beanstalk Application Version to use in deployment.
    WaitForReadyTimeout string
    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
    cnamePrefix 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
    platformArn String
    The ARN of the Elastic Beanstalk Platform to use in deployment
    pollInterval 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 or update action. Minimum 10s, maximum 180s. Omit this to use the default behavior, which is an exponential backoff
    settings 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
    solutionStackName String
    A solution stack to base your environment off of. Example stacks can be found in the Amazon API documentation
    tags 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.
    templateName String
    The name of the Elastic Beanstalk Configuration template to use in deployment
    tier String
    Elastic Beanstalk Environment tier. Valid values are Worker or WebServer. If tier is left blank WebServer will be used.
    version String
    The name of the Elastic Beanstalk Application Version to use in deployment.
    waitForReadyTimeout String
    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
    cnamePrefix 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
    platformArn string
    The ARN of the Elastic Beanstalk Platform to use in deployment
    pollInterval 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 or update action. Minimum 10s, maximum 180s. Omit this to use the default behavior, which is an exponential backoff
    settings 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
    solutionStackName string
    A solution stack to base your environment off of. Example stacks can be found in the Amazon API documentation
    tags {[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.
    templateName string
    The name of the Elastic Beanstalk Configuration template to use in deployment
    tier string
    Elastic Beanstalk Environment tier. Valid values are Worker or WebServer. If tier is left blank WebServer will be used.
    version ApplicationVersion
    The name of the Elastic Beanstalk Application Version to use in deployment.
    waitForReadyTimeout string
    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 or update action. Minimum 10s, maximum 180s. Omit this to use the default behavior, which is an exponential backoff
    settings Sequence[EnvironmentSettingArgs]
    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_name str
    A solution stack to base your environment off of. Example stacks can be found in the Amazon API documentation
    tags 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 or WebServer. If tier is left blank WebServer will be used.
    version str
    The name of the Elastic Beanstalk Application Version to use in deployment.
    wait_for_ready_timeout str
    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
    cnamePrefix 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
    platformArn String
    The ARN of the Elastic Beanstalk Platform to use in deployment
    pollInterval 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 or update action. Minimum 10s, maximum 180s. 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
    solutionStackName String
    A solution stack to base your environment off of. Example stacks can be found in the Amazon API documentation
    tags 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.
    templateName String
    The name of the Elastic Beanstalk Configuration template to use in deployment
    tier String
    Elastic Beanstalk Environment tier. Valid values are Worker or WebServer. If tier is left blank WebServer will be used.
    version
    The name of the Elastic Beanstalk Application Version to use in deployment.
    waitForReadyTimeout String
    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:

    AllSettings List<EnvironmentAllSetting>
    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
    AutoscalingGroups List<string>
    The autoscaling groups used by this Environment.
    Cname string
    Fully qualified DNS name for this Environment.
    EndpointUrl 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.
    LaunchConfigurations List<string>
    Launch configurations in use by this Environment.
    LoadBalancers List<string>
    Elastic load balancers in use by this Environment.
    Queues List<string>
    SQS queues in use by this Environment.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Triggers List<string>
    Autoscaling triggers in use by this Environment.
    AllSettings []EnvironmentAllSetting
    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
    AutoscalingGroups []string
    The autoscaling groups used by this Environment.
    Cname string
    Fully qualified DNS name for this Environment.
    EndpointUrl 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.
    LaunchConfigurations []string
    Launch configurations in use by this Environment.
    LoadBalancers []string
    Elastic load balancers in use by this Environment.
    Queues []string
    SQS queues in use by this Environment.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Triggers []string
    Autoscaling triggers in use by this Environment.
    allSettings List<EnvironmentAllSetting>
    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
    autoscalingGroups List<String>
    The autoscaling groups used by this Environment.
    cname String
    Fully qualified DNS name for this Environment.
    endpointUrl 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.
    launchConfigurations List<String>
    Launch configurations in use by this Environment.
    loadBalancers List<String>
    Elastic load balancers in use by this Environment.
    queues List<String>
    SQS queues in use by this Environment.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    triggers List<String>
    Autoscaling triggers in use by this Environment.
    allSettings EnvironmentAllSetting[]
    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
    autoscalingGroups string[]
    The autoscaling groups used by this Environment.
    cname string
    Fully qualified DNS name for this Environment.
    endpointUrl 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.
    launchConfigurations string[]
    Launch configurations in use by this Environment.
    loadBalancers string[]
    Elastic load balancers in use by this Environment.
    queues string[]
    SQS queues in use by this Environment.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    triggers string[]
    Autoscaling triggers in use by this Environment.
    all_settings Sequence[EnvironmentAllSetting]
    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.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    triggers Sequence[str]
    Autoscaling triggers in use by this Environment.
    allSettings 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
    autoscalingGroups List<String>
    The autoscaling groups used by this Environment.
    cname String
    Fully qualified DNS name for this Environment.
    endpointUrl 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.
    launchConfigurations List<String>
    Launch configurations in use by this Environment.
    loadBalancers List<String>
    Elastic load balancers in use by this Environment.
    queues List<String>
    SQS queues in use by this Environment.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    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.
    The following state arguments are supported:
    AllSettings List<EnvironmentAllSetting>
    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
    AutoscalingGroups List<string>
    The autoscaling groups used by this Environment.
    Cname string
    Fully qualified DNS name for this Environment.
    CnamePrefix string
    Prefix to use for the fully qualified DNS name of the Environment.
    Description string
    Short description of the Environment
    EndpointUrl string
    The URL to the Load Balancer for this Environment
    Instances List<string>
    Instances used by this Environment.
    LaunchConfigurations List<string>
    Launch configurations in use by this Environment.
    LoadBalancers 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
    PlatformArn string
    The ARN of the Elastic Beanstalk Platform to use in deployment
    PollInterval 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 or update action. Minimum 10s, maximum 180s. Omit this to use the default behavior, which is an exponential backoff
    Queues List<string>
    SQS queues in use by this Environment.
    Settings 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
    SolutionStackName string
    A solution stack to base your environment off of. Example stacks can be found in the Amazon API documentation
    Tags 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.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    TemplateName string
    The name of the Elastic Beanstalk Configuration template to use in deployment
    Tier string
    Elastic Beanstalk Environment tier. Valid values are Worker or WebServer. If tier is left blank WebServer 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.
    WaitForReadyTimeout string
    The maximum duration that this provider should wait for an Elastic Beanstalk Environment to be in a ready state before timing out.
    AllSettings []EnvironmentAllSettingArgs
    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
    AutoscalingGroups []string
    The autoscaling groups used by this Environment.
    Cname string
    Fully qualified DNS name for this Environment.
    CnamePrefix string
    Prefix to use for the fully qualified DNS name of the Environment.
    Description string
    Short description of the Environment
    EndpointUrl string
    The URL to the Load Balancer for this Environment
    Instances []string
    Instances used by this Environment.
    LaunchConfigurations []string
    Launch configurations in use by this Environment.
    LoadBalancers []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
    PlatformArn string
    The ARN of the Elastic Beanstalk Platform to use in deployment
    PollInterval 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 or update action. Minimum 10s, maximum 180s. Omit this to use the default behavior, which is an exponential backoff
    Queues []string
    SQS queues in use by this Environment.
    Settings []EnvironmentSettingArgs
    Option settings to configure the new Environment. These override specific values that are set as defaults. The format is detailed below in Option Settings
    SolutionStackName string
    A solution stack to base your environment off of. Example stacks can be found in the Amazon API documentation
    Tags 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.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    TemplateName string
    The name of the Elastic Beanstalk Configuration template to use in deployment
    Tier string
    Elastic Beanstalk Environment tier. Valid values are Worker or WebServer. If tier is left blank WebServer 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.
    WaitForReadyTimeout string
    The maximum duration that this provider should wait for an Elastic Beanstalk Environment to be in a ready state before timing out.
    allSettings List<EnvironmentAllSetting>
    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
    autoscalingGroups List<String>
    The autoscaling groups used by this Environment.
    cname String
    Fully qualified DNS name for this Environment.
    cnamePrefix String
    Prefix to use for the fully qualified DNS name of the Environment.
    description String
    Short description of the Environment
    endpointUrl String
    The URL to the Load Balancer for this Environment
    instances List<String>
    Instances used by this Environment.
    launchConfigurations List<String>
    Launch configurations in use by this Environment.
    loadBalancers 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
    platformArn String
    The ARN of the Elastic Beanstalk Platform to use in deployment
    pollInterval 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 or update action. Minimum 10s, maximum 180s. Omit this to use the default behavior, which is an exponential backoff
    queues List<String>
    SQS queues in use by this Environment.
    settings 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
    solutionStackName String
    A solution stack to base your environment off of. Example stacks can be found in the Amazon API documentation
    tags 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.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    templateName String
    The name of the Elastic Beanstalk Configuration template to use in deployment
    tier String
    Elastic Beanstalk Environment tier. Valid values are Worker or WebServer. If tier is left blank WebServer 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.
    waitForReadyTimeout String
    The maximum duration that this provider should wait for an Elastic Beanstalk Environment to be in a ready state before timing out.
    allSettings EnvironmentAllSetting[]
    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
    autoscalingGroups string[]
    The autoscaling groups used by this Environment.
    cname string
    Fully qualified DNS name for this Environment.
    cnamePrefix string
    Prefix to use for the fully qualified DNS name of the Environment.
    description string
    Short description of the Environment
    endpointUrl string
    The URL to the Load Balancer for this Environment
    instances string[]
    Instances used by this Environment.
    launchConfigurations string[]
    Launch configurations in use by this Environment.
    loadBalancers 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
    platformArn string
    The ARN of the Elastic Beanstalk Platform to use in deployment
    pollInterval 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 or update action. Minimum 10s, maximum 180s. Omit this to use the default behavior, which is an exponential backoff
    queues string[]
    SQS queues in use by this Environment.
    settings 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
    solutionStackName string
    A solution stack to base your environment off of. Example stacks can be found in the Amazon API documentation
    tags {[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.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    templateName string
    The name of the Elastic Beanstalk Configuration template to use in deployment
    tier string
    Elastic Beanstalk Environment tier. Valid values are Worker or WebServer. If tier is left blank WebServer will be used.
    triggers string[]
    Autoscaling triggers in use by this Environment.
    version ApplicationVersion
    The name of the Elastic Beanstalk Application Version to use in deployment.
    waitForReadyTimeout string
    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[EnvironmentAllSettingArgs]
    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 or update action. Minimum 10s, maximum 180s. Omit this to use the default behavior, which is an exponential backoff
    queues Sequence[str]
    SQS queues in use by this Environment.
    settings Sequence[EnvironmentSettingArgs]
    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_name str
    A solution stack to base your environment off of. Example stacks can be found in the Amazon API documentation
    tags 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.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    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 or WebServer. If tier is left blank WebServer 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_ready_timeout str
    The maximum duration that this provider should wait for an Elastic Beanstalk Environment to be in a ready state before timing out.
    allSettings 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
    autoscalingGroups List<String>
    The autoscaling groups used by this Environment.
    cname String
    Fully qualified DNS name for this Environment.
    cnamePrefix String
    Prefix to use for the fully qualified DNS name of the Environment.
    description String
    Short description of the Environment
    endpointUrl String
    The URL to the Load Balancer for this Environment
    instances List<String>
    Instances used by this Environment.
    launchConfigurations List<String>
    Launch configurations in use by this Environment.
    loadBalancers 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
    platformArn String
    The ARN of the Elastic Beanstalk Platform to use in deployment
    pollInterval 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 or update action. Minimum 10s, maximum 180s. 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
    solutionStackName String
    A solution stack to base your environment off of. Example stacks can be found in the Amazon API documentation
    tags 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.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    templateName String
    The name of the Elastic Beanstalk Configuration template to use in deployment
    tier String
    Elastic Beanstalk Environment tier. Valid values are Worker or WebServer. If tier is left blank WebServer 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.
    waitForReadyTimeout String
    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, EnvironmentAllSettingArgs

    Name string
    A unique name for this Environment. This name is used in the application URL
    Namespace string
    Value string
    Resource string
    Name string
    A unique name for this Environment. This name is used in the application URL
    Namespace string
    Value string
    Resource string
    name String
    A unique name for this Environment. This name is used in the application URL
    namespace String
    value String
    resource String
    name string
    A unique name for this Environment. This name is used in the application URL
    namespace string
    value string
    resource string
    name str
    A unique name for this Environment. This name is used in the application URL
    namespace str
    value str
    resource str
    name String
    A unique name for this Environment. This name is used in the application URL
    namespace String
    value String
    resource String

    EnvironmentSetting, EnvironmentSettingArgs

    Name string
    A unique name for this Environment. This name is used in the application URL
    Namespace string
    Value string
    Resource string
    Name string
    A unique name for this Environment. This name is used in the application URL
    Namespace string
    Value string
    Resource string
    name String
    A unique name for this Environment. This name is used in the application URL
    namespace String
    value String
    resource String
    name string
    A unique name for this Environment. This name is used in the application URL
    namespace string
    value string
    resource string
    name str
    A unique name for this Environment. This name is used in the application URL
    namespace str
    value str
    resource str
    name String
    A unique name for this Environment. This name is used in the application URL
    namespace String
    value String
    resource String

    Import

    Using pulumi import, import Elastic Beanstalk Environments using the id. For example:

    $ pulumi import aws:elasticbeanstalk/environment:Environment prodenv e-rpqsewtp2j
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.40.0 published on Wednesday, Jun 12, 2024 by Pulumi