Module servicequotas

This page documents the language specification for the aws package. If you're looking for help working with the inputs, outputs, or functions of aws resources in a Pulumi program, please see the resource documentation for examples and API reference.

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-aws repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-aws repo.

Resources

Resource ServiceQuota

class ServiceQuota extends CustomResource

Manages an individual Service Quota.

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,
});

constructor

new ServiceQuota(name: string, args: ServiceQuotaArgs, opts?: pulumi.CustomResourceOptions)

Create a ServiceQuota resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ServiceQuotaState, opts?: pulumi.CustomResourceOptions): ServiceQuota

Get an existing ServiceQuota resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ServiceQuota

Returns true if the given object is an instance of ServiceQuota. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property adjustable

public adjustable: pulumi.Output<boolean>;

Whether the service quota can be increased.

property arn

public arn: pulumi.Output<string>;

Amazon Resource Name (ARN) of the service quota.

property defaultValue

public defaultValue: pulumi.Output<number>;

Default value of the service quota.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property quotaCode

public quotaCode: pulumi.Output<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.

property quotaName

public quotaName: pulumi.Output<string>;

Name of the quota.

property requestId

public requestId: pulumi.Output<string>;

property requestStatus

public requestStatus: pulumi.Output<string>;

property serviceCode

public serviceCode: pulumi.Output<string>;

Code of the service to track. For example: vpc. Available values can be found with the AWS CLI service-quotas list-services command.

property serviceName

public serviceName: pulumi.Output<string>;

Name of the service.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property value

public value: pulumi.Output<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.

Functions

Function getService

getService(args: GetServiceArgs, opts?: pulumi.InvokeOptions): Promise<GetServiceResult>

Retrieve information about a Service Quotas Service.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = pulumi.output(aws.servicequotas.getService({
    serviceName: "Amazon Virtual Private Cloud (Amazon VPC)",
}, { async: true }));

Function getServiceQuota

getServiceQuota(args: GetServiceQuotaArgs, opts?: pulumi.InvokeOptions): Promise<GetServiceQuotaResult>

Retrieve information about a Service Quota.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const byQuotaCode = pulumi.output(aws.servicequotas.getServiceQuota({
    quotaCode: "L-F678F1CE",
    serviceCode: "vpc",
}, { async: true }));
const byQuotaName = pulumi.output(aws.servicequotas.getServiceQuota({
    quotaName: "VPCs per Region",
    serviceCode: "vpc",
}, { async: true }));

Others

interface GetServiceArgs

interface GetServiceArgs

A collection of arguments for invoking getService.

property serviceName

serviceName: string;

Service name to lookup within Service Quotas. Available values can be found with the AWS CLI service-quotas list-services command.

interface GetServiceQuotaArgs

interface GetServiceQuotaArgs

A collection of arguments for invoking getServiceQuota.

property quotaCode

quotaCode?: undefined | string;

Quota code within the service. When configured, the data source directly looks up the service quota. Available values can be found with the AWS CLI service-quotas list-service-quotas command.

property quotaName

quotaName?: undefined | string;

Quota name within the service. When configured, the data source searches through all service quotas to find the matching quota name. Available values can be found with the AWS CLI service-quotas list-service-quotas command.

property serviceCode

serviceCode: string;

Service code for the quota. Available values can be found with the aws.servicequotas.getService data source or AWS CLI service-quotas list-services command.

interface GetServiceQuotaResult

interface GetServiceQuotaResult

A collection of values returned by getServiceQuota.

property adjustable

adjustable: boolean;

Whether the service quota is adjustable.

property arn

arn: string;

Amazon Resource Name (ARN) of the service quota.

property defaultValue

defaultValue: number;

Default value of the service quota.

property globalQuota

globalQuota: boolean;

Whether the service quota is global for the AWS account.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property quotaCode

quotaCode: string;

property quotaName

quotaName: string;

property serviceCode

serviceCode: string;

property serviceName

serviceName: string;

Name of the service.

property value

value: number;

Current value of the service quota.

interface GetServiceResult

interface GetServiceResult

A collection of values returned by getService.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property serviceCode

serviceCode: string;

Code of the service.

property serviceName

serviceName: string;

interface ServiceQuotaArgs

interface ServiceQuotaArgs

The set of arguments for constructing a ServiceQuota resource.

property quotaCode

quotaCode: pulumi.Input<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.

property serviceCode

serviceCode: pulumi.Input<string>;

Code of the service to track. For example: vpc. Available values can be found with the AWS CLI service-quotas list-services command.

property value

value: pulumi.Input<number>;

interface ServiceQuotaState

interface ServiceQuotaState

Input properties used for looking up and filtering ServiceQuota resources.

property adjustable

adjustable?: pulumi.Input<boolean>;

Whether the service quota can be increased.

property arn

arn?: pulumi.Input<string>;

Amazon Resource Name (ARN) of the service quota.

property defaultValue

defaultValue?: pulumi.Input<number>;

Default value of the service quota.

property quotaCode

quotaCode?: pulumi.Input<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.