Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. F5bigip Provider
  3. API Docs
  4. ltm
  5. ProfileHttpCompress
f5 BIG-IP v3.17.9 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-f5bigip

f5bigip.ltm.ProfileHttpCompress

Explore with Pulumi AI

f5bigip logo
f5 BIG-IP v3.17.9 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-f5bigip

    f5bigip.ltm.ProfileHttpCompress Virtual server HTTP compression profile configuration

    Resources should be named with their full path.The full path is the combination of the partition + name (example: /Common/my-httpcompresprofile ) or partition + directory + name of the resource (example: /Common/test/my-httpcompresprofile)

    Example Usage

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

const sjhttpcompression = new f5bigip.ltm.ProfileHttpCompress("sjhttpcompression", {
    name: "/Common/sjhttpcompression2",
    defaultsFrom: "/Common/httpcompression",
    uriExcludes: [
        "www.abc.f5.com",
        "www.abc2.f5.com",
    ],
    uriIncludes: ["www.xyzbc.cisco.com"],
    contentTypeIncludes: ["nicecontent.com"],
    contentTypeExcludes: ["nicecontentexclude.com"],
});

    import pulumi
import pulumi_f5bigip as f5bigip

sjhttpcompression = f5bigip.ltm.ProfileHttpCompress("sjhttpcompression",
    name="/Common/sjhttpcompression2",
    defaults_from="/Common/httpcompression",
    uri_excludes=[
        "www.abc.f5.com",
        "www.abc2.f5.com",
    ],
    uri_includes=["www.xyzbc.cisco.com"],
    content_type_includes=["nicecontent.com"],
    content_type_excludes=["nicecontentexclude.com"])

    package main

