Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Akamai
  3. API Docs
  4. getCloudletsApiPrioritizationMatchRule
Akamai v8.1.0 published on Friday, Apr 11, 2025 by Pulumi
pulumi/pulumi-akamai

akamai.getCloudletsApiPrioritizationMatchRule

Explore with Pulumi AI

Akamai v8.1.0 published on Friday, Apr 11, 2025 by Pulumi
pulumi/pulumi-akamai

Using getCloudletsApiPrioritizationMatchRule

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 getCloudletsApiPrioritizationMatchRule(args: GetCloudletsApiPrioritizationMatchRuleArgs, opts?: InvokeOptions): Promise<GetCloudletsApiPrioritizationMatchRuleResult>
function getCloudletsApiPrioritizationMatchRuleOutput(args: GetCloudletsApiPrioritizationMatchRuleOutputArgs, opts?: InvokeOptions): Output<GetCloudletsApiPrioritizationMatchRuleResult>
Copy
def get_cloudlets_api_prioritization_match_rule(match_rules: Optional[Sequence[GetCloudletsApiPrioritizationMatchRuleMatchRule]] = None,
                                                opts: Optional[InvokeOptions] = None) -> GetCloudletsApiPrioritizationMatchRuleResult
def get_cloudlets_api_prioritization_match_rule_output(match_rules: Optional[pulumi.Input[Sequence[pulumi.Input[GetCloudletsApiPrioritizationMatchRuleMatchRuleArgs]]]] = None,
                                                opts: Optional[InvokeOptions] = None) -> Output[GetCloudletsApiPrioritizationMatchRuleResult]
Copy
func GetCloudletsApiPrioritizationMatchRule(ctx *Context, args *GetCloudletsApiPrioritizationMatchRuleArgs, opts ...InvokeOption) (*GetCloudletsApiPrioritizationMatchRuleResult, error)
func GetCloudletsApiPrioritizationMatchRuleOutput(ctx *Context, args *GetCloudletsApiPrioritizationMatchRuleOutputArgs, opts ...InvokeOption) GetCloudletsApiPrioritizationMatchRuleResultOutput
Copy

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

