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

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

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.elasticbeanstalk.Environment

Explore with Pulumi AI

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

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

Resource Type definition for AWS::ElasticBeanstalk::Environment

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_name: Optional[str] = None,
                cname_prefix: Optional[str] = None,
                description: Optional[str] = None,
                environment_name: Optional[str] = None,
                operations_role: Optional[str] = None,
                option_settings: Optional[Sequence[EnvironmentOptionSettingArgs]] = None,
                platform_arn: Optional[str] = None,
                solution_stack_name: Optional[str] = None,
                tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
                template_name: Optional[str] = None,
                tier: Optional[EnvironmentTierArgs] = None,
                version_label: 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-native:elasticbeanstalk:Environment
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. EnvironmentArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. EnvironmentArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. EnvironmentArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. 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

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Environment resource accepts the following input properties:

ApplicationName This property is required. string
The name of the application that is associated with this environment.
CnamePrefix string
If specified, the environment attempts to use this value as the prefix for the CNAME in your Elastic Beanstalk environment URL. If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name.
Description string
Your description for this environment.
EnvironmentName string
A unique name for the environment.
OperationsRole string
The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role.
OptionSettings List<Pulumi.AwsNative.ElasticBeanstalk.Inputs.EnvironmentOptionSetting>
Key-value pairs defining configuration options for this environment, such as the instance type.
PlatformArn string
The Amazon Resource Name (ARN) of the custom platform to use with the environment.
SolutionStackName string
The name of an Elastic Beanstalk solution stack (platform version) to use with the environment.
Tags List<Pulumi.AwsNative.Inputs.Tag>
Specifies the tags applied to resources in the environment.
TemplateName string
The name of the Elastic Beanstalk configuration template to use with the environment.
Tier Pulumi.AwsNative.ElasticBeanstalk.Inputs.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.
ApplicationName This property is required. string
The name of the application that is associated with this environment.
CnamePrefix string
If specified, the environment attempts to use this value as the prefix for the CNAME in your Elastic Beanstalk environment URL. If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name.
Description string
Your description for this environment.
EnvironmentName string
A unique name for the environment.
OperationsRole string
The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role.
OptionSettings []EnvironmentOptionSettingArgs
Key-value pairs defining configuration options for this environment, such as the instance type.
PlatformArn string
The Amazon Resource Name (ARN) of the custom platform to use with the environment.
SolutionStackName string
The name of an Elastic Beanstalk solution stack (platform version) to use with the environment.
Tags TagArgs
Specifies the tags applied to resources in the environment.
TemplateName string
The name of the Elastic Beanstalk configuration template to use with the environment.
Tier EnvironmentTierArgs
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.
applicationName This property is required. String
The name of the application that is associated with this environment.
cnamePrefix String
If specified, the environment attempts to use this value as the prefix for the CNAME in your Elastic Beanstalk environment URL. If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name.
description String
Your description for this environment.
environmentName String
A unique name for the environment.
operationsRole String
The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role.
optionSettings List<EnvironmentOptionSetting>
Key-value pairs defining configuration options for this environment, such as the instance type.
platformArn String
The Amazon Resource Name (ARN) of the custom platform to use with the environment.
solutionStackName String
The name of an Elastic Beanstalk solution stack (platform version) to use with the environment.
tags List<Tag>
Specifies the tags applied to resources in the environment.
templateName String
The name of the Elastic Beanstalk configuration template to use with 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.
applicationName This property is required. string
The name of the application that is associated with this environment.
cnamePrefix string
If specified, the environment attempts to use this value as the prefix for the CNAME in your Elastic Beanstalk environment URL. If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name.
description string
Your description for this environment.
environmentName string
A unique name for the environment.
operationsRole string
The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role.
optionSettings EnvironmentOptionSetting[]
Key-value pairs defining configuration options for this environment, such as the instance type.
platformArn string
The Amazon Resource Name (ARN) of the custom platform to use with the environment.
solutionStackName string
The name of an Elastic Beanstalk solution stack (platform version) to use with the environment.
tags Tag[]
Specifies the tags applied to resources in the environment.
templateName string
The name of the Elastic Beanstalk configuration template to use with 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.
application_name This property is required. str
The name of the application that is associated with this environment.
cname_prefix str
If specified, the environment attempts to use this value as the prefix for the CNAME in your Elastic Beanstalk environment URL. If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name.
description str
Your description for this environment.
environment_name str
A unique name for the environment.
operations_role str
The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role.
option_settings Sequence[EnvironmentOptionSettingArgs]
Key-value pairs defining configuration options for this environment, such as the instance type.
platform_arn str
The Amazon Resource Name (ARN) of the custom platform to use with the environment.
solution_stack_name str
The name of an Elastic Beanstalk solution stack (platform version) to use with the environment.
tags Sequence[TagArgs]
Specifies the tags applied to resources in the environment.
template_name str
The name of the Elastic Beanstalk configuration template to use with the environment.
tier EnvironmentTierArgs
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.
applicationName This property is required. String
The name of the application that is associated with this environment.
cnamePrefix String
If specified, the environment attempts to use this value as the prefix for the CNAME in your Elastic Beanstalk environment URL. If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name.
description String
Your description for this environment.
environmentName String
A unique name for the environment.
operationsRole String
The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role.
optionSettings List<Property Map>
Key-value pairs defining configuration options for this environment, such as the instance type.
platformArn String
The Amazon Resource Name (ARN) of the custom platform to use with the environment.
solutionStackName String
The name of an Elastic Beanstalk solution stack (platform version) to use with the environment.
tags List<Property Map>
Specifies the tags applied to resources in the environment.
templateName String
The name of the Elastic Beanstalk configuration template to use with 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.

