oci.Waa.AppAccelerationPolicy
Explore with Pulumi AI
This resource provides the Web App Acceleration Policy resource in Oracle Cloud Infrastructure Waa service.
Creates a new WebAppAccelerationPolicy.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testWebAppAccelerationPolicy = new oci.waa.AppAccelerationPolicy("test_web_app_acceleration_policy", {
compartmentId: compartmentId,
definedTags: {
"foo-namespace.bar-key": "value",
},
displayName: webAppAccelerationPolicyDisplayName,
freeformTags: {
"bar-key": "value",
},
responseCachingPolicy: {
isResponseHeaderBasedCachingEnabled: webAppAccelerationPolicyResponseCachingPolicyIsResponseHeaderBasedCachingEnabled,
},
responseCompressionPolicy: {
gzipCompression: {
isEnabled: webAppAccelerationPolicyResponseCompressionPolicyGzipCompressionIsEnabled,
},
},
systemTags: webAppAccelerationPolicySystemTags,
});
import pulumi
import pulumi_oci as oci
test_web_app_acceleration_policy = oci.waa.AppAccelerationPolicy("test_web_app_acceleration_policy",
compartment_id=compartment_id,
defined_tags={
"foo-namespace.bar-key": "value",
},
display_name=web_app_acceleration_policy_display_name,
freeform_tags={
"bar-key": "value",
},
response_caching_policy=oci.waa.AppAccelerationPolicyResponseCachingPolicyArgs(
is_response_header_based_caching_enabled=web_app_acceleration_policy_response_caching_policy_is_response_header_based_caching_enabled,
),
response_compression_policy=oci.waa.AppAccelerationPolicyResponseCompressionPolicyArgs(
gzip_compression=oci.waa.AppAccelerationPolicyResponseCompressionPolicyGzipCompressionArgs(
is_enabled=web_app_acceleration_policy_response_compression_policy_gzip_compression_is_enabled,
),
),
system_tags=web_app_acceleration_policy_system_tags)
package main
import (
"github.com/pulumi/pulumi-oci/sdk/go/oci/Waa"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := Waa.NewAppAccelerationPolicy(ctx, "test_web_app_acceleration_policy", &Waa.AppAccelerationPolicyArgs{
CompartmentId: pulumi.Any(compartmentId),
DefinedTags: pulumi.Map{
"foo-namespace.bar-key": pulumi.Any("value"),
},
DisplayName: pulumi.Any(webAppAccelerationPolicyDisplayName),
FreeformTags: pulumi.Map{
"bar-key": pulumi.Any("value"),
},
ResponseCachingPolicy: &waa.AppAccelerationPolicyResponseCachingPolicyArgs{
IsResponseHeaderBasedCachingEnabled: pulumi.Any(webAppAccelerationPolicyResponseCachingPolicyIsResponseHeaderBasedCachingEnabled),
},
ResponseCompressionPolicy: &waa.AppAccelerationPolicyResponseCompressionPolicyArgs{
GzipCompression: &waa.AppAccelerationPolicyResponseCompressionPolicyGzipCompressionArgs{
IsEnabled: pulumi.Any(webAppAccelerationPolicyResponseCompressionPolicyGzipCompressionIsEnabled),
},
},
SystemTags: pulumi.Any(webAppAccelerationPolicySystemTags),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;
return await Deployment.RunAsync(() =>
{
var testWebAppAccelerationPolicy = new Oci.Waa.AppAccelerationPolicy("test_web_app_acceleration_policy", new()
{
CompartmentId = compartmentId,
DefinedTags =
{
{ "foo-namespace.bar-key", "value" },
},
DisplayName = webAppAccelerationPolicyDisplayName,
FreeformTags =
{
{ "bar-key", "value" },
},
ResponseCachingPolicy = new Oci.Waa.Inputs.AppAccelerationPolicyResponseCachingPolicyArgs
{
IsResponseHeaderBasedCachingEnabled = webAppAccelerationPolicyResponseCachingPolicyIsResponseHeaderBasedCachingEnabled,
},
ResponseCompressionPolicy = new Oci.Waa.Inputs.AppAccelerationPolicyResponseCompressionPolicyArgs
{
GzipCompression = new Oci.Waa.Inputs.AppAccelerationPolicyResponseCompressionPolicyGzipCompressionArgs
{
IsEnabled = webAppAccelerationPolicyResponseCompressionPolicyGzipCompressionIsEnabled,
},
},
SystemTags = webAppAccelerationPolicySystemTags,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Waa.AppAccelerationPolicy;
import com.pulumi.oci.Waa.AppAccelerationPolicyArgs;
import com.pulumi.oci.Waa.inputs.AppAccelerationPolicyResponseCachingPolicyArgs;
import com.pulumi.oci.Waa.inputs.AppAccelerationPolicyResponseCompressionPolicyArgs;
import com.pulumi.oci.Waa.inputs.AppAccelerationPolicyResponseCompressionPolicyGzipCompressionArgs;
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 testWebAppAccelerationPolicy = new AppAccelerationPolicy("testWebAppAccelerationPolicy", AppAccelerationPolicyArgs.builder()
.compartmentId(compartmentId)
.definedTags(Map.of("foo-namespace.bar-key", "value"))
.displayName(webAppAccelerationPolicyDisplayName)
.freeformTags(Map.of("bar-key", "value"))
.responseCachingPolicy(AppAccelerationPolicyResponseCachingPolicyArgs.builder()
.isResponseHeaderBasedCachingEnabled(webAppAccelerationPolicyResponseCachingPolicyIsResponseHeaderBasedCachingEnabled)
.build())
.responseCompressionPolicy(AppAccelerationPolicyResponseCompressionPolicyArgs.builder()
.gzipCompression(AppAccelerationPolicyResponseCompressionPolicyGzipCompressionArgs.builder()
.isEnabled(webAppAccelerationPolicyResponseCompressionPolicyGzipCompressionIsEnabled)
.build())
.build())
.systemTags(webAppAccelerationPolicySystemTags)
.build());
}
}
resources:
testWebAppAccelerationPolicy:
type: oci:Waa:AppAccelerationPolicy
name: test_web_app_acceleration_policy
properties:
compartmentId: ${compartmentId}
definedTags:
foo-namespace.bar-key: value
displayName: ${webAppAccelerationPolicyDisplayName}
freeformTags:
bar-key: value
responseCachingPolicy:
isResponseHeaderBasedCachingEnabled: ${webAppAccelerationPolicyResponseCachingPolicyIsResponseHeaderBasedCachingEnabled}
responseCompressionPolicy:
gzipCompression:
isEnabled: ${webAppAccelerationPolicyResponseCompressionPolicyGzipCompressionIsEnabled}
systemTags: ${webAppAccelerationPolicySystemTags}
Create AppAccelerationPolicy Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new AppAccelerationPolicy(name: string, args: AppAccelerationPolicyArgs, opts?: CustomResourceOptions);
@overload
def AppAccelerationPolicy(resource_name: str,
args: AppAccelerationPolicyArgs,
opts: Optional[ResourceOptions] = None)
@overload
def AppAccelerationPolicy(resource_name: str,
opts: Optional[ResourceOptions] = None,
compartment_id: Optional[str] = None,
defined_tags: Optional[Mapping[str, Any]] = None,
display_name: Optional[str] = None,
freeform_tags: Optional[Mapping[str, Any]] = None,
response_caching_policy: Optional[_waa.AppAccelerationPolicyResponseCachingPolicyArgs] = None,
response_compression_policy: Optional[_waa.AppAccelerationPolicyResponseCompressionPolicyArgs] = None,
system_tags: Optional[Mapping[str, Any]] = None)
func NewAppAccelerationPolicy(ctx *Context, name string, args AppAccelerationPolicyArgs, opts ...ResourceOption) (*AppAccelerationPolicy, error)
public AppAccelerationPolicy(string name, AppAccelerationPolicyArgs args, CustomResourceOptions? opts = null)
public AppAccelerationPolicy(String name, AppAccelerationPolicyArgs args)
public AppAccelerationPolicy(String name, AppAccelerationPolicyArgs args, CustomResourceOptions options)
type: oci:Waa:AppAccelerationPolicy
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 AppAccelerationPolicyArgs
- 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 AppAccelerationPolicyArgs
- 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 AppAccelerationPolicyArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AppAccelerationPolicyArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args AppAccelerationPolicyArgs
- 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 appAccelerationPolicyResource = new Oci.Waa.AppAccelerationPolicy("appAccelerationPolicyResource", new()
{
CompartmentId = "string",
DefinedTags =
{
{ "string", "any" },
},
DisplayName = "string",
FreeformTags =
{
{ "string", "any" },
},
ResponseCachingPolicy = new Oci.Waa.Inputs.AppAccelerationPolicyResponseCachingPolicyArgs
{
IsResponseHeaderBasedCachingEnabled = false,
},
ResponseCompressionPolicy = new Oci.Waa.Inputs.AppAccelerationPolicyResponseCompressionPolicyArgs
{
GzipCompression = new Oci.Waa.Inputs.AppAccelerationPolicyResponseCompressionPolicyGzipCompressionArgs
{
IsEnabled = false,
},
},
SystemTags =
{
{ "string", "any" },
},
});
example, err := Waa.NewAppAccelerationPolicy(ctx, "appAccelerationPolicyResource", &Waa.AppAccelerationPolicyArgs{
CompartmentId: pulumi.String("string"),
DefinedTags: pulumi.Map{
"string": pulumi.Any("any"),
},
DisplayName: pulumi.String("string"),
FreeformTags: pulumi.Map{
"string": pulumi.Any("any"),
},
ResponseCachingPolicy: &waa.AppAccelerationPolicyResponseCachingPolicyArgs{
IsResponseHeaderBasedCachingEnabled: pulumi.Bool(false),
},
ResponseCompressionPolicy: &waa.AppAccelerationPolicyResponseCompressionPolicyArgs{
GzipCompression: &waa.AppAccelerationPolicyResponseCompressionPolicyGzipCompressionArgs{
IsEnabled: pulumi.Bool(false),
},
},
SystemTags: pulumi.Map{
"string": pulumi.Any("any"),
},
})
var appAccelerationPolicyResource = new AppAccelerationPolicy("appAccelerationPolicyResource", AppAccelerationPolicyArgs.builder()
.compartmentId("string")
.definedTags(Map.of("string", "any"))
.displayName("string")
.freeformTags(Map.of("string", "any"))
.responseCachingPolicy(AppAccelerationPolicyResponseCachingPolicyArgs.builder()
.isResponseHeaderBasedCachingEnabled(false)
.build())
.responseCompressionPolicy(AppAccelerationPolicyResponseCompressionPolicyArgs.builder()
.gzipCompression(AppAccelerationPolicyResponseCompressionPolicyGzipCompressionArgs.builder()
.isEnabled(false)
.build())
.build())
.systemTags(Map.of("string", "any"))
.build());
app_acceleration_policy_resource = oci.waa.AppAccelerationPolicy("appAccelerationPolicyResource",
compartment_id="string",
defined_tags={
"string": "any",
},
display_name="string",
freeform_tags={
"string": "any",
},
response_caching_policy=oci.waa.AppAccelerationPolicyResponseCachingPolicyArgs(
is_response_header_based_caching_enabled=False,
),
response_compression_policy=oci.waa.AppAccelerationPolicyResponseCompressionPolicyArgs(
gzip_compression=oci.waa.AppAccelerationPolicyResponseCompressionPolicyGzipCompressionArgs(
is_enabled=False,
),
),
system_tags={
"string": "any",
})
const appAccelerationPolicyResource = new oci.waa.AppAccelerationPolicy("appAccelerationPolicyResource", {
compartmentId: "string",
definedTags: {
string: "any",
},
displayName: "string",
freeformTags: {
string: "any",
},
responseCachingPolicy: {
isResponseHeaderBasedCachingEnabled: false,
},
responseCompressionPolicy: {
gzipCompression: {
isEnabled: false,
},
},
systemTags: {
string: "any",
},
});
type: oci:Waa:AppAccelerationPolicy
properties:
compartmentId: string
definedTags:
string: any
displayName: string
freeformTags:
string: any
responseCachingPolicy:
isResponseHeaderBasedCachingEnabled: false
responseCompressionPolicy:
gzipCompression:
isEnabled: false
systemTags:
string: any
AppAccelerationPolicy Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The AppAccelerationPolicy resource accepts the following input properties:
- Compartment
Id string - (Updatable) The OCID of the compartment.
- Dictionary<string, object>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- Display
Name string - (Updatable) WebAppAccelerationPolicy display name, can be renamed.
- Dictionary<string, object>
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"}
- Response
Caching AppPolicy Acceleration Policy Response Caching Policy - (Updatable) An object that specifies an HTTP response caching policy.
- Response
Compression AppPolicy Acceleration Policy Response Compression Policy (Updatable) An object that specifies a compression policy for HTTP response from ENABLEMENT POINT to the client.
This compression policy can be used to enable support for HTTP response compression algorithms like gzip and configure the conditions of when a compression algorithm will be used.
HTTP responses will only be compressed if the client indicates support for one of the enabled compression algorithms via the "Accept-Encoding" request header.
- Dictionary<string, object>
(Updatable) Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Compartment
Id string - (Updatable) The OCID of the compartment.
- map[string]interface{}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- Display
Name string - (Updatable) WebAppAccelerationPolicy display name, can be renamed.
- map[string]interface{}
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"}
- Response
Caching AppPolicy Acceleration Policy Response Caching Policy Args - (Updatable) An object that specifies an HTTP response caching policy.
- Response
Compression AppPolicy Acceleration Policy Response Compression Policy Args (Updatable) An object that specifies a compression policy for HTTP response from ENABLEMENT POINT to the client.
This compression policy can be used to enable support for HTTP response compression algorithms like gzip and configure the conditions of when a compression algorithm will be used.
HTTP responses will only be compressed if the client indicates support for one of the enabled compression algorithms via the "Accept-Encoding" request header.
- map[string]interface{}
(Updatable) Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- compartment
Id String - (Updatable) The OCID of the compartment.
- Map<String,Object>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- display
Name String - (Updatable) WebAppAccelerationPolicy display name, can be renamed.
- Map<String,Object>
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"}
- response
Caching AppPolicy Acceleration Policy Response Caching Policy - (Updatable) An object that specifies an HTTP response caching policy.
- response
Compression AppPolicy Acceleration Policy Response Compression Policy (Updatable) An object that specifies a compression policy for HTTP response from ENABLEMENT POINT to the client.
This compression policy can be used to enable support for HTTP response compression algorithms like gzip and configure the conditions of when a compression algorithm will be used.
HTTP responses will only be compressed if the client indicates support for one of the enabled compression algorithms via the "Accept-Encoding" request header.
- Map<String,Object>
(Updatable) Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- compartment
Id string - (Updatable) The OCID of the compartment.
- {[key: string]: any}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- display
Name string - (Updatable) WebAppAccelerationPolicy display name, can be renamed.
- {[key: string]: any}
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"}
- response
Caching AppPolicy Acceleration Policy Response Caching Policy - (Updatable) An object that specifies an HTTP response caching policy.
- response
Compression AppPolicy Acceleration Policy Response Compression Policy (Updatable) An object that specifies a compression policy for HTTP response from ENABLEMENT POINT to the client.
This compression policy can be used to enable support for HTTP response compression algorithms like gzip and configure the conditions of when a compression algorithm will be used.
HTTP responses will only be compressed if the client indicates support for one of the enabled compression algorithms via the "Accept-Encoding" request header.
- {[key: string]: any}
(Updatable) Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- compartment_
id str - (Updatable) The OCID of the compartment.
- Mapping[str, Any]
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- display_
name str - (Updatable) WebAppAccelerationPolicy display name, can be renamed.
- Mapping[str, Any]
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"}
- response_
caching_ waa.policy App Acceleration Policy Response Caching Policy Args - (Updatable) An object that specifies an HTTP response caching policy.
- response_
compression_ waa.policy App Acceleration Policy Response Compression Policy Args (Updatable) An object that specifies a compression policy for HTTP response from ENABLEMENT POINT to the client.
This compression policy can be used to enable support for HTTP response compression algorithms like gzip and configure the conditions of when a compression algorithm will be used.
HTTP responses will only be compressed if the client indicates support for one of the enabled compression algorithms via the "Accept-Encoding" request header.
- Mapping[str, Any]
(Updatable) Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- compartment
Id String - (Updatable) The OCID of the compartment.
- Map<Any>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- display
Name String - (Updatable) WebAppAccelerationPolicy display name, can be renamed.
- Map<Any>
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"}
- response
Caching Property MapPolicy - (Updatable) An object that specifies an HTTP response caching policy.
- response
Compression Property MapPolicy (Updatable) An object that specifies a compression policy for HTTP response from ENABLEMENT POINT to the client.
This compression policy can be used to enable support for HTTP response compression algorithms like gzip and configure the conditions of when a compression algorithm will be used.
HTTP responses will only be compressed if the client indicates support for one of the enabled compression algorithms via the "Accept-Encoding" request header.
- Map<Any>
(Updatable) Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
Outputs
All input properties are implicitly available as output properties. Additionally, the AppAccelerationPolicy resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Lifecycle
Details string - A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in FAILED state.
- State string
- The current state of the WebAppAccelerationPolicy.
- Time
Created string - The time the WebAppAccelerationPolicy was created. An RFC3339 formatted datetime string.
- Time
Updated string - The time the WebAppAccelerationPolicy was updated. An RFC3339 formatted datetime string.
- Id string
- The provider-assigned unique ID for this managed resource.
- Lifecycle
Details string - A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in FAILED state.
- State string
- The current state of the WebAppAccelerationPolicy.
- Time
Created string - The time the WebAppAccelerationPolicy was created. An RFC3339 formatted datetime string.
- Time
Updated string - The time the WebAppAccelerationPolicy was updated. An RFC3339 formatted datetime string.
- id String
- The provider-assigned unique ID for this managed resource.
- lifecycle
Details String - A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in FAILED state.
- state String
- The current state of the WebAppAccelerationPolicy.
- time
Created String - The time the WebAppAccelerationPolicy was created. An RFC3339 formatted datetime string.
- time
Updated String - The time the WebAppAccelerationPolicy was updated. An RFC3339 formatted datetime string.
- id string
- The provider-assigned unique ID for this managed resource.
- lifecycle
Details string - A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in FAILED state.
- state string
- The current state of the WebAppAccelerationPolicy.
- time
Created string - The time the WebAppAccelerationPolicy was created. An RFC3339 formatted datetime string.
- time
Updated string - The time the WebAppAccelerationPolicy was updated. An RFC3339 formatted datetime string.
- id str
- The provider-assigned unique ID for this managed resource.
- lifecycle_
details str - A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in FAILED state.
- state str
- The current state of the WebAppAccelerationPolicy.
- time_
created str - The time the WebAppAccelerationPolicy was created. An RFC3339 formatted datetime string.
- time_
updated str - The time the WebAppAccelerationPolicy was updated. An RFC3339 formatted datetime string.
- id String
- The provider-assigned unique ID for this managed resource.
- lifecycle
Details String - A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in FAILED state.
- state String
- The current state of the WebAppAccelerationPolicy.
- time
Created String - The time the WebAppAccelerationPolicy was created. An RFC3339 formatted datetime string.
- time
Updated String - The time the WebAppAccelerationPolicy was updated. An RFC3339 formatted datetime string.
Look up Existing AppAccelerationPolicy Resource
Get an existing AppAccelerationPolicy 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?: AppAccelerationPolicyState, opts?: CustomResourceOptions): AppAccelerationPolicy
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
compartment_id: Optional[str] = None,
defined_tags: Optional[Mapping[str, Any]] = None,
display_name: Optional[str] = None,
freeform_tags: Optional[Mapping[str, Any]] = None,
lifecycle_details: Optional[str] = None,
response_caching_policy: Optional[_waa.AppAccelerationPolicyResponseCachingPolicyArgs] = None,
response_compression_policy: Optional[_waa.AppAccelerationPolicyResponseCompressionPolicyArgs] = None,
state: Optional[str] = None,
system_tags: Optional[Mapping[str, Any]] = None,
time_created: Optional[str] = None,
time_updated: Optional[str] = None) -> AppAccelerationPolicy
func GetAppAccelerationPolicy(ctx *Context, name string, id IDInput, state *AppAccelerationPolicyState, opts ...ResourceOption) (*AppAccelerationPolicy, error)
public static AppAccelerationPolicy Get(string name, Input<string> id, AppAccelerationPolicyState? state, CustomResourceOptions? opts = null)
public static AppAccelerationPolicy get(String name, Output<String> id, AppAccelerationPolicyState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- 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.
- Compartment
Id string - (Updatable) The OCID of the compartment.
- Dictionary<string, object>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- Display
Name string - (Updatable) WebAppAccelerationPolicy display name, can be renamed.
- Dictionary<string, object>
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"}
- Lifecycle
Details string - A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in FAILED state.
- Response
Caching AppPolicy Acceleration Policy Response Caching Policy - (Updatable) An object that specifies an HTTP response caching policy.
- Response
Compression AppPolicy Acceleration Policy Response Compression Policy (Updatable) An object that specifies a compression policy for HTTP response from ENABLEMENT POINT to the client.
This compression policy can be used to enable support for HTTP response compression algorithms like gzip and configure the conditions of when a compression algorithm will be used.
HTTP responses will only be compressed if the client indicates support for one of the enabled compression algorithms via the "Accept-Encoding" request header.
- State string
- The current state of the WebAppAccelerationPolicy.
- Dictionary<string, object>
(Updatable) Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Time
Created string - The time the WebAppAccelerationPolicy was created. An RFC3339 formatted datetime string.
- Time
Updated string - The time the WebAppAccelerationPolicy was updated. An RFC3339 formatted datetime string.
- Compartment
Id string - (Updatable) The OCID of the compartment.
- map[string]interface{}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- Display
Name string - (Updatable) WebAppAccelerationPolicy display name, can be renamed.
- map[string]interface{}
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"}
- Lifecycle
Details string - A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in FAILED state.
- Response
Caching AppPolicy Acceleration Policy Response Caching Policy Args - (Updatable) An object that specifies an HTTP response caching policy.
- Response
Compression AppPolicy Acceleration Policy Response Compression Policy Args (Updatable) An object that specifies a compression policy for HTTP response from ENABLEMENT POINT to the client.
This compression policy can be used to enable support for HTTP response compression algorithms like gzip and configure the conditions of when a compression algorithm will be used.
HTTP responses will only be compressed if the client indicates support for one of the enabled compression algorithms via the "Accept-Encoding" request header.
- State string
- The current state of the WebAppAccelerationPolicy.
- map[string]interface{}
(Updatable) Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Time
Created string - The time the WebAppAccelerationPolicy was created. An RFC3339 formatted datetime string.
- Time
Updated string - The time the WebAppAccelerationPolicy was updated. An RFC3339 formatted datetime string.
- compartment
Id String - (Updatable) The OCID of the compartment.
- Map<String,Object>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- display
Name String - (Updatable) WebAppAccelerationPolicy display name, can be renamed.
- Map<String,Object>
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"}
- lifecycle
Details String - A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in FAILED state.
- response
Caching AppPolicy Acceleration Policy Response Caching Policy - (Updatable) An object that specifies an HTTP response caching policy.
- response
Compression AppPolicy Acceleration Policy Response Compression Policy (Updatable) An object that specifies a compression policy for HTTP response from ENABLEMENT POINT to the client.
This compression policy can be used to enable support for HTTP response compression algorithms like gzip and configure the conditions of when a compression algorithm will be used.
HTTP responses will only be compressed if the client indicates support for one of the enabled compression algorithms via the "Accept-Encoding" request header.
- state String
- The current state of the WebAppAccelerationPolicy.
- Map<String,Object>
(Updatable) Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- time
Created String - The time the WebAppAccelerationPolicy was created. An RFC3339 formatted datetime string.
- time
Updated String - The time the WebAppAccelerationPolicy was updated. An RFC3339 formatted datetime string.
- compartment
Id string - (Updatable) The OCID of the compartment.
- {[key: string]: any}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- display
Name string - (Updatable) WebAppAccelerationPolicy display name, can be renamed.
- {[key: string]: any}
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"}
- lifecycle
Details string - A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in FAILED state.
- response
Caching AppPolicy Acceleration Policy Response Caching Policy - (Updatable) An object that specifies an HTTP response caching policy.
- response
Compression AppPolicy Acceleration Policy Response Compression Policy (Updatable) An object that specifies a compression policy for HTTP response from ENABLEMENT POINT to the client.
This compression policy can be used to enable support for HTTP response compression algorithms like gzip and configure the conditions of when a compression algorithm will be used.
HTTP responses will only be compressed if the client indicates support for one of the enabled compression algorithms via the "Accept-Encoding" request header.
- state string
- The current state of the WebAppAccelerationPolicy.
- {[key: string]: any}
(Updatable) Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- time
Created string - The time the WebAppAccelerationPolicy was created. An RFC3339 formatted datetime string.
- time
Updated string - The time the WebAppAccelerationPolicy was updated. An RFC3339 formatted datetime string.
- compartment_
id str - (Updatable) The OCID of the compartment.
- Mapping[str, Any]
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- display_
name str - (Updatable) WebAppAccelerationPolicy display name, can be renamed.
- Mapping[str, Any]
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"}
- lifecycle_
details str - A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in FAILED state.
- response_
caching_ waa.policy App Acceleration Policy Response Caching Policy Args - (Updatable) An object that specifies an HTTP response caching policy.
- response_
compression_ waa.policy App Acceleration Policy Response Compression Policy Args (Updatable) An object that specifies a compression policy for HTTP response from ENABLEMENT POINT to the client.
This compression policy can be used to enable support for HTTP response compression algorithms like gzip and configure the conditions of when a compression algorithm will be used.
HTTP responses will only be compressed if the client indicates support for one of the enabled compression algorithms via the "Accept-Encoding" request header.
- state str
- The current state of the WebAppAccelerationPolicy.
- Mapping[str, Any]
(Updatable) Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- time_
created str - The time the WebAppAccelerationPolicy was created. An RFC3339 formatted datetime string.
- time_
updated str - The time the WebAppAccelerationPolicy was updated. An RFC3339 formatted datetime string.
- compartment
Id String - (Updatable) The OCID of the compartment.
- Map<Any>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- display
Name String - (Updatable) WebAppAccelerationPolicy display name, can be renamed.
- Map<Any>
- (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"}
- lifecycle
Details String - A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in FAILED state.
- response
Caching Property MapPolicy - (Updatable) An object that specifies an HTTP response caching policy.
- response
Compression Property MapPolicy (Updatable) An object that specifies a compression policy for HTTP response from ENABLEMENT POINT to the client.
This compression policy can be used to enable support for HTTP response compression algorithms like gzip and configure the conditions of when a compression algorithm will be used.
HTTP responses will only be compressed if the client indicates support for one of the enabled compression algorithms via the "Accept-Encoding" request header.
- state String
- The current state of the WebAppAccelerationPolicy.
- Map<Any>
(Updatable) Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- time
Created String - The time the WebAppAccelerationPolicy was created. An RFC3339 formatted datetime string.
- time
Updated String - The time the WebAppAccelerationPolicy was updated. An RFC3339 formatted datetime string.
Supporting Types
AppAccelerationPolicyResponseCachingPolicy, AppAccelerationPolicyResponseCachingPolicyArgs
- Is
Response boolHeader Based Caching Enabled (Updatable) When false, responses will not be cached by the backend based on response headers.
When true, responses that contain one of the supported cache control headers will be cached according to the values specified in the cache control headers.
The "X-Accel-Expires" header field sets caching time of a response in seconds. The zero value disables caching for a response. If the value starts with the @ prefix, it sets an absolute time in seconds since Epoch, up to which the response may be cached.
If the header does not include the "X-Accel-Expires" field, parameters of caching may be set in the header fields "Expires" or "Cache-Control".
If the header includes the "Set-Cookie" field, such a response will not be cached.
If the header includes the "Vary" field with the special value "*", such a response will not be cached. If the header includes the "Vary" field with another value, such a response will be cached taking into account the corresponding request header fields.
- Is
Response boolHeader Based Caching Enabled (Updatable) When false, responses will not be cached by the backend based on response headers.
When true, responses that contain one of the supported cache control headers will be cached according to the values specified in the cache control headers.
The "X-Accel-Expires" header field sets caching time of a response in seconds. The zero value disables caching for a response. If the value starts with the @ prefix, it sets an absolute time in seconds since Epoch, up to which the response may be cached.
If the header does not include the "X-Accel-Expires" field, parameters of caching may be set in the header fields "Expires" or "Cache-Control".
If the header includes the "Set-Cookie" field, such a response will not be cached.
If the header includes the "Vary" field with the special value "*", such a response will not be cached. If the header includes the "Vary" field with another value, such a response will be cached taking into account the corresponding request header fields.
- is
Response BooleanHeader Based Caching Enabled (Updatable) When false, responses will not be cached by the backend based on response headers.
When true, responses that contain one of the supported cache control headers will be cached according to the values specified in the cache control headers.
The "X-Accel-Expires" header field sets caching time of a response in seconds. The zero value disables caching for a response. If the value starts with the @ prefix, it sets an absolute time in seconds since Epoch, up to which the response may be cached.
If the header does not include the "X-Accel-Expires" field, parameters of caching may be set in the header fields "Expires" or "Cache-Control".
If the header includes the "Set-Cookie" field, such a response will not be cached.
If the header includes the "Vary" field with the special value "*", such a response will not be cached. If the header includes the "Vary" field with another value, such a response will be cached taking into account the corresponding request header fields.
- is
Response booleanHeader Based Caching Enabled (Updatable) When false, responses will not be cached by the backend based on response headers.
When true, responses that contain one of the supported cache control headers will be cached according to the values specified in the cache control headers.
The "X-Accel-Expires" header field sets caching time of a response in seconds. The zero value disables caching for a response. If the value starts with the @ prefix, it sets an absolute time in seconds since Epoch, up to which the response may be cached.
If the header does not include the "X-Accel-Expires" field, parameters of caching may be set in the header fields "Expires" or "Cache-Control".
If the header includes the "Set-Cookie" field, such a response will not be cached.
If the header includes the "Vary" field with the special value "*", such a response will not be cached. If the header includes the "Vary" field with another value, such a response will be cached taking into account the corresponding request header fields.
- is_
response_ boolheader_ based_ caching_ enabled (Updatable) When false, responses will not be cached by the backend based on response headers.
When true, responses that contain one of the supported cache control headers will be cached according to the values specified in the cache control headers.
The "X-Accel-Expires" header field sets caching time of a response in seconds. The zero value disables caching for a response. If the value starts with the @ prefix, it sets an absolute time in seconds since Epoch, up to which the response may be cached.
If the header does not include the "X-Accel-Expires" field, parameters of caching may be set in the header fields "Expires" or "Cache-Control".
If the header includes the "Set-Cookie" field, such a response will not be cached.
If the header includes the "Vary" field with the special value "*", such a response will not be cached. If the header includes the "Vary" field with another value, such a response will be cached taking into account the corresponding request header fields.
- is
Response BooleanHeader Based Caching Enabled (Updatable) When false, responses will not be cached by the backend based on response headers.
When true, responses that contain one of the supported cache control headers will be cached according to the values specified in the cache control headers.
The "X-Accel-Expires" header field sets caching time of a response in seconds. The zero value disables caching for a response. If the value starts with the @ prefix, it sets an absolute time in seconds since Epoch, up to which the response may be cached.
If the header does not include the "X-Accel-Expires" field, parameters of caching may be set in the header fields "Expires" or "Cache-Control".
If the header includes the "Set-Cookie" field, such a response will not be cached.
If the header includes the "Vary" field with the special value "*", such a response will not be cached. If the header includes the "Vary" field with another value, such a response will be cached taking into account the corresponding request header fields.
AppAccelerationPolicyResponseCompressionPolicy, AppAccelerationPolicyResponseCompressionPolicyArgs
- Gzip
Compression AppAcceleration Policy Response Compression Policy Gzip Compression - (Updatable) An object that specifies the gzip compression policy.
- Gzip
Compression AppAcceleration Policy Response Compression Policy Gzip Compression - (Updatable) An object that specifies the gzip compression policy.
- gzip
Compression AppAcceleration Policy Response Compression Policy Gzip Compression - (Updatable) An object that specifies the gzip compression policy.
- gzip
Compression AppAcceleration Policy Response Compression Policy Gzip Compression - (Updatable) An object that specifies the gzip compression policy.
- gzip_
compression waa.App Acceleration Policy Response Compression Policy Gzip Compression - (Updatable) An object that specifies the gzip compression policy.
- gzip
Compression Property Map - (Updatable) An object that specifies the gzip compression policy.
AppAccelerationPolicyResponseCompressionPolicyGzipCompression, AppAccelerationPolicyResponseCompressionPolicyGzipCompressionArgs
- Is
Enabled bool (Updatable) When true, support for gzip compression is enabled. HTTP responses will be compressed with gzip only if the client indicates support for gzip via the "Accept-Encoding: gzip" request header.
When false, support for gzip compression is disabled and HTTP responses will not be compressed with gzip even if the client indicates support for gzip.
- Is
Enabled bool (Updatable) When true, support for gzip compression is enabled. HTTP responses will be compressed with gzip only if the client indicates support for gzip via the "Accept-Encoding: gzip" request header.
When false, support for gzip compression is disabled and HTTP responses will not be compressed with gzip even if the client indicates support for gzip.
- is
Enabled Boolean (Updatable) When true, support for gzip compression is enabled. HTTP responses will be compressed with gzip only if the client indicates support for gzip via the "Accept-Encoding: gzip" request header.
When false, support for gzip compression is disabled and HTTP responses will not be compressed with gzip even if the client indicates support for gzip.
- is
Enabled boolean (Updatable) When true, support for gzip compression is enabled. HTTP responses will be compressed with gzip only if the client indicates support for gzip via the "Accept-Encoding: gzip" request header.
When false, support for gzip compression is disabled and HTTP responses will not be compressed with gzip even if the client indicates support for gzip.
- is_
enabled bool (Updatable) When true, support for gzip compression is enabled. HTTP responses will be compressed with gzip only if the client indicates support for gzip via the "Accept-Encoding: gzip" request header.
When false, support for gzip compression is disabled and HTTP responses will not be compressed with gzip even if the client indicates support for gzip.
- is
Enabled Boolean (Updatable) When true, support for gzip compression is enabled. HTTP responses will be compressed with gzip only if the client indicates support for gzip via the "Accept-Encoding: gzip" request header.
When false, support for gzip compression is disabled and HTTP responses will not be compressed with gzip even if the client indicates support for gzip.
Import
WebAppAccelerationPolicies can be imported using the id
, e.g.
$ pulumi import oci:Waa/appAccelerationPolicy:AppAccelerationPolicy test_web_app_acceleration_policy "id"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
oci
Terraform Provider.