Package com.pulumi.aws.elasticbeanstalk

Class Environment

  • public class Environment
extends com.pulumi.resources.CustomResource
    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 <!--Start PulumiCodeChooser --> ```java 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()); } } ``` <!--End PulumiCodeChooser --> ## Option Settings Some options can be stack-specific, check [AWS Docs](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options-general.html) 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](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options-general.html#command-options-general-autoscalingscheduledaction) ### Example With Options <!--Start PulumiCodeChooser --> ```java 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()); } } ``` <!--End PulumiCodeChooser --> ## Import Using `pulumi import`, import Elastic Beanstalk Environments using the `id`. For example: ```sh $ pulumi import aws:elasticbeanstalk/environment:Environment prodenv e-rpqsewtp2j ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.util.List<EnvironmentAllSetting>> allSettings()  
      com.pulumi.core.Output<java.lang.String> application()  
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.util.List<java.lang.String>> autoscalingGroups()  
      com.pulumi.core.Output<java.lang.String> cname()  
      com.pulumi.core.Output<java.lang.String> cnamePrefix()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()  
      com.pulumi.core.Output<java.lang.String> endpointUrl()  
      static Environment get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, EnvironmentState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.util.List<java.lang.String>> instances()  
      com.pulumi.core.Output<java.util.List<java.lang.String>> launchConfigurations()  
      com.pulumi.core.Output<java.util.List<java.lang.String>> loadBalancers()  
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.lang.String> platformArn()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> pollInterval()  
      com.pulumi.core.Output<java.util.List<java.lang.String>> queues()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<EnvironmentSetting>>> settings()  
      com.pulumi.core.Output<java.lang.String> solutionStackName()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> templateName()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> tier()  
      com.pulumi.core.Output<java.util.List<java.lang.String>> triggers()  
      com.pulumi.core.Output<java.lang.String> version()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> waitForReadyTimeout()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • Environment

        public Environment​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • Environment

        public Environment​(java.lang.String name,
                   EnvironmentArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • Environment

        public Environment​(java.lang.String name,
                   EnvironmentArgs args,
                   @Nullable
                   com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • allSettings

        public com.pulumi.core.Output<java.util.List<EnvironmentAllSetting>> allSettings()
        Returns:
        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

        public com.pulumi.core.Output<java.lang.String> application()
        Returns:
        Name of the application that contains the version to be deployed

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()

      • autoscalingGroups

        public com.pulumi.core.Output<java.util.List<java.lang.String>> autoscalingGroups()
        Returns:
        The autoscaling groups used by this Environment.

      • cname

        public com.pulumi.core.Output<java.lang.String> cname()
        Returns:
        Fully qualified DNS name for this Environment.

      • cnamePrefix

        public com.pulumi.core.Output<java.lang.String> cnamePrefix()
        Returns:
        Prefix to use for the fully qualified DNS name of the Environment.

      • description

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()
        Returns:
        Short description of the Environment

      • endpointUrl

        public com.pulumi.core.Output<java.lang.String> endpointUrl()
        Returns:
        The URL to the Load Balancer for this Environment

      • instances

        public com.pulumi.core.Output<java.util.List<java.lang.String>> instances()
        Returns:
        Instances used by this Environment.

      • launchConfigurations

        public com.pulumi.core.Output<java.util.List<java.lang.String>> launchConfigurations()
        Returns:
        Launch configurations in use by this Environment.

      • loadBalancers

        public com.pulumi.core.Output<java.util.List<java.lang.String>> loadBalancers()
        Returns:
        Elastic load balancers in use by this Environment.

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        A unique name for this Environment. This name is used in the application URL

      • platformArn

        public com.pulumi.core.Output<java.lang.String> platformArn()
        Returns:
        The [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the Elastic Beanstalk [Platform](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-beanstalk-environment.html#cfn-beanstalk-environment-platformarn) to use in deployment

      • pollInterval

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> pollInterval()
        Returns:
        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

        public com.pulumi.core.Output<java.util.List<java.lang.String>> queues()
        Returns:
        SQS queues in use by this Environment.

      • settings

        public com.pulumi.core.Output<java.util.Optional<java.util.List<EnvironmentSetting>>> settings()
        Returns:
        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

        public com.pulumi.core.Output<java.lang.String> solutionStackName()
        Returns:
        A solution stack to base your environment off of. Example stacks can be found in the [Amazon API documentation](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/concepts.platforms.html)

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        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

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        A map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.

      • templateName

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> templateName()
        Returns:
        The name of the Elastic Beanstalk Configuration template to use in deployment

      • tier

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> tier()
        Returns:
        Elastic Beanstalk Environment tier. Valid values are `Worker` or `WebServer`. If tier is left blank `WebServer` will be used.

      • triggers

        public com.pulumi.core.Output<java.util.List<java.lang.String>> triggers()
        Returns:
        Autoscaling triggers in use by this Environment.

      • version

        public com.pulumi.core.Output<java.lang.String> version()
        Returns:
        The name of the Elastic Beanstalk Application Version to use in deployment.

      • waitForReadyTimeout

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> waitForReadyTimeout()
        Returns:
        The maximum [duration](https://golang.org/pkg/time/#ParseDuration) that this provider should wait for an Elastic Beanstalk Environment to be in a ready state before timing out.

      • get

        public static Environment get​(java.lang.String name,
                              com.pulumi.core.Output<java.lang.String> id,
                              @Nullable
                              EnvironmentState state,
                              @Nullable
                              com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.