Outputs

All input properties are implicitly available as output properties. Additionally, the Environment resource produces the following output properties:

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

Id string
The provider-assigned unique ID for this managed resource.
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

Id string
The provider-assigned unique ID for this managed resource.
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

id String
The provider-assigned unique ID for this managed resource.
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

id string
The provider-assigned unique ID for this managed resource.
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

id str
The provider-assigned unique ID for this managed resource.
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

id String
The provider-assigned unique ID for this managed resource.

Supporting Types

EnvironmentOptionSetting
, EnvironmentOptionSettingArgs

Namespace This property is required. string
A unique namespace that identifies the option's associated AWS resource.
OptionName This property is required. string
The name of the configuration option.
ResourceName string
A unique resource name for the option setting. Use it for a time–based scaling configuration option.
Value string
The current value for the configuration option.
Namespace This property is required. string
A unique namespace that identifies the option's associated AWS resource.
OptionName This property is required. string
The name of the configuration option.
ResourceName string
A unique resource name for the option setting. Use it for a time–based scaling configuration option.
Value string
The current value for the configuration option.
namespace This property is required. String
A unique namespace that identifies the option's associated AWS resource.
optionName This property is required. String
The name of the configuration option.
resourceName String
A unique resource name for the option setting. Use it for a time–based scaling configuration option.
value String
The current value for the configuration option.
namespace This property is required. string
A unique namespace that identifies the option's associated AWS resource.
optionName This property is required. string
The name of the configuration option.
resourceName string
A unique resource name for the option setting. Use it for a time–based scaling configuration option.
value string
The current value for the configuration option.
namespace This property is required. str
A unique namespace that identifies the option's associated AWS resource.
option_name This property is required. str
The name of the configuration option.
resource_name str
A unique resource name for the option setting. Use it for a time–based scaling configuration option.
value str
The current value for the configuration option.
namespace This property is required. String
A unique namespace that identifies the option's associated AWS resource.
optionName This property is required. String
The name of the configuration option.
resourceName String
A unique resource name for the option setting. Use it for a time–based scaling configuration option.
value String
The current value for the configuration option.

EnvironmentTier
, EnvironmentTierArgs

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
, TagArgs

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.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native