@pulumi/linode
Version:
A Pulumi package for creating and managing linode cloud resources.
95 lines (94 loc) • 3.2 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "./types/output";
/**
* Provides details about Object Storage quota information on your account.
* For more information, see the [Linode APIv4 docs](https://techdocs.akamai.com/linode-api/reference/get-object-storage-quota).
*
* ## Example Usage
*
* The following example shows how one might use this data source to access information about an Object Storage quota.
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as linode from "@pulumi/linode";
*
* const myQuota = linode.getObjectStorageQuota({
* quotaId: "obj-buckets-br-gru-1.linodeobjects.com",
* });
* ```
*/
export declare function getObjectStorageQuota(args: GetObjectStorageQuotaArgs, opts?: pulumi.InvokeOptions): Promise<GetObjectStorageQuotaResult>;
/**
* A collection of arguments for invoking getObjectStorageQuota.
*/
export interface GetObjectStorageQuotaArgs {
/**
* The Object Storage quota ID.
*/
quotaId: string;
}
/**
* A collection of values returned by getObjectStorageQuota.
*/
export interface GetObjectStorageQuotaResult {
/**
* The description of the Object Storage quota.
*/
readonly description: string;
/**
* The type of the S3 endpoint of the Object Storage.
*/
readonly endpointType: string;
/**
* The unique ID of the Object Storage quota data source.
*/
readonly id: string;
readonly quotaId: string;
/**
* The maximum quantity allowed by the quota.
*/
readonly quotaLimit: number;
/**
* The name of the Object Storage quota.
*/
readonly quotaName: string;
/**
* The usage data for a specific Object Storage related quota on your account. For more information, see the [Linode APIv4 docs](https://techdocs.akamai.com/linode-api/reference/get-object-storage-quota-usage).
*/
readonly quotaUsage: outputs.GetObjectStorageQuotaQuotaUsage;
/**
* The specific Object Storage resource for the quota.
*/
readonly resourceMetric: string;
/**
* The S3 endpoint URL of the Object Storage, based on the `endpointType` and `region`.
*/
readonly s3Endpoint: string;
}
/**
* Provides details about Object Storage quota information on your account.
* For more information, see the [Linode APIv4 docs](https://techdocs.akamai.com/linode-api/reference/get-object-storage-quota).
*
* ## Example Usage
*
* The following example shows how one might use this data source to access information about an Object Storage quota.
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as linode from "@pulumi/linode";
*
* const myQuota = linode.getObjectStorageQuota({
* quotaId: "obj-buckets-br-gru-1.linodeobjects.com",
* });
* ```
*/
export declare function getObjectStorageQuotaOutput(args: GetObjectStorageQuotaOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetObjectStorageQuotaResult>;
/**
* A collection of arguments for invoking getObjectStorageQuota.
*/
export interface GetObjectStorageQuotaOutputArgs {
/**
* The Object Storage quota ID.
*/
quotaId: pulumi.Input<string>;
}