1. Packages
  2. Fortimanager Provider
  3. API Docs
  4. ObjectWebproxyProfile
fortimanager 1.13.0 published on Thursday, Mar 13, 2025 by fortinetdev

fortimanager.ObjectWebproxyProfile

Explore with Pulumi AI

Configure web proxy profiles.

The following variables have sub resource. Avoid using them together, otherwise conflicts and overwrites may occur.

  • headers: fortimanager.ObjectWebproxyProfileHeaders

Example Usage

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

const trname = new fortimanager.ObjectWebproxyProfile("trname", {
    headerClientIp: "pass",
    headerFrontEndHttps: "add",
    headerViaRequest: "add",
    headerViaResponse: "pass",
    headerXAuthenticatedGroups: "add",
    headerXAuthenticatedUser: "add",
    headerXForwardedFor: "add",
    logHeaderChange: "disable",
    stripEncoding: "enable",
});
Copy
import pulumi
import pulumi_fortimanager as fortimanager

trname = fortimanager.ObjectWebproxyProfile("trname",
    header_client_ip="pass",
    header_front_end_https="add",
    header_via_request="add",
    header_via_response="pass",
    header_x_authenticated_groups="add",
    header_x_authenticated_user="add",
    header_x_forwarded_for="add",
    log_header_change="disable",
    strip_encoding="enable")
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/fortimanager/fortimanager"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := fortimanager.NewObjectWebproxyProfile(ctx, "trname", &fortimanager.ObjectWebproxyProfileArgs{
			HeaderClientIp:             pulumi.String("pass"),
			HeaderFrontEndHttps:        pulumi.String("add"),
			HeaderViaRequest:           pulumi.String("add"),
			HeaderViaResponse:          pulumi.String("pass"),
			HeaderXAuthenticatedGroups: pulumi.String("add"),
			HeaderXAuthenticatedUser:   pulumi.String("add"),
			HeaderXForwardedFor:        pulumi.String("add"),
			LogHeaderChange:            pulumi.String("disable"),
			StripEncoding:              pulumi.String("enable"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Fortimanager = Pulumi.Fortimanager;

return await Deployment.RunAsync(() => 
{
    var trname = new Fortimanager.ObjectWebproxyProfile("trname", new()
    {
        HeaderClientIp = "pass",
        HeaderFrontEndHttps = "add",
        HeaderViaRequest = "add",
        HeaderViaResponse = "pass",
        HeaderXAuthenticatedGroups = "add",
        HeaderXAuthenticatedUser = "add",
        HeaderXForwardedFor = "add",
        LogHeaderChange = "disable",
        StripEncoding = "enable",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fortimanager.ObjectWebproxyProfile;
import com.pulumi.fortimanager.ObjectWebproxyProfileArgs;
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) {
        var trname = new ObjectWebproxyProfile("trname", ObjectWebproxyProfileArgs.builder()
            .headerClientIp("pass")
            .headerFrontEndHttps("add")
            .headerViaRequest("add")
            .headerViaResponse("pass")
            .headerXAuthenticatedGroups("add")
            .headerXAuthenticatedUser("add")
            .headerXForwardedFor("add")
            .logHeaderChange("disable")
            .stripEncoding("enable")
            .build());

    }
}
Copy
resources:
  trname:
    type: fortimanager:ObjectWebproxyProfile
    properties:
      headerClientIp: pass
      headerFrontEndHttps: add
      headerViaRequest: add
      headerViaResponse: pass
      headerXAuthenticatedGroups: add
      headerXAuthenticatedUser: add
      headerXForwardedFor: add
      logHeaderChange: disable
      stripEncoding: enable
Copy

Create ObjectWebproxyProfile Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new ObjectWebproxyProfile(name: string, args?: ObjectWebproxyProfileArgs, opts?: CustomResourceOptions);
@overload
def ObjectWebproxyProfile(resource_name: str,
                          args: Optional[ObjectWebproxyProfileArgs] = None,
                          opts: Optional[ResourceOptions] = None)

@overload
def ObjectWebproxyProfile(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          adom: Optional[str] = None,
                          dynamic_sort_subtable: Optional[str] = None,
                          header_client_ip: Optional[str] = None,
                          header_front_end_https: Optional[str] = None,
                          header_via_request: Optional[str] = None,
                          header_via_response: Optional[str] = None,
                          header_x_authenticated_groups: Optional[str] = None,
                          header_x_authenticated_user: Optional[str] = None,
                          header_x_forwarded_client_cert: Optional[str] = None,
                          header_x_forwarded_for: Optional[str] = None,
                          headers: Optional[Sequence[ObjectWebproxyProfileHeaderArgs]] = None,
                          log_header_change: Optional[str] = None,
                          name: Optional[str] = None,
                          object_webproxy_profile_id: Optional[str] = None,
                          scopetype: Optional[str] = None,
                          strip_encoding: Optional[str] = None)
func NewObjectWebproxyProfile(ctx *Context, name string, args *ObjectWebproxyProfileArgs, opts ...ResourceOption) (*ObjectWebproxyProfile, error)
public ObjectWebproxyProfile(string name, ObjectWebproxyProfileArgs? args = null, CustomResourceOptions? opts = null)
public ObjectWebproxyProfile(String name, ObjectWebproxyProfileArgs args)
public ObjectWebproxyProfile(String name, ObjectWebproxyProfileArgs args, CustomResourceOptions options)
type: fortimanager:ObjectWebproxyProfile
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args ObjectWebproxyProfileArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args ObjectWebproxyProfileArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args ObjectWebproxyProfileArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args ObjectWebproxyProfileArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ObjectWebproxyProfileArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var objectWebproxyProfileResource = new Fortimanager.ObjectWebproxyProfile("objectWebproxyProfileResource", new()
{
    Adom = "string",
    DynamicSortSubtable = "string",
    HeaderClientIp = "string",
    HeaderFrontEndHttps = "string",
    HeaderViaRequest = "string",
    HeaderViaResponse = "string",
    HeaderXAuthenticatedGroups = "string",
    HeaderXAuthenticatedUser = "string",
    HeaderXForwardedClientCert = "string",
    HeaderXForwardedFor = "string",
    Headers = new[]
    {
        new Fortimanager.Inputs.ObjectWebproxyProfileHeaderArgs
        {
            Action = "string",
            AddOption = "string",
            Base64Encoding = "string",
            Content = "string",
            Dstaddr = "string",
            Dstaddr6 = "string",
            Id = 0,
            Name = "string",
            Protocols = new[]
            {
                "string",
            },
        },
    },
    LogHeaderChange = "string",
    Name = "string",
    ObjectWebproxyProfileId = "string",
    Scopetype = "string",
    StripEncoding = "string",
});
Copy
example, err := fortimanager.NewObjectWebproxyProfile(ctx, "objectWebproxyProfileResource", &fortimanager.ObjectWebproxyProfileArgs{
Adom: pulumi.String("string"),
DynamicSortSubtable: pulumi.String("string"),
HeaderClientIp: pulumi.String("string"),
HeaderFrontEndHttps: pulumi.String("string"),
HeaderViaRequest: pulumi.String("string"),
HeaderViaResponse: pulumi.String("string"),
HeaderXAuthenticatedGroups: pulumi.String("string"),
HeaderXAuthenticatedUser: pulumi.String("string"),
HeaderXForwardedClientCert: pulumi.String("string"),
HeaderXForwardedFor: pulumi.String("string"),
Headers: .ObjectWebproxyProfileHeaderArray{
&.ObjectWebproxyProfileHeaderArgs{
Action: pulumi.String("string"),
AddOption: pulumi.String("string"),
Base64Encoding: pulumi.String("string"),
Content: pulumi.String("string"),
Dstaddr: pulumi.String("string"),
Dstaddr6: pulumi.String("string"),
Id: pulumi.Float64(0),
Name: pulumi.String("string"),
Protocols: pulumi.StringArray{
pulumi.String("string"),
},
},
},
LogHeaderChange: pulumi.String("string"),
Name: pulumi.String("string"),
ObjectWebproxyProfileId: pulumi.String("string"),
Scopetype: pulumi.String("string"),
StripEncoding: pulumi.String("string"),
})
Copy
var objectWebproxyProfileResource = new ObjectWebproxyProfile("objectWebproxyProfileResource", ObjectWebproxyProfileArgs.builder()
    .adom("string")
    .dynamicSortSubtable("string")
    .headerClientIp("string")
    .headerFrontEndHttps("string")
    .headerViaRequest("string")
    .headerViaResponse("string")
    .headerXAuthenticatedGroups("string")
    .headerXAuthenticatedUser("string")
    .headerXForwardedClientCert("string")
    .headerXForwardedFor("string")
    .headers(ObjectWebproxyProfileHeaderArgs.builder()
        .action("string")
        .addOption("string")
        .base64Encoding("string")
        .content("string")
        .dstaddr("string")
        .dstaddr6("string")
        .id(0)
        .name("string")
        .protocols("string")
        .build())
    .logHeaderChange("string")
    .name("string")
    .objectWebproxyProfileId("string")
    .scopetype("string")
    .stripEncoding("string")
    .build());
Copy
object_webproxy_profile_resource = fortimanager.ObjectWebproxyProfile("objectWebproxyProfileResource",
    adom="string",
    dynamic_sort_subtable="string",
    header_client_ip="string",
    header_front_end_https="string",
    header_via_request="string",
    header_via_response="string",
    header_x_authenticated_groups="string",
    header_x_authenticated_user="string",
    header_x_forwarded_client_cert="string",
    header_x_forwarded_for="string",
    headers=[{
        "action": "string",
        "add_option": "string",
        "base64_encoding": "string",
        "content": "string",
        "dstaddr": "string",
        "dstaddr6": "string",
        "id": 0,
        "name": "string",
        "protocols": ["string"],
    }],
    log_header_change="string",
    name="string",
    object_webproxy_profile_id="string",
    scopetype="string",
    strip_encoding="string")
Copy
const objectWebproxyProfileResource = new fortimanager.ObjectWebproxyProfile("objectWebproxyProfileResource", {
    adom: "string",
    dynamicSortSubtable: "string",
    headerClientIp: "string",
    headerFrontEndHttps: "string",
    headerViaRequest: "string",
    headerViaResponse: "string",
    headerXAuthenticatedGroups: "string",
    headerXAuthenticatedUser: "string",
    headerXForwardedClientCert: "string",
    headerXForwardedFor: "string",
    headers: [{
        action: "string",
        addOption: "string",
        base64Encoding: "string",
        content: "string",
        dstaddr: "string",
        dstaddr6: "string",
        id: 0,
        name: "string",
        protocols: ["string"],
    }],
    logHeaderChange: "string",
    name: "string",
    objectWebproxyProfileId: "string",
    scopetype: "string",
    stripEncoding: "string",
});
Copy
type: fortimanager:ObjectWebproxyProfile
properties:
    adom: string
    dynamicSortSubtable: string
    headerClientIp: string
    headerFrontEndHttps: string
    headerViaRequest: string
    headerViaResponse: string
    headerXAuthenticatedGroups: string
    headerXAuthenticatedUser: string
    headerXForwardedClientCert: string
    headerXForwardedFor: string
    headers:
        - action: string
          addOption: string
          base64Encoding: string
          content: string
          dstaddr: string
          dstaddr6: string
          id: 0
          name: string
          protocols:
            - string
    logHeaderChange: string
    name: string
    objectWebproxyProfileId: string
    scopetype: string
    stripEncoding: string
Copy

ObjectWebproxyProfile Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The ObjectWebproxyProfile resource accepts the following input properties:

Adom string
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
DynamicSortSubtable string
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
HeaderClientIp string
Action to take on the HTTP client-IP header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
HeaderFrontEndHttps string
Action to take on the HTTP front-end-HTTPS header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
HeaderViaRequest string
Action to take on the HTTP via header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
HeaderViaResponse string
Action to take on the HTTP via header in forwarded responses: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
HeaderXAuthenticatedGroups string
Action to take on the HTTP x-authenticated-groups header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
HeaderXAuthenticatedUser string
Action to take on the HTTP x-authenticated-user header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
HeaderXForwardedClientCert string
Action to take on the HTTP x-forwarded-client-cert header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
HeaderXForwardedFor string
Action to take on the HTTP x-forwarded-for header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
Headers List<ObjectWebproxyProfileHeader>
Headers. The structure of headers block is documented below.
LogHeaderChange string
Enable/disable logging HTTP header changes. Valid values: disable, enable.
Name string
Profile name.
ObjectWebproxyProfileId string
an identifier for the resource with format {{name}}.
Scopetype string
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
StripEncoding string
Enable/disable stripping unsupported encoding from the request header. Valid values: disable, enable.
Adom string
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
DynamicSortSubtable string
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
HeaderClientIp string
Action to take on the HTTP client-IP header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
HeaderFrontEndHttps string
Action to take on the HTTP front-end-HTTPS header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
HeaderViaRequest string
Action to take on the HTTP via header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
HeaderViaResponse string
Action to take on the HTTP via header in forwarded responses: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
HeaderXAuthenticatedGroups string
Action to take on the HTTP x-authenticated-groups header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
HeaderXAuthenticatedUser string
Action to take on the HTTP x-authenticated-user header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
HeaderXForwardedClientCert string
Action to take on the HTTP x-forwarded-client-cert header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
HeaderXForwardedFor string
Action to take on the HTTP x-forwarded-for header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
Headers []ObjectWebproxyProfileHeaderArgs
Headers. The structure of headers block is documented below.
LogHeaderChange string
Enable/disable logging HTTP header changes. Valid values: disable, enable.
Name string
Profile name.
ObjectWebproxyProfileId string
an identifier for the resource with format {{name}}.
Scopetype string
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
StripEncoding string
Enable/disable stripping unsupported encoding from the request header. Valid values: disable, enable.
adom String
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
dynamicSortSubtable String
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
headerClientIp String
Action to take on the HTTP client-IP header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
headerFrontEndHttps String
Action to take on the HTTP front-end-HTTPS header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
headerViaRequest String
Action to take on the HTTP via header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
headerViaResponse String
Action to take on the HTTP via header in forwarded responses: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
headerXAuthenticatedGroups String
Action to take on the HTTP x-authenticated-groups header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
headerXAuthenticatedUser String
Action to take on the HTTP x-authenticated-user header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
headerXForwardedClientCert String
Action to take on the HTTP x-forwarded-client-cert header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
headerXForwardedFor String
Action to take on the HTTP x-forwarded-for header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
headers List<ObjectWebproxyProfileHeader>
Headers. The structure of headers block is documented below.
logHeaderChange String
Enable/disable logging HTTP header changes. Valid values: disable, enable.
name String
Profile name.
objectWebproxyProfileId String
an identifier for the resource with format {{name}}.
scopetype String
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
stripEncoding String
Enable/disable stripping unsupported encoding from the request header. Valid values: disable, enable.
adom string
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
dynamicSortSubtable string
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
headerClientIp string
Action to take on the HTTP client-IP header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
headerFrontEndHttps string
Action to take on the HTTP front-end-HTTPS header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
headerViaRequest string
Action to take on the HTTP via header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
headerViaResponse string
Action to take on the HTTP via header in forwarded responses: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
headerXAuthenticatedGroups string
Action to take on the HTTP x-authenticated-groups header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
headerXAuthenticatedUser string
Action to take on the HTTP x-authenticated-user header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
headerXForwardedClientCert string
Action to take on the HTTP x-forwarded-client-cert header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
headerXForwardedFor string
Action to take on the HTTP x-forwarded-for header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
headers ObjectWebproxyProfileHeader[]
Headers. The structure of headers block is documented below.
logHeaderChange string
Enable/disable logging HTTP header changes. Valid values: disable, enable.
name string
Profile name.
objectWebproxyProfileId string
an identifier for the resource with format {{name}}.
scopetype string
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
stripEncoding string
Enable/disable stripping unsupported encoding from the request header. Valid values: disable, enable.
adom str
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
dynamic_sort_subtable str
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
header_client_ip str
Action to take on the HTTP client-IP header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
header_front_end_https str
Action to take on the HTTP front-end-HTTPS header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
header_via_request str
Action to take on the HTTP via header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
header_via_response str
Action to take on the HTTP via header in forwarded responses: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
header_x_authenticated_groups str
Action to take on the HTTP x-authenticated-groups header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
header_x_authenticated_user str
Action to take on the HTTP x-authenticated-user header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
header_x_forwarded_client_cert str
Action to take on the HTTP x-forwarded-client-cert header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
header_x_forwarded_for str
Action to take on the HTTP x-forwarded-for header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
headers Sequence[ObjectWebproxyProfileHeaderArgs]
Headers. The structure of headers block is documented below.
log_header_change str
Enable/disable logging HTTP header changes. Valid values: disable, enable.
name str
Profile name.
object_webproxy_profile_id str
an identifier for the resource with format {{name}}.
scopetype str
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
strip_encoding str
Enable/disable stripping unsupported encoding from the request header. Valid values: disable, enable.
adom String
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
dynamicSortSubtable String
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
headerClientIp String
Action to take on the HTTP client-IP header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
headerFrontEndHttps String
Action to take on the HTTP front-end-HTTPS header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
headerViaRequest String
Action to take on the HTTP via header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
headerViaResponse String
Action to take on the HTTP via header in forwarded responses: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
headerXAuthenticatedGroups String
Action to take on the HTTP x-authenticated-groups header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
headerXAuthenticatedUser String
Action to take on the HTTP x-authenticated-user header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
headerXForwardedClientCert String
Action to take on the HTTP x-forwarded-client-cert header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
headerXForwardedFor String
Action to take on the HTTP x-forwarded-for header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
headers List<Property Map>
Headers. The structure of headers block is documented below.
logHeaderChange String
Enable/disable logging HTTP header changes. Valid values: disable, enable.
name String
Profile name.
objectWebproxyProfileId String
an identifier for the resource with format {{name}}.
scopetype String
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
stripEncoding String
Enable/disable stripping unsupported encoding from the request header. Valid values: disable, enable.

Outputs

All input properties are implicitly available as output properties. Additionally, the ObjectWebproxyProfile resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing ObjectWebproxyProfile Resource

Get an existing ObjectWebproxyProfile resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ObjectWebproxyProfileState, opts?: CustomResourceOptions): ObjectWebproxyProfile
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        adom: Optional[str] = None,
        dynamic_sort_subtable: Optional[str] = None,
        header_client_ip: Optional[str] = None,
        header_front_end_https: Optional[str] = None,
        header_via_request: Optional[str] = None,
        header_via_response: Optional[str] = None,
        header_x_authenticated_groups: Optional[str] = None,
        header_x_authenticated_user: Optional[str] = None,
        header_x_forwarded_client_cert: Optional[str] = None,
        header_x_forwarded_for: Optional[str] = None,
        headers: Optional[Sequence[ObjectWebproxyProfileHeaderArgs]] = None,
        log_header_change: Optional[str] = None,
        name: Optional[str] = None,
        object_webproxy_profile_id: Optional[str] = None,
        scopetype: Optional[str] = None,
        strip_encoding: Optional[str] = None) -> ObjectWebproxyProfile
func GetObjectWebproxyProfile(ctx *Context, name string, id IDInput, state *ObjectWebproxyProfileState, opts ...ResourceOption) (*ObjectWebproxyProfile, error)
public static ObjectWebproxyProfile Get(string name, Input<string> id, ObjectWebproxyProfileState? state, CustomResourceOptions? opts = null)
public static ObjectWebproxyProfile get(String name, Output<String> id, ObjectWebproxyProfileState state, CustomResourceOptions options)
resources:  _:    type: fortimanager:ObjectWebproxyProfile    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Adom string
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
DynamicSortSubtable string
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
HeaderClientIp string
Action to take on the HTTP client-IP header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
HeaderFrontEndHttps string
Action to take on the HTTP front-end-HTTPS header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
HeaderViaRequest string
Action to take on the HTTP via header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
HeaderViaResponse string
Action to take on the HTTP via header in forwarded responses: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
HeaderXAuthenticatedGroups string
Action to take on the HTTP x-authenticated-groups header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
HeaderXAuthenticatedUser string
Action to take on the HTTP x-authenticated-user header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
HeaderXForwardedClientCert string
Action to take on the HTTP x-forwarded-client-cert header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
HeaderXForwardedFor string
Action to take on the HTTP x-forwarded-for header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
Headers List<ObjectWebproxyProfileHeader>
Headers. The structure of headers block is documented below.
LogHeaderChange string
Enable/disable logging HTTP header changes. Valid values: disable, enable.
Name string
Profile name.
ObjectWebproxyProfileId string
an identifier for the resource with format {{name}}.
Scopetype string
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
StripEncoding string
Enable/disable stripping unsupported encoding from the request header. Valid values: disable, enable.
Adom string
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
DynamicSortSubtable string
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
HeaderClientIp string
Action to take on the HTTP client-IP header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
HeaderFrontEndHttps string
Action to take on the HTTP front-end-HTTPS header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
HeaderViaRequest string
Action to take on the HTTP via header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
HeaderViaResponse string
Action to take on the HTTP via header in forwarded responses: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
HeaderXAuthenticatedGroups string
Action to take on the HTTP x-authenticated-groups header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
HeaderXAuthenticatedUser string
Action to take on the HTTP x-authenticated-user header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
HeaderXForwardedClientCert string
Action to take on the HTTP x-forwarded-client-cert header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
HeaderXForwardedFor string
Action to take on the HTTP x-forwarded-for header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
Headers []ObjectWebproxyProfileHeaderArgs
Headers. The structure of headers block is documented below.
LogHeaderChange string
Enable/disable logging HTTP header changes. Valid values: disable, enable.
Name string
Profile name.
ObjectWebproxyProfileId string
an identifier for the resource with format {{name}}.
Scopetype string
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
StripEncoding string
Enable/disable stripping unsupported encoding from the request header. Valid values: disable, enable.
adom String
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
dynamicSortSubtable String
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
headerClientIp String
Action to take on the HTTP client-IP header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
headerFrontEndHttps String
Action to take on the HTTP front-end-HTTPS header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
headerViaRequest String
Action to take on the HTTP via header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
headerViaResponse String
Action to take on the HTTP via header in forwarded responses: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
headerXAuthenticatedGroups String
Action to take on the HTTP x-authenticated-groups header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
headerXAuthenticatedUser String
Action to take on the HTTP x-authenticated-user header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
headerXForwardedClientCert String
Action to take on the HTTP x-forwarded-client-cert header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
headerXForwardedFor String
Action to take on the HTTP x-forwarded-for header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
headers List<ObjectWebproxyProfileHeader>
Headers. The structure of headers block is documented below.
logHeaderChange String
Enable/disable logging HTTP header changes. Valid values: disable, enable.
name String
Profile name.
objectWebproxyProfileId String
an identifier for the resource with format {{name}}.
scopetype String
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
stripEncoding String
Enable/disable stripping unsupported encoding from the request header. Valid values: disable, enable.
adom string
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
dynamicSortSubtable string
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
headerClientIp string
Action to take on the HTTP client-IP header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
headerFrontEndHttps string
Action to take on the HTTP front-end-HTTPS header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
headerViaRequest string
Action to take on the HTTP via header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
headerViaResponse string
Action to take on the HTTP via header in forwarded responses: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
headerXAuthenticatedGroups string
Action to take on the HTTP x-authenticated-groups header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
headerXAuthenticatedUser string
Action to take on the HTTP x-authenticated-user header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
headerXForwardedClientCert string
Action to take on the HTTP x-forwarded-client-cert header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
headerXForwardedFor string
Action to take on the HTTP x-forwarded-for header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
headers ObjectWebproxyProfileHeader[]
Headers. The structure of headers block is documented below.
logHeaderChange string
Enable/disable logging HTTP header changes. Valid values: disable, enable.
name string
Profile name.
objectWebproxyProfileId string
an identifier for the resource with format {{name}}.
scopetype string
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
stripEncoding string
Enable/disable stripping unsupported encoding from the request header. Valid values: disable, enable.
adom str
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
dynamic_sort_subtable str
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
header_client_ip str
Action to take on the HTTP client-IP header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
header_front_end_https str
Action to take on the HTTP front-end-HTTPS header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
header_via_request str
Action to take on the HTTP via header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
header_via_response str
Action to take on the HTTP via header in forwarded responses: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
header_x_authenticated_groups str
Action to take on the HTTP x-authenticated-groups header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
header_x_authenticated_user str
Action to take on the HTTP x-authenticated-user header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
header_x_forwarded_client_cert str
Action to take on the HTTP x-forwarded-client-cert header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
header_x_forwarded_for str
Action to take on the HTTP x-forwarded-for header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
headers Sequence[ObjectWebproxyProfileHeaderArgs]
Headers. The structure of headers block is documented below.
log_header_change str
Enable/disable logging HTTP header changes. Valid values: disable, enable.
name str
Profile name.
object_webproxy_profile_id str
an identifier for the resource with format {{name}}.
scopetype str
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
strip_encoding str
Enable/disable stripping unsupported encoding from the request header. Valid values: disable, enable.
adom String
Adom. This value is valid only when the scopetype is adom, otherwise the value of adom in the provider will be inherited.
dynamicSortSubtable String
true or false, set this parameter to true when using dynamic for_each + toset to configure and sort sub-tables, please do not set this parameter when configuring static sub-tables.
headerClientIp String
Action to take on the HTTP client-IP header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
headerFrontEndHttps String
Action to take on the HTTP front-end-HTTPS header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
headerViaRequest String
Action to take on the HTTP via header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
headerViaResponse String
Action to take on the HTTP via header in forwarded responses: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
headerXAuthenticatedGroups String
Action to take on the HTTP x-authenticated-groups header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
headerXAuthenticatedUser String
Action to take on the HTTP x-authenticated-user header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
headerXForwardedClientCert String
Action to take on the HTTP x-forwarded-client-cert header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
headerXForwardedFor String
Action to take on the HTTP x-forwarded-for header in forwarded requests: forwards (pass), adds, or removes the HTTP header. Valid values: pass, add, remove.
headers List<Property Map>
Headers. The structure of headers block is documented below.
logHeaderChange String
Enable/disable logging HTTP header changes. Valid values: disable, enable.
name String
Profile name.
objectWebproxyProfileId String
an identifier for the resource with format {{name}}.
scopetype String
The scope of application of the resource. Valid values: inherit, adom, global. The inherit means that the scopetype of the provider will be inherited, and adom will also be inherited. The default value is inherit.
stripEncoding String
Enable/disable stripping unsupported encoding from the request header. Valid values: disable, enable.

Supporting Types

ObjectWebproxyProfileHeader
, ObjectWebproxyProfileHeaderArgs

Action string
Action when the HTTP header is forwarded. Valid values: add-to-request, add-to-response, remove-from-request, remove-from-response.
AddOption string
Configure options to append content to existing HTTP header or add new HTTP header. Valid values: append, new-on-not-found, new.
Base64Encoding string
Enable/disable use of base64 encoding of HTTP content. Valid values: disable, enable.
Content string
HTTP header content.
Dstaddr string
Destination address and address group names.
Dstaddr6 string
Destination address and address group names (IPv6).
Id double
HTTP forwarded header id.
Name string
HTTP forwarded header name.
Protocols List<string>
Configure protocol(s) to take add-option action on (HTTP, HTTPS, or both). Valid values: https, http.
Action string
Action when the HTTP header is forwarded. Valid values: add-to-request, add-to-response, remove-from-request, remove-from-response.
AddOption string
Configure options to append content to existing HTTP header or add new HTTP header. Valid values: append, new-on-not-found, new.
Base64Encoding string
Enable/disable use of base64 encoding of HTTP content. Valid values: disable, enable.
Content string
HTTP header content.
Dstaddr string
Destination address and address group names.
Dstaddr6 string
Destination address and address group names (IPv6).
Id float64
HTTP forwarded header id.
Name string
HTTP forwarded header name.
Protocols []string
Configure protocol(s) to take add-option action on (HTTP, HTTPS, or both). Valid values: https, http.
action String
Action when the HTTP header is forwarded. Valid values: add-to-request, add-to-response, remove-from-request, remove-from-response.
addOption String
Configure options to append content to existing HTTP header or add new HTTP header. Valid values: append, new-on-not-found, new.
base64Encoding String
Enable/disable use of base64 encoding of HTTP content. Valid values: disable, enable.
content String
HTTP header content.
dstaddr String
Destination address and address group names.
dstaddr6 String
Destination address and address group names (IPv6).
id Double
HTTP forwarded header id.
name String
HTTP forwarded header name.
protocols List<String>
Configure protocol(s) to take add-option action on (HTTP, HTTPS, or both). Valid values: https, http.
action string
Action when the HTTP header is forwarded. Valid values: add-to-request, add-to-response, remove-from-request, remove-from-response.
addOption string
Configure options to append content to existing HTTP header or add new HTTP header. Valid values: append, new-on-not-found, new.
base64Encoding string
Enable/disable use of base64 encoding of HTTP content. Valid values: disable, enable.
content string
HTTP header content.
dstaddr string
Destination address and address group names.
dstaddr6 string
Destination address and address group names (IPv6).
id number
HTTP forwarded header id.
name string
HTTP forwarded header name.
protocols string[]
Configure protocol(s) to take add-option action on (HTTP, HTTPS, or both). Valid values: https, http.
action str
Action when the HTTP header is forwarded. Valid values: add-to-request, add-to-response, remove-from-request, remove-from-response.
add_option str
Configure options to append content to existing HTTP header or add new HTTP header. Valid values: append, new-on-not-found, new.
base64_encoding str
Enable/disable use of base64 encoding of HTTP content. Valid values: disable, enable.
content str
HTTP header content.
dstaddr str
Destination address and address group names.
dstaddr6 str
Destination address and address group names (IPv6).
id float
HTTP forwarded header id.
name str
HTTP forwarded header name.
protocols Sequence[str]
Configure protocol(s) to take add-option action on (HTTP, HTTPS, or both). Valid values: https, http.
action String
Action when the HTTP header is forwarded. Valid values: add-to-request, add-to-response, remove-from-request, remove-from-response.
addOption String
Configure options to append content to existing HTTP header or add new HTTP header. Valid values: append, new-on-not-found, new.
base64Encoding String
Enable/disable use of base64 encoding of HTTP content. Valid values: disable, enable.
content String
HTTP header content.
dstaddr String
Destination address and address group names.
dstaddr6 String
Destination address and address group names (IPv6).
id Number
HTTP forwarded header id.
name String
HTTP forwarded header name.
protocols List<String>
Configure protocol(s) to take add-option action on (HTTP, HTTPS, or both). Valid values: https, http.

Import

ObjectWebProxy Profile can be imported using any of these accepted formats:

$ export “FORTIMANAGER_IMPORT_TABLE”=“true”

$ pulumi import fortimanager:index/objectWebproxyProfile:ObjectWebproxyProfile labelname {{name}}
Copy

$ unset “FORTIMANAGER_IMPORT_TABLE”

-> Hint: The scopetype and adom for import will directly inherit the scopetype and adom configuration of the provider.

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
fortimanager fortinetdev/terraform-provider-fortimanager
License
Notes
This Pulumi package is based on the fortimanager Terraform Provider.