public static class GetCloudletsApiPrioritizationMatchRule 
{
    public static Task<GetCloudletsApiPrioritizationMatchRuleResult> InvokeAsync(GetCloudletsApiPrioritizationMatchRuleArgs args, InvokeOptions? opts = null)
    public static Output<GetCloudletsApiPrioritizationMatchRuleResult> Invoke(GetCloudletsApiPrioritizationMatchRuleInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetCloudletsApiPrioritizationMatchRuleResult> getCloudletsApiPrioritizationMatchRule(GetCloudletsApiPrioritizationMatchRuleArgs args, InvokeOptions options)
public static Output<GetCloudletsApiPrioritizationMatchRuleResult> getCloudletsApiPrioritizationMatchRule(GetCloudletsApiPrioritizationMatchRuleArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: akamai:index/getCloudletsApiPrioritizationMatchRule:getCloudletsApiPrioritizationMatchRule
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

getCloudletsApiPrioritizationMatchRule Result

The following output properties are available:

Id string
The provider-assigned unique ID for this managed resource.
Json string
MatchRules List<GetCloudletsApiPrioritizationMatchRuleMatchRule>
Id string
The provider-assigned unique ID for this managed resource.
Json string
MatchRules []GetCloudletsApiPrioritizationMatchRuleMatchRule
id String
The provider-assigned unique ID for this managed resource.
json String
matchRules List<GetCloudletsApiPrioritizationMatchRuleMatchRule>
id string
The provider-assigned unique ID for this managed resource.
json string
matchRules GetCloudletsApiPrioritizationMatchRuleMatchRule[]
id str
The provider-assigned unique ID for this managed resource.
json str
match_rules Sequence[GetCloudletsApiPrioritizationMatchRuleMatchRule]
id String
The provider-assigned unique ID for this managed resource.
json String
matchRules List<Property Map>

Supporting Types

GetCloudletsApiPrioritizationMatchRuleMatchRule

PassThroughPercent This property is required. double
The range 0.0: 99.0 specifies the percentage of requests that pass through to the origin. The value of 100 means the request always passes through to the origin. A value of -1 means send everyone to the waiting room.
Type This property is required. string
The type of Cloudlet the rule is for
Disabled bool
If set to true, disables a rule so it is not evaluated against incoming requests.
End int
The end time for this match (in seconds since the epoch)
MatchUrl string
If using a URL match, this property is the URL that the Cloudlet uses to match the incoming request
Matches List<GetCloudletsApiPrioritizationMatchRuleMatchRuleMatch>
Defines a set of match objects
Name string
The name of the rule
Start int
The start time for this match (in seconds since the epoch)
PassThroughPercent This property is required. float64
The range 0.0: 99.0 specifies the percentage of requests that pass through to the origin. The value of 100 means the request always passes through to the origin. A value of -1 means send everyone to the waiting room.
Type This property is required. string
The type of Cloudlet the rule is for
Disabled bool
If set to true, disables a rule so it is not evaluated against incoming requests.
End int
The end time for this match (in seconds since the epoch)
MatchUrl string
If using a URL match, this property is the URL that the Cloudlet uses to match the incoming request
Matches []GetCloudletsApiPrioritizationMatchRuleMatchRuleMatch
Defines a set of match objects
Name string
The name of the rule
Start int
The start time for this match (in seconds since the epoch)
passThroughPercent This property is required. Double
The range 0.0: 99.0 specifies the percentage of requests that pass through to the origin. The value of 100 means the request always passes through to the origin. A value of -1 means send everyone to the waiting room.
type This property is required. String
The type of Cloudlet the rule is for
disabled Boolean
If set to true, disables a rule so it is not evaluated against incoming requests.
end Integer
The end time for this match (in seconds since the epoch)
matchUrl String
If using a URL match, this property is the URL that the Cloudlet uses to match the incoming request
matches List<GetCloudletsApiPrioritizationMatchRuleMatchRuleMatch>
Defines a set of match objects
name String
The name of the rule
start Integer
The start time for this match (in seconds since the epoch)
passThroughPercent This property is required. number
The range 0.0: 99.0 specifies the percentage of requests that pass through to the origin. The value of 100 means the request always passes through to the origin. A value of -1 means send everyone to the waiting room.
type This property is required. string
The type of Cloudlet the rule is for
disabled boolean
If set to true, disables a rule so it is not evaluated against incoming requests.
end number
The end time for this match (in seconds since the epoch)
matchUrl string
If using a URL match, this property is the URL that the Cloudlet uses to match the incoming request
matches GetCloudletsApiPrioritizationMatchRuleMatchRuleMatch[]
Defines a set of match objects
name string
The name of the rule
start number
The start time for this match (in seconds since the epoch)
pass_through_percent This property is required. float
The range 0.0: 99.0 specifies the percentage of requests that pass through to the origin. The value of 100 means the request always passes through to the origin. A value of -1 means send everyone to the waiting room.
type This property is required. str
The type of Cloudlet the rule is for
disabled bool
If set to true, disables a rule so it is not evaluated against incoming requests.
end int
The end time for this match (in seconds since the epoch)
match_url str
If using a URL match, this property is the URL that the Cloudlet uses to match the incoming request
matches Sequence[GetCloudletsApiPrioritizationMatchRuleMatchRuleMatch]
Defines a set of match objects
name str
The name of the rule
start int
The start time for this match (in seconds since the epoch)
passThroughPercent This property is required. Number
The range 0.0: 99.0 specifies the percentage of requests that pass through to the origin. The value of 100 means the request always passes through to the origin. A value of -1 means send everyone to the waiting room.
type This property is required. String
The type of Cloudlet the rule is for
disabled Boolean
If set to true, disables a rule so it is not evaluated against incoming requests.
end Number
The end time for this match (in seconds since the epoch)
matchUrl String
If using a URL match, this property is the URL that the Cloudlet uses to match the incoming request
matches List<Property Map>
Defines a set of match objects
name String
The name of the rule
start Number
The start time for this match (in seconds since the epoch)

GetCloudletsApiPrioritizationMatchRuleMatchRuleMatch

CaseSensitive bool
If true, the match is case sensitive
CheckIps string
For clientip, continent, countrycode, proxy, and regioncode match types, the part of the request that determines the IP address to use
MatchOperator string
Valid entries for this property: contains, exists, and equals
MatchType string
The type of match used
MatchValue string
Depends on the matchType
Negate bool
If true, negates the match
ObjectMatchValues List<GetCloudletsApiPrioritizationMatchRuleMatchRuleMatchObjectMatchValue>
An object used when a rule either includes more complex match criteria, like multiple value attributes
CaseSensitive bool
If true, the match is case sensitive
CheckIps string
For clientip, continent, countrycode, proxy, and regioncode match types, the part of the request that determines the IP address to use
MatchOperator string
Valid entries for this property: contains, exists, and equals
MatchType string
The type of match used
MatchValue string
Depends on the matchType
Negate bool
If true, negates the match
ObjectMatchValues []GetCloudletsApiPrioritizationMatchRuleMatchRuleMatchObjectMatchValue
An object used when a rule either includes more complex match criteria, like multiple value attributes
caseSensitive Boolean
If true, the match is case sensitive
checkIps String
For clientip, continent, countrycode, proxy, and regioncode match types, the part of the request that determines the IP address to use
matchOperator String
Valid entries for this property: contains, exists, and equals
matchType String
The type of match used
matchValue String
Depends on the matchType
negate Boolean
If true, negates the match
objectMatchValues List<GetCloudletsApiPrioritizationMatchRuleMatchRuleMatchObjectMatchValue>
An object used when a rule either includes more complex match criteria, like multiple value attributes
caseSensitive boolean
If true, the match is case sensitive
checkIps string
For clientip, continent, countrycode, proxy, and regioncode match types, the part of the request that determines the IP address to use
matchOperator string
Valid entries for this property: contains, exists, and equals
matchType string
The type of match used
matchValue string
Depends on the matchType
negate boolean
If true, negates the match
objectMatchValues GetCloudletsApiPrioritizationMatchRuleMatchRuleMatchObjectMatchValue[]
An object used when a rule either includes more complex match criteria, like multiple value attributes
case_sensitive bool
If true, the match is case sensitive
check_ips str
For clientip, continent, countrycode, proxy, and regioncode match types, the part of the request that determines the IP address to use
match_operator str
Valid entries for this property: contains, exists, and equals
match_type str
The type of match used
match_value str
Depends on the matchType
negate bool
If true, negates the match
object_match_values Sequence[GetCloudletsApiPrioritizationMatchRuleMatchRuleMatchObjectMatchValue]
An object used when a rule either includes more complex match criteria, like multiple value attributes
caseSensitive Boolean
If true, the match is case sensitive
checkIps String
For clientip, continent, countrycode, proxy, and regioncode match types, the part of the request that determines the IP address to use
matchOperator String
Valid entries for this property: contains, exists, and equals
matchType String
The type of match used
matchValue String
Depends on the matchType
negate Boolean
If true, negates the match
objectMatchValues List<Property Map>
An object used when a rule either includes more complex match criteria, like multiple value attributes

GetCloudletsApiPrioritizationMatchRuleMatchRuleMatchObjectMatchValue

Type This property is required. string
The array type, which can be one of the following: object or simple. Use the simple option when adding only an array of string-based values
Name string
If using a match type that supports name attributes, enter the value in the incoming request to match on. The following match types support this property: cookie, header, parameter, and query
NameCaseSensitive bool
Set to true if the entry for the name property should be evaluated based on case sensitivity
NameHasWildcard bool
Set to true if the entry for the name property includes wildcards
Options GetCloudletsApiPrioritizationMatchRuleMatchRuleMatchObjectMatchValueOptions
If using the object type, use this set to list the values to match on (use only with the object type)
Values List<string>
The value attributes in the incoming request to match on (use only with simple type)
Type This property is required. string
The array type, which can be one of the following: object or simple. Use the simple option when adding only an array of string-based values
Name string
If using a match type that supports name attributes, enter the value in the incoming request to match on. The following match types support this property: cookie, header, parameter, and query
NameCaseSensitive bool
Set to true if the entry for the name property should be evaluated based on case sensitivity
NameHasWildcard bool
Set to true if the entry for the name property includes wildcards
Options GetCloudletsApiPrioritizationMatchRuleMatchRuleMatchObjectMatchValueOptions
If using the object type, use this set to list the values to match on (use only with the object type)
Values []string
The value attributes in the incoming request to match on (use only with simple type)
type This property is required. String
The array type, which can be one of the following: object or simple. Use the simple option when adding only an array of string-based values
name String
If using a match type that supports name attributes, enter the value in the incoming request to match on. The following match types support this property: cookie, header, parameter, and query
nameCaseSensitive Boolean
Set to true if the entry for the name property should be evaluated based on case sensitivity
nameHasWildcard Boolean
Set to true if the entry for the name property includes wildcards
options GetCloudletsApiPrioritizationMatchRuleMatchRuleMatchObjectMatchValueOptions
If using the object type, use this set to list the values to match on (use only with the object type)
values List<String>
The value attributes in the incoming request to match on (use only with simple type)
type This property is required. string
The array type, which can be one of the following: object or simple. Use the simple option when adding only an array of string-based values
name string
If using a match type that supports name attributes, enter the value in the incoming request to match on. The following match types support this property: cookie, header, parameter, and query
nameCaseSensitive boolean
Set to true if the entry for the name property should be evaluated based on case sensitivity
nameHasWildcard boolean
Set to true if the entry for the name property includes wildcards
options GetCloudletsApiPrioritizationMatchRuleMatchRuleMatchObjectMatchValueOptions
If using the object type, use this set to list the values to match on (use only with the object type)
values string[]
The value attributes in the incoming request to match on (use only with simple type)
type This property is required. str
The array type, which can be one of the following: object or simple. Use the simple option when adding only an array of string-based values
name str
If using a match type that supports name attributes, enter the value in the incoming request to match on. The following match types support this property: cookie, header, parameter, and query
name_case_sensitive bool
Set to true if the entry for the name property should be evaluated based on case sensitivity
name_has_wildcard bool
Set to true if the entry for the name property includes wildcards
options GetCloudletsApiPrioritizationMatchRuleMatchRuleMatchObjectMatchValueOptions
If using the object type, use this set to list the values to match on (use only with the object type)
values Sequence[str]
The value attributes in the incoming request to match on (use only with simple type)
type This property is required. String
The array type, which can be one of the following: object or simple. Use the simple option when adding only an array of string-based values
name String
If using a match type that supports name attributes, enter the value in the incoming request to match on. The following match types support this property: cookie, header, parameter, and query
nameCaseSensitive Boolean
Set to true if the entry for the name property should be evaluated based on case sensitivity
nameHasWildcard Boolean
Set to true if the entry for the name property includes wildcards
options Property Map
If using the object type, use this set to list the values to match on (use only with the object type)
values List<String>
The value attributes in the incoming request to match on (use only with simple type)

GetCloudletsApiPrioritizationMatchRuleMatchRuleMatchObjectMatchValueOptions

ValueCaseSensitive bool
Set to true if the entries for the value property should be evaluated based on case sensitivity
ValueEscaped bool
Set to true if provided value should be compared in escaped form
ValueHasWildcard bool
Set to true if the entries for the value property include wildcards
Values List<string>
The value attributes in the incoming request to match on
ValueCaseSensitive bool
Set to true if the entries for the value property should be evaluated based on case sensitivity
ValueEscaped bool
Set to true if provided value should be compared in escaped form
ValueHasWildcard bool
Set to true if the entries for the value property include wildcards
Values []string
The value attributes in the incoming request to match on
valueCaseSensitive Boolean
Set to true if the entries for the value property should be evaluated based on case sensitivity
valueEscaped Boolean
Set to true if provided value should be compared in escaped form
valueHasWildcard Boolean
Set to true if the entries for the value property include wildcards
values List<String>
The value attributes in the incoming request to match on
valueCaseSensitive boolean
Set to true if the entries for the value property should be evaluated based on case sensitivity
valueEscaped boolean
Set to true if provided value should be compared in escaped form
valueHasWildcard boolean
Set to true if the entries for the value property include wildcards
values string[]
The value attributes in the incoming request to match on
value_case_sensitive bool
Set to true if the entries for the value property should be evaluated based on case sensitivity
value_escaped bool
Set to true if provided value should be compared in escaped form
value_has_wildcard bool
Set to true if the entries for the value property include wildcards
values Sequence[str]
The value attributes in the incoming request to match on
valueCaseSensitive Boolean
Set to true if the entries for the value property should be evaluated based on case sensitivity
valueEscaped Boolean
Set to true if provided value should be compared in escaped form
valueHasWildcard Boolean
Set to true if the entries for the value property include wildcards
values List<String>
The value attributes in the incoming request to match on

Package Details

Repository
Akamai pulumi/pulumi-akamai
License
Apache-2.0
Notes
This Pulumi package is based on the akamai Terraform Provider.
Akamai v8.1.0 published on Friday, Apr 11, 2025 by Pulumi
pulumi/pulumi-akamai