Menu
AWS Elastic Beanstalk
Developer Guide (API Version 2010-12-01)

Tagging Your Elastic Beanstalk Environment's Resources

When you create an Elastic Beanstalk environment, you can specify tags to apply to resources in the environment. Tags can help you identify environments in cost allocation reports, especially if you have many to manage. You can also use tags to manage permissions at the resource level.

Elastic Beanstalk applies three tags by default. elasticbeanstalk:environment-name is the name of the environment. elasticbeanstalk:environment-id is the environment ID. Name is also the name of the environment. Name is used in the EC2 dashboard to identify and sort resources.

You can add an additional 47 tags during environment creation. Specify tags on the Environment Tags page of the create environment wizard:

Constraints

  • Key-value pairs must be separated by commas.

  • Keys and values can contain any alphabetic character in any language, any numeric character, white space, invisible separator, and the following symbols: _ . : / + - @

  • Keys can contain up to 128 characters. Values can contain up to 256 characters.

  • Keys and values are case sensitive.

  • Values cannot match the environment name.

  • Values cannot include either aws: or elasticbeanstalk:.

If you use the EB CLI to create environments, use the --tags option with eb create to add tags:

~/workspace/my-app$ eb create --tags mytag1=value1,mytag2=value2

With the AWS CLI or other API-based clients, use the --tags parameter on the create-environment command:

$ aws elasticbeanstalk create-environment --tags Key=mytag1,Value=value1 Key=mytag2,Value=value2 --application-name my-app --environment-name my-env --cname-prefix my-app --version-label v1 --template-name my-saved-config

Saved configurations include user-defined tags. When you apply a saved configuration that contains tags during environment creation, those tags will be applied to the new environment, as long as you don't specify any new tags. If you add tags to an environment using one of the preceding methods, any tags defined in the saved configuration will be discarded.

You can use cost allocation reports to track your usage of AWS resources. The reports include both tagged and untagged resources, but they aggregate costs according to tags. For information about how cost allocation reports use tags, see Use Cost Allocation Tags for Custom Billing Reports in the AWS Billing and Cost Management User Guide.