Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi
oci.ApiGateway.getUsagePlan
Explore with Pulumi AI
Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi
This data source provides details about a specific Usage Plan resource in Oracle Cloud Infrastructure API Gateway service.
Gets a usage plan by identifier.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testUsagePlan = oci.ApiGateway.getUsagePlan({
usagePlanId: testUsagePlanOciApigatewayUsagePlan.id,
});
import pulumi
import pulumi_oci as oci
test_usage_plan = oci.ApiGateway.get_usage_plan(usage_plan_id=test_usage_plan_oci_apigateway_usage_plan["id"])
package main
import (
"github.com/pulumi/pulumi-oci/sdk/go/oci/ApiGateway"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := ApiGateway.GetUsagePlan(ctx, &apigateway.GetUsagePlanArgs{
UsagePlanId: testUsagePlanOciApigatewayUsagePlan.Id,
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;
return await Deployment.RunAsync(() =>
{
var testUsagePlan = Oci.ApiGateway.GetUsagePlan.Invoke(new()
{
UsagePlanId = testUsagePlanOciApigatewayUsagePlan.Id,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.ApiGateway.ApiGatewayFunctions;
import com.pulumi.oci.ApiGateway.inputs.GetUsagePlanArgs;
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) {
final var testUsagePlan = ApiGatewayFunctions.getUsagePlan(GetUsagePlanArgs.builder()
.usagePlanId(testUsagePlanOciApigatewayUsagePlan.id())
.build());
}
}
variables:
testUsagePlan:
fn::invoke:
Function: oci:ApiGateway:getUsagePlan
Arguments:
usagePlanId: ${testUsagePlanOciApigatewayUsagePlan.id}
Using getUsagePlan
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getUsagePlan(args: GetUsagePlanArgs, opts?: InvokeOptions): Promise<GetUsagePlanResult>
function getUsagePlanOutput(args: GetUsagePlanOutputArgs, opts?: InvokeOptions): Output<GetUsagePlanResult>
def get_usage_plan(usage_plan_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetUsagePlanResult
def get_usage_plan_output(usage_plan_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetUsagePlanResult]
func GetUsagePlan(ctx *Context, args *GetUsagePlanArgs, opts ...InvokeOption) (*GetUsagePlanResult, error)
func GetUsagePlanOutput(ctx *Context, args *GetUsagePlanOutputArgs, opts ...InvokeOption) GetUsagePlanResultOutput
> Note: This function is named GetUsagePlan
in the Go SDK.
public static class GetUsagePlan
{
public static Task<GetUsagePlanResult> InvokeAsync(GetUsagePlanArgs args, InvokeOptions? opts = null)
public static Output<GetUsagePlanResult> Invoke(GetUsagePlanInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetUsagePlanResult> getUsagePlan(GetUsagePlanArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: oci:ApiGateway/getUsagePlan:getUsagePlan
arguments:
# arguments dictionary
The following arguments are supported:
- Usage
Plan stringId - The ocid of the usage plan.
- Usage
Plan stringId - The ocid of the usage plan.
- usage
Plan StringId - The ocid of the usage plan.
- usage
Plan stringId - The ocid of the usage plan.
- usage_
plan_ strid - The ocid of the usage plan.
- usage
Plan StringId - The ocid of the usage plan.
getUsagePlan Result
The following output properties are available:
- Compartment
Id string - The OCID of the compartment in which the resource is created.
- Dictionary<string, object>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- Display
Name string - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example:
My new resource
- Entitlements
List<Get
Usage Plan Entitlement> - A collection of entitlements currently assigned to the usage plan.
- Dictionary<string, object>
- 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. Example:
{"Department": "Finance"}
- Id string
- The OCID of a usage plan resource.
- Lifecycle
Details string - 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.
- State string
- The current state of the usage plan.
- Time
Created string - The time this resource was created. An RFC3339 formatted datetime string.
- Time
Updated string - The time this resource was last updated. An RFC3339 formatted datetime string.
- Usage
Plan stringId
- Compartment
Id string - The OCID of the compartment in which the resource is created.
- map[string]interface{}
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- Display
Name string - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example:
My new resource
- Entitlements
[]Get
Usage Plan Entitlement - A collection of entitlements currently assigned to the usage plan.
- map[string]interface{}
- 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. Example:
{"Department": "Finance"}
- Id string
- The OCID of a usage plan resource.
- Lifecycle
Details string - 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.
- State string
- The current state of the usage plan.
- Time
Created string - The time this resource was created. An RFC3339 formatted datetime string.
- Time
Updated string - The time this resource was last updated. An RFC3339 formatted datetime string.
- Usage
Plan stringId
- compartment
Id String - The OCID of the compartment in which the resource is created.
- Map<String,Object>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- display
Name String - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example:
My new resource
- entitlements
List<Get
Usage Plan Entitlement> - A collection of entitlements currently assigned to the usage plan.
- Map<String,Object>
- 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. Example:
{"Department": "Finance"}
- id String
- The OCID of a usage plan resource.
- lifecycle
Details String - 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.
- state String
- The current state of the usage plan.
- time
Created String - The time this resource was created. An RFC3339 formatted datetime string.
- time
Updated String - The time this resource was last updated. An RFC3339 formatted datetime string.
- usage
Plan StringId
- compartment
Id string - The OCID of the compartment in which the resource is created.
- {[key: string]: any}
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- display
Name string - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example:
My new resource
- entitlements
Get
Usage Plan Entitlement[] - A collection of entitlements currently assigned to the usage plan.
- {[key: string]: any}
- 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. Example:
{"Department": "Finance"}
- id string
- The OCID of a usage plan resource.
- lifecycle
Details string - 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.
- state string
- The current state of the usage plan.
- time
Created string - The time this resource was created. An RFC3339 formatted datetime string.
- time
Updated string - The time this resource was last updated. An RFC3339 formatted datetime string.
- usage
Plan stringId
- compartment_
id str - The OCID of the compartment in which the resource is created.
- Mapping[str, Any]
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- display_
name str - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example:
My new resource
- entitlements
Sequence[apigateway.
Get Usage Plan Entitlement] - A collection of entitlements currently assigned to the usage plan.
- Mapping[str, Any]
- 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. Example:
{"Department": "Finance"}
- id str
- The OCID of a usage plan resource.
- lifecycle_
details str - 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.
- state str
- The current state of the usage plan.
- time_
created str - The time this resource was created. An RFC3339 formatted datetime string.
- time_
updated str - The time this resource was last updated. An RFC3339 formatted datetime string.
- usage_
plan_ strid
- compartment
Id String - The OCID of the compartment in which the resource is created.
- Map<Any>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"Operations.CostCenter": "42"}
- display
Name String - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example:
My new resource
- entitlements List<Property Map>
- A collection of entitlements currently assigned to the usage plan.
- Map<Any>
- 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. Example:
{"Department": "Finance"}
- id String
- The OCID of a usage plan resource.
- lifecycle
Details String - 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.
- state String
- The current state of the usage plan.
- time
Created String - The time this resource was created. An RFC3339 formatted datetime string.
- time
Updated String - The time this resource was last updated. An RFC3339 formatted datetime string.
- usage
Plan StringId
Supporting Types
GetUsagePlanEntitlement
- Description string
- A user-friendly description. To provide some insight about the resource. Avoid entering confidential information.
- Name string
- An entitlement name, unique within a usage plan.
- Quotas
List<Get
Usage Plan Entitlement Quota> - Quota policy for a usage plan.
- Rate
Limits List<GetUsage Plan Entitlement Rate Limit> - Rate-limiting policy for a usage plan.
- Targets
List<Get
Usage Plan Entitlement Target> - A collection of targeted deployments that the entitlement will be applied to.
- Description string
- A user-friendly description. To provide some insight about the resource. Avoid entering confidential information.
- Name string
- An entitlement name, unique within a usage plan.
- Quotas
[]Get
Usage Plan Entitlement Quota - Quota policy for a usage plan.
- Rate
Limits []GetUsage Plan Entitlement Rate Limit - Rate-limiting policy for a usage plan.
- Targets
[]Get
Usage Plan Entitlement Target - A collection of targeted deployments that the entitlement will be applied to.
- description String
- A user-friendly description. To provide some insight about the resource. Avoid entering confidential information.
- name String
- An entitlement name, unique within a usage plan.
- quotas
List<Get
Usage Plan Entitlement Quota> - Quota policy for a usage plan.
- rate
Limits List<GetUsage Plan Entitlement Rate Limit> - Rate-limiting policy for a usage plan.
- targets
List<Get
Usage Plan Entitlement Target> - A collection of targeted deployments that the entitlement will be applied to.
- description string
- A user-friendly description. To provide some insight about the resource. Avoid entering confidential information.
- name string
- An entitlement name, unique within a usage plan.
- quotas
Get
Usage Plan Entitlement Quota[] - Quota policy for a usage plan.
- rate
Limits GetUsage Plan Entitlement Rate Limit[] - Rate-limiting policy for a usage plan.
- targets
Get
Usage Plan Entitlement Target[] - A collection of targeted deployments that the entitlement will be applied to.
- description str
- A user-friendly description. To provide some insight about the resource. Avoid entering confidential information.
- name str
- An entitlement name, unique within a usage plan.
- quotas
Sequence[apigateway.
Get Usage Plan Entitlement Quota] - Quota policy for a usage plan.
- rate_
limits Sequence[apigateway.Get Usage Plan Entitlement Rate Limit] - Rate-limiting policy for a usage plan.
- targets
Sequence[apigateway.
Get Usage Plan Entitlement Target] - A collection of targeted deployments that the entitlement will be applied to.
- description String
- A user-friendly description. To provide some insight about the resource. Avoid entering confidential information.
- name String
- An entitlement name, unique within a usage plan.
- quotas List<Property Map>
- Quota policy for a usage plan.
- rate
Limits List<Property Map> - Rate-limiting policy for a usage plan.
- targets List<Property Map>
- A collection of targeted deployments that the entitlement will be applied to.
GetUsagePlanEntitlementQuota
- Operation
On stringBreach - What the usage plan will do when a quota is breached:
REJECT
will allow no further requestsALLOW
will continue to allow further requests - Reset
Policy string - The policy that controls when quotas will reset. Example:
CALENDAR
- Unit string
- The unit of time over which rate limits are calculated. Example:
SECOND
- Value int
- The number of requests that can be made per time period.
- Operation
On stringBreach - What the usage plan will do when a quota is breached:
REJECT
will allow no further requestsALLOW
will continue to allow further requests - Reset
Policy string - The policy that controls when quotas will reset. Example:
CALENDAR
- Unit string
- The unit of time over which rate limits are calculated. Example:
SECOND
- Value int
- The number of requests that can be made per time period.
- operation
On StringBreach - What the usage plan will do when a quota is breached:
REJECT
will allow no further requestsALLOW
will continue to allow further requests - reset
Policy String - The policy that controls when quotas will reset. Example:
CALENDAR
- unit String
- The unit of time over which rate limits are calculated. Example:
SECOND
- value Integer
- The number of requests that can be made per time period.
- operation
On stringBreach - What the usage plan will do when a quota is breached:
REJECT
will allow no further requestsALLOW
will continue to allow further requests - reset
Policy string - The policy that controls when quotas will reset. Example:
CALENDAR
- unit string
- The unit of time over which rate limits are calculated. Example:
SECOND
- value number
- The number of requests that can be made per time period.
- operation_
on_ strbreach - What the usage plan will do when a quota is breached:
REJECT
will allow no further requestsALLOW
will continue to allow further requests - reset_
policy str - The policy that controls when quotas will reset. Example:
CALENDAR
- unit str
- The unit of time over which rate limits are calculated. Example:
SECOND
- value int
- The number of requests that can be made per time period.
- operation
On StringBreach - What the usage plan will do when a quota is breached:
REJECT
will allow no further requestsALLOW
will continue to allow further requests - reset
Policy String - The policy that controls when quotas will reset. Example:
CALENDAR
- unit String
- The unit of time over which rate limits are calculated. Example:
SECOND
- value Number
- The number of requests that can be made per time period.
GetUsagePlanEntitlementRateLimit
GetUsagePlanEntitlementTarget
- Deployment
Id string - The OCID of a deployment resource.
- Deployment
Id string - The OCID of a deployment resource.
- deployment
Id String - The OCID of a deployment resource.
- deployment
Id string - The OCID of a deployment resource.
- deployment_
id str - The OCID of a deployment resource.
- deployment
Id String - The OCID of a deployment resource.
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
oci
Terraform Provider.
Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi