1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Waa
  5. AppAccelerationPolicy
Oracle Cloud Infrastructure v2.18.0 published on Friday, Nov 22, 2024 by Pulumi

oci.Waa.AppAccelerationPolicy

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.18.0 published on Friday, Nov 22, 2024 by Pulumi

    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={
            "is_response_header_based_caching_enabled": web_app_acceleration_policy_response_caching_policy_is_response_header_based_caching_enabled,
        },
        response_compression_policy={
            "gzip_compression": {
                "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/v2/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.StringMap{
    				"foo-namespace.bar-key": pulumi.String("value"),
    			},
    			DisplayName: pulumi.Any(webAppAccelerationPolicyDisplayName),
    			FreeformTags: pulumi.StringMap{
    				"bar-key": pulumi.String("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, str]] = None,
                              display_name: Optional[str] = None,
                              freeform_tags: Optional[Mapping[str, str]] = None,
                              response_caching_policy: Optional[_waa.AppAccelerationPolicyResponseCachingPolicyArgs] = None,
                              response_compression_policy: Optional[_waa.AppAccelerationPolicyResponseCompressionPolicyArgs] = None,
                              system_tags: Optional[Mapping[str, str]] = 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", "string" },
        },
        DisplayName = "string",
        FreeformTags = 
        {
            { "string", "string" },
        },
        ResponseCachingPolicy = new Oci.Waa.Inputs.AppAccelerationPolicyResponseCachingPolicyArgs
        {
            IsResponseHeaderBasedCachingEnabled = false,
        },
        ResponseCompressionPolicy = new Oci.Waa.Inputs.AppAccelerationPolicyResponseCompressionPolicyArgs
        {
            GzipCompression = new Oci.Waa.Inputs.AppAccelerationPolicyResponseCompressionPolicyGzipCompressionArgs
            {
                IsEnabled = false,
            },
        },
        SystemTags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := Waa.NewAppAccelerationPolicy(ctx, "appAccelerationPolicyResource", &Waa.AppAccelerationPolicyArgs{
    	CompartmentId: pulumi.String("string"),
    	DefinedTags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	DisplayName: pulumi.String("string"),
    	FreeformTags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	ResponseCachingPolicy: &waa.AppAccelerationPolicyResponseCachingPolicyArgs{
    		IsResponseHeaderBasedCachingEnabled: pulumi.Bool(false),
    	},
    	ResponseCompressionPolicy: &waa.AppAccelerationPolicyResponseCompressionPolicyArgs{
    		GzipCompression: &waa.AppAccelerationPolicyResponseCompressionPolicyGzipCompressionArgs{
    			IsEnabled: pulumi.Bool(false),
    		},
    	},
    	SystemTags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var appAccelerationPolicyResource = new AppAccelerationPolicy("appAccelerationPolicyResource", AppAccelerationPolicyArgs.builder()
        .compartmentId("string")
        .definedTags(Map.of("string", "string"))
        .displayName("string")
        .freeformTags(Map.of("string", "string"))
        .responseCachingPolicy(AppAccelerationPolicyResponseCachingPolicyArgs.builder()
            .isResponseHeaderBasedCachingEnabled(false)
            .build())
        .responseCompressionPolicy(AppAccelerationPolicyResponseCompressionPolicyArgs.builder()
            .gzipCompression(AppAccelerationPolicyResponseCompressionPolicyGzipCompressionArgs.builder()
                .isEnabled(false)
                .build())
            .build())
        .systemTags(Map.of("string", "string"))
        .build());
    
    app_acceleration_policy_resource = oci.waa.AppAccelerationPolicy("appAccelerationPolicyResource",
        compartment_id="string",
        defined_tags={
            "string": "string",
        },
        display_name="string",
        freeform_tags={
            "string": "string",
        },
        response_caching_policy={
            "is_response_header_based_caching_enabled": False,
        },
        response_compression_policy={
            "gzip_compression": {
                "is_enabled": False,
            },
        },
        system_tags={
            "string": "string",
        })
    
    const appAccelerationPolicyResource = new oci.waa.AppAccelerationPolicy("appAccelerationPolicyResource", {
        compartmentId: "string",
        definedTags: {
            string: "string",
        },
        displayName: "string",
        freeformTags: {
            string: "string",
        },
        responseCachingPolicy: {
            isResponseHeaderBasedCachingEnabled: false,
        },
        responseCompressionPolicy: {
            gzipCompression: {
                isEnabled: false,
            },
        },
        systemTags: {
            string: "string",
        },
    });
    
    type: oci:Waa:AppAccelerationPolicy
    properties:
        compartmentId: string
        definedTags:
            string: string
        displayName: string
        freeformTags:
            string: string
        responseCachingPolicy:
            isResponseHeaderBasedCachingEnabled: false
        responseCompressionPolicy:
            gzipCompression:
                isEnabled: false
        systemTags:
            string: string
    

    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

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

    The AppAccelerationPolicy resource accepts the following input properties:

    CompartmentId string
    (Updatable) The OCID of the compartment.
    DefinedTags Dictionary<string, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    DisplayName string
    (Updatable) WebAppAccelerationPolicy display name, can be renamed.
    FreeformTags Dictionary<string, string>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    ResponseCachingPolicy AppAccelerationPolicyResponseCachingPolicy
    (Updatable) An object that specifies an HTTP response caching policy.
    ResponseCompressionPolicy AppAccelerationPolicyResponseCompressionPolicy

    (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.

    SystemTags Dictionary<string, string>

    (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

    CompartmentId string
    (Updatable) The OCID of the compartment.
    DefinedTags map[string]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    DisplayName string
    (Updatable) WebAppAccelerationPolicy display name, can be renamed.
    FreeformTags map[string]string
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    ResponseCachingPolicy AppAccelerationPolicyResponseCachingPolicyArgs
    (Updatable) An object that specifies an HTTP response caching policy.
    ResponseCompressionPolicy AppAccelerationPolicyResponseCompressionPolicyArgs

    (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.

    SystemTags map[string]string

    (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

    compartmentId String
    (Updatable) The OCID of the compartment.
    definedTags Map<String,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    displayName String
    (Updatable) WebAppAccelerationPolicy display name, can be renamed.
    freeformTags Map<String,String>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    responseCachingPolicy AppAccelerationPolicyResponseCachingPolicy
    (Updatable) An object that specifies an HTTP response caching policy.
    responseCompressionPolicy AppAccelerationPolicyResponseCompressionPolicy

    (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.

    systemTags Map<String,String>

    (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

    compartmentId string
    (Updatable) The OCID of the compartment.
    definedTags {[key: string]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    displayName string
    (Updatable) WebAppAccelerationPolicy display name, can be renamed.
    freeformTags {[key: string]: string}
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    responseCachingPolicy AppAccelerationPolicyResponseCachingPolicy
    (Updatable) An object that specifies an HTTP response caching policy.
    responseCompressionPolicy AppAccelerationPolicyResponseCompressionPolicy

    (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.

    systemTags {[key: string]: string}

    (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.
    defined_tags Mapping[str, str]
    (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.
    freeform_tags Mapping[str, str]
    (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_policy waa.AppAccelerationPolicyResponseCachingPolicyArgs
    (Updatable) An object that specifies an HTTP response caching policy.
    response_compression_policy waa.AppAccelerationPolicyResponseCompressionPolicyArgs

    (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.

    system_tags Mapping[str, str]

    (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

    compartmentId String
    (Updatable) The OCID of the compartment.
    definedTags Map<String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    displayName String
    (Updatable) WebAppAccelerationPolicy display name, can be renamed.
    freeformTags Map<String>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    responseCachingPolicy Property Map
    (Updatable) An object that specifies an HTTP response caching policy.
    responseCompressionPolicy Property Map

    (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.

    systemTags Map<String>

    (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.
    LifecycleDetails 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.
    TimeCreated string
    The time the WebAppAccelerationPolicy was created. An RFC3339 formatted datetime string.
    TimeUpdated string
    The time the WebAppAccelerationPolicy was updated. An RFC3339 formatted datetime string.
    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleDetails 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.
    TimeCreated string
    The time the WebAppAccelerationPolicy was created. An RFC3339 formatted datetime string.
    TimeUpdated string
    The time the WebAppAccelerationPolicy was updated. An RFC3339 formatted datetime string.
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails 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.
    timeCreated String
    The time the WebAppAccelerationPolicy was created. An RFC3339 formatted datetime string.
    timeUpdated String
    The time the WebAppAccelerationPolicy was updated. An RFC3339 formatted datetime string.
    id string
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails 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.
    timeCreated string
    The time the WebAppAccelerationPolicy was created. An RFC3339 formatted datetime string.
    timeUpdated 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.
    lifecycleDetails 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.
    timeCreated String
    The time the WebAppAccelerationPolicy was created. An RFC3339 formatted datetime string.
    timeUpdated 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, str]] = None,
            display_name: Optional[str] = None,
            freeform_tags: Optional[Mapping[str, str]] = 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, str]] = 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.
    The following state arguments are supported:
    CompartmentId string
    (Updatable) The OCID of the compartment.
    DefinedTags Dictionary<string, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    DisplayName string
    (Updatable) WebAppAccelerationPolicy display name, can be renamed.
    FreeformTags Dictionary<string, string>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    LifecycleDetails 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.
    ResponseCachingPolicy AppAccelerationPolicyResponseCachingPolicy
    (Updatable) An object that specifies an HTTP response caching policy.
    ResponseCompressionPolicy AppAccelerationPolicyResponseCompressionPolicy

    (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.
    SystemTags Dictionary<string, string>

    (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

    TimeCreated string
    The time the WebAppAccelerationPolicy was created. An RFC3339 formatted datetime string.
    TimeUpdated string
    The time the WebAppAccelerationPolicy was updated. An RFC3339 formatted datetime string.
    CompartmentId string
    (Updatable) The OCID of the compartment.
    DefinedTags map[string]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    DisplayName string
    (Updatable) WebAppAccelerationPolicy display name, can be renamed.
    FreeformTags map[string]string
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    LifecycleDetails 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.
    ResponseCachingPolicy AppAccelerationPolicyResponseCachingPolicyArgs
    (Updatable) An object that specifies an HTTP response caching policy.
    ResponseCompressionPolicy AppAccelerationPolicyResponseCompressionPolicyArgs

    (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.
    SystemTags map[string]string

    (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

    TimeCreated string
    The time the WebAppAccelerationPolicy was created. An RFC3339 formatted datetime string.
    TimeUpdated string
    The time the WebAppAccelerationPolicy was updated. An RFC3339 formatted datetime string.
    compartmentId String
    (Updatable) The OCID of the compartment.
    definedTags Map<String,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    displayName String
    (Updatable) WebAppAccelerationPolicy display name, can be renamed.
    freeformTags Map<String,String>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    lifecycleDetails 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.
    responseCachingPolicy AppAccelerationPolicyResponseCachingPolicy
    (Updatable) An object that specifies an HTTP response caching policy.
    responseCompressionPolicy AppAccelerationPolicyResponseCompressionPolicy

    (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.
    systemTags Map<String,String>

    (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

    timeCreated String
    The time the WebAppAccelerationPolicy was created. An RFC3339 formatted datetime string.
    timeUpdated String
    The time the WebAppAccelerationPolicy was updated. An RFC3339 formatted datetime string.
    compartmentId string
    (Updatable) The OCID of the compartment.
    definedTags {[key: string]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    displayName string
    (Updatable) WebAppAccelerationPolicy display name, can be renamed.
    freeformTags {[key: string]: string}
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    lifecycleDetails 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.
    responseCachingPolicy AppAccelerationPolicyResponseCachingPolicy
    (Updatable) An object that specifies an HTTP response caching policy.
    responseCompressionPolicy AppAccelerationPolicyResponseCompressionPolicy

    (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.
    systemTags {[key: string]: string}

    (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

    timeCreated string
    The time the WebAppAccelerationPolicy was created. An RFC3339 formatted datetime string.
    timeUpdated string
    The time the WebAppAccelerationPolicy was updated. An RFC3339 formatted datetime string.
    compartment_id str
    (Updatable) The OCID of the compartment.
    defined_tags Mapping[str, str]
    (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.
    freeform_tags Mapping[str, str]
    (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_policy waa.AppAccelerationPolicyResponseCachingPolicyArgs
    (Updatable) An object that specifies an HTTP response caching policy.
    response_compression_policy waa.AppAccelerationPolicyResponseCompressionPolicyArgs

    (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.
    system_tags Mapping[str, str]

    (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.
    compartmentId String
    (Updatable) The OCID of the compartment.
    definedTags Map<String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    displayName String
    (Updatable) WebAppAccelerationPolicy display name, can be renamed.
    freeformTags Map<String>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    lifecycleDetails 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.
    responseCachingPolicy Property Map
    (Updatable) An object that specifies an HTTP response caching policy.
    responseCompressionPolicy Property Map

    (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.
    systemTags Map<String>

    (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

    timeCreated String
    The time the WebAppAccelerationPolicy was created. An RFC3339 formatted datetime string.
    timeUpdated String
    The time the WebAppAccelerationPolicy was updated. An RFC3339 formatted datetime string.

    Supporting Types

    AppAccelerationPolicyResponseCachingPolicy, AppAccelerationPolicyResponseCachingPolicyArgs

    IsResponseHeaderBasedCachingEnabled bool

    (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.

    IsResponseHeaderBasedCachingEnabled bool

    (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.

    isResponseHeaderBasedCachingEnabled Boolean

    (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.

    isResponseHeaderBasedCachingEnabled boolean

    (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_header_based_caching_enabled bool

    (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.

    isResponseHeaderBasedCachingEnabled Boolean

    (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

    GzipCompression AppAccelerationPolicyResponseCompressionPolicyGzipCompression
    (Updatable) An object that specifies the gzip compression policy.
    GzipCompression AppAccelerationPolicyResponseCompressionPolicyGzipCompression
    (Updatable) An object that specifies the gzip compression policy.
    gzipCompression AppAccelerationPolicyResponseCompressionPolicyGzipCompression
    (Updatable) An object that specifies the gzip compression policy.
    gzipCompression AppAccelerationPolicyResponseCompressionPolicyGzipCompression
    (Updatable) An object that specifies the gzip compression policy.
    gzip_compression waa.AppAccelerationPolicyResponseCompressionPolicyGzipCompression
    (Updatable) An object that specifies the gzip compression policy.
    gzipCompression Property Map
    (Updatable) An object that specifies the gzip compression policy.

    AppAccelerationPolicyResponseCompressionPolicyGzipCompression, AppAccelerationPolicyResponseCompressionPolicyGzipCompressionArgs

    IsEnabled 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.

    IsEnabled 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.

    isEnabled 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.

    isEnabled 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.

    isEnabled 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.
    oci logo
    Oracle Cloud Infrastructure v2.18.0 published on Friday, Nov 22, 2024 by Pulumi