Akamai v8.0.0 published on Saturday, Mar 1, 2025 by Pulumi
akamai.getCloudletsEdgeRedirectorMatchRule
Explore with Pulumi AI
Using getCloudletsEdgeRedirectorMatchRule
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 getCloudletsEdgeRedirectorMatchRule(args: GetCloudletsEdgeRedirectorMatchRuleArgs, opts?: InvokeOptions): Promise<GetCloudletsEdgeRedirectorMatchRuleResult>
function getCloudletsEdgeRedirectorMatchRuleOutput(args: GetCloudletsEdgeRedirectorMatchRuleOutputArgs, opts?: InvokeOptions): Output<GetCloudletsEdgeRedirectorMatchRuleResult>def get_cloudlets_edge_redirector_match_rule(match_rules: Optional[Sequence[GetCloudletsEdgeRedirectorMatchRuleMatchRule]] = None,
                                             opts: Optional[InvokeOptions] = None) -> GetCloudletsEdgeRedirectorMatchRuleResult
def get_cloudlets_edge_redirector_match_rule_output(match_rules: Optional[pulumi.Input[Sequence[pulumi.Input[GetCloudletsEdgeRedirectorMatchRuleMatchRuleArgs]]]] = None,
                                             opts: Optional[InvokeOptions] = None) -> Output[GetCloudletsEdgeRedirectorMatchRuleResult]func GetCloudletsEdgeRedirectorMatchRule(ctx *Context, args *GetCloudletsEdgeRedirectorMatchRuleArgs, opts ...InvokeOption) (*GetCloudletsEdgeRedirectorMatchRuleResult, error)
