1. Packages
  2. Akamai
  3. API Docs
  4. getCloudletsForwardRewriteMatchRule
Akamai v10.2.0 published on Friday, Nov 14, 2025 by Pulumi
Schema (JSON)
pulumi/pulumi-akamai

akamai.getCloudletsForwardRewriteMatchRule

akamai logo
Akamai v10.2.0 published on Friday, Nov 14, 2025 by Pulumi
Schema (JSON)
pulumi/pulumi-akamai

    Using getCloudletsForwardRewriteMatchRule

    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 getCloudletsForwardRewriteMatchRule(args: GetCloudletsForwardRewriteMatchRuleArgs, opts?: InvokeOptions): Promise<GetCloudletsForwardRewriteMatchRuleResult>
function getCloudletsForwardRewriteMatchRuleOutput(args: GetCloudletsForwardRewriteMatchRuleOutputArgs, opts?: InvokeOptions): Output<GetCloudletsForwardRewriteMatchRuleResult>
    def get_cloudlets_forward_rewrite_match_rule(match_rules: Optional[Sequence[GetCloudletsForwardRewriteMatchRuleMatchRule]] = None,
                                             opts: Optional[InvokeOptions] = None) -> GetCloudletsForwardRewriteMatchRuleResult
def get_cloudlets_forward_rewrite_match_rule_output(match_rules: Optional[pulumi.Input[Sequence[pulumi.Input[GetCloudletsForwardRewriteMatchRuleMatchRuleArgs]]]] = None,
                                             opts: Optional[InvokeOptions] = None) -> Output[GetCloudletsForwardRewriteMatchRuleResult]
    func GetCloudletsForwardRewriteMatchRule(ctx *Context, args *GetCloudletsForwardRewriteMatchRuleArgs, opts ...InvokeOption) (*GetCloudletsForwardRewriteMatchRuleResult, error)
