aws.servicequotas.ServiceQuota
Explore with Pulumi AI
Manages an individual Service Quota.
NOTE: Global quotas apply to all AWS regions, but can only be accessed in
us-east-1in the Commercial partition orus-gov-west-1in the GovCloud partition. In other regions, the AWS API will return the errorThe request failed because the specified service does not exist.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.servicequotas.ServiceQuota("example", {
    quotaCode: "L-F678F1CE",
    serviceCode: "vpc",
    value: 75,
});
import pulumi
import pulumi_aws as aws
example = aws.servicequotas.ServiceQuota("example",
    quota_code="L-F678F1CE",
    service_code="vpc",
    value=75)
package main
import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/servicequotas"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := servicequotas.NewServiceQuota(ctx, "example", &servicequotas.ServiceQuotaArgs{
			QuotaCode:   pulumi.String("L-F678F1CE"),
			ServiceCode: pulumi.String("vpc"),
			Value:       pulumi.Float64(75),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() => 
{
    var example = new Aws.ServiceQuotas.ServiceQuota("example", new()
    {
        QuotaCode = "L-F678F1CE",
        ServiceCode = "vpc",
        Value = 75,
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.servicequotas.ServiceQuota;
import com.pulumi.aws.servicequotas.ServiceQuotaArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var example = new ServiceQuota("example", ServiceQuotaArgs.builder()
            .quotaCode("L-F678F1CE")
            .serviceCode("vpc")
            .value(75)
            .build());
    }
}
resources:
  example:
    type: aws:servicequotas:ServiceQuota
    properties:
      quotaCode: L-F678F1CE
      serviceCode: vpc
      value: 75
Create ServiceQuota Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ServiceQuota(name: string, args: ServiceQuotaArgs, opts?: CustomResourceOptions);@overload
def ServiceQuota(resource_name: str,
                 args: ServiceQuotaArgs,
                 opts: Optional[ResourceOptions] = None)
@overload
def ServiceQuota(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 quota_code: Optional[str] = None,
                 service_code: Optional[str] = None,
                 value: Optional[float] = None)func NewServiceQuota(ctx *Context, name string, args ServiceQuotaArgs, opts ...ResourceOption) (*ServiceQuota, error)public ServiceQuota(string name, ServiceQuotaArgs args, CustomResourceOptions? opts = null)
public ServiceQuota(String name, ServiceQuotaArgs args)
public ServiceQuota(String name, ServiceQuotaArgs args, CustomResourceOptions options)
type: aws:servicequotas:ServiceQuota
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 ServiceQuotaArgs
- 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 ServiceQuotaArgs
- 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 ServiceQuotaArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ServiceQuotaArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ServiceQuotaArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var serviceQuotaResource = new Aws.ServiceQuotas.ServiceQuota("serviceQuotaResource", new()
{
    QuotaCode = "string",
    ServiceCode = "string",
    Value = 0,
});
example, err := servicequotas.NewServiceQuota(ctx, "serviceQuotaResource", &servicequotas.ServiceQuotaArgs{
	QuotaCode:   pulumi.String("string"),
	ServiceCode: pulumi.String("string"),
	Value:       pulumi.Float64(0),
})
var serviceQuotaResource = new ServiceQuota("serviceQuotaResource", ServiceQuotaArgs.builder()
    .quotaCode("string")
    .serviceCode("string")
    .value(0)
    .build());
service_quota_resource = aws.servicequotas.ServiceQuota("serviceQuotaResource",
    quota_code="string",
    service_code="string",
    value=0)
const serviceQuotaResource = new aws.servicequotas.ServiceQuota("serviceQuotaResource", {
    quotaCode: "string",
    serviceCode: "string",
    value: 0,
});
type: aws:servicequotas:ServiceQuota
properties:
    quotaCode: string
    serviceCode: string
    value: 0
ServiceQuota 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 ServiceQuota resource accepts the following input properties:
- QuotaCode string
- Code of the service quota to track. For example: L-F678F1CE. Available values can be found with the AWS CLI service-quotas list-service-quotas command.
- ServiceCode string
- Code of the service to track. For example: vpc. Available values can be found with the AWS CLI service-quotas list-services command.
- Value double
- Float specifying the desired value for the service quota. If the desired value is higher than the current value, a quota increase request is submitted. When a known request is submitted and pending, the value reflects the desired value of the pending request.
- QuotaCode string
- Code of the service quota to track. For example: L-F678F1CE. Available values can be found with the AWS CLI service-quotas list-service-quotas command.
- ServiceCode string
- Code of the service to track. For example: vpc. Available values can be found with the AWS CLI service-quotas list-services command.
- Value float64
- Float specifying the desired value for the service quota. If the desired value is higher than the current value, a quota increase request is submitted. When a known request is submitted and pending, the value reflects the desired value of the pending request.
- quotaCode String
- Code of the service quota to track. For example: L-F678F1CE. Available values can be found with the AWS CLI service-quotas list-service-quotas command.
- serviceCode String
- Code of the service to track. For example: vpc. Available values can be found with the AWS CLI service-quotas list-services command.
- value Double
- Float specifying the desired value for the service quota. If the desired value is higher than the current value, a quota increase request is submitted. When a known request is submitted and pending, the value reflects the desired value of the pending request.
- quotaCode string
- Code of the service quota to track. For example: L-F678F1CE. Available values can be found with the AWS CLI service-quotas list-service-quotas command.
- serviceCode string
- Code of the service to track. For example: vpc. Available values can be found with the AWS CLI service-quotas list-services command.
- value number
- Float specifying the desired value for the service quota. If the desired value is higher than the current value, a quota increase request is submitted. When a known request is submitted and pending, the value reflects the desired value of the pending request.
- quota_code str
- Code of the service quota to track. For example: L-F678F1CE. Available values can be found with the AWS CLI service-quotas list-service-quotas command.
- service_code str
- Code of the service to track. For example: vpc. Available values can be found with the AWS CLI service-quotas list-services command.
- value float
- Float specifying the desired value for the service quota. If the desired value is higher than the current value, a quota increase request is submitted. When a known request is submitted and pending, the value reflects the desired value of the pending request.
- quotaCode String
- Code of the service quota to track. For example: L-F678F1CE. Available values can be found with the AWS CLI service-quotas list-service-quotas command.
- serviceCode String
- Code of the service to track. For example: vpc. Available values can be found with the AWS CLI service-quotas list-services command.
- value Number
- Float specifying the desired value for the service quota. If the desired value is higher than the current value, a quota increase request is submitted. When a known request is submitted and pending, the value reflects the desired value of the pending request.
Outputs
All input properties are implicitly available as output properties. Additionally, the ServiceQuota resource produces the following output properties:
- Adjustable bool
- Whether the service quota can be increased.
- Arn string
- Amazon Resource Name (ARN) of the service quota.
- DefaultValue double
- Default value of the service quota.
- Id string
- The provider-assigned unique ID for this managed resource.
- QuotaName string
- Name of the quota.
- RequestId string
- RequestStatus string
- ServiceName string
- Name of the service.
- UsageMetrics List<ServiceQuota Usage Metric> 
- Information about the measurement.
- Adjustable bool
- Whether the service quota can be increased.
- Arn string
- Amazon Resource Name (ARN) of the service quota.
- DefaultValue float64
- Default value of the service quota.
- Id string
- The provider-assigned unique ID for this managed resource.
- QuotaName string
- Name of the quota.
- RequestId string
- RequestStatus string
- ServiceName string
- Name of the service.
- UsageMetrics []ServiceQuota Usage Metric 
- Information about the measurement.
- adjustable Boolean
- Whether the service quota can be increased.
- arn String
- Amazon Resource Name (ARN) of the service quota.
- defaultValue Double
- Default value of the service quota.
- id String
- The provider-assigned unique ID for this managed resource.
- quotaName String
- Name of the quota.
- requestId String
- requestStatus String
- serviceName String
- Name of the service.
- usageMetrics List<ServiceQuota Usage Metric> 
- Information about the measurement.
- adjustable boolean
- Whether the service quota can be increased.
- arn string
- Amazon Resource Name (ARN) of the service quota.
- defaultValue number
- Default value of the service quota.
- id string
- The provider-assigned unique ID for this managed resource.
- quotaName string
- Name of the quota.
- requestId string
- requestStatus string
- serviceName string
- Name of the service.
- usageMetrics ServiceQuota Usage Metric[] 
- Information about the measurement.
- adjustable bool
- Whether the service quota can be increased.
- arn str
- Amazon Resource Name (ARN) of the service quota.
- default_value float
- Default value of the service quota.
- id str
- The provider-assigned unique ID for this managed resource.
- quota_name str
- Name of the quota.
- request_id str
- request_status str
- service_name str
- Name of the service.
- usage_metrics Sequence[ServiceQuota Usage Metric] 
- Information about the measurement.
- adjustable Boolean
- Whether the service quota can be increased.
- arn String
- Amazon Resource Name (ARN) of the service quota.
- defaultValue Number
- Default value of the service quota.
- id String
- The provider-assigned unique ID for this managed resource.
- quotaName String
- Name of the quota.
- requestId String
- requestStatus String
- serviceName String
- Name of the service.
- usageMetrics List<Property Map>
- Information about the measurement.
Look up Existing ServiceQuota Resource
Get an existing ServiceQuota resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: ServiceQuotaState, opts?: CustomResourceOptions): ServiceQuota@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        adjustable: Optional[bool] = None,
        arn: Optional[str] = None,
        default_value: Optional[float] = None,
        quota_code: Optional[str] = None,
        quota_name: Optional[str] = None,
        request_id: Optional[str] = None,
        request_status: Optional[str] = None,
        service_code: Optional[str] = None,
        service_name: Optional[str] = None,
        usage_metrics: Optional[Sequence[ServiceQuotaUsageMetricArgs]] = None,
        value: Optional[float] = None) -> ServiceQuotafunc GetServiceQuota(ctx *Context, name string, id IDInput, state *ServiceQuotaState, opts ...ResourceOption) (*ServiceQuota, error)public static ServiceQuota Get(string name, Input<string> id, ServiceQuotaState? state, CustomResourceOptions? opts = null)public static ServiceQuota get(String name, Output<String> id, ServiceQuotaState state, CustomResourceOptions options)resources:  _:    type: aws:servicequotas:ServiceQuota    get:      id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Adjustable bool
