akamai.getCloudletsForwardRewriteMatchRule

Every policy version specifies the match rules that govern how the Cloudlet is used. Matches specify conditions that need to be met in the incoming request.

Use the akamai.getCloudletsForwardRewriteMatchRule data source to build a match rule JSON object for the Forward Rewrite Cloudlet.

Basic usage

This example returns the JSON-encoded rules for the Forward Rewrite Cloudlet:

import * as pulumi from "@pulumi/pulumi";
import * as akamai from "@pulumi/akamai";

const example = akamai.getCloudletsForwardRewriteMatchRule({
    matchRules: [{
        forwardSettings: {
            originId: "1234",
            pathAndQs: "/path",
            useIncomingQueryString: true,
        },
        matches: [{
            caseSensitive: false,
            checkIps: "CONNECTING_IP XFF_HEADERS",
            matchOperator: "equals",
            matchType: "clientip",
            matchValue: "192.0.2.0",
            negate: false,
        }],
        name: "rule",
    }],
});
import pulumi
import pulumi_akamai as akamai

example = akamai.get_cloudlets_forward_rewrite_match_rule(match_rules=[akamai.GetCloudletsForwardRewriteMatchRuleMatchRuleArgs(
    forward_settings=akamai.GetCloudletsForwardRewriteMatchRuleMatchRuleForwardSettingsArgs(
        origin_id="1234",
        path_and_qs="/path",
        use_incoming_query_string=True,
    ),
    matches=[akamai.GetCloudletsForwardRewriteMatchRuleMatchRuleMatchArgs(
        case_sensitive=False,
        check_ips="CONNECTING_IP XFF_HEADERS",
        match_operator="equals",
        match_type="clientip",
        match_value="192.0.2.0",
        negate=False,
    )],
    name="rule",
)])
using System.Collections.Generic;
using Pulumi;
using Akamai = Pulumi.Akamai;

return await Deployment.RunAsync(() => 
{
    var example = Akamai.GetCloudletsForwardRewriteMatchRule.Invoke(new()
    {
        MatchRules = new[]
        {
            new Akamai.Inputs.GetCloudletsForwardRewriteMatchRuleMatchRuleInputArgs
            {
                ForwardSettings = new Akamai.Inputs.GetCloudletsForwardRewriteMatchRuleMatchRuleForwardSettingsInputArgs
                {
                    OriginId = "1234",
                    PathAndQs = "/path",
                    UseIncomingQueryString = true,
                },
                Matches = new[]
                {
                    new Akamai.Inputs.GetCloudletsForwardRewriteMatchRuleMatchRuleMatchInputArgs
                    {
                        CaseSensitive = false,
                        CheckIps = "CONNECTING_IP XFF_HEADERS",
                        MatchOperator = "equals",
                        MatchType = "clientip",
                        MatchValue = "192.0.2.0",
                        Negate = false,
                    },
                },
                Name = "rule",
            },
        },
    });

});
package main

