@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
77 lines (76 loc) • 3.08 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Retrieve information about a Service Quotas Service.
*
* > **NOTE:** Global quotas apply to all AWS regions, but can only be accessed in `us-east-1` in the Commercial partition or `us-gov-west-1` in the GovCloud partition. In other regions, the AWS API will return the error `The request failed because the specified service does not exist.`
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = aws.servicequotas.getService({
* serviceName: "Amazon Virtual Private Cloud (Amazon VPC)",
* });
* ```
*/
export declare function getService(args: GetServiceArgs, opts?: pulumi.InvokeOptions): Promise<GetServiceResult>;
/**
* A collection of arguments for invoking getService.
*/
export interface GetServiceArgs {
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: string;
/**
* Service name to lookup within Service Quotas. Available values can be found with the [AWS CLI service-quotas list-services command](https://docs.aws.amazon.com/cli/latest/reference/service-quotas/list-services.html).
*/
serviceName: string;
}
/**
* A collection of values returned by getService.
*/
export interface GetServiceResult {
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
readonly region: string;
/**
* Code of the service.
*/
readonly serviceCode: string;
readonly serviceName: string;
}
/**
* Retrieve information about a Service Quotas Service.
*
* > **NOTE:** Global quotas apply to all AWS regions, but can only be accessed in `us-east-1` in the Commercial partition or `us-gov-west-1` in the GovCloud partition. In other regions, the AWS API will return the error `The request failed because the specified service does not exist.`
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = aws.servicequotas.getService({
* serviceName: "Amazon Virtual Private Cloud (Amazon VPC)",
* });
* ```
*/
export declare function getServiceOutput(args: GetServiceOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetServiceResult>;
/**
* A collection of arguments for invoking getService.
*/
export interface GetServiceOutputArgs {
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
/**
* Service name to lookup within Service Quotas. Available values can be found with the [AWS CLI service-quotas list-services command](https://docs.aws.amazon.com/cli/latest/reference/service-quotas/list-services.html).
*/
serviceName: pulumi.Input<string>;
}