Oracle Cloud Infrastructure

Pulumi Official
Package maintained by Pulumi
v0.1.1 published on Tuesday, May 3, 2022 by Pulumi

getLimitDefinitions

This data source provides the list of Limit Definitions in Oracle Cloud Infrastructure Limits service.

Includes a list of resource limits that are currently supported. If the ‘areQuotasSupported’ property is true, you can create quota policies on top of this limit at the compartment level.

Example Usage

using Pulumi;
using Oci = Pulumi.Oci;

class MyStack : Stack
{
    public MyStack()
    {
        var testLimitDefinitions = Output.Create(Oci.Limits.GetLimitDefinitions.InvokeAsync(new Oci.Limits.GetLimitDefinitionsArgs
        {
            CompartmentId = @var.Tenancy_ocid,
            Name = @var.Limit_definition_name,
            ServiceName = oci_limits_service.Test_service.Name,
        }));
    }

}
package main

import (
	"github.com/pulumi/pulumi-oci/sdk/go/oci/Limits"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := Limits.GetLimitDefinitions(ctx, &limits.GetLimitDefinitionsArgs{
			CompartmentId: _var.Tenancy_ocid,
			Name:          pulumi.StringRef(_var.Limit_definition_name),
			ServiceName:   pulumi.StringRef(oci_limits_service.Test_service.Name),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_oci as oci

test_limit_definitions = oci.Limits.get_limit_definitions(compartment_id=var["tenancy_ocid"],
    name=var["limit_definition_name"],
    service_name=oci_limits_service["test_service"]["name"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testLimitDefinitions = oci.Limits.getLimitDefinitions({
    compartmentId: _var.tenancy_ocid,
    name: _var.limit_definition_name,
    serviceName: oci_limits_service.test_service.name,
});

Coming soon!

Using getLimitDefinitions

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 getLimitDefinitions(args: GetLimitDefinitionsArgs, opts?: InvokeOptions): Promise<GetLimitDefinitionsResult>
function getLimitDefinitionsOutput(args: GetLimitDefinitionsOutputArgs, opts?: InvokeOptions): Output<GetLimitDefinitionsResult>
def get_limit_definitions(compartment_id: Optional[str] = None,
                          filters: Optional[Sequence[_limits.GetLimitDefinitionsFilter]] = None,
                          name: Optional[str] = None,
                          service_name: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetLimitDefinitionsResult
def get_limit_definitions_output(compartment_id: Optional[pulumi.Input[str]] = None,
                          filters: Optional[pulumi.Input[Sequence[pulumi.Input[_limits.GetLimitDefinitionsFilterArgs]]]] = None,
                          name: Optional[pulumi.Input[str]] = None,
                          service_name: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetLimitDefinitionsResult]
func GetLimitDefinitions(ctx *Context, args *GetLimitDefinitionsArgs, opts ...InvokeOption) (*GetLimitDefinitionsResult, error)
func GetLimitDefinitionsOutput(ctx *Context, args *GetLimitDefinitionsOutputArgs, opts ...InvokeOption) GetLimitDefinitionsResultOutput

> Note: This function is named GetLimitDefinitions in the Go SDK.

public static class GetLimitDefinitions 
{
    public static Task<GetLimitDefinitionsResult> InvokeAsync(GetLimitDefinitionsArgs args, InvokeOptions? opts = null)
    public static Output<GetLimitDefinitionsResult> Invoke(GetLimitDefinitionsInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetLimitDefinitionsResult> getLimitDefinitions(GetLimitDefinitionsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: oci:Limits/getLimitDefinitions:getLimitDefinitions
  Arguments:
    # Arguments dictionary

The following arguments are supported:

CompartmentId string

The OCID of the parent compartment (remember that the tenancy is simply the root compartment).

Filters List<GetLimitDefinitionsFilter>
Name string

Optional field, filter for a specific resource limit.

ServiceName string

The target service name.

CompartmentId string

The OCID of the parent compartment (remember that the tenancy is simply the root compartment).

Filters []GetLimitDefinitionsFilter
Name string

Optional field, filter for a specific resource limit.

ServiceName string

The target service name.

compartmentId String

The OCID of the parent compartment (remember that the tenancy is simply the root compartment).

filters List<GetLimitDefinitionsFilter>
name String

Optional field, filter for a specific resource limit.

serviceName String

The target service name.

compartmentId string

The OCID of the parent compartment (remember that the tenancy is simply the root compartment).

filters GetLimitDefinitionsFilter[]
name string

Optional field, filter for a specific resource limit.

serviceName string

The target service name.

compartment_id str

The OCID of the parent compartment (remember that the tenancy is simply the root compartment).

filters GetLimitDefinitionsFilter]
name str

Optional field, filter for a specific resource limit.

service_name str

The target service name.

compartmentId String

The OCID of the parent compartment (remember that the tenancy is simply the root compartment).

filters List<Property Map>
name String

Optional field, filter for a specific resource limit.

serviceName String

The target service name.

getLimitDefinitions Result

The following output properties are available:

CompartmentId string
Id string

The provider-assigned unique ID for this managed resource.

LimitDefinitions List<GetLimitDefinitionsLimitDefinition>

The list of limit_definitions.

Filters List<GetLimitDefinitionsFilter>
Name string

The resource limit name. To be used for writing policies (in case of quotas) or other programmatic calls.

ServiceName string

The service name of the limit.

CompartmentId string
Id string

The provider-assigned unique ID for this managed resource.

LimitDefinitions []GetLimitDefinitionsLimitDefinition

The list of limit_definitions.

Filters []GetLimitDefinitionsFilter
Name string

The resource limit name. To be used for writing policies (in case of quotas) or other programmatic calls.

ServiceName string

The service name of the limit.

compartmentId String
id String

The provider-assigned unique ID for this managed resource.

limitDefinitions List<GetLimitDefinitionsLimitDefinition>

The list of limit_definitions.

filters List<GetLimitDefinitionsFilter>
name String

The resource limit name. To be used for writing policies (in case of quotas) or other programmatic calls.

serviceName String

The service name of the limit.

compartmentId string
id string

The provider-assigned unique ID for this managed resource.

limitDefinitions GetLimitDefinitionsLimitDefinition[]

The list of limit_definitions.

filters GetLimitDefinitionsFilter[]
name string

The resource limit name. To be used for writing policies (in case of quotas) or other programmatic calls.

serviceName string

The service name of the limit.

compartment_id str
id str

The provider-assigned unique ID for this managed resource.

limit_definitions GetLimitDefinitionsLimitDefinition]

The list of limit_definitions.

filters GetLimitDefinitionsFilter]
name str

The resource limit name. To be used for writing policies (in case of quotas) or other programmatic calls.

service_name str

The service name of the limit.

compartmentId String
id String

The provider-assigned unique ID for this managed resource.

limitDefinitions List<Property Map>

The list of limit_definitions.

filters List<Property Map>
name String

The resource limit name. To be used for writing policies (in case of quotas) or other programmatic calls.

serviceName String

The service name of the limit.

Supporting Types

GetLimitDefinitionsFilter

Name string

Optional field, filter for a specific resource limit.

Values List<string>
Regex bool
Name string

Optional field, filter for a specific resource limit.

Values []string
Regex bool
name String

Optional field, filter for a specific resource limit.

values List<String>
regex Boolean
name string

Optional field, filter for a specific resource limit.

values string[]
regex boolean
name str

Optional field, filter for a specific resource limit.

values Sequence[str]
regex bool
name String

Optional field, filter for a specific resource limit.

values List<String>
regex Boolean

GetLimitDefinitionsLimitDefinition

AreQuotasSupported bool

If true, quota policies can be created on top of this resource limit.

Description string

The limit description.

IsDeprecated bool

Indicates if the limit has been deprecated.

IsDynamic bool

The limit for this resource has a dynamic value that is based on consumption across all Oracle Cloud Infrastructure services.

IsEligibleForLimitIncrease bool

Indicates if the customer can request a limit increase for this resource.

IsResourceAvailabilitySupported bool

Reflects whether or not the GetResourceAvailability API is supported for this limit. If not, the API returns an empty JSON response.

Name string

Optional field, filter for a specific resource limit.

ScopeType string

Reflects the scope of the resource limit, whether Global (across all regions), regional, or availability domain-specific.

ServiceName string

The target service name.

AreQuotasSupported bool

If true, quota policies can be created on top of this resource limit.

Description string

The limit description.

IsDeprecated bool

Indicates if the limit has been deprecated.

IsDynamic bool

The limit for this resource has a dynamic value that is based on consumption across all Oracle Cloud Infrastructure services.

IsEligibleForLimitIncrease bool

Indicates if the customer can request a limit increase for this resource.

IsResourceAvailabilitySupported bool

Reflects whether or not the GetResourceAvailability API is supported for this limit. If not, the API returns an empty JSON response.

Name string

Optional field, filter for a specific resource limit.

ScopeType string

Reflects the scope of the resource limit, whether Global (across all regions), regional, or availability domain-specific.

ServiceName string

The target service name.

areQuotasSupported Boolean

If true, quota policies can be created on top of this resource limit.

description String

The limit description.

isDeprecated Boolean

Indicates if the limit has been deprecated.

isDynamic Boolean

The limit for this resource has a dynamic value that is based on consumption across all Oracle Cloud Infrastructure services.

isEligibleForLimitIncrease Boolean

Indicates if the customer can request a limit increase for this resource.

isResourceAvailabilitySupported Boolean

Reflects whether or not the GetResourceAvailability API is supported for this limit. If not, the API returns an empty JSON response.

name String

Optional field, filter for a specific resource limit.

scopeType String

Reflects the scope of the resource limit, whether Global (across all regions), regional, or availability domain-specific.

serviceName String

The target service name.

areQuotasSupported boolean

If true, quota policies can be created on top of this resource limit.

description string

The limit description.

isDeprecated boolean

Indicates if the limit has been deprecated.

isDynamic boolean

The limit for this resource has a dynamic value that is based on consumption across all Oracle Cloud Infrastructure services.

isEligibleForLimitIncrease boolean

Indicates if the customer can request a limit increase for this resource.

isResourceAvailabilitySupported boolean

Reflects whether or not the GetResourceAvailability API is supported for this limit. If not, the API returns an empty JSON response.

name string

Optional field, filter for a specific resource limit.

scopeType string

Reflects the scope of the resource limit, whether Global (across all regions), regional, or availability domain-specific.

serviceName string

The target service name.

are_quotas_supported bool

If true, quota policies can be created on top of this resource limit.

description str

The limit description.

is_deprecated bool

Indicates if the limit has been deprecated.

is_dynamic bool

The limit for this resource has a dynamic value that is based on consumption across all Oracle Cloud Infrastructure services.

is_eligible_for_limit_increase bool

Indicates if the customer can request a limit increase for this resource.

is_resource_availability_supported bool

Reflects whether or not the GetResourceAvailability API is supported for this limit. If not, the API returns an empty JSON response.

name str

Optional field, filter for a specific resource limit.

scope_type str

Reflects the scope of the resource limit, whether Global (across all regions), regional, or availability domain-specific.

service_name str

The target service name.

areQuotasSupported Boolean

If true, quota policies can be created on top of this resource limit.

description String

The limit description.

isDeprecated Boolean

Indicates if the limit has been deprecated.

isDynamic Boolean

The limit for this resource has a dynamic value that is based on consumption across all Oracle Cloud Infrastructure services.

isEligibleForLimitIncrease Boolean

Indicates if the customer can request a limit increase for this resource.

isResourceAvailabilitySupported Boolean

Reflects whether or not the GetResourceAvailability API is supported for this limit. If not, the API returns an empty JSON response.

name String

Optional field, filter for a specific resource limit.

scopeType String

Reflects the scope of the resource limit, whether Global (across all regions), regional, or availability domain-specific.

serviceName String

The target service name.

Package Details

Repository
https://github.com/pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.