@pulumi/f5bigip
Version:
A Pulumi package for creating and managing F5 BigIP resources.
224 lines (223 loc) • 11.4 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* `f5bigip.ltm.ProfileWebAcceleration` Configures a custom web-acceleration profile for use.
*
* For resources should be named with their "full path". The full path is the combination of the partition + name of the resource. For example /Common/sample-resource.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as f5bigip from "@pulumi/f5bigip";
*
* const sample_resource = new f5bigip.ltm.ProfileWebAcceleration("sample-resource", {
* name: "/Common/sample-resource",
* defaultsFrom: "/Common/test2",
* cacheSize: 101,
* cacheMaxEntries: 201,
* });
* ```
*/
export declare class ProfileWebAcceleration extends pulumi.CustomResource {
/**
* Get an existing ProfileWebAcceleration resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ProfileWebAccelerationState, opts?: pulumi.CustomResourceOptions): ProfileWebAcceleration;
/**
* Returns true if the given object is an instance of ProfileWebAcceleration. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is ProfileWebAcceleration;
/**
* Specifies how quickly the system ages a cache entry. The aging rate ranges from 0 (slowest aging) to 10 (fastest aging). The default value is `9`.
*/
readonly cacheAgingRate: pulumi.Output<number>;
/**
* Specifies which cache disabling headers sent by clients the system ignores. The default value is `all`.
*/
readonly cacheClientCacheControlMode: pulumi.Output<string>;
/**
* Inserts Age and Date headers in the response. The default value is `enabled`.
*/
readonly cacheInsertAgeHeader: pulumi.Output<string>;
/**
* Specifies how long the system considers the cached content to be valid. The default value is `3600 seconds`.
*/
readonly cacheMaxAge: pulumi.Output<number>;
/**
* Specifies the maximum number of entries that can be in the cache. The default value is `0` (zero), which means that the system does not limit the maximum entries.
*/
readonly cacheMaxEntries: pulumi.Output<number>;
/**
* Specifies the smallest object that the system considers eligible for caching. The default value is `500 bytes`.
*/
readonly cacheObjectMaxSize: pulumi.Output<number>;
/**
* Specifies the smallest object that the system considers eligible for caching. The default value is `500 bytes`.
*/
readonly cacheObjectMinSize: pulumi.Output<number>;
/**
* Specifies the maximum size for the cache. When the cache reaches the maximum size, the system starts removing the oldest entries. The default value is `100 megabytes`.
*/
readonly cacheSize: pulumi.Output<number>;
/**
* Configures a list of URIs to exclude from the cache. The default value of `none` specifies no URIs are excluded.
*/
readonly cacheUriExcludes: pulumi.Output<string[]>;
/**
* Configures a list of URIs to include in the cache even if they would normally be excluded due to factors like object size or HTTP request type. The default value of none specifies no URIs are to be forced into the cache.
*/
readonly cacheUriIncludeOverrides: pulumi.Output<string[]>;
/**
* Configures a list of URIs to include in the cache. The default value of `.*` specifies that all URIs are cacheable.
*/
readonly cacheUriIncludes: pulumi.Output<string[]>;
/**
* Configures a list of URIs to keep in the cache. The pinning process keeps URIs in cache when they would normally be evicted to make room for more active URIs.
*/
readonly cacheUriPinneds: pulumi.Output<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.
*/
readonly defaultsFrom: pulumi.Output<string>;
/**
* Specifies the name of the web acceleration profile service ,name of Profile should be full path. Full path is the combination of the `partition + web acceleration profile name`,For example `/Common/sample-resource`.
*/
readonly name: pulumi.Output<string>;
/**
* Create a ProfileWebAcceleration resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: ProfileWebAccelerationArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ProfileWebAcceleration resources.
*/
export interface ProfileWebAccelerationState {
/**
* Specifies how quickly the system ages a cache entry. The aging rate ranges from 0 (slowest aging) to 10 (fastest aging). The default value is `9`.
*/
cacheAgingRate?: pulumi.Input<number>;
/**
* Specifies which cache disabling headers sent by clients the system ignores. The default value is `all`.
*/
cacheClientCacheControlMode?: pulumi.Input<string>;
/**
* Inserts Age and Date headers in the response. The default value is `enabled`.
*/
cacheInsertAgeHeader?: pulumi.Input<string>;
/**
* Specifies how long the system considers the cached content to be valid. The default value is `3600 seconds`.
*/
cacheMaxAge?: pulumi.Input<number>;
/**
* Specifies the maximum number of entries that can be in the cache. The default value is `0` (zero), which means that the system does not limit the maximum entries.
*/
cacheMaxEntries?: pulumi.Input<number>;
/**
* Specifies the smallest object that the system considers eligible for caching. The default value is `500 bytes`.
*/
cacheObjectMaxSize?: pulumi.Input<number>;
/**
* Specifies the smallest object that the system considers eligible for caching. The default value is `500 bytes`.
*/
cacheObjectMinSize?: pulumi.Input<number>;
/**
* Specifies the maximum size for the cache. When the cache reaches the maximum size, the system starts removing the oldest entries. The default value is `100 megabytes`.
*/
cacheSize?: pulumi.Input<number>;
/**
* Configures a list of URIs to exclude from the cache. The default value of `none` specifies no URIs are excluded.
*/
cacheUriExcludes?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Configures a list of URIs to include in the cache even if they would normally be excluded due to factors like object size or HTTP request type. The default value of none specifies no URIs are to be forced into the cache.
*/
cacheUriIncludeOverrides?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Configures a list of URIs to include in the cache. The default value of `.*` specifies that all URIs are cacheable.
*/
cacheUriIncludes?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Configures a list of URIs to keep in the cache. The pinning process keeps URIs in cache when they would normally be evicted to make room for more active URIs.
*/
cacheUriPinneds?: pulumi.Input<pulumi.Input<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.
*/
defaultsFrom?: pulumi.Input<string>;
/**
* Specifies the name of the web acceleration profile service ,name of Profile should be full path. Full path is the combination of the `partition + web acceleration profile name`,For example `/Common/sample-resource`.
*/
name?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a ProfileWebAcceleration resource.
*/
export interface ProfileWebAccelerationArgs {
/**
* Specifies how quickly the system ages a cache entry. The aging rate ranges from 0 (slowest aging) to 10 (fastest aging). The default value is `9`.
*/
cacheAgingRate?: pulumi.Input<number>;
/**
* Specifies which cache disabling headers sent by clients the system ignores. The default value is `all`.
*/
cacheClientCacheControlMode?: pulumi.Input<string>;
/**
* Inserts Age and Date headers in the response. The default value is `enabled`.
*/
cacheInsertAgeHeader?: pulumi.Input<string>;
/**
* Specifies how long the system considers the cached content to be valid. The default value is `3600 seconds`.
*/
cacheMaxAge?: pulumi.Input<number>;
/**
* Specifies the maximum number of entries that can be in the cache. The default value is `0` (zero), which means that the system does not limit the maximum entries.
*/
cacheMaxEntries?: pulumi.Input<number>;
/**
* Specifies the smallest object that the system considers eligible for caching. The default value is `500 bytes`.
*/
cacheObjectMaxSize?: pulumi.Input<number>;
/**
* Specifies the smallest object that the system considers eligible for caching. The default value is `500 bytes`.
*/
cacheObjectMinSize?: pulumi.Input<number>;
/**
* Specifies the maximum size for the cache. When the cache reaches the maximum size, the system starts removing the oldest entries. The default value is `100 megabytes`.
*/
cacheSize?: pulumi.Input<number>;
/**
* Configures a list of URIs to exclude from the cache. The default value of `none` specifies no URIs are excluded.
*/
cacheUriExcludes?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Configures a list of URIs to include in the cache even if they would normally be excluded due to factors like object size or HTTP request type. The default value of none specifies no URIs are to be forced into the cache.
*/
cacheUriIncludeOverrides?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Configures a list of URIs to include in the cache. The default value of `.*` specifies that all URIs are cacheable.
*/
cacheUriIncludes?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Configures a list of URIs to keep in the cache. The pinning process keeps URIs in cache when they would normally be evicted to make room for more active URIs.
*/
cacheUriPinneds?: pulumi.Input<pulumi.Input<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.
*/
defaultsFrom?: pulumi.Input<string>;
/**
* Specifies the name of the web acceleration profile service ,name of Profile should be full path. Full path is the combination of the `partition + web acceleration profile name`,For example `/Common/sample-resource`.
*/
name: pulumi.Input<string>;
}