import (
	"github.com/pulumi/pulumi-akamai/sdk/v4/go/akamai"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := akamai.GetCloudletsForwardRewriteMatchRule(ctx, &akamai.GetCloudletsForwardRewriteMatchRuleArgs{
			MatchRules: []akamai.GetCloudletsForwardRewriteMatchRuleMatchRule{
				{
					ForwardSettings: {
						OriginId:               pulumi.StringRef("1234"),
						PathAndQs:              pulumi.StringRef("/path"),
						UseIncomingQueryString: pulumi.BoolRef(true),
					},
					Matches: []akamai.GetCloudletsForwardRewriteMatchRuleMatchRuleMatch{
						{
							CaseSensitive: pulumi.BoolRef(false),
							CheckIps:      pulumi.StringRef("CONNECTING_IP XFF_HEADERS"),
							MatchOperator: pulumi.StringRef("equals"),
							MatchType:     pulumi.StringRef("clientip"),
							MatchValue:    pulumi.StringRef("192.0.2.0"),
							Negate:        pulumi.BoolRef(false),
						},
					},
					Name: pulumi.StringRef("rule"),
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.akamai.AkamaiFunctions;
import com.pulumi.akamai.inputs.GetCloudletsForwardRewriteMatchRuleArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = AkamaiFunctions.getCloudletsForwardRewriteMatchRule(GetCloudletsForwardRewriteMatchRuleArgs.builder()
            .matchRules(GetCloudletsForwardRewriteMatchRuleMatchRuleArgs.builder()
                .forwardSettings(GetCloudletsForwardRewriteMatchRuleMatchRuleForwardSettingsArgs.builder()
                    .originId("1234")
                    .pathAndQs("/path")
                    .useIncomingQueryString(true)
                    .build())
                .matches(GetCloudletsForwardRewriteMatchRuleMatchRuleMatchArgs.builder()
                    .caseSensitive(false)
                    .checkIps("CONNECTING_IP XFF_HEADERS")
                    .matchOperator("equals")
                    .matchType("clientip")
                    .matchValue("192.0.2.0")
                    .negate(false)
                    .build())
                .name("rule")
                .build())
            .build());

    }
}
variables:
  example:
    fn::invoke:
      Function: akamai:getCloudletsForwardRewriteMatchRule
      Arguments:
        matchRules:
          - forwardSettings:
              originId: '1234'
              pathAndQs: /path
              useIncomingQueryString: true
            matches:
              - caseSensitive: false
                checkIps: CONNECTING_IP XFF_HEADERS
                matchOperator: equals
                matchType: clientip
                matchValue: 192.0.2.0
                negate: false
            name: rule

Attributes reference

This data source returns these attributes:

  • type - The type of Cloudlet the rule is for.
  • json - A match_rules JSON structure generated from the API schema that defines the rules for this policy.

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)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: akamai:index/getCloudletsForwardRewriteMatchRule:getCloudletsForwardRewriteMatchRule
  arguments:
    # arguments dictionary

The following arguments are supported:

MatchRules List<GetCloudletsForwardRewriteMatchRuleMatchRule>

(Optional) A list of Cloudlet-specific match rules for a policy.

MatchRules []GetCloudletsForwardRewriteMatchRuleMatchRule

(Optional) A list of Cloudlet-specific match rules for a policy.

matchRules List<GetCloudletsForwardRewriteMatchRuleMatchRule>

(Optional) A list of Cloudlet-specific match rules for a policy.

matchRules GetCloudletsForwardRewriteMatchRuleMatchRule[]

(Optional) A list of Cloudlet-specific match rules for a policy.

match_rules Sequence[GetCloudletsForwardRewriteMatchRuleMatchRule]

(Optional) A list of Cloudlet-specific match rules for a policy.

matchRules List<Property Map>

(Optional) A list of Cloudlet-specific match rules for a policy.

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

(Required) The data used to construct a new request URL if all match conditions are met. If all conditions are met, the edge server returns an HTTP response from the rewritten URL.

Type string

(Required) The type of the array, either object or simple. Use the simple option when adding only an array of string-based values.

Disabled bool

(Optional) Whether to disable a rule so it is not evaluated against incoming requests.

End int

(Optional) The end time for this match. Specify the value in UTC in seconds since the epoch.

MatchUrl string

(Optional) If you're using a URL match, this specifies the URL that the Cloudlet uses to match the incoming request.

Matches List<GetCloudletsForwardRewriteMatchRuleMatchRuleMatch>

(Optional) A list of conditions to apply to a Cloudlet, including:

Name string

(Optional) If you're using a match_type that supports name attributes, specify the part the incoming request to match on, either cookie, header, parameter, or query.

Start int

(Optional) The start time for this match. Specify the value in UTC in seconds since the epoch.

ForwardSettings GetCloudletsForwardRewriteMatchRuleMatchRuleForwardSettings

(Required) The data used to construct a new request URL if all match conditions are met. If all conditions are met, the edge server returns an HTTP response from the rewritten URL.

Type string

(Required) The type of the array, either object or simple. Use the simple option when adding only an array of string-based values.

Disabled bool

(Optional) Whether to disable a rule so it is not evaluated against incoming requests.

End int

(Optional) The end time for this match. Specify the value in UTC in seconds since the epoch.

MatchUrl string

(Optional) If you're using a URL match, this specifies the URL that the Cloudlet uses to match the incoming request.

Matches []GetCloudletsForwardRewriteMatchRuleMatchRuleMatch

(Optional) A list of conditions to apply to a Cloudlet, including:

Name string

(Optional) If you're using a match_type that supports name attributes, specify the part the incoming request to match on, either cookie, header, parameter, or query.

Start int

(Optional) The start time for this match. Specify the value in UTC in seconds since the epoch.

forwardSettings GetCloudletsForwardRewriteMatchRuleMatchRuleForwardSettings

(Required) The data used to construct a new request URL if all match conditions are met. If all conditions are met, the edge server returns an HTTP response from the rewritten URL.

type String

(Required) The type of the array, either object or simple. Use the simple option when adding only an array of string-based values.

disabled Boolean

(Optional) Whether to disable a rule so it is not evaluated against incoming requests.

end Integer

(Optional) The end time for this match. Specify the value in UTC in seconds since the epoch.

matchUrl String

(Optional) If you're using a URL match, this specifies the URL that the Cloudlet uses to match the incoming request.

matches List<GetCloudletsForwardRewriteMatchRuleMatchRuleMatch>

(Optional) A list of conditions to apply to a Cloudlet, including:

name String

(Optional) If you're using a match_type that supports name attributes, specify the part the incoming request to match on, either cookie, header, parameter, or query.

start Integer

(Optional) The start time for this match. Specify the value in UTC in seconds since the epoch.

forwardSettings GetCloudletsForwardRewriteMatchRuleMatchRuleForwardSettings

(Required) The data used to construct a new request URL if all match conditions are met. If all conditions are met, the edge server returns an HTTP response from the rewritten URL.

type string

(Required) The type of the array, either object or simple. Use the simple option when adding only an array of string-based values.

disabled boolean

(Optional) Whether to disable a rule so it is not evaluated against incoming requests.

end number

(Optional) The end time for this match. Specify the value in UTC in seconds since the epoch.

matchUrl string

(Optional) If you're using a URL match, this specifies the URL that the Cloudlet uses to match the incoming request.

matches GetCloudletsForwardRewriteMatchRuleMatchRuleMatch[]

(Optional) A list of conditions to apply to a Cloudlet, including:

name string

(Optional) If you're using a match_type that supports name attributes, specify the part the incoming request to match on, either cookie, header, parameter, or query.

start number

(Optional) The start time for this match. Specify the value in UTC in seconds since the epoch.

forward_settings GetCloudletsForwardRewriteMatchRuleMatchRuleForwardSettings

(Required) The data used to construct a new request URL if all match conditions are met. If all conditions are met, the edge server returns an HTTP response from the rewritten URL.

type str

(Required) The type of the array, either object or simple. Use the simple option when adding only an array of string-based values.

disabled bool

(Optional) Whether to disable a rule so it is not evaluated against incoming requests.

end int

(Optional) The end time for this match. Specify the value in UTC in seconds since the epoch.

match_url str

(Optional) If you're using a URL match, this specifies the URL that the Cloudlet uses to match the incoming request.

matches Sequence[GetCloudletsForwardRewriteMatchRuleMatchRuleMatch]

(Optional) A list of conditions to apply to a Cloudlet, including:

name str

(Optional) If you're using a match_type that supports name attributes, specify the part the incoming request to match on, either cookie, header, parameter, or query.

start int

(Optional) The start time for this match. Specify the value in UTC in seconds since the epoch.

forwardSettings Property Map

(Required) The data used to construct a new request URL if all match conditions are met. If all conditions are met, the edge server returns an HTTP response from the rewritten URL.

type String

(Required) The type of the array, either object or simple. Use the simple option when adding only an array of string-based values.

disabled Boolean

(Optional) Whether to disable a rule so it is not evaluated against incoming requests.

end Number

(Optional) The end time for this match. Specify the value in UTC in seconds since the epoch.

matchUrl String

(Optional) If you're using a URL match, this specifies the URL that the Cloudlet uses to match the incoming request.

matches List<Property Map>

(Optional) A list of conditions to apply to a Cloudlet, including:

name String

(Optional) If you're using a match_type that supports name attributes, specify the part the incoming request to match on, either cookie, header, parameter, or query.

start Number

(Optional) The start time for this match. Specify the value in UTC in seconds since the epoch.

GetCloudletsForwardRewriteMatchRuleMatchRuleForwardSettings

OriginId string

(Optional) The ID of the new origin requests are forwarded to. This type of origin is known as a Conditional Origin. See Property requirements for Cloudlets that forward requests to learn more.

PathAndQs string

(Optional) When match conditions are met, this value defines the path, resource, or query string added to the rewritten URL.

UseIncomingQueryString bool

(Optional) Whether the Cloudlet should include the query string from the request in the rewritten or forwarded URL.

OriginId string

(Optional) The ID of the new origin requests are forwarded to. This type of origin is known as a Conditional Origin. See Property requirements for Cloudlets that forward requests to learn more.

PathAndQs string

(Optional) When match conditions are met, this value defines the path, resource, or query string added to the rewritten URL.

UseIncomingQueryString bool

(Optional) Whether the Cloudlet should include the query string from the request in the rewritten or forwarded URL.

originId String

(Optional) The ID of the new origin requests are forwarded to. This type of origin is known as a Conditional Origin. See Property requirements for Cloudlets that forward requests to learn more.

pathAndQs String

(Optional) When match conditions are met, this value defines the path, resource, or query string added to the rewritten URL.

useIncomingQueryString Boolean

(Optional) Whether the Cloudlet should include the query string from the request in the rewritten or forwarded URL.

originId string

(Optional) The ID of the new origin requests are forwarded to. This type of origin is known as a Conditional Origin. See Property requirements for Cloudlets that forward requests to learn more.

pathAndQs string

(Optional) When match conditions are met, this value defines the path, resource, or query string added to the rewritten URL.

useIncomingQueryString boolean

(Optional) Whether the Cloudlet should include the query string from the request in the rewritten or forwarded URL.

origin_id str

(Optional) The ID of the new origin requests are forwarded to. This type of origin is known as a Conditional Origin. See Property requirements for Cloudlets that forward requests to learn more.

path_and_qs str

(Optional) When match conditions are met, this value defines the path, resource, or query string added to the rewritten URL.

use_incoming_query_string bool

(Optional) Whether the Cloudlet should include the query string from the request in the rewritten or forwarded URL.

originId String

(Optional) The ID of the new origin requests are forwarded to. This type of origin is known as a Conditional Origin. See Property requirements for Cloudlets that forward requests to learn more.

pathAndQs String

(Optional) When match conditions are met, this value defines the path, resource, or query string added to the rewritten URL.

useIncomingQueryString Boolean

(Optional) Whether the Cloudlet should include the query string from the request in the rewritten or forwarded URL.

GetCloudletsForwardRewriteMatchRuleMatchRuleMatch

CaseSensitive bool

(Optional) Whether the match is case sensitive.

CheckIps string

(Optional) For clientip, continent, countrycode, proxy, and regioncode match types, this defines the part of the request that determines the IP address to use. Values include the connecting IP address (CONNECTING_IP) and the X_Forwarded_For header (XFF_HEADERS). To select both, enter the two values separated by a space delimiter. When both values are included, the connecting IP address is evaluated first.

MatchOperator string

(Optional) Compares a string expression with a pattern, either contains, exists, or equals.

MatchType string

(Optional) The type of match used, either header, hostname, path, extension, query, regex, cookie, deviceCharacteristics, clientip, continent, countrycode, regioncode, protocol, method, or proxy.

MatchValue string

(Optional) This depends on the match_type. If the match_type is hostname, then match_value is the fully qualified domain name, like www.akamai.com.

Negate bool

(Optional) Whether to negate the match.

ObjectMatchValues List<GetCloudletsForwardRewriteMatchRuleMatchRuleMatchObjectMatchValue>

(Optional) If match_value is empty, this argument is required. An object used when a rule includes more complex match criteria, like multiple value attributes. Includes these sub-arguments:

CaseSensitive bool

(Optional) Whether the match is case sensitive.

CheckIps string

(Optional) For clientip, continent, countrycode, proxy, and regioncode match types, this defines the part of the request that determines the IP address to use. Values include the connecting IP address (CONNECTING_IP) and the X_Forwarded_For header (XFF_HEADERS). To select both, enter the two values separated by a space delimiter. When both values are included, the connecting IP address is evaluated first.

MatchOperator string

(Optional) Compares a string expression with a pattern, either contains, exists, or equals.

MatchType string

(Optional) The type of match used, either header, hostname, path, extension, query, regex, cookie, deviceCharacteristics, clientip, continent, countrycode, regioncode, protocol, method, or proxy.

MatchValue string

(Optional) This depends on the match_type. If the match_type is hostname, then match_value is the fully qualified domain name, like www.akamai.com.

Negate bool

(Optional) Whether to negate the match.

ObjectMatchValues []GetCloudletsForwardRewriteMatchRuleMatchRuleMatchObjectMatchValue

(Optional) If match_value is empty, this argument is required. An object used when a rule includes more complex match criteria, like multiple value attributes. Includes these sub-arguments:

caseSensitive Boolean

(Optional) Whether the match is case sensitive.

checkIps String

(Optional) For clientip, continent, countrycode, proxy, and regioncode match types, this defines the part of the request that determines the IP address to use. Values include the connecting IP address (CONNECTING_IP) and the X_Forwarded_For header (XFF_HEADERS). To select both, enter the two values separated by a space delimiter. When both values are included, the connecting IP address is evaluated first.

matchOperator String

(Optional) Compares a string expression with a pattern, either contains, exists, or equals.

matchType String

(Optional) The type of match used, either header, hostname, path, extension, query, regex, cookie, deviceCharacteristics, clientip, continent, countrycode, regioncode, protocol, method, or proxy.

matchValue String

(Optional) This depends on the match_type. If the match_type is hostname, then match_value is the fully qualified domain name, like www.akamai.com.

negate Boolean

(Optional) Whether to negate the match.

objectMatchValues List<GetCloudletsForwardRewriteMatchRuleMatchRuleMatchObjectMatchValue>

(Optional) If match_value is empty, this argument is required. An object used when a rule includes more complex match criteria, like multiple value attributes. Includes these sub-arguments:

caseSensitive boolean

(Optional) Whether the match is case sensitive.

checkIps string

(Optional) For clientip, continent, countrycode, proxy, and regioncode match types, this defines the part of the request that determines the IP address to use. Values include the connecting IP address (CONNECTING_IP) and the X_Forwarded_For header (XFF_HEADERS). To select both, enter the two values separated by a space delimiter. When both values are included, the connecting IP address is evaluated first.

matchOperator string

(Optional) Compares a string expression with a pattern, either contains, exists, or equals.

matchType string

(Optional) The type of match used, either header, hostname, path, extension, query, regex, cookie, deviceCharacteristics, clientip, continent, countrycode, regioncode, protocol, method, or proxy.

matchValue string

(Optional) This depends on the match_type. If the match_type is hostname, then match_value is the fully qualified domain name, like www.akamai.com.

negate boolean

(Optional) Whether to negate the match.

objectMatchValues GetCloudletsForwardRewriteMatchRuleMatchRuleMatchObjectMatchValue[]

(Optional) If match_value is empty, this argument is required. An object used when a rule includes more complex match criteria, like multiple value attributes. Includes these sub-arguments:

case_sensitive bool

(Optional) Whether the match is case sensitive.

check_ips str

(Optional) For clientip, continent, countrycode, proxy, and regioncode match types, this defines the part of the request that determines the IP address to use. Values include the connecting IP address (CONNECTING_IP) and the X_Forwarded_For header (XFF_HEADERS). To select both, enter the two values separated by a space delimiter. When both values are included, the connecting IP address is evaluated first.

match_operator str

(Optional) Compares a string expression with a pattern, either contains, exists, or equals.

match_type str

(Optional) The type of match used, either header, hostname, path, extension, query, regex, cookie, deviceCharacteristics, clientip, continent, countrycode, regioncode, protocol, method, or proxy.

match_value str

(Optional) This depends on the match_type. If the match_type is hostname, then match_value is the fully qualified domain name, like www.akamai.com.

negate bool

(Optional) Whether to negate the match.

object_match_values Sequence[GetCloudletsForwardRewriteMatchRuleMatchRuleMatchObjectMatchValue]

(Optional) If match_value is empty, this argument is required. An object used when a rule includes more complex match criteria, like multiple value attributes. Includes these sub-arguments:

caseSensitive Boolean

(Optional) Whether the match is case sensitive.

checkIps String

(Optional) For clientip, continent, countrycode, proxy, and regioncode match types, this defines the part of the request that determines the IP address to use. Values include the connecting IP address (CONNECTING_IP) and the X_Forwarded_For header (XFF_HEADERS). To select both, enter the two values separated by a space delimiter. When both values are included, the connecting IP address is evaluated first.

matchOperator String

(Optional) Compares a string expression with a pattern, either contains, exists, or equals.

matchType String

(Optional) The type of match used, either header, hostname, path, extension, query, regex, cookie, deviceCharacteristics, clientip, continent, countrycode, regioncode, protocol, method, or proxy.

matchValue String

(Optional) This depends on the match_type. If the match_type is hostname, then match_value is the fully qualified domain name, like www.akamai.com.

negate Boolean

(Optional) Whether to negate the match.

objectMatchValues List<Property Map>

(Optional) If match_value is empty, this argument is required. An object used when a rule includes more complex match criteria, like multiple value attributes. Includes these sub-arguments:

GetCloudletsForwardRewriteMatchRuleMatchRuleMatchObjectMatchValue

Type string

(Required) The type of the array, either object or simple. Use the simple option when adding only an array of string-based values.

Name string

(Optional) If you're using a match_type that supports name attributes, specify the part the incoming request to match on, either cookie, header, parameter, or query.

NameCaseSensitive bool

(Optional) Whether the name argument should be evaluated based on case sensitivity.

NameHasWildcard bool

(Optional) Whether the name argument includes wildcards.

Options GetCloudletsForwardRewriteMatchRuleMatchRuleMatchObjectMatchValueOptions

(Optional) If you set the type argument to object, use this array to list the values to match on.

Values List<string>

(Optional) If you set the type argument to simple, specify the values in the incoming request to match on.

Type string

(Required) The type of the array, either object or simple. Use the simple option when adding only an array of string-based values.

Name string

(Optional) If you're using a match_type that supports name attributes, specify the part the incoming request to match on, either cookie, header, parameter, or query.

NameCaseSensitive bool

(Optional) Whether the name argument should be evaluated based on case sensitivity.

NameHasWildcard bool

(Optional) Whether the name argument includes wildcards.

Options GetCloudletsForwardRewriteMatchRuleMatchRuleMatchObjectMatchValueOptions

(Optional) If you set the type argument to object, use this array to list the values to match on.

Values []string

(Optional) If you set the type argument to simple, specify the values in the incoming request to match on.

type String

(Required) The type of the array, either object or simple. Use the simple option when adding only an array of string-based values.

name String

(Optional) If you're using a match_type that supports name attributes, specify the part the incoming request to match on, either cookie, header, parameter, or query.

nameCaseSensitive Boolean

(Optional) Whether the name argument should be evaluated based on case sensitivity.

nameHasWildcard Boolean

(Optional) Whether the name argument includes wildcards.

options GetCloudletsForwardRewriteMatchRuleMatchRuleMatchObjectMatchValueOptions

(Optional) If you set the type argument to object, use this array to list the values to match on.

values List<String>

(Optional) If you set the type argument to simple, specify the values in the incoming request to match on.

type string

(Required) The type of the array, either object or simple. Use the simple option when adding only an array of string-based values.

name string

(Optional) If you're using a match_type that supports name attributes, specify the part the incoming request to match on, either cookie, header, parameter, or query.

nameCaseSensitive boolean

(Optional) Whether the name argument should be evaluated based on case sensitivity.

nameHasWildcard boolean

(Optional) Whether the name argument includes wildcards.

options GetCloudletsForwardRewriteMatchRuleMatchRuleMatchObjectMatchValueOptions

(Optional) If you set the type argument to object, use this array to list the values to match on.

values string[]

(Optional) If you set the type argument to simple, specify the values in the incoming request to match on.

type str

(Required) The type of the array, either object or simple. Use the simple option when adding only an array of string-based values.

name str

(Optional) If you're using a match_type that supports name attributes, specify the part the incoming request to match on, either cookie, header, parameter, or query.

name_case_sensitive bool

(Optional) Whether the name argument should be evaluated based on case sensitivity.

name_has_wildcard bool

(Optional) Whether the name argument includes wildcards.

options GetCloudletsForwardRewriteMatchRuleMatchRuleMatchObjectMatchValueOptions

(Optional) If you set the type argument to object, use this array to list the values to match on.

values Sequence[str]

(Optional) If you set the type argument to simple, specify the values in the incoming request to match on.

type String

(Required) The type of the array, either object or simple. Use the simple option when adding only an array of string-based values.

name String

(Optional) If you're using a match_type that supports name attributes, specify the part the incoming request to match on, either cookie, header, parameter, or query.

nameCaseSensitive Boolean

(Optional) Whether the name argument should be evaluated based on case sensitivity.

nameHasWildcard Boolean

(Optional) Whether the name argument includes wildcards.

options Property Map

(Optional) If you set the type argument to object, use this array to list the values to match on.

values List<String>

(Optional) If you set the type argument to simple, specify the values in the incoming request to match on.

GetCloudletsForwardRewriteMatchRuleMatchRuleMatchObjectMatchValueOptions

ValueCaseSensitive bool

(Optional) Whether the value argument should be evaluated based on case sensitivity.

ValueEscaped bool

(Optional) Whether the value argument should be compared in an escaped form.

ValueHasWildcard bool

(Optional) Whether the value argument includes wildcards.

Values List<string>

(Optional) If you set the type argument to simple, specify the values in the incoming request to match on.

ValueCaseSensitive bool

(Optional) Whether the value argument should be evaluated based on case sensitivity.

ValueEscaped bool

(Optional) Whether the value argument should be compared in an escaped form.

ValueHasWildcard bool

(Optional) Whether the value argument includes wildcards.

Values []string

(Optional) If you set the type argument to simple, specify the values in the incoming request to match on.

valueCaseSensitive Boolean

(Optional) Whether the value argument should be evaluated based on case sensitivity.

valueEscaped Boolean

(Optional) Whether the value argument should be compared in an escaped form.

valueHasWildcard Boolean

(Optional) Whether the value argument includes wildcards.

values List<String>

(Optional) If you set the type argument to simple, specify the values in the incoming request to match on.

valueCaseSensitive boolean

(Optional) Whether the value argument should be evaluated based on case sensitivity.

valueEscaped boolean

(Optional) Whether the value argument should be compared in an escaped form.

valueHasWildcard boolean

(Optional) Whether the value argument includes wildcards.

values string[]

(Optional) If you set the type argument to simple, specify the values in the incoming request to match on.

value_case_sensitive bool

(Optional) Whether the value argument should be evaluated based on case sensitivity.

value_escaped bool

(Optional) Whether the value argument should be compared in an escaped form.

value_has_wildcard bool

(Optional) Whether the value argument includes wildcards.

values Sequence[str]

(Optional) If you set the type argument to simple, specify the values in the incoming request to match on.

valueCaseSensitive Boolean

(Optional) Whether the value argument should be evaluated based on case sensitivity.

valueEscaped Boolean

(Optional) Whether the value argument should be compared in an escaped form.

valueHasWildcard Boolean

(Optional) Whether the value argument includes wildcards.

values List<String>

(Optional) If you set the type argument to simple, specify the values 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.