Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. elasticbeanstalk
  5. getEnvironment

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.elasticbeanstalk.getEnvironment

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

Resource Type definition for AWS::ElasticBeanstalk::Environment

Using getEnvironment

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getEnvironment(args: GetEnvironmentArgs, opts?: InvokeOptions): Promise<GetEnvironmentResult>
function getEnvironmentOutput(args: GetEnvironmentOutputArgs, opts?: InvokeOptions): Output<GetEnvironmentResult>
Copy
def get_environment(environment_name: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetEnvironmentResult
def get_environment_output(environment_name: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetEnvironmentResult]
Copy
func LookupEnvironment(ctx *Context, args *LookupEnvironmentArgs, opts ...InvokeOption) (*LookupEnvironmentResult, error)
func LookupEnvironmentOutput(ctx *Context, args *LookupEnvironmentOutputArgs, opts ...InvokeOption) LookupEnvironmentResultOutput
Copy

> Note: This function is named LookupEnvironment in the Go SDK.

public static class GetEnvironment 
{
    public static Task<GetEnvironmentResult> InvokeAsync(GetEnvironmentArgs args, InvokeOptions? opts = null)
    public static Output<GetEnvironmentResult> Invoke(GetEnvironmentInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetEnvironmentResult> getEnvironment(GetEnvironmentArgs args, InvokeOptions options)
public static Output<GetEnvironmentResult> getEnvironment(GetEnvironmentArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:elasticbeanstalk:getEnvironment
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

EnvironmentName This property is required. string
A unique name for the environment.
EnvironmentName This property is required. string
A unique name for the environment.
environmentName This property is required. String
A unique name for the environment.
environmentName This property is required. string
A unique name for the environment.
environment_name This property is required. str
A unique name for the environment.
environmentName This property is required. String
A unique name for the environment.

getEnvironment Result

The following output properties are available:

Description string
Your description for this environment.
EndpointUrl string

For load-balanced, autoscaling environments, the URL to the load balancer. For single-instance environments, the IP address of the instance.

Example load balancer URL:

Example instance IP address:

192.0.2.0

OperationsRole string
The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role.
PlatformArn string
The Amazon Resource Name (ARN) of the custom platform to use with the environment.
Tags List<Pulumi.AwsNative.Outputs.Tag>
Specifies the tags applied to resources in the environment.
Tier Pulumi.AwsNative.ElasticBeanstalk.Outputs.EnvironmentTier
Specifies the tier to use in creating this environment. The environment tier that you choose determines whether Elastic Beanstalk provisions resources to support a web application that handles HTTP(S) requests or a web application that handles background-processing tasks.
VersionLabel string
The name of the application version to deploy.
Description string
Your description for this environment.
EndpointUrl string

For load-balanced, autoscaling environments, the URL to the load balancer. For single-instance environments, the IP address of the instance.

Example load balancer URL:

Example instance IP address:

192.0.2.0

OperationsRole string
The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role.
PlatformArn string
The Amazon Resource Name (ARN) of the custom platform to use with the environment.
Tags Tag
Specifies the tags applied to resources in the environment.
Tier EnvironmentTier
Specifies the tier to use in creating this environment. The environment tier that you choose determines whether Elastic Beanstalk provisions resources to support a web application that handles HTTP(S) requests or a web application that handles background-processing tasks.
VersionLabel string
The name of the application version to deploy.
description String
Your description for this environment.
endpointUrl String

For load-balanced, autoscaling environments, the URL to the load balancer. For single-instance environments, the IP address of the instance.

Example load balancer URL:

Example instance IP address:

192.0.2.0

operationsRole String
The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role.
platformArn String
The Amazon Resource Name (ARN) of the custom platform to use with the environment.
tags List<Tag>
Specifies the tags applied to resources in the environment.
tier EnvironmentTier
Specifies the tier to use in creating this environment. The environment tier that you choose determines whether Elastic Beanstalk provisions resources to support a web application that handles HTTP(S) requests or a web application that handles background-processing tasks.
versionLabel String
The name of the application version to deploy.
description string
Your description for this environment.
endpointUrl string

For load-balanced, autoscaling environments, the URL to the load balancer. For single-instance environments, the IP address of the instance.

Example load balancer URL:

Example instance IP address:

192.0.2.0

operationsRole string
The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role.
platformArn string
The Amazon Resource Name (ARN) of the custom platform to use with the environment.
tags Tag[]
Specifies the tags applied to resources in the environment.
tier EnvironmentTier
Specifies the tier to use in creating this environment. The environment tier that you choose determines whether Elastic Beanstalk provisions resources to support a web application that handles HTTP(S) requests or a web application that handles background-processing tasks.
versionLabel string
The name of the application version to deploy.
description str
Your description for this environment.
endpoint_url str

For load-balanced, autoscaling environments, the URL to the load balancer. For single-instance environments, the IP address of the instance.

Example load balancer URL:

Example instance IP address:

192.0.2.0

operations_role str
The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role.
platform_arn str
The Amazon Resource Name (ARN) of the custom platform to use with the environment.
tags Sequence[root_Tag]
Specifies the tags applied to resources in the environment.
tier EnvironmentTier
Specifies the tier to use in creating this environment. The environment tier that you choose determines whether Elastic Beanstalk provisions resources to support a web application that handles HTTP(S) requests or a web application that handles background-processing tasks.
version_label str
The name of the application version to deploy.
description String
Your description for this environment.
endpointUrl String

For load-balanced, autoscaling environments, the URL to the load balancer. For single-instance environments, the IP address of the instance.

Example load balancer URL:

Example instance IP address:

192.0.2.0

operationsRole String
The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role.
platformArn String
The Amazon Resource Name (ARN) of the custom platform to use with the environment.
tags List<Property Map>
Specifies the tags applied to resources in the environment.
tier Property Map
Specifies the tier to use in creating this environment. The environment tier that you choose determines whether Elastic Beanstalk provisions resources to support a web application that handles HTTP(S) requests or a web application that handles background-processing tasks.
versionLabel String
The name of the application version to deploy.

Supporting Types

EnvironmentTier

Name Changes to this property will trigger replacement. string
The name of this environment tier.
Type Changes to this property will trigger replacement. string
The type of this environment tier.
Version string
The version of this environment tier. When you don't set a value to it, Elastic Beanstalk uses the latest compatible worker tier version.
Name Changes to this property will trigger replacement. string
The name of this environment tier.
Type Changes to this property will trigger replacement. string
The type of this environment tier.
Version string
The version of this environment tier. When you don't set a value to it, Elastic Beanstalk uses the latest compatible worker tier version.
name Changes to this property will trigger replacement. String
The name of this environment tier.
type Changes to this property will trigger replacement. String
The type of this environment tier.
version String
The version of this environment tier. When you don't set a value to it, Elastic Beanstalk uses the latest compatible worker tier version.
name Changes to this property will trigger replacement. string
The name of this environment tier.
type Changes to this property will trigger replacement. string
The type of this environment tier.
version string
The version of this environment tier. When you don't set a value to it, Elastic Beanstalk uses the latest compatible worker tier version.
name Changes to this property will trigger replacement. str
The name of this environment tier.
type Changes to this property will trigger replacement. str
The type of this environment tier.
version str
The version of this environment tier. When you don't set a value to it, Elastic Beanstalk uses the latest compatible worker tier version.
name Changes to this property will trigger replacement. String
The name of this environment tier.
type Changes to this property will trigger replacement. String
The type of this environment tier.
version String
The version of this environment tier. When you don't set a value to it, Elastic Beanstalk uses the latest compatible worker tier version.

Tag

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native