import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * This resource provides the Usage Plan resource in Oracle Cloud Infrastructure API Gateway service. * Api doc link for the resource: https://docs.oracle.com/iaas/api/#/en/api-gateway/latest/UsagePlan * * Example terraform configs related to the resource : https://github.com/oracle/terraform-provider-oci/tree/master/examples/api_gateway * * Creates a new usage plan. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as oci from "@pulumi/oci"; * * const testUsagePlan = new oci.apigateway.UsagePlan("test_usage_plan", { * compartmentId: compartmentId, * entitlements: [{ * name: usagePlanEntitlementsName, * description: usagePlanEntitlementsDescription, * quota: { * operationOnBreach: usagePlanEntitlementsQuotaOperationOnBreach, * resetPolicy: usagePlanEntitlementsQuotaResetPolicy, * unit: usagePlanEntitlementsQuotaUnit, * value: Number(usagePlanEntitlementsQuotaValue), * }, * rateLimit: { * unit: usagePlanEntitlementsRateLimitUnit, * value: Number(usagePlanEntitlementsRateLimitValue), * }, * targets: [{ * deploymentId: testDeployment.id, * }], * }], * definedTags: { * "Operations.CostCenter": "42", * }, * displayName: usagePlanDisplayName, * freeformTags: { * Department: "Finance", * }, * locks: [{ * type: usagePlanLocksType, * message: usagePlanLocksMessage, * }], * }); * ``` * * ## Import * * UsagePlans can be imported using the `id`, e.g. * * ```sh * $ pulumi import oci:ApiGateway/usagePlan:UsagePlan test_usage_plan "id" * ``` */ export declare class UsagePlan extends pulumi.CustomResource { /** * Get an existing UsagePlan resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: UsagePlanState, opts?: pulumi.CustomResourceOptions): UsagePlan; /** * Returns true if the given object is an instance of UsagePlan. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is UsagePlan; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which the resource is created. */ readonly compartmentId: pulumi.Output; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ readonly definedTags: pulumi.Output<{ [key: string]: string; }>; /** * (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: `My new resource` */ readonly displayName: pulumi.Output; /** * (Updatable) A collection of entitlements to assign to the newly created usage plan. */ readonly entitlements: pulumi.Output; /** * (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ readonly freeformTags: pulumi.Output<{ [key: string]: string; }>; readonly isLockOverride: pulumi.Output; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state. */ readonly lifecycleDetails: pulumi.Output; /** * Locks associated with this resource. */ readonly locks: pulumi.Output; /** * The current state of the usage plan. */ readonly state: pulumi.Output; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ readonly systemTags: pulumi.Output<{ [key: string]: string; }>; /** * The time this resource was created. An RFC3339 formatted datetime string. */ readonly timeCreated: pulumi.Output; /** * The time this resource was last updated. An RFC3339 formatted datetime string. */ readonly timeUpdated: pulumi.Output; /** * Create a UsagePlan resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: UsagePlanArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering UsagePlan resources. */ export interface UsagePlanState { /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which the resource is created. */ compartmentId?: pulumi.Input; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ definedTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: `My new resource` */ displayName?: pulumi.Input; /** * (Updatable) A collection of entitlements to assign to the newly created usage plan. */ entitlements?: pulumi.Input[] | undefined>; /** * (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ freeformTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; isLockOverride?: pulumi.Input; /** * A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state. */ lifecycleDetails?: pulumi.Input; /** * Locks associated with this resource. */ locks?: pulumi.Input[] | undefined>; /** * The current state of the usage plan. */ state?: pulumi.Input; /** * System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ systemTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * The time this resource was created. An RFC3339 formatted datetime string. */ timeCreated?: pulumi.Input; /** * The time this resource was last updated. An RFC3339 formatted datetime string. */ timeUpdated?: pulumi.Input; } /** * The set of arguments for constructing a UsagePlan resource. */ export interface UsagePlanArgs { /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which the resource is created. */ compartmentId: pulumi.Input; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ definedTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: `My new resource` */ displayName?: pulumi.Input; /** * (Updatable) A collection of entitlements to assign to the newly created usage plan. */ entitlements: pulumi.Input[]>; /** * (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ freeformTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; isLockOverride?: pulumi.Input; /** * Locks associated with this resource. */ locks?: pulumi.Input[] | undefined>; } //# sourceMappingURL=usagePlan.d.ts.map