1. Packages
  2. Akeyless Provider
  3. API Docs
  4. GatewayCache
akeyless 1.9.0 published on Monday, Apr 14, 2025 by akeyless-community

akeyless.GatewayCache

Explore with Pulumi AI

akeyless logo
akeyless 1.9.0 published on Monday, Apr 14, 2025 by akeyless-community

    Cache settings

    Create GatewayCache Resource

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

    Constructor syntax

    new GatewayCache(name: string, args?: GatewayCacheArgs, opts?: CustomResourceOptions);
    @overload
    def GatewayCache(resource_name: str,
                     args: Optional[GatewayCacheArgs] = None,
                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def GatewayCache(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     backup_interval: Optional[str] = None,
                     enable_cache: Optional[str] = None,
                     enable_proactive: Optional[str] = None,
                     gateway_cache_id: Optional[str] = None,
                     minimum_fetch_interval: Optional[str] = None,
                     stale_timeout: Optional[str] = None)
    func NewGatewayCache(ctx *Context, name string, args *GatewayCacheArgs, opts ...ResourceOption) (*GatewayCache, error)
    public GatewayCache(string name, GatewayCacheArgs? args = null, CustomResourceOptions? opts = null)
    public GatewayCache(String name, GatewayCacheArgs args)
    public GatewayCache(String name, GatewayCacheArgs args, CustomResourceOptions options)
    
    type: akeyless:GatewayCache
    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 GatewayCacheArgs
    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 GatewayCacheArgs
    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 GatewayCacheArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GatewayCacheArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GatewayCacheArgs
    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 gatewayCacheResource = new Akeyless.GatewayCache("gatewayCacheResource", new()
    {
        BackupInterval = "string",
        EnableCache = "string",
        EnableProactive = "string",
        GatewayCacheId = "string",
        MinimumFetchInterval = "string",
        StaleTimeout = "string",
    });
    
    example, err := akeyless.NewGatewayCache(ctx, "gatewayCacheResource", &akeyless.GatewayCacheArgs{
    	BackupInterval:       pulumi.String("string"),
    	EnableCache:          pulumi.String("string"),
    	EnableProactive:      pulumi.String("string"),
    	GatewayCacheId:       pulumi.String("string"),
    	MinimumFetchInterval: pulumi.String("string"),
    	StaleTimeout:         pulumi.String("string"),
    })
    
    var gatewayCacheResource = new GatewayCache("gatewayCacheResource", GatewayCacheArgs.builder()
        .backupInterval("string")
        .enableCache("string")
        .enableProactive("string")
        .gatewayCacheId("string")
        .minimumFetchInterval("string")
        .staleTimeout("string")
        .build());
    
    gateway_cache_resource = akeyless.GatewayCache("gatewayCacheResource",
        backup_interval="string",
        enable_cache="string",
        enable_proactive="string",
        gateway_cache_id="string",
        minimum_fetch_interval="string",
        stale_timeout="string")
    
    const gatewayCacheResource = new akeyless.GatewayCache("gatewayCacheResource", {
        backupInterval: "string",
        enableCache: "string",
        enableProactive: "string",
        gatewayCacheId: "string",
        minimumFetchInterval: "string",
        staleTimeout: "string",
    });
    
    type: akeyless:GatewayCache
    properties:
        backupInterval: string
        enableCache: string
        enableProactive: string
        gatewayCacheId: string
        minimumFetchInterval: string
        staleTimeout: string
    

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

    BackupInterval string
    Secure backup interval in minutes. To ensure service continuity in case of power cycle and network outage secrets will be backed up periodically per backup interval
    EnableCache string
    Enable cache [true/false]
    EnableProactive string
    Enable proactive caching [true/false]
    GatewayCacheId string
    The ID of this resource.
    MinimumFetchInterval string
    When using Cache or/and Proactive Cache, additional secrets will be fetched upon requesting a secret, based on the requestor's access policy. Define minimum fetching interval to avoid over fetching in a given time frame
    StaleTimeout string
    Stale timeout in minutes, cache entries which are not accessed within timeout will be removed from cache
    BackupInterval string
    Secure backup interval in minutes. To ensure service continuity in case of power cycle and network outage secrets will be backed up periodically per backup interval
    EnableCache string
    Enable cache [true/false]
    EnableProactive string
    Enable proactive caching [true/false]
    GatewayCacheId string
    The ID of this resource.
    MinimumFetchInterval string
    When using Cache or/and Proactive Cache, additional secrets will be fetched upon requesting a secret, based on the requestor's access policy. Define minimum fetching interval to avoid over fetching in a given time frame
    StaleTimeout string
    Stale timeout in minutes, cache entries which are not accessed within timeout will be removed from cache
    backupInterval String
    Secure backup interval in minutes. To ensure service continuity in case of power cycle and network outage secrets will be backed up periodically per backup interval
    enableCache String
    Enable cache [true/false]
    enableProactive String
    Enable proactive caching [true/false]
    gatewayCacheId String
    The ID of this resource.
    minimumFetchInterval String
    When using Cache or/and Proactive Cache, additional secrets will be fetched upon requesting a secret, based on the requestor's access policy. Define minimum fetching interval to avoid over fetching in a given time frame
    staleTimeout String
    Stale timeout in minutes, cache entries which are not accessed within timeout will be removed from cache
    backupInterval string
    Secure backup interval in minutes. To ensure service continuity in case of power cycle and network outage secrets will be backed up periodically per backup interval
    enableCache string
    Enable cache [true/false]
    enableProactive string
    Enable proactive caching [true/false]
    gatewayCacheId string
    The ID of this resource.
    minimumFetchInterval string
    When using Cache or/and Proactive Cache, additional secrets will be fetched upon requesting a secret, based on the requestor's access policy. Define minimum fetching interval to avoid over fetching in a given time frame
    staleTimeout string
    Stale timeout in minutes, cache entries which are not accessed within timeout will be removed from cache
    backup_interval str
    Secure backup interval in minutes. To ensure service continuity in case of power cycle and network outage secrets will be backed up periodically per backup interval
    enable_cache str
    Enable cache [true/false]
    enable_proactive str
    Enable proactive caching [true/false]
    gateway_cache_id str
    The ID of this resource.
    minimum_fetch_interval str
    When using Cache or/and Proactive Cache, additional secrets will be fetched upon requesting a secret, based on the requestor's access policy. Define minimum fetching interval to avoid over fetching in a given time frame
    stale_timeout str
    Stale timeout in minutes, cache entries which are not accessed within timeout will be removed from cache
    backupInterval String
    Secure backup interval in minutes. To ensure service continuity in case of power cycle and network outage secrets will be backed up periodically per backup interval
    enableCache String
    Enable cache [true/false]
    enableProactive String
    Enable proactive caching [true/false]
    gatewayCacheId String
    The ID of this resource.
    minimumFetchInterval String
    When using Cache or/and Proactive Cache, additional secrets will be fetched upon requesting a secret, based on the requestor's access policy. Define minimum fetching interval to avoid over fetching in a given time frame
    staleTimeout String
    Stale timeout in minutes, cache entries which are not accessed within timeout will be removed from cache

    Outputs

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

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

    Look up Existing GatewayCache Resource

    Get an existing GatewayCache 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?: GatewayCacheState, opts?: CustomResourceOptions): GatewayCache
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            backup_interval: Optional[str] = None,
            enable_cache: Optional[str] = None,
            enable_proactive: Optional[str] = None,
            gateway_cache_id: Optional[str] = None,
            minimum_fetch_interval: Optional[str] = None,
            stale_timeout: Optional[str] = None) -> GatewayCache
    func GetGatewayCache(ctx *Context, name string, id IDInput, state *GatewayCacheState, opts ...ResourceOption) (*GatewayCache, error)
    public static GatewayCache Get(string name, Input<string> id, GatewayCacheState? state, CustomResourceOptions? opts = null)
    public static GatewayCache get(String name, Output<String> id, GatewayCacheState state, CustomResourceOptions options)
    resources:  _:    type: akeyless:GatewayCache    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    BackupInterval string
    Secure backup interval in minutes. To ensure service continuity in case of power cycle and network outage secrets will be backed up periodically per backup interval
    EnableCache string
    Enable cache [true/false]
    EnableProactive string
    Enable proactive caching [true/false]
    GatewayCacheId string
    The ID of this resource.
    MinimumFetchInterval string
    When using Cache or/and Proactive Cache, additional secrets will be fetched upon requesting a secret, based on the requestor's access policy. Define minimum fetching interval to avoid over fetching in a given time frame
    StaleTimeout string
    Stale timeout in minutes, cache entries which are not accessed within timeout will be removed from cache
    BackupInterval string
    Secure backup interval in minutes. To ensure service continuity in case of power cycle and network outage secrets will be backed up periodically per backup interval
    EnableCache string
    Enable cache [true/false]
    EnableProactive string
    Enable proactive caching [true/false]
    GatewayCacheId string
    The ID of this resource.
    MinimumFetchInterval string
    When using Cache or/and Proactive Cache, additional secrets will be fetched upon requesting a secret, based on the requestor's access policy. Define minimum fetching interval to avoid over fetching in a given time frame
    StaleTimeout string
    Stale timeout in minutes, cache entries which are not accessed within timeout will be removed from cache
    backupInterval String
    Secure backup interval in minutes. To ensure service continuity in case of power cycle and network outage secrets will be backed up periodically per backup interval
    enableCache String
    Enable cache [true/false]
    enableProactive String
    Enable proactive caching [true/false]
    gatewayCacheId String
    The ID of this resource.
    minimumFetchInterval String
    When using Cache or/and Proactive Cache, additional secrets will be fetched upon requesting a secret, based on the requestor's access policy. Define minimum fetching interval to avoid over fetching in a given time frame
    staleTimeout String
    Stale timeout in minutes, cache entries which are not accessed within timeout will be removed from cache
    backupInterval string
    Secure backup interval in minutes. To ensure service continuity in case of power cycle and network outage secrets will be backed up periodically per backup interval
    enableCache string
    Enable cache [true/false]
    enableProactive string
    Enable proactive caching [true/false]
    gatewayCacheId string
    The ID of this resource.
    minimumFetchInterval string
    When using Cache or/and Proactive Cache, additional secrets will be fetched upon requesting a secret, based on the requestor's access policy. Define minimum fetching interval to avoid over fetching in a given time frame
    staleTimeout string
    Stale timeout in minutes, cache entries which are not accessed within timeout will be removed from cache
    backup_interval str
    Secure backup interval in minutes. To ensure service continuity in case of power cycle and network outage secrets will be backed up periodically per backup interval
    enable_cache str
    Enable cache [true/false]
    enable_proactive str
    Enable proactive caching [true/false]
    gateway_cache_id str
    The ID of this resource.
    minimum_fetch_interval str
    When using Cache or/and Proactive Cache, additional secrets will be fetched upon requesting a secret, based on the requestor's access policy. Define minimum fetching interval to avoid over fetching in a given time frame
    stale_timeout str
    Stale timeout in minutes, cache entries which are not accessed within timeout will be removed from cache
    backupInterval String
    Secure backup interval in minutes. To ensure service continuity in case of power cycle and network outage secrets will be backed up periodically per backup interval
    enableCache String
    Enable cache [true/false]
    enableProactive String
    Enable proactive caching [true/false]
    gatewayCacheId String
    The ID of this resource.
    minimumFetchInterval String
    When using Cache or/and Proactive Cache, additional secrets will be fetched upon requesting a secret, based on the requestor's access policy. Define minimum fetching interval to avoid over fetching in a given time frame
    staleTimeout String
    Stale timeout in minutes, cache entries which are not accessed within timeout will be removed from cache

    Package Details

    Repository
    akeyless akeyless-community/terraform-provider-akeyless
    License
    Notes
    This Pulumi package is based on the akeyless Terraform Provider.
    akeyless logo
    akeyless 1.9.0 published on Monday, Apr 14, 2025 by akeyless-community