We recommend new projects start with resources from the AWS provider.
aws-native.elasticbeanstalk.Environment
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
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 string
- The unique name of the resource.
- args EnvironmentArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args EnvironmentArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args EnvironmentArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args EnvironmentArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args EnvironmentArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Environment Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Environment resource accepts the following input properties:
- Application
Name string - The name of the application that is associated with this environment.
- Cname
Prefix 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.
- Environment
Name string - A unique name for the environment.
- Operations
Role string - The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role.
- Option
Settings List<Pulumi.Aws Native. Elastic Beanstalk. Inputs. Environment Option Setting> - Key-value pairs defining configuration options for this environment, such as the instance type.
- Platform
Arn string - The Amazon Resource Name (ARN) of the custom platform to use with the environment.
- Solution
Stack stringName - The name of an Elastic Beanstalk solution stack (platform version) to use with the environment.
- List<Pulumi.
Aws Native. Inputs. Tag> - Specifies the tags applied to resources in the environment.
- Template
Name string - The name of the Elastic Beanstalk configuration template to use with the environment.
- Tier
Pulumi.
Aws Native. Elastic Beanstalk. Inputs. Environment Tier - 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 string - The name of the application version to deploy.
- Application
Name string - The name of the application that is associated with this environment.
- Cname
Prefix 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.
- Environment
Name string - A unique name for the environment.
- Operations
Role string - The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role.
- Option
Settings []EnvironmentOption Setting Args - Key-value pairs defining configuration options for this environment, such as the instance type.
- Platform
Arn string - The Amazon Resource Name (ARN) of the custom platform to use with the environment.
- Solution
Stack stringName - The name of an Elastic Beanstalk solution stack (platform version) to use with the environment.
- Tag
Args - Specifies the tags applied to resources in the environment.
- Template
Name string - The name of the Elastic Beanstalk configuration template to use with the environment.
- Tier
Environment
Tier Args - 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 string - The name of the application version to deploy.
- application
Name String - The name of the application that is associated with this environment.
- cname
Prefix 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.
- environment
Name String - A unique name for the environment.
- operations
Role String - The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role.
- option
Settings List<EnvironmentOption Setting> - Key-value pairs defining configuration options for this environment, such as the instance type.
- platform
Arn String - The Amazon Resource Name (ARN) of the custom platform to use with the environment.
- solution
Stack StringName - The name of an Elastic Beanstalk solution stack (platform version) to use with the environment.
- List<Tag>
- Specifies the tags applied to resources in the environment.
- template
Name String - The name of the Elastic Beanstalk configuration template to use with the environment.
- tier
Environment
Tier - 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 String - The name of the application version to deploy.
- application
Name string - The name of the application that is associated with this environment.
- cname
Prefix 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.
- environment
Name string - A unique name for the environment.
- operations
Role string - The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role.
- option
Settings EnvironmentOption Setting[] - Key-value pairs defining configuration options for this environment, such as the instance type.
- platform
Arn string - The Amazon Resource Name (ARN) of the custom platform to use with the environment.
- solution
Stack stringName - The name of an Elastic Beanstalk solution stack (platform version) to use with the environment.
- Tag[]
- Specifies the tags applied to resources in the environment.
- template
Name string - The name of the Elastic Beanstalk configuration template to use with the environment.
- tier
Environment
Tier - 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 string - The name of the application version to deploy.
- application_
name 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[EnvironmentOption Setting Args] - 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_ strname - The name of an Elastic Beanstalk solution stack (platform version) to use with the environment.
- Sequence[Tag
Args] - 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
Environment
Tier Args - 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.
- application
Name String - The name of the application that is associated with this environment.
- cname
Prefix 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.
- environment
Name String - A unique name for the environment.
- operations
Role String - The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role.
- option
Settings List<Property Map> - Key-value pairs defining configuration options for this environment, such as the instance type.
- platform
Arn String - The Amazon Resource Name (ARN) of the custom platform to use with the environment.
- solution
Stack StringName - The name of an Elastic Beanstalk solution stack (platform version) to use with the environment.
- List<Property Map>
- Specifies the tags applied to resources in the environment.
- template
Name 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.
- version
Label 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:
- Endpoint
Url 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 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 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 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.
- endpoint
Url 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 string
- A unique namespace that identifies the option's associated AWS resource.
- Option
Name string - The name of the configuration option.
- Resource
Name 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 string
- A unique namespace that identifies the option's associated AWS resource.
- Option
Name string - The name of the configuration option.
- Resource
Name 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 String
- A unique namespace that identifies the option's associated AWS resource.
- option
Name String - The name of the configuration option.
- resource
Name 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 string
- A unique namespace that identifies the option's associated AWS resource.
- option
Name string - The name of the configuration option.
- resource
Name 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 str
- A unique namespace that identifies the option's associated AWS resource.
- option_
name 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 String
- A unique namespace that identifies the option's associated AWS resource.
- option
Name String - The name of the configuration option.
- resource
Name 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
Tag, TagArgs
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.