This component is responsible for requesting service quota increases. We recommend
making requests here rather than in
is a restricted component that can only be applied by SuperAdmin.
Stack Level: Global and Regional (depending on quota)
Global resources must be provisioned in
us-east-1. Put them in the
gbl stack, but set
region: us-east-1 in the
You can refer to services either by their exact full name (e.g.
service_name: "Amazon Elastic Compute Cloud (Amazon EC2)") or by the
service code (e.g.
service_code: "ec2"). Similarly, you can refer to quota names either by their exact full name
quota_name: "EC2-VPC Elastic IPs") or by the quota code (e.g.
You can find service codes and full names via the AWS CLI (be sure to use the correct region):
aws --region us-east-1 service-quotas list-services
You can find quota codes and full names, and also whether the quotas are adjustable or global, via the AWS CLI, but you will need the service code from the previous step:
aws --region us-east-1 service-quotas list-service-quotas --service-code ec2
If you make a request to raise a quota, the output will show the requested value as
value while the request is pending.
Even though the Terraform will submit the support request, you may need to follow up with AWS support to get the request approved, via the AWS console or email.
Here's an example snippet for how to use this component.
quota_name: "VPCs per Region"
quota_name: "EC2-VPC Elastic IPs"
|additional_tag_map||Additional key-value pairs to add to each map in |
This is for some rare cases where resources want additional configuration of tags
and therefore take a list of maps with tag key, value, and additional configuration.
|attributes||ID element. Additional attributes (e.g. |
in the order they appear in the list. New attributes are appended to the
end of the list. The elements of the list are joined by the
and treated as a single ID element.
|context||Single object for setting entire context at once.|
See description of individual variables for details.
Leave string and numeric variables as
Individual variable settings (non-null) override settings in context object,
except for attributes, tags, and additional_tag_map, which are merged.
|delimiter||Delimiter to be used between ID elements.|
|descriptor_formats||Describe additional descriptors to be output in the |
Map of maps. Keys are names of descriptors. Values are maps of the form
Label values will be normalized before being passed to
identical to how they appear in
|enabled||Set to false to prevent the module from creating any resources||no|
|environment||ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'||no|
Does not affect
|import_profile_name||AWS Profile name to use when importing a resource||no|
|import_role_arn||IAM Role ARN to use when importing a resource||no|
|label_key_case||Controls the letter case of the |
Does not affect keys of tags passed in via the
|label_order||The order in which the labels (ID elements) appear in the |
Defaults to ["namespace", "environment", "stage", "name", "attributes"].
You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.
|label_value_case||Controls the letter case of ID elements (labels) as included in |
set as tag values, and output by this module individually.
Does not affect values of tags passed in via the
Set this to
|labels_as_tags||Set of labels (ID elements) to include as tags in the |
Default is to include all labels.
Tags with empty values will not be included in the
The value of the
changed in later chained modules. Attempts to change it will be silently ignored.
|name||ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.|
This is the only ID element not also included as a
The "name" tag is set to the full
|namespace||ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique||no|
|quotas||Map of quotas to set. Map keys are arbitrary and are used to allow Atmos to merge configurations.|
Delete an inherited quota by setting its key's value to null.
You only need to provide one of either name or code for each of "service" and "quota".
If you provide both, the code will be used.
|regex_replace_chars||Terraform regular expression (regex) string.|
Characters matching the regex will be removed from the ID elements.
If not set,
|stage||ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'||no|
|tags||Additional tags (e.g. |
Neither the tag keys nor the tag values will be modified by this module.
|tenant||ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for||no|
|quotas||Full report on all service quotas managed by this component.|
- AWS Service Quotas
- AWS CLI command to list service codes:
aws service-quotas list-services