1. Packages
  2. Akamai
  3. API Docs
  4. getCloudletsRequestControlMatchRule
Akamai v8.0.0 published on Saturday, Mar 1, 2025 by Pulumi

akamai.getCloudletsRequestControlMatchRule

Explore with Pulumi AI

Using getCloudletsRequestControlMatchRule

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 getCloudletsRequestControlMatchRule(args: GetCloudletsRequestControlMatchRuleArgs, opts?: InvokeOptions): Promise<GetCloudletsRequestControlMatchRuleResult>
function getCloudletsRequestControlMatchRuleOutput(args: GetCloudletsRequestControlMatchRuleOutputArgs, opts?: InvokeOptions): Output<GetCloudletsRequestControlMatchRuleResult>
Copy
def get_cloudlets_request_control_match_rule(match_rules: Optional[Sequence[GetCloudletsRequestControlMatchRuleMatchRule]] = None,
                                             opts: Optional[InvokeOptions] = None) -> GetCloudletsRequestControlMatchRuleResult
def get_cloudlets_request_control_match_rule_output(match_rules: Optional[pulumi.Input[Sequence[pulumi.Input[GetCloudletsRequestControlMatchRuleMatchRuleArgs]]]] = None,
                                             opts: Optional[InvokeOptions] = None) -> Output[GetCloudletsRequestControlMatchRuleResult]
Copy
func GetCloudletsRequestControlMatchRule(ctx *Context, args *GetCloudletsRequestControlMatchRuleArgs, opts ...InvokeOption) (*GetCloudletsRequestControlMatchRuleResult, error)
func GetCloudletsRequestControlMatchRuleOutput(ctx *Context, args *GetCloudletsRequestControlMatchRuleOutputArgs, opts ...InvokeOption) GetCloudletsRequestControlMatchRuleResultOutput
Copy

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

public static class GetCloudletsRequestControlMatchRule 
{
    public static Task<GetCloudletsRequestControlMatchRuleResult> InvokeAsync(GetCloudletsRequestControlMatchRuleArgs args, InvokeOptions? opts = null)
    public static Output<GetCloudletsRequestControlMatchRuleResult> Invoke(GetCloudletsRequestControlMatchRuleInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetCloudletsRequestControlMatchRuleResult> getCloudletsRequestControlMatchRule(GetCloudletsRequestControlMatchRuleArgs args, InvokeOptions options)
public static Output<GetCloudletsRequestControlMatchRuleResult> getCloudletsRequestControlMatchRule(GetCloudletsRequestControlMatchRuleArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: akamai:index/getCloudletsRequestControlMatchRule:getCloudletsRequestControlMatchRule
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

getCloudletsRequestControlMatchRule Result

The following output properties are available:

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

Supporting Types

GetCloudletsRequestControlMatchRuleMatchRule

AllowDeny This property is required. string
If set to allow, the request is sent to origin when all conditions are true. If deny, the request is denied when all conditions are true. If denybranded, the request is denied and rerouted according to the configuration of the Request Control behavior
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)
Matches List<GetCloudletsRequestControlMatchRuleMatchRuleMatch>
Defines a set of match objects
MatchesAlways bool
Is used in some cloudlets to support default rules (rule that is always matched)
Name string
The name of the rule
Start int
The start time for this match (in seconds since the epoch)
AllowDeny This property is required. string
If set to allow, the request is sent to origin when all conditions are true. If deny, the request is denied when all conditions are true. If denybranded, the request is denied and rerouted according to the configuration of the Request Control behavior
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)
Matches []GetCloudletsRequestControlMatchRuleMatchRuleMatch
Defines a set of match objects
MatchesAlways bool
Is used in some cloudlets to support default rules (rule that is always matched)
Name string
The name of the rule
Start int
The start time for this match (in seconds since the epoch)
allowDeny This property is required. String
If set to allow, the request is sent to origin when all conditions are true. If deny, the request is denied when all conditions are true. If denybranded, the request is denied and rerouted according to the configuration of the Request Control behavior
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)
matches List<GetCloudletsRequestControlMatchRuleMatchRuleMatch>
Defines a set of match objects
matchesAlways Boolean
Is used in some cloudlets to support default rules (rule that is always matched)
name String
The name of the rule
start Integer
The start time for this match (in seconds since the epoch)
allowDeny This property is required. string
If set to allow, the request is sent to origin when all conditions are true. If deny, the request is denied when all conditions are true. If denybranded, the request is denied and rerouted according to the configuration of the Request Control behavior
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)
matches GetCloudletsRequestControlMatchRuleMatchRuleMatch[]
Defines a set of match objects
matchesAlways boolean
Is used in some cloudlets to support default rules (rule that is always matched)
name string
The name of the rule
start number
The start time for this match (in seconds since the epoch)
allow_deny This property is required. str
If set to allow, the request is sent to origin when all conditions are true. If deny, the request is denied when all conditions are true. If denybranded, the request is denied and rerouted according to the configuration of the Request Control behavior
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)
matches Sequence[GetCloudletsRequestControlMatchRuleMatchRuleMatch]
Defines a set of match objects
matches_always bool
Is used in some cloudlets to support default rules (rule that is always matched)
name str
The name of the rule
start int
The start time for this match (in seconds since the epoch)
allowDeny This property is required. String
If set to allow, the request is sent to origin when all conditions are true. If deny, the request is denied when all conditions are true. If denybranded, the request is denied and rerouted according to the configuration of the Request Control behavior
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)
matches List<Property Map>
Defines a set of match objects
matchesAlways Boolean
Is used in some cloudlets to support default rules (rule that is always matched)
name String
The name of the rule
start Number
The start time for this match (in seconds since the epoch)

GetCloudletsRequestControlMatchRuleMatchRuleMatch

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<GetCloudletsRequestControlMatchRuleMatchRuleMatchObjectMatchValue>
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 []GetCloudletsRequestControlMatchRuleMatchRuleMatchObjectMatchValue
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<GetCloudletsRequestControlMatchRuleMatchRuleMatchObjectMatchValue>
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 GetCloudletsRequestControlMatchRuleMatchRuleMatchObjectMatchValue[]
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[GetCloudletsRequestControlMatchRuleMatchRuleMatchObjectMatchValue]
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

GetCloudletsRequestControlMatchRuleMatchRuleMatchObjectMatchValue

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 GetCloudletsRequestControlMatchRuleMatchRuleMatchObjectMatchValueOptions
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 GetCloudletsRequestControlMatchRuleMatchRuleMatchObjectMatchValueOptions
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 GetCloudletsRequestControlMatchRuleMatchRuleMatchObjectMatchValueOptions
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 GetCloudletsRequestControlMatchRuleMatchRuleMatchObjectMatchValueOptions
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 GetCloudletsRequestControlMatchRuleMatchRuleMatchObjectMatchValueOptions
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)

GetCloudletsRequestControlMatchRuleMatchRuleMatchObjectMatchValueOptions

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.