func GetCloudletsForwardRewriteMatchRuleOutput(ctx *Context, args *GetCloudletsForwardRewriteMatchRuleOutputArgs, opts ...InvokeOption) GetCloudletsForwardRewriteMatchRuleResultOutput

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

    public static class GetCloudletsForwardRewriteMatchRule 
{
    public static Task<GetCloudletsForwardRewriteMatchRuleResult> InvokeAsync(GetCloudletsForwardRewriteMatchRuleArgs args, InvokeOptions? opts = null)
    public static Output<GetCloudletsForwardRewriteMatchRuleResult> Invoke(GetCloudletsForwardRewriteMatchRuleInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetCloudletsForwardRewriteMatchRuleResult> getCloudletsForwardRewriteMatchRule(GetCloudletsForwardRewriteMatchRuleArgs args, InvokeOptions options)
public static Output<GetCloudletsForwardRewriteMatchRuleResult> getCloudletsForwardRewriteMatchRule(GetCloudletsForwardRewriteMatchRuleArgs args, InvokeOptions options)

    fn::invoke:
  function: akamai:index/getCloudletsForwardRewriteMatchRule:getCloudletsForwardRewriteMatchRule
  arguments:
    # arguments dictionary

    The following arguments are supported:

    getCloudletsForwardRewriteMatchRule Result

    The following output properties are available:

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

    Supporting Types

    GetCloudletsForwardRewriteMatchRuleMatchRule

    ForwardSettings GetCloudletsForwardRewriteMatchRuleMatchRuleForwardSettings
    This property defines data used to construct a new request URL if all conditions are met. If all of the conditions you set are true, then the Edge Server returns an HTTP response from the rewritten URL
    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<GetCloudletsForwardRewriteMatchRuleMatchRuleMatch>
    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)
    ForwardSettings GetCloudletsForwardRewriteMatchRuleMatchRuleForwardSettings
    This property defines data used to construct a new request URL if all conditions are met. If all of the conditions you set are true, then the Edge Server returns an HTTP response from the rewritten URL
    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 []GetCloudletsForwardRewriteMatchRuleMatchRuleMatch
    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)
    forwardSettings GetCloudletsForwardRewriteMatchRuleMatchRuleForwardSettings
    This property defines data used to construct a new request URL if all conditions are met. If all of the conditions you set are true, then the Edge Server returns an HTTP response from the rewritten URL
    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<GetCloudletsForwardRewriteMatchRuleMatchRuleMatch>
    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)
    forwardSettings GetCloudletsForwardRewriteMatchRuleMatchRuleForwardSettings
    This property defines data used to construct a new request URL if all conditions are met. If all of the conditions you set are true, then the Edge Server returns an HTTP response from the rewritten URL
    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 GetCloudletsForwardRewriteMatchRuleMatchRuleMatch[]
    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)
    forward_settings GetCloudletsForwardRewriteMatchRuleMatchRuleForwardSettings
    This property defines data used to construct a new request URL if all conditions are met. If all of the conditions you set are true, then the Edge Server returns an HTTP response from the rewritten URL
    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[GetCloudletsForwardRewriteMatchRuleMatchRuleMatch]
    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)
    forwardSettings Property Map
    This property defines data used to construct a new request URL if all conditions are met. If all of the conditions you set are true, then the Edge Server returns an HTTP response from the rewritten URL
    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
    name String
    The name of the rule
    start Number
    The start time for this match (in seconds since the epoch)

    GetCloudletsForwardRewriteMatchRuleMatchRuleForwardSettings

    OriginId string
    The ID of the Conditional Origin requests are forwarded to
    PathAndQs string
    If a value is provided and match conditions are met, this property defines the path/resource/query string to rewrite URL for the incoming request.
    UseIncomingQueryString bool
    If set to true, the Cloudlet includes the query string from the request in the rewritten or forwarded URL.
    OriginId string
    The ID of the Conditional Origin requests are forwarded to
    PathAndQs string
    If a value is provided and match conditions are met, this property defines the path/resource/query string to rewrite URL for the incoming request.
    UseIncomingQueryString bool
    If set to true, the Cloudlet includes the query string from the request in the rewritten or forwarded URL.
    originId String
    The ID of the Conditional Origin requests are forwarded to
    pathAndQs String
    If a value is provided and match conditions are met, this property defines the path/resource/query string to rewrite URL for the incoming request.
    useIncomingQueryString Boolean
    If set to true, the Cloudlet includes the query string from the request in the rewritten or forwarded URL.
    originId string
    The ID of the Conditional Origin requests are forwarded to
    pathAndQs string
    If a value is provided and match conditions are met, this property defines the path/resource/query string to rewrite URL for the incoming request.
    useIncomingQueryString boolean
    If set to true, the Cloudlet includes the query string from the request in the rewritten or forwarded URL.
    origin_id str
    The ID of the Conditional Origin requests are forwarded to
    path_and_qs str
    If a value is provided and match conditions are met, this property defines the path/resource/query string to rewrite URL for the incoming request.
    use_incoming_query_string bool
    If set to true, the Cloudlet includes the query string from the request in the rewritten or forwarded URL.
    originId String
    The ID of the Conditional Origin requests are forwarded to
    pathAndQs String
    If a value is provided and match conditions are met, this property defines the path/resource/query string to rewrite URL for the incoming request.
    useIncomingQueryString Boolean
    If set to true, the Cloudlet includes the query string from the request in the rewritten or forwarded URL.

    GetCloudletsForwardRewriteMatchRuleMatchRuleMatch

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

    GetCloudletsForwardRewriteMatchRuleMatchRuleMatchObjectMatchValue

    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
    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 GetCloudletsForwardRewriteMatchRuleMatchRuleMatchObjectMatchValueOptions
    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 or range 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
    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 GetCloudletsForwardRewriteMatchRuleMatchRuleMatchObjectMatchValueOptions
    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 or range 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
    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 GetCloudletsForwardRewriteMatchRuleMatchRuleMatchObjectMatchValueOptions
    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 or range 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
    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 GetCloudletsForwardRewriteMatchRuleMatchRuleMatchObjectMatchValueOptions
    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 or range 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_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 GetCloudletsForwardRewriteMatchRuleMatchRuleMatchObjectMatchValueOptions
    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 or range 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
    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 or range type)

    GetCloudletsForwardRewriteMatchRuleMatchRuleMatchObjectMatchValueOptions

    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 logo
    Akamai v10.2.0 published on Friday, Nov 14, 2025 by Pulumi
    Schema (JSON)
    pulumi/pulumi-akamai
      Meet Neo: Your AI Platform Teammate