| « PreviousNext » | |
   | Did this page help you? Yes | No | Tell us about it... |
AWS::ElasticBeanstalk::Environment
Creates or updates an AWS Elastic Beanstalk environment.
Syntax
{
"Type" : "AWS::ElasticBeanstalk::Environment",
"Properties" : {
"ApplicationName" : String,
"CNAMEPrefix" : String,
"Description" : String,
"OptionSettings" : [ OptionSettings, ... ],
"OptionsToRemove" : [ OptionSettings, ... ],
"SolutionStackName" : String,
"TemplateName" : String,
"VersionLabel" : String
}
}
Properties
- ApplicationName
The name of the application associated with this environment.
Required: Yes.
Type: String.
- CNAMEPrefix
The URL to the CNAME for this environment.
Required: No.
Type: String.
- Description
Required: No.
Type: String.
- OptionSettings
The option settings to add.
Required: No.
Type: A list of OptionSettings.
- OptionsToRemove
The option settings to remove.
Required: No.
Type: A list of OptionSettings.
- SolutionStackName
The stack name associated with the environment.
Required: No.
Type: String.
- TemplateName
The name of the template to use with the environment.
Required: No.
Type: String.
- VersionLabel
The version to associate with the environment.
Required: No.
Type: String.
Return Values
Ref
When the logical ID of this resource is provided to the Ref intrinsic
function, it returns the resource name.
For more information about using the Ref function, see Ref.
Fn::GetAtt
Fn::GetAtt returns a value for a specified attribute of this type.
This section lists the available attributes and corresponding return values.
- EndpointURL
The URL to the load balancer for this environment.
Example:
awseb-myst-myen-132MQC4KRLAMD-1371280482.us-east-1.elb.amazonaws.com
For more information about using Fn:GetAtt, see Fn::GetAtt.
Examples
Simple environment
{
"Type" : "AWS::ElasticBeanstalk::Environment",
"Properties" : {
"ApplicationName" : { "Ref" : "sampleApplication" },
"Description" : "AWS Elastic Beanstalk Environment running PHP Sample Application",
"TemplateName" : "DefaultConfiguration",
"VersionLabel" : "Initial Version"
}
} Environment with embedded option settings
{
"Type" : "AWS::ElasticBeanstalk::Environment",
"Properties" : {
"ApplicationName" : { "Ref" : "sampleApplication" },
"Description" : "AWS Elastic Beanstalk Environment running Python Sample Application",
"SolutionStackName" : "64bit Amazon Linux running Python",
"OptionSettings" : [ {
"Namespace" : "aws:autoscaling:launchconfiguration",
"OptionName" : "EC2KeyName",
"Value" : { "Ref" : "KeyName" }
} ],
"VersionLabel" : "Initial Version"
}
} See Also
Launching New Environments in the AWS Elastic Beanstalk Developer Guide
Managing Environments in the AWS Elastic Beanstalk Developer Guide