import (
	"github.com/pulumi/pulumi-f5bigip/sdk/v3/go/f5bigip/ltm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ltm.NewProfileHttpCompress(ctx, "sjhttpcompression", &ltm.ProfileHttpCompressArgs{
			Name:         pulumi.String("/Common/sjhttpcompression2"),
			DefaultsFrom: pulumi.String("/Common/httpcompression"),
			UriExcludes: pulumi.StringArray{
				pulumi.String("www.abc.f5.com"),
				pulumi.String("www.abc2.f5.com"),
			},
			UriIncludes: pulumi.StringArray{
				pulumi.String("www.xyzbc.cisco.com"),
			},
			ContentTypeIncludes: pulumi.StringArray{
				pulumi.String("nicecontent.com"),
			},
			ContentTypeExcludes: pulumi.StringArray{
				pulumi.String("nicecontentexclude.com"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using F5BigIP = Pulumi.F5BigIP;

return await Deployment.RunAsync(() => 
{
    var sjhttpcompression = new F5BigIP.Ltm.ProfileHttpCompress("sjhttpcompression", new()
    {
        Name = "/Common/sjhttpcompression2",
        DefaultsFrom = "/Common/httpcompression",
        UriExcludes = new[]
        {
            "www.abc.f5.com",
            "www.abc2.f5.com",
        },
        UriIncludes = new[]
        {
            "www.xyzbc.cisco.com",
        },
        ContentTypeIncludes = new[]
        {
            "nicecontent.com",
        },
        ContentTypeExcludes = new[]
        {
            "nicecontentexclude.com",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.f5bigip.ltm.ProfileHttpCompress;
import com.pulumi.f5bigip.ltm.ProfileHttpCompressArgs;
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 sjhttpcompression = new ProfileHttpCompress("sjhttpcompression", ProfileHttpCompressArgs.builder()
            .name("/Common/sjhttpcompression2")
            .defaultsFrom("/Common/httpcompression")
            .uriExcludes(            
                "www.abc.f5.com",
                "www.abc2.f5.com")
            .uriIncludes("www.xyzbc.cisco.com")
            .contentTypeIncludes("nicecontent.com")
            .contentTypeExcludes("nicecontentexclude.com")
            .build());

    }
}

    resources:
  sjhttpcompression:
    type: f5bigip:ltm:ProfileHttpCompress
    properties:
      name: /Common/sjhttpcompression2
      defaultsFrom: /Common/httpcompression
      uriExcludes:
        - www.abc.f5.com
        - www.abc2.f5.com
      uriIncludes:
        - www.xyzbc.cisco.com
      contentTypeIncludes:
        - nicecontent.com
      contentTypeExcludes:
        - nicecontentexclude.com

    Create ProfileHttpCompress Resource

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

    Constructor syntax

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

@overload
def ProfileHttpCompress(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        name: Optional[str] = None,
                        cpu_saver: Optional[str] = None,
                        content_type_includes: Optional[Sequence[str]] = None,
                        compression_buffersize: Optional[int] = None,
                        defaults_from: Optional[str] = None,
                        gzip_compression_level: Optional[int] = None,
                        gzip_memory_level: Optional[int] = None,
                        gzip_window_size: Optional[int] = None,
                        keep_accept_encoding: Optional[str] = None,
                        content_type_excludes: Optional[Sequence[str]] = None,
                        uri_excludes: Optional[Sequence[str]] = None,
                        uri_includes: Optional[Sequence[str]] = None,
                        vary_header: Optional[str] = None)
    func NewProfileHttpCompress(ctx *Context, name string, args ProfileHttpCompressArgs, opts ...ResourceOption) (*ProfileHttpCompress, error)
    public ProfileHttpCompress(string name, ProfileHttpCompressArgs args, CustomResourceOptions? opts = null)
    public ProfileHttpCompress(String name, ProfileHttpCompressArgs args)
public ProfileHttpCompress(String name, ProfileHttpCompressArgs args, CustomResourceOptions options)

    type: f5bigip:ltm:ProfileHttpCompress
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ProfileHttpCompressArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ProfileHttpCompressArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ProfileHttpCompressArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ProfileHttpCompressArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ProfileHttpCompressArgs
    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 profileHttpCompressResource = new F5BigIP.Ltm.ProfileHttpCompress("profileHttpCompressResource", new()
{
    Name = "string",
    CpuSaver = "string",
    ContentTypeIncludes = new[]
    {
        "string",
    },
    CompressionBuffersize = 0,
    DefaultsFrom = "string",
    GzipCompressionLevel = 0,
    GzipMemoryLevel = 0,
    GzipWindowSize = 0,
    KeepAcceptEncoding = "string",
    ContentTypeExcludes = new[]
    {
        "string",
    },
    UriExcludes = new[]
    {
        "string",
    },
    UriIncludes = new[]
    {
        "string",
    },
    VaryHeader = "string",
});

    example, err := ltm.NewProfileHttpCompress(ctx, "profileHttpCompressResource", &ltm.ProfileHttpCompressArgs{
	Name:     pulumi.String("string"),
	CpuSaver: pulumi.String("string"),
	ContentTypeIncludes: pulumi.StringArray{
		pulumi.String("string"),
	},
	CompressionBuffersize: pulumi.Int(0),
	DefaultsFrom:          pulumi.String("string"),
	GzipCompressionLevel:  pulumi.Int(0),
	GzipMemoryLevel:       pulumi.Int(0),
	GzipWindowSize:        pulumi.Int(0),
	KeepAcceptEncoding:    pulumi.String("string"),
	ContentTypeExcludes: pulumi.StringArray{
		pulumi.String("string"),
	},
	UriExcludes: pulumi.StringArray{
		pulumi.String("string"),
	},
	UriIncludes: pulumi.StringArray{
		pulumi.String("string"),
	},
	VaryHeader: pulumi.String("string"),
})

    var profileHttpCompressResource = new ProfileHttpCompress("profileHttpCompressResource", ProfileHttpCompressArgs.builder()
    .name("string")
    .cpuSaver("string")
    .contentTypeIncludes("string")
    .compressionBuffersize(0)
    .defaultsFrom("string")
    .gzipCompressionLevel(0)
    .gzipMemoryLevel(0)
    .gzipWindowSize(0)
    .keepAcceptEncoding("string")
    .contentTypeExcludes("string")
    .uriExcludes("string")
    .uriIncludes("string")
    .varyHeader("string")
    .build());

    profile_http_compress_resource = f5bigip.ltm.ProfileHttpCompress("profileHttpCompressResource",
    name="string",
    cpu_saver="string",
    content_type_includes=["string"],
    compression_buffersize=0,
    defaults_from="string",
    gzip_compression_level=0,
    gzip_memory_level=0,
    gzip_window_size=0,
    keep_accept_encoding="string",
    content_type_excludes=["string"],
    uri_excludes=["string"],
    uri_includes=["string"],
    vary_header="string")

    const profileHttpCompressResource = new f5bigip.ltm.ProfileHttpCompress("profileHttpCompressResource", {
    name: "string",
    cpuSaver: "string",
    contentTypeIncludes: ["string"],
    compressionBuffersize: 0,
    defaultsFrom: "string",
    gzipCompressionLevel: 0,
    gzipMemoryLevel: 0,
    gzipWindowSize: 0,
    keepAcceptEncoding: "string",
    contentTypeExcludes: ["string"],
    uriExcludes: ["string"],
    uriIncludes: ["string"],
    varyHeader: "string",
});

    type: f5bigip:ltm:ProfileHttpCompress
properties:
    compressionBuffersize: 0
    contentTypeExcludes:
        - string
    contentTypeIncludes:
        - string
    cpuSaver: string
    defaultsFrom: string
    gzipCompressionLevel: 0
    gzipMemoryLevel: 0
    gzipWindowSize: 0
    keepAcceptEncoding: string
    name: string
    uriExcludes:
        - string
    uriIncludes:
        - string
    varyHeader: string

    ProfileHttpCompress 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 ProfileHttpCompress resource accepts the following input properties:

    Name string
    Name of the LTM http compress profile,named with their full path.The full path is the combination of the partition + name (example: /Common/my-httpcompresprofile ) or partition + directory + name of the resource (example: my-httpcompresprofile)
    CompressionBuffersize int
    Specifies the maximum number of compressed bytes that the system buffers before inserting a Content-Length header (which specifies the compressed size) into the response. The default is 4096 bytes.
    ContentTypeExcludes List<string>
    Excludes a specified list of content types from compression of HTTP Content-Type responses. Use a string list to specify a list of content types you want to compress.
    ContentTypeIncludes List<string>
    Specifies a list of content types for compression of HTTP Content-Type responses. Use a string list to specify a list of content types you want to compress.
    CpuSaver string
    Specifies, when checked (enabled), that the system monitors the percent CPU usage and adjusts compression rates automatically when the CPU usage reaches either the CPU Saver High Threshold or the CPU Saver Low Threshold. The default is enabled.
    DefaultsFrom string
    Specifies the profile that you want to use as the parent profile. Your new profile inherits all settings and values from the parent profile specified.
    GzipCompressionLevel int
    Specifies the degree to which the system compresses the content. Higher compression levels cause the compression process to be slower. The default is 1 - Least Compression (Fastest)
    GzipMemoryLevel int
    Specifies the number of bytes of memory that the system uses for internal compression buffers when compressing a server response. The default is 8 kilobytes/8192 bytes.
    GzipWindowSize int
    Specifies the number of kilobytes in the window size that the system uses when compressing a server response. The default is 16 kilobytes
    KeepAcceptEncoding string
    Specifies, when checked (enabled), that the system does not remove the Accept-Encoding: header from an HTTP request. The default is disabled.
    UriExcludes List<string>
    Disables compression on a specified list of HTTP Request-URI responses. Use a regular expression to specify a list of URIs you do not want to compress.
    UriIncludes List<string>
    Enables compression on a specified list of HTTP Request-URI responses. Use a regular expression to specify a list of URIs you want to compress.
    VaryHeader string
    Specifies, when checked (enabled), that the system inserts a Vary header into cacheable server responses. The default is enabled.
    Name string
    Name of the LTM http compress profile,named with their full path.The full path is the combination of the partition + name (example: /Common/my-httpcompresprofile ) or partition + directory + name of the resource (example: my-httpcompresprofile)
    CompressionBuffersize int
    Specifies the maximum number of compressed bytes that the system buffers before inserting a Content-Length header (which specifies the compressed size) into the response. The default is 4096 bytes.
    ContentTypeExcludes []string
    Excludes a specified list of content types from compression of HTTP Content-Type responses. Use a string list to specify a list of content types you want to compress.
    ContentTypeIncludes []string
    Specifies a list of content types for compression of HTTP Content-Type responses. Use a string list to specify a list of content types you want to compress.
    CpuSaver string
    Specifies, when checked (enabled), that the system monitors the percent CPU usage and adjusts compression rates automatically when the CPU usage reaches either the CPU Saver High Threshold or the CPU Saver Low Threshold. The default is enabled.
    DefaultsFrom string
    Specifies the profile that you want to use as the parent profile. Your new profile inherits all settings and values from the parent profile specified.
    GzipCompressionLevel int
    Specifies the degree to which the system compresses the content. Higher compression levels cause the compression process to be slower. The default is 1 - Least Compression (Fastest)
    GzipMemoryLevel int
    Specifies the number of bytes of memory that the system uses for internal compression buffers when compressing a server response. The default is 8 kilobytes/8192 bytes.
    GzipWindowSize int
    Specifies the number of kilobytes in the window size that the system uses when compressing a server response. The default is 16 kilobytes
    KeepAcceptEncoding string
    Specifies, when checked (enabled), that the system does not remove the Accept-Encoding: header from an HTTP request. The default is disabled.
    UriExcludes []string
    Disables compression on a specified list of HTTP Request-URI responses. Use a regular expression to specify a list of URIs you do not want to compress.
    UriIncludes []string
    Enables compression on a specified list of HTTP Request-URI responses. Use a regular expression to specify a list of URIs you want to compress.
    VaryHeader string
    Specifies, when checked (enabled), that the system inserts a Vary header into cacheable server responses. The default is enabled.
    name String
    Name of the LTM http compress profile,named with their full path.The full path is the combination of the partition + name (example: /Common/my-httpcompresprofile ) or partition + directory + name of the resource (example: my-httpcompresprofile)
    compressionBuffersize Integer
    Specifies the maximum number of compressed bytes that the system buffers before inserting a Content-Length header (which specifies the compressed size) into the response. The default is 4096 bytes.
    contentTypeExcludes List<String>
    Excludes a specified list of content types from compression of HTTP Content-Type responses. Use a string list to specify a list of content types you want to compress.
    contentTypeIncludes List<String>
    Specifies a list of content types for compression of HTTP Content-Type responses. Use a string list to specify a list of content types you want to compress.
    cpuSaver String
    Specifies, when checked (enabled), that the system monitors the percent CPU usage and adjusts compression rates automatically when the CPU usage reaches either the CPU Saver High Threshold or the CPU Saver Low Threshold. The default is enabled.
    defaultsFrom String
    Specifies the profile that you want to use as the parent profile. Your new profile inherits all settings and values from the parent profile specified.
    gzipCompressionLevel Integer
    Specifies the degree to which the system compresses the content. Higher compression levels cause the compression process to be slower. The default is 1 - Least Compression (Fastest)
    gzipMemoryLevel Integer
    Specifies the number of bytes of memory that the system uses for internal compression buffers when compressing a server response. The default is 8 kilobytes/8192 bytes.
    gzipWindowSize Integer
    Specifies the number of kilobytes in the window size that the system uses when compressing a server response. The default is 16 kilobytes
    keepAcceptEncoding String
    Specifies, when checked (enabled), that the system does not remove the Accept-Encoding: header from an HTTP request. The default is disabled.
    uriExcludes List<String>
    Disables compression on a specified list of HTTP Request-URI responses. Use a regular expression to specify a list of URIs you do not want to compress.
    uriIncludes List<String>
    Enables compression on a specified list of HTTP Request-URI responses. Use a regular expression to specify a list of URIs you want to compress.
    varyHeader String
    Specifies, when checked (enabled), that the system inserts a Vary header into cacheable server responses. The default is enabled.
    name string
    Name of the LTM http compress profile,named with their full path.The full path is the combination of the partition + name (example: /Common/my-httpcompresprofile ) or partition + directory + name of the resource (example: my-httpcompresprofile)
    compressionBuffersize number
    Specifies the maximum number of compressed bytes that the system buffers before inserting a Content-Length header (which specifies the compressed size) into the response. The default is 4096 bytes.
    contentTypeExcludes string[]
    Excludes a specified list of content types from compression of HTTP Content-Type responses. Use a string list to specify a list of content types you want to compress.
    contentTypeIncludes string[]
    Specifies a list of content types for compression of HTTP Content-Type responses. Use a string list to specify a list of content types you want to compress.
    cpuSaver string
    Specifies, when checked (enabled), that the system monitors the percent CPU usage and adjusts compression rates automatically when the CPU usage reaches either the CPU Saver High Threshold or the CPU Saver Low Threshold. The default is enabled.
    defaultsFrom string
    Specifies the profile that you want to use as the parent profile. Your new profile inherits all settings and values from the parent profile specified.
    gzipCompressionLevel number
    Specifies the degree to which the system compresses the content. Higher compression levels cause the compression process to be slower. The default is 1 - Least Compression (Fastest)
    gzipMemoryLevel number
    Specifies the number of bytes of memory that the system uses for internal compression buffers when compressing a server response. The default is 8 kilobytes/8192 bytes.
    gzipWindowSize number
    Specifies the number of kilobytes in the window size that the system uses when compressing a server response. The default is 16 kilobytes
    keepAcceptEncoding string
    Specifies, when checked (enabled), that the system does not remove the Accept-Encoding: header from an HTTP request. The default is disabled.
    uriExcludes string[]
    Disables compression on a specified list of HTTP Request-URI responses. Use a regular expression to specify a list of URIs you do not want to compress.
    uriIncludes string[]
    Enables compression on a specified list of HTTP Request-URI responses. Use a regular expression to specify a list of URIs you want to compress.
    varyHeader string
    Specifies, when checked (enabled), that the system inserts a Vary header into cacheable server responses. The default is enabled.
    name str
    Name of the LTM http compress profile,named with their full path.The full path is the combination of the partition + name (example: /Common/my-httpcompresprofile ) or partition + directory + name of the resource (example: my-httpcompresprofile)
    compression_buffersize int
    Specifies the maximum number of compressed bytes that the system buffers before inserting a Content-Length header (which specifies the compressed size) into the response. The default is 4096 bytes.
    content_type_excludes Sequence[str]
    Excludes a specified list of content types from compression of HTTP Content-Type responses. Use a string list to specify a list of content types you want to compress.
    content_type_includes Sequence[str]
    Specifies a list of content types for compression of HTTP Content-Type responses. Use a string list to specify a list of content types you want to compress.
    cpu_saver str
    Specifies, when checked (enabled), that the system monitors the percent CPU usage and adjusts compression rates automatically when the CPU usage reaches either the CPU Saver High Threshold or the CPU Saver Low Threshold. The default is enabled.
    defaults_from str
    Specifies the profile that you want to use as the parent profile. Your new profile inherits all settings and values from the parent profile specified.
    gzip_compression_level int
    Specifies the degree to which the system compresses the content. Higher compression levels cause the compression process to be slower. The default is 1 - Least Compression (Fastest)
    gzip_memory_level int
    Specifies the number of bytes of memory that the system uses for internal compression buffers when compressing a server response. The default is 8 kilobytes/8192 bytes.
    gzip_window_size int
    Specifies the number of kilobytes in the window size that the system uses when compressing a server response. The default is 16 kilobytes
    keep_accept_encoding str
    Specifies, when checked (enabled), that the system does not remove the Accept-Encoding: header from an HTTP request. The default is disabled.
    uri_excludes Sequence[str]
    Disables compression on a specified list of HTTP Request-URI responses. Use a regular expression to specify a list of URIs you do not want to compress.
    uri_includes Sequence[str]
    Enables compression on a specified list of HTTP Request-URI responses. Use a regular expression to specify a list of URIs you want to compress.
    vary_header str
    Specifies, when checked (enabled), that the system inserts a Vary header into cacheable server responses. The default is enabled.
    name String
    Name of the LTM http compress profile,named with their full path.The full path is the combination of the partition + name (example: /Common/my-httpcompresprofile ) or partition + directory + name of the resource (example: my-httpcompresprofile)
    compressionBuffersize Number
    Specifies the maximum number of compressed bytes that the system buffers before inserting a Content-Length header (which specifies the compressed size) into the response. The default is 4096 bytes.
    contentTypeExcludes List<String>
    Excludes a specified list of content types from compression of HTTP Content-Type responses. Use a string list to specify a list of content types you want to compress.
    contentTypeIncludes List<String>
    Specifies a list of content types for compression of HTTP Content-Type responses. Use a string list to specify a list of content types you want to compress.
    cpuSaver String
    Specifies, when checked (enabled), that the system monitors the percent CPU usage and adjusts compression rates automatically when the CPU usage reaches either the CPU Saver High Threshold or the CPU Saver Low Threshold. The default is enabled.
    defaultsFrom String
    Specifies the profile that you want to use as the parent profile. Your new profile inherits all settings and values from the parent profile specified.
    gzipCompressionLevel Number
    Specifies the degree to which the system compresses the content. Higher compression levels cause the compression process to be slower. The default is 1 - Least Compression (Fastest)
    gzipMemoryLevel Number
    Specifies the number of bytes of memory that the system uses for internal compression buffers when compressing a server response. The default is 8 kilobytes/8192 bytes.
    gzipWindowSize Number
    Specifies the number of kilobytes in the window size that the system uses when compressing a server response. The default is 16 kilobytes
    keepAcceptEncoding String
    Specifies, when checked (enabled), that the system does not remove the Accept-Encoding: header from an HTTP request. The default is disabled.
    uriExcludes List<String>
    Disables compression on a specified list of HTTP Request-URI responses. Use a regular expression to specify a list of URIs you do not want to compress.
    uriIncludes List<String>
    Enables compression on a specified list of HTTP Request-URI responses. Use a regular expression to specify a list of URIs you want to compress.
    varyHeader String
    Specifies, when checked (enabled), that the system inserts a Vary header into cacheable server responses. The default is enabled.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ProfileHttpCompress 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 ProfileHttpCompress Resource

    Get an existing ProfileHttpCompress 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?: ProfileHttpCompressState, opts?: CustomResourceOptions): ProfileHttpCompress
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        compression_buffersize: Optional[int] = None,
        content_type_excludes: Optional[Sequence[str]] = None,
        content_type_includes: Optional[Sequence[str]] = None,
        cpu_saver: Optional[str] = None,
        defaults_from: Optional[str] = None,
        gzip_compression_level: Optional[int] = None,
        gzip_memory_level: Optional[int] = None,
        gzip_window_size: Optional[int] = None,
        keep_accept_encoding: Optional[str] = None,
        name: Optional[str] = None,
        uri_excludes: Optional[Sequence[str]] = None,
        uri_includes: Optional[Sequence[str]] = None,
        vary_header: Optional[str] = None) -> ProfileHttpCompress
    func GetProfileHttpCompress(ctx *Context, name string, id IDInput, state *ProfileHttpCompressState, opts ...ResourceOption) (*ProfileHttpCompress, error)
    public static ProfileHttpCompress Get(string name, Input<string> id, ProfileHttpCompressState? state, CustomResourceOptions? opts = null)
    public static ProfileHttpCompress get(String name, Output<String> id, ProfileHttpCompressState state, CustomResourceOptions options)
    resources:  _:    type: f5bigip:ltm:ProfileHttpCompress    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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:
    CompressionBuffersize int
    Specifies the maximum number of compressed bytes that the system buffers before inserting a Content-Length header (which specifies the compressed size) into the response. The default is 4096 bytes.
    ContentTypeExcludes List<string>
    Excludes a specified list of content types from compression of HTTP Content-Type responses. Use a string list to specify a list of content types you want to compress.
    ContentTypeIncludes List<string>
    Specifies a list of content types for compression of HTTP Content-Type responses. Use a string list to specify a list of content types you want to compress.
    CpuSaver string
    Specifies, when checked (enabled), that the system monitors the percent CPU usage and adjusts compression rates automatically when the CPU usage reaches either the CPU Saver High Threshold or the CPU Saver Low Threshold. The default is enabled.
    DefaultsFrom string
    Specifies the profile that you want to use as the parent profile. Your new profile inherits all settings and values from the parent profile specified.
    GzipCompressionLevel int
    Specifies the degree to which the system compresses the content. Higher compression levels cause the compression process to be slower. The default is 1 - Least Compression (Fastest)
    GzipMemoryLevel int
    Specifies the number of bytes of memory that the system uses for internal compression buffers when compressing a server response. The default is 8 kilobytes/8192 bytes.
    GzipWindowSize int
    Specifies the number of kilobytes in the window size that the system uses when compressing a server response. The default is 16 kilobytes
    KeepAcceptEncoding string
    Specifies, when checked (enabled), that the system does not remove the Accept-Encoding: header from an HTTP request. The default is disabled.
    Name string
    Name of the LTM http compress profile,named with their full path.The full path is the combination of the partition + name (example: /Common/my-httpcompresprofile ) or partition + directory + name of the resource (example: my-httpcompresprofile)
    UriExcludes List<string>
    Disables compression on a specified list of HTTP Request-URI responses. Use a regular expression to specify a list of URIs you do not want to compress.
    UriIncludes List<string>
    Enables compression on a specified list of HTTP Request-URI responses. Use a regular expression to specify a list of URIs you want to compress.
    VaryHeader string
    Specifies, when checked (enabled), that the system inserts a Vary header into cacheable server responses. The default is enabled.
    CompressionBuffersize int
    Specifies the maximum number of compressed bytes that the system buffers before inserting a Content-Length header (which specifies the compressed size) into the response. The default is 4096 bytes.
    ContentTypeExcludes []string
    Excludes a specified list of content types from compression of HTTP Content-Type responses. Use a string list to specify a list of content types you want to compress.
    ContentTypeIncludes []string
    Specifies a list of content types for compression of HTTP Content-Type responses. Use a string list to specify a list of content types you want to compress.
    CpuSaver string
    Specifies, when checked (enabled), that the system monitors the percent CPU usage and adjusts compression rates automatically when the CPU usage reaches either the CPU Saver High Threshold or the CPU Saver Low Threshold. The default is enabled.
    DefaultsFrom string
    Specifies the profile that you want to use as the parent profile. Your new profile inherits all settings and values from the parent profile specified.
    GzipCompressionLevel int
    Specifies the degree to which the system compresses the content. Higher compression levels cause the compression process to be slower. The default is 1 - Least Compression (Fastest)
    GzipMemoryLevel int
    Specifies the number of bytes of memory that the system uses for internal compression buffers when compressing a server response. The default is 8 kilobytes/8192 bytes.
    GzipWindowSize int
    Specifies the number of kilobytes in the window size that the system uses when compressing a server response. The default is 16 kilobytes
    KeepAcceptEncoding string
    Specifies, when checked (enabled), that the system does not remove the Accept-Encoding: header from an HTTP request. The default is disabled.
    Name string
    Name of the LTM http compress profile,named with their full path.The full path is the combination of the partition + name (example: /Common/my-httpcompresprofile ) or partition + directory + name of the resource (example: my-httpcompresprofile)
    UriExcludes []string
    Disables compression on a specified list of HTTP Request-URI responses. Use a regular expression to specify a list of URIs you do not want to compress.
    UriIncludes []string
    Enables compression on a specified list of HTTP Request-URI responses. Use a regular expression to specify a list of URIs you want to compress.
    VaryHeader string
    Specifies, when checked (enabled), that the system inserts a Vary header into cacheable server responses. The default is enabled.
    compressionBuffersize Integer
    Specifies the maximum number of compressed bytes that the system buffers before inserting a Content-Length header (which specifies the compressed size) into the response. The default is 4096 bytes.
    contentTypeExcludes List<String>
    Excludes a specified list of content types from compression of HTTP Content-Type responses. Use a string list to specify a list of content types you want to compress.
    contentTypeIncludes List<String>
    Specifies a list of content types for compression of HTTP Content-Type responses. Use a string list to specify a list of content types you want to compress.
    cpuSaver String
    Specifies, when checked (enabled), that the system monitors the percent CPU usage and adjusts compression rates automatically when the CPU usage reaches either the CPU Saver High Threshold or the CPU Saver Low Threshold. The default is enabled.
    defaultsFrom String
    Specifies the profile that you want to use as the parent profile. Your new profile inherits all settings and values from the parent profile specified.
    gzipCompressionLevel Integer
    Specifies the degree to which the system compresses the content. Higher compression levels cause the compression process to be slower. The default is 1 - Least Compression (Fastest)
    gzipMemoryLevel Integer
    Specifies the number of bytes of memory that the system uses for internal compression buffers when compressing a server response. The default is 8 kilobytes/8192 bytes.
    gzipWindowSize Integer
    Specifies the number of kilobytes in the window size that the system uses when compressing a server response. The default is 16 kilobytes
    keepAcceptEncoding String
    Specifies, when checked (enabled), that the system does not remove the Accept-Encoding: header from an HTTP request. The default is disabled.
    name String
    Name of the LTM http compress profile,named with their full path.The full path is the combination of the partition + name (example: /Common/my-httpcompresprofile ) or partition + directory + name of the resource (example: my-httpcompresprofile)
    uriExcludes List<String>
    Disables compression on a specified list of HTTP Request-URI responses. Use a regular expression to specify a list of URIs you do not want to compress.
    uriIncludes List<String>
    Enables compression on a specified list of HTTP Request-URI responses. Use a regular expression to specify a list of URIs you want to compress.
    varyHeader String
    Specifies, when checked (enabled), that the system inserts a Vary header into cacheable server responses. The default is enabled.
    compressionBuffersize number
    Specifies the maximum number of compressed bytes that the system buffers before inserting a Content-Length header (which specifies the compressed size) into the response. The default is 4096 bytes.
    contentTypeExcludes string[]
    Excludes a specified list of content types from compression of HTTP Content-Type responses. Use a string list to specify a list of content types you want to compress.
    contentTypeIncludes string[]
    Specifies a list of content types for compression of HTTP Content-Type responses. Use a string list to specify a list of content types you want to compress.
    cpuSaver string
    Specifies, when checked (enabled), that the system monitors the percent CPU usage and adjusts compression rates automatically when the CPU usage reaches either the CPU Saver High Threshold or the CPU Saver Low Threshold. The default is enabled.
    defaultsFrom string
    Specifies the profile that you want to use as the parent profile. Your new profile inherits all settings and values from the parent profile specified.
    gzipCompressionLevel number
    Specifies the degree to which the system compresses the content. Higher compression levels cause the compression process to be slower. The default is 1 - Least Compression (Fastest)
    gzipMemoryLevel number
    Specifies the number of bytes of memory that the system uses for internal compression buffers when compressing a server response. The default is 8 kilobytes/8192 bytes.
    gzipWindowSize number
    Specifies the number of kilobytes in the window size that the system uses when compressing a server response. The default is 16 kilobytes
    keepAcceptEncoding string
    Specifies, when checked (enabled), that the system does not remove the Accept-Encoding: header from an HTTP request. The default is disabled.
    name string
    Name of the LTM http compress profile,named with their full path.The full path is the combination of the partition + name (example: /Common/my-httpcompresprofile ) or partition + directory + name of the resource (example: my-httpcompresprofile)
    uriExcludes string[]
    Disables compression on a specified list of HTTP Request-URI responses. Use a regular expression to specify a list of URIs you do not want to compress.
    uriIncludes string[]
    Enables compression on a specified list of HTTP Request-URI responses. Use a regular expression to specify a list of URIs you want to compress.
    varyHeader string
    Specifies, when checked (enabled), that the system inserts a Vary header into cacheable server responses. The default is enabled.
    compression_buffersize int
    Specifies the maximum number of compressed bytes that the system buffers before inserting a Content-Length header (which specifies the compressed size) into the response. The default is 4096 bytes.
    content_type_excludes Sequence[str]
    Excludes a specified list of content types from compression of HTTP Content-Type responses. Use a string list to specify a list of content types you want to compress.
    content_type_includes Sequence[str]
    Specifies a list of content types for compression of HTTP Content-Type responses. Use a string list to specify a list of content types you want to compress.
    cpu_saver str
    Specifies, when checked (enabled), that the system monitors the percent CPU usage and adjusts compression rates automatically when the CPU usage reaches either the CPU Saver High Threshold or the CPU Saver Low Threshold. The default is enabled.
    defaults_from str
    Specifies the profile that you want to use as the parent profile. Your new profile inherits all settings and values from the parent profile specified.
    gzip_compression_level int
    Specifies the degree to which the system compresses the content. Higher compression levels cause the compression process to be slower. The default is 1 - Least Compression (Fastest)
    gzip_memory_level int
    Specifies the number of bytes of memory that the system uses for internal compression buffers when compressing a server response. The default is 8 kilobytes/8192 bytes.
    gzip_window_size int
    Specifies the number of kilobytes in the window size that the system uses when compressing a server response. The default is 16 kilobytes
    keep_accept_encoding str
    Specifies, when checked (enabled), that the system does not remove the Accept-Encoding: header from an HTTP request. The default is disabled.
    name str
    Name of the LTM http compress profile,named with their full path.The full path is the combination of the partition + name (example: /Common/my-httpcompresprofile ) or partition + directory + name of the resource (example: my-httpcompresprofile)
    uri_excludes Sequence[str]
    Disables compression on a specified list of HTTP Request-URI responses. Use a regular expression to specify a list of URIs you do not want to compress.
    uri_includes Sequence[str]
    Enables compression on a specified list of HTTP Request-URI responses. Use a regular expression to specify a list of URIs you want to compress.
    vary_header str
    Specifies, when checked (enabled), that the system inserts a Vary header into cacheable server responses. The default is enabled.
    compressionBuffersize Number
    Specifies the maximum number of compressed bytes that the system buffers before inserting a Content-Length header (which specifies the compressed size) into the response. The default is 4096 bytes.
    contentTypeExcludes List<String>
    Excludes a specified list of content types from compression of HTTP Content-Type responses. Use a string list to specify a list of content types you want to compress.
    contentTypeIncludes List<String>
    Specifies a list of content types for compression of HTTP Content-Type responses. Use a string list to specify a list of content types you want to compress.
    cpuSaver String
    Specifies, when checked (enabled), that the system monitors the percent CPU usage and adjusts compression rates automatically when the CPU usage reaches either the CPU Saver High Threshold or the CPU Saver Low Threshold. The default is enabled.
    defaultsFrom String
    Specifies the profile that you want to use as the parent profile. Your new profile inherits all settings and values from the parent profile specified.
    gzipCompressionLevel Number
    Specifies the degree to which the system compresses the content. Higher compression levels cause the compression process to be slower. The default is 1 - Least Compression (Fastest)
    gzipMemoryLevel Number
    Specifies the number of bytes of memory that the system uses for internal compression buffers when compressing a server response. The default is 8 kilobytes/8192 bytes.
    gzipWindowSize Number
    Specifies the number of kilobytes in the window size that the system uses when compressing a server response. The default is 16 kilobytes
    keepAcceptEncoding String
    Specifies, when checked (enabled), that the system does not remove the Accept-Encoding: header from an HTTP request. The default is disabled.
    name String
    Name of the LTM http compress profile,named with their full path.The full path is the combination of the partition + name (example: /Common/my-httpcompresprofile ) or partition + directory + name of the resource (example: my-httpcompresprofile)
    uriExcludes List<String>
    Disables compression on a specified list of HTTP Request-URI responses. Use a regular expression to specify a list of URIs you do not want to compress.
    uriIncludes List<String>
    Enables compression on a specified list of HTTP Request-URI responses. Use a regular expression to specify a list of URIs you want to compress.
    varyHeader String
    Specifies, when checked (enabled), that the system inserts a Vary header into cacheable server responses. The default is enabled.

    Import

    BIG-IP LTM HTTP Compress profiles can be imported using the name, e.g.

    $ pulumi import f5bigip:ltm/profileHttpCompress:ProfileHttpCompress test-httpcomprs_import /Common/test-httpcomprs

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

    Package Details

    Repository
    f5 BIG-IP pulumi/pulumi-f5bigip
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the bigip Terraform Provider.
    f5bigip logo
    f5 BIG-IP v3.17.9 published on Friday, Mar 7, 2025 by Pulumi
    pulumi/pulumi-f5bigip