func GetCloudletsEdgeRedirectorMatchRuleOutput(ctx *Context, args *GetCloudletsEdgeRedirectorMatchRuleOutputArgs, opts ...InvokeOption) GetCloudletsEdgeRedirectorMatchRuleResultOutput> Note: This function is named GetCloudletsEdgeRedirectorMatchRule in the Go SDK.
public static class GetCloudletsEdgeRedirectorMatchRule 
{
    public static Task<GetCloudletsEdgeRedirectorMatchRuleResult> InvokeAsync(GetCloudletsEdgeRedirectorMatchRuleArgs args, InvokeOptions? opts = null)
    public static Output<GetCloudletsEdgeRedirectorMatchRuleResult> Invoke(GetCloudletsEdgeRedirectorMatchRuleInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetCloudletsEdgeRedirectorMatchRuleResult> getCloudletsEdgeRedirectorMatchRule(GetCloudletsEdgeRedirectorMatchRuleArgs args, InvokeOptions options)
public static Output<GetCloudletsEdgeRedirectorMatchRuleResult> getCloudletsEdgeRedirectorMatchRule(GetCloudletsEdgeRedirectorMatchRuleArgs args, InvokeOptions options)
fn::invoke:
  function: akamai:index/getCloudletsEdgeRedirectorMatchRule:getCloudletsEdgeRedirectorMatchRule
  arguments:
    # arguments dictionaryThe following arguments are supported:
getCloudletsEdgeRedirectorMatchRule Result
The following output properties are available:
- Id string
- The provider-assigned unique ID for this managed resource.
- Json string
- MatchRules List<GetCloudlets Edge Redirector Match Rule Match Rule> 
- Id string
- The provider-assigned unique ID for this managed resource.
- Json string
- MatchRules []GetCloudlets Edge Redirector Match Rule Match Rule 
- id String
- The provider-assigned unique ID for this managed resource.
- json String
- matchRules List<GetCloudlets Edge Redirector Match Rule Match Rule> 
- id string
- The provider-assigned unique ID for this managed resource.
- json string
- matchRules GetCloudlets Edge Redirector Match Rule Match Rule[] 
- id str
- The provider-assigned unique ID for this managed resource.
- json str
- match_rules Sequence[GetCloudlets Edge Redirector Match Rule Match Rule] 
- id String
- The provider-assigned unique ID for this managed resource.
- json String
- matchRules List<Property Map>
Supporting Types
GetCloudletsEdgeRedirectorMatchRuleMatchRule       
- RedirectUrl string
- The URL Edge Redirector redirects the request to. If using use_relative_url, you can enter a path for the value
- StatusCode int
- The HTTP response status code (allowed values: 301, 302, 303, 307, 308)
- Type 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<GetCloudlets Edge Redirector Match Rule Match Rule Match> 
- 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)
- UseIncoming boolQuery String 
- If set to true, the Cloudlet includes the query string from the request in the rewritten or forwarded URL
- UseRelative stringUrl 
- If set to relative_url, takes the path entered for the redirectUrl and sets it in the response’s Location header. If set to copy_scheme_hostname, creates an absolute path by taking the protocol and hostname from the incoming request and combining them with path information entered for the redirectUrl. If this property is not included, or is set to none, then the redirect_url should be fully-qualified URL
- RedirectUrl string
- The URL Edge Redirector redirects the request to. If using use_relative_url, you can enter a path for the value
- StatusCode int
- The HTTP response status code (allowed values: 301, 302, 303, 307, 308)
- Type 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
[]GetCloudlets Edge Redirector Match Rule Match Rule Match 
- 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)
- UseIncoming boolQuery String 
- If set to true, the Cloudlet includes the query string from the request in the rewritten or forwarded URL
- UseRelative stringUrl 
- If set to relative_url, takes the path entered for the redirectUrl and sets it in the response’s Location header. If set to copy_scheme_hostname, creates an absolute path by taking the protocol and hostname from the incoming request and combining them with path information entered for the redirectUrl. If this property is not included, or is set to none, then the redirect_url should be fully-qualified URL
- redirectUrl String
- The URL Edge Redirector redirects the request to. If using use_relative_url, you can enter a path for the value
- statusCode Integer
- The HTTP response status code (allowed values: 301, 302, 303, 307, 308)
- type 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<GetCloudlets Edge Redirector Match Rule Match Rule Match> 
- 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)
- useIncoming BooleanQuery String 
- If set to true, the Cloudlet includes the query string from the request in the rewritten or forwarded URL
- useRelative StringUrl 
- If set to relative_url, takes the path entered for the redirectUrl and sets it in the response’s Location header. If set to copy_scheme_hostname, creates an absolute path by taking the protocol and hostname from the incoming request and combining them with path information entered for the redirectUrl. If this property is not included, or is set to none, then the redirect_url should be fully-qualified URL
- redirectUrl string
- The URL Edge Redirector redirects the request to. If using use_relative_url, you can enter a path for the value
- statusCode number
- The HTTP response status code (allowed values: 301, 302, 303, 307, 308)
- type 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
GetCloudlets Edge Redirector Match Rule Match Rule Match[] 
- 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)
- useIncoming booleanQuery String 
- If set to true, the Cloudlet includes the query string from the request in the rewritten or forwarded URL
- useRelative stringUrl 
- If set to relative_url, takes the path entered for the redirectUrl and sets it in the response’s Location header. If set to copy_scheme_hostname, creates an absolute path by taking the protocol and hostname from the incoming request and combining them with path information entered for the redirectUrl. If this property is not included, or is set to none, then the redirect_url should be fully-qualified URL
- redirect_url str
- The URL Edge Redirector redirects the request to. If using use_relative_url, you can enter a path for the value
- status_code int
- The HTTP response status code (allowed values: 301, 302, 303, 307, 308)
- type 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[GetCloudlets Edge Redirector Match Rule Match Rule Match] 
- 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)
- use_incoming_ boolquery_ string 
- If set to true, the Cloudlet includes the query string from the request in the rewritten or forwarded URL
- use_relative_ strurl 
- If set to relative_url, takes the path entered for the redirectUrl and sets it in the response’s Location header. If set to copy_scheme_hostname, creates an absolute path by taking the protocol and hostname from the incoming request and combining them with path information entered for the redirectUrl. If this property is not included, or is set to none, then the redirect_url should be fully-qualified URL
- redirectUrl String
- The URL Edge Redirector redirects the request to. If using use_relative_url, you can enter a path for the value
- statusCode Number
- The HTTP response status code (allowed values: 301, 302, 303, 307, 308)
- type 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
- 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)
- useIncoming BooleanQuery String 
- If set to true, the Cloudlet includes the query string from the request in the rewritten or forwarded URL
- useRelative StringUrl 
- If set to relative_url, takes the path entered for the redirectUrl and sets it in the response’s Location header. If set to copy_scheme_hostname, creates an absolute path by taking the protocol and hostname from the incoming request and combining them with path information entered for the redirectUrl. If this property is not included, or is set to none, then the redirect_url should be fully-qualified URL
GetCloudletsEdgeRedirectorMatchRuleMatchRuleMatch        
- 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
- ObjectMatch List<GetValues Cloudlets Edge Redirector Match Rule Match Rule Match Object Match Value> 
- 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
- ObjectMatch []GetValues Cloudlets Edge Redirector Match Rule Match Rule Match Object Match Value 
- 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
- objectMatch List<GetValues Cloudlets Edge Redirector Match Rule Match Rule Match Object Match Value> 
- 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
- objectMatch GetValues Cloudlets Edge Redirector Match Rule Match Rule Match Object Match Value[] 
- 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_ Sequence[Getvalues Cloudlets Edge Redirector Match Rule Match Rule Match Object Match Value] 
- 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
- objectMatch List<Property Map>Values 
- An object used when a rule either includes more complex match criteria, like multiple value attributes
GetCloudletsEdgeRedirectorMatchRuleMatchRuleMatchObjectMatchValue           
- Type 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
- NameCase boolSensitive 
- Set to true if the entry for the name property should be evaluated based on case sensitivity
- NameHas boolWildcard 
- Set to true if the entry for the name property includes wildcards
- Options
GetCloudlets Edge Redirector Match Rule Match Rule Match Object Match Value Options 
- 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 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
- NameCase boolSensitive 
- Set to true if the entry for the name property should be evaluated based on case sensitivity
- NameHas boolWildcard 
- Set to true if the entry for the name property includes wildcards
- Options
GetCloudlets Edge Redirector Match Rule Match Rule Match Object Match Value Options 
- 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 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
- nameCase BooleanSensitive 
- Set to true if the entry for the name property should be evaluated based on case sensitivity
- nameHas BooleanWildcard 
- Set to true if the entry for the name property includes wildcards
- options
GetCloudlets Edge Redirector Match Rule Match Rule Match Object Match Value Options 
- 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 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
- nameCase booleanSensitive 
- Set to true if the entry for the name property should be evaluated based on case sensitivity
- nameHas booleanWildcard 
- Set to true if the entry for the name property includes wildcards
- options
GetCloudlets Edge Redirector Match Rule Match Rule Match Object Match Value Options 
- 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 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_ boolsensitive 
- Set to true if the entry for the name property should be evaluated based on case sensitivity
- name_has_ boolwildcard 
- Set to true if the entry for the name property includes wildcards
- options
GetCloudlets Edge Redirector Match Rule Match Rule Match Object Match Value Options 
- 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 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
- nameCase BooleanSensitive 
- Set to true if the entry for the name property should be evaluated based on case sensitivity
- nameHas BooleanWildcard 
- 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)
GetCloudletsEdgeRedirectorMatchRuleMatchRuleMatchObjectMatchValueOptions            
- ValueCase boolSensitive 
- 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
- ValueHas boolWildcard 
- 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
- ValueCase boolSensitive 
- 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
- ValueHas boolWildcard 
- Set to true if the entries for the value property include wildcards
- Values []string
- The value attributes in the incoming request to match on
- valueCase BooleanSensitive 
- 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
- valueHas BooleanWildcard 
- 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
- valueCase booleanSensitive 
- 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
- valueHas booleanWildcard 
- 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_ boolsensitive 
- 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_ boolwildcard 
- 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
- valueCase BooleanSensitive 
- 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
- valueHas BooleanWildcard 
- 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 akamaiTerraform Provider.