- Whether the service quota can be increased.
- Arn string
- Amazon Resource Name (ARN) of the service quota.
- DefaultValue double
- Default value of the service quota.
- QuotaCode string
- Code of the service quota to track. For example: L-F678F1CE. Available values can be found with the AWS CLI service-quotas list-service-quotas command.
- QuotaName string
- Name of the quota.
- RequestId string
- RequestStatus string
- ServiceCode string
- Code of the service to track. For example: vpc. Available values can be found with the AWS CLI service-quotas list-services command.
- ServiceName string
- Name of the service.
- UsageMetrics List<ServiceQuota Usage Metric> 
- Information about the measurement.
- Value double
- Float specifying the desired value for the service quota. If the desired value is higher than the current value, a quota increase request is submitted. When a known request is submitted and pending, the value reflects the desired value of the pending request.
- Adjustable bool
- Whether the service quota can be increased.
- Arn string
- Amazon Resource Name (ARN) of the service quota.
- DefaultValue float64
- Default value of the service quota.
- QuotaCode string
- Code of the service quota to track. For example: L-F678F1CE. Available values can be found with the AWS CLI service-quotas list-service-quotas command.
- QuotaName string
- Name of the quota.
- RequestId string
- RequestStatus string
- ServiceCode string
- Code of the service to track. For example: vpc. Available values can be found with the AWS CLI service-quotas list-services command.
- ServiceName string
- Name of the service.
- UsageMetrics []ServiceQuota Usage Metric Args 
- Information about the measurement.
- Value float64
- Float specifying the desired value for the service quota. If the desired value is higher than the current value, a quota increase request is submitted. When a known request is submitted and pending, the value reflects the desired value of the pending request.
- adjustable Boolean
- Whether the service quota can be increased.
- arn String
- Amazon Resource Name (ARN) of the service quota.
- defaultValue Double
- Default value of the service quota.
- quotaCode String
- Code of the service quota to track. For example: L-F678F1CE. Available values can be found with the AWS CLI service-quotas list-service-quotas command.
- quotaName String
- Name of the quota.
- requestId String
- requestStatus String
- serviceCode String
- Code of the service to track. For example: vpc. Available values can be found with the AWS CLI service-quotas list-services command.
- serviceName String
- Name of the service.
- usageMetrics List<ServiceQuota Usage Metric> 
- Information about the measurement.
- value Double
- Float specifying the desired value for the service quota. If the desired value is higher than the current value, a quota increase request is submitted. When a known request is submitted and pending, the value reflects the desired value of the pending request.
- adjustable boolean
- Whether the service quota can be increased.
- arn string
- Amazon Resource Name (ARN) of the service quota.
- defaultValue number
- Default value of the service quota.
- quotaCode string
- Code of the service quota to track. For example: L-F678F1CE. Available values can be found with the AWS CLI service-quotas list-service-quotas command.
- quotaName string
- Name of the quota.
- requestId string
- requestStatus string
- serviceCode string
- Code of the service to track. For example: vpc. Available values can be found with the AWS CLI service-quotas list-services command.
- serviceName string
- Name of the service.
- usageMetrics ServiceQuota Usage Metric[] 
- Information about the measurement.
- value number
- Float specifying the desired value for the service quota. If the desired value is higher than the current value, a quota increase request is submitted. When a known request is submitted and pending, the value reflects the desired value of the pending request.
- adjustable bool
- Whether the service quota can be increased.
- arn str
- Amazon Resource Name (ARN) of the service quota.
- default_value float
- Default value of the service quota.
- quota_code str
- Code of the service quota to track. For example: L-F678F1CE. Available values can be found with the AWS CLI service-quotas list-service-quotas command.
- quota_name str
- Name of the quota.
- request_id str
- request_status str
- service_code str
- Code of the service to track. For example: vpc. Available values can be found with the AWS CLI service-quotas list-services command.
- service_name str
- Name of the service.
- usage_metrics Sequence[ServiceQuota Usage Metric Args] 
- Information about the measurement.
- value float
- Float specifying the desired value for the service quota. If the desired value is higher than the current value, a quota increase request is submitted. When a known request is submitted and pending, the value reflects the desired value of the pending request.
- adjustable Boolean
- Whether the service quota can be increased.
- arn String
- Amazon Resource Name (ARN) of the service quota.
- defaultValue Number
- Default value of the service quota.
- quotaCode String
- Code of the service quota to track. For example: L-F678F1CE. Available values can be found with the AWS CLI service-quotas list-service-quotas command.
- quotaName String
- Name of the quota.
- requestId String
- requestStatus String
- serviceCode String
- Code of the service to track. For example: vpc. Available values can be found with the AWS CLI service-quotas list-services command.
- serviceName String
- Name of the service.
- usageMetrics List<Property Map>
- Information about the measurement.
- value Number
- Float specifying the desired value for the service quota. If the desired value is higher than the current value, a quota increase request is submitted. When a known request is submitted and pending, the value reflects the desired value of the pending request.
Supporting Types
ServiceQuotaUsageMetric, ServiceQuotaUsageMetricArgs        
- MetricDimensions List<ServiceQuota Usage Metric Metric Dimension> 
- The metric dimensions.
- MetricName string
- The name of the metric.
- MetricNamespace string
- The namespace of the metric.
- MetricStatistic stringRecommendation 
- The metric statistic that AWS recommend you use when determining quota usage.
- MetricDimensions []ServiceQuota Usage Metric Metric Dimension 
- The metric dimensions.
- MetricName string
- The name of the metric.
- MetricNamespace string
- The namespace of the metric.
- MetricStatistic stringRecommendation 
- The metric statistic that AWS recommend you use when determining quota usage.
- metricDimensions List<ServiceQuota Usage Metric Metric Dimension> 
- The metric dimensions.
- metricName String
- The name of the metric.
- metricNamespace String
- The namespace of the metric.
- metricStatistic StringRecommendation 
- The metric statistic that AWS recommend you use when determining quota usage.
- metricDimensions ServiceQuota Usage Metric Metric Dimension[] 
- The metric dimensions.
- metricName string
- The name of the metric.
- metricNamespace string
- The namespace of the metric.
- metricStatistic stringRecommendation 
- The metric statistic that AWS recommend you use when determining quota usage.
- metric_dimensions Sequence[ServiceQuota Usage Metric Metric Dimension] 
- The metric dimensions.
- metric_name str
- The name of the metric.
- metric_namespace str
- The namespace of the metric.
- metric_statistic_ strrecommendation 
- The metric statistic that AWS recommend you use when determining quota usage.
- metricDimensions List<Property Map>
- The metric dimensions.
- metricName String
- The name of the metric.
- metricNamespace String
- The namespace of the metric.
- metricStatistic StringRecommendation 
- The metric statistic that AWS recommend you use when determining quota usage.
ServiceQuotaUsageMetricMetricDimension, ServiceQuotaUsageMetricMetricDimensionArgs            
Import
Using pulumi import, import aws_servicequotas_service_quota using the service code and quota code, separated by a front slash (/). For example:
~> NOTE: This resource does not require explicit import and will assume management of an existing service quota on Pulumi resource creation.
$ pulumi import aws:servicequotas/serviceQuota:ServiceQuota example vpc/L-F678F1CE
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the awsTerraform Provider.