Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. cloudstoragegateway
  5. GatewayCacheDisk
Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-alicloud

alicloud.cloudstoragegateway.GatewayCacheDisk

Explore with Pulumi AI

Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-alicloud

Provides a Cloud Storage Gateway Gateway Cache Disk resource.

For information about Cloud Storage Gateway Gateway Cache Disk and how to use it, see What is Gateway Cache Disk.

NOTE: Available since v1.144.0.

Create GatewayCacheDisk Resource

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

Constructor syntax

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

@overload
def GatewayCacheDisk(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     cache_disk_size_in_gb: Optional[int] = None,
                     gateway_id: Optional[str] = None,
                     cache_disk_category: Optional[str] = None,
                     performance_level: Optional[str] = None)
func NewGatewayCacheDisk(ctx *Context, name string, args GatewayCacheDiskArgs, opts ...ResourceOption) (*GatewayCacheDisk, error)
public GatewayCacheDisk(string name, GatewayCacheDiskArgs args, CustomResourceOptions? opts = null)
public GatewayCacheDisk(String name, GatewayCacheDiskArgs args)
public GatewayCacheDisk(String name, GatewayCacheDiskArgs args, CustomResourceOptions options)

type: alicloud:cloudstoragegateway:GatewayCacheDisk
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. GatewayCacheDiskArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. GatewayCacheDiskArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. GatewayCacheDiskArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. GatewayCacheDiskArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. GatewayCacheDiskArgs
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 gatewayCacheDiskResource = new AliCloud.CloudStorageGateway.GatewayCacheDisk("gatewayCacheDiskResource", new()
{
    CacheDiskSizeInGb = 0,
    GatewayId = "string",
    CacheDiskCategory = "string",
    PerformanceLevel = "string",
});
Copy
example, err := cloudstoragegateway.NewGatewayCacheDisk(ctx, "gatewayCacheDiskResource", &cloudstoragegateway.GatewayCacheDiskArgs{
	CacheDiskSizeInGb: pulumi.Int(0),
	GatewayId:         pulumi.String("string"),
	CacheDiskCategory: pulumi.String("string"),
	PerformanceLevel:  pulumi.String("string"),
})
Copy
var gatewayCacheDiskResource = new GatewayCacheDisk("gatewayCacheDiskResource", GatewayCacheDiskArgs.builder()
    .cacheDiskSizeInGb(0)
    .gatewayId("string")
    .cacheDiskCategory("string")
    .performanceLevel("string")
    .build());
Copy
gateway_cache_disk_resource = alicloud.cloudstoragegateway.GatewayCacheDisk("gatewayCacheDiskResource",
    cache_disk_size_in_gb=0,
    gateway_id="string",
    cache_disk_category="string",
    performance_level="string")
Copy
const gatewayCacheDiskResource = new alicloud.cloudstoragegateway.GatewayCacheDisk("gatewayCacheDiskResource", {
    cacheDiskSizeInGb: 0,
    gatewayId: "string",
    cacheDiskCategory: "string",
    performanceLevel: "string",
});
Copy
type: alicloud:cloudstoragegateway:GatewayCacheDisk
properties:
    cacheDiskCategory: string
    cacheDiskSizeInGb: 0
    gatewayId: string
    performanceLevel: string
Copy

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

CacheDiskSizeInGb This property is required. int
The capacity of the cache disk.
GatewayId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the gateway.
CacheDiskCategory Changes to this property will trigger replacement. string
The type of the cache disk. Valid values: cloud_efficiency, cloud_ssd, cloud_essd. NOTE: From version 1.227.0, cache_disk_category can be set to cloud_essd.
PerformanceLevel Changes to this property will trigger replacement. string
The performance level (PL) of the Enterprise SSD (ESSD). Valid values: PL1, PL2, PL3. NOTE: If cache_disk_category is set to cloud_essd, performance_level is required.
CacheDiskSizeInGb This property is required. int
The capacity of the cache disk.
GatewayId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the gateway.
CacheDiskCategory Changes to this property will trigger replacement. string
The type of the cache disk. Valid values: cloud_efficiency, cloud_ssd, cloud_essd. NOTE: From version 1.227.0, cache_disk_category can be set to cloud_essd.
PerformanceLevel Changes to this property will trigger replacement. string
The performance level (PL) of the Enterprise SSD (ESSD). Valid values: PL1, PL2, PL3. NOTE: If cache_disk_category is set to cloud_essd, performance_level is required.
cacheDiskSizeInGb This property is required. Integer
The capacity of the cache disk.
gatewayId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the gateway.
cacheDiskCategory Changes to this property will trigger replacement. String
The type of the cache disk. Valid values: cloud_efficiency, cloud_ssd, cloud_essd. NOTE: From version 1.227.0, cache_disk_category can be set to cloud_essd.
performanceLevel Changes to this property will trigger replacement. String
The performance level (PL) of the Enterprise SSD (ESSD). Valid values: PL1, PL2, PL3. NOTE: If cache_disk_category is set to cloud_essd, performance_level is required.
cacheDiskSizeInGb This property is required. number
The capacity of the cache disk.
gatewayId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the gateway.
cacheDiskCategory Changes to this property will trigger replacement. string
The type of the cache disk. Valid values: cloud_efficiency, cloud_ssd, cloud_essd. NOTE: From version 1.227.0, cache_disk_category can be set to cloud_essd.
performanceLevel Changes to this property will trigger replacement. string
The performance level (PL) of the Enterprise SSD (ESSD). Valid values: PL1, PL2, PL3. NOTE: If cache_disk_category is set to cloud_essd, performance_level is required.
cache_disk_size_in_gb This property is required. int
The capacity of the cache disk.
gateway_id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the gateway.
cache_disk_category Changes to this property will trigger replacement. str
The type of the cache disk. Valid values: cloud_efficiency, cloud_ssd, cloud_essd. NOTE: From version 1.227.0, cache_disk_category can be set to cloud_essd.
performance_level Changes to this property will trigger replacement. str
The performance level (PL) of the Enterprise SSD (ESSD). Valid values: PL1, PL2, PL3. NOTE: If cache_disk_category is set to cloud_essd, performance_level is required.
cacheDiskSizeInGb This property is required. Number
The capacity of the cache disk.
gatewayId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the gateway.
cacheDiskCategory Changes to this property will trigger replacement. String
The type of the cache disk. Valid values: cloud_efficiency, cloud_ssd, cloud_essd. NOTE: From version 1.227.0, cache_disk_category can be set to cloud_essd.
performanceLevel Changes to this property will trigger replacement. String
The performance level (PL) of the Enterprise SSD (ESSD). Valid values: PL1, PL2, PL3. NOTE: If cache_disk_category is set to cloud_essd, performance_level is required.

Outputs

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

CacheId string
The ID of the cache disk.
Id string
The provider-assigned unique ID for this managed resource.
LocalFilePath string
The path of the cache disk.
Status int
The status of the Gateway Cache Disk.
CacheId string
The ID of the cache disk.
Id string
The provider-assigned unique ID for this managed resource.
LocalFilePath string
The path of the cache disk.
Status int
The status of the Gateway Cache Disk.
cacheId String
The ID of the cache disk.
id String
The provider-assigned unique ID for this managed resource.
localFilePath String
The path of the cache disk.
status Integer
The status of the Gateway Cache Disk.
cacheId string
The ID of the cache disk.
id string
The provider-assigned unique ID for this managed resource.
localFilePath string
The path of the cache disk.
status number
The status of the Gateway Cache Disk.
cache_id str
The ID of the cache disk.
id str
The provider-assigned unique ID for this managed resource.
local_file_path str
The path of the cache disk.
status int
The status of the Gateway Cache Disk.
cacheId String
The ID of the cache disk.
id String
The provider-assigned unique ID for this managed resource.
localFilePath String
The path of the cache disk.
status Number
The status of the Gateway Cache Disk.

Look up Existing GatewayCacheDisk Resource

Get an existing GatewayCacheDisk 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?: GatewayCacheDiskState, opts?: CustomResourceOptions): GatewayCacheDisk
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cache_disk_category: Optional[str] = None,
        cache_disk_size_in_gb: Optional[int] = None,
        cache_id: Optional[str] = None,
        gateway_id: Optional[str] = None,
        local_file_path: Optional[str] = None,
        performance_level: Optional[str] = None,
        status: Optional[int] = None) -> GatewayCacheDisk
func GetGatewayCacheDisk(ctx *Context, name string, id IDInput, state *GatewayCacheDiskState, opts ...ResourceOption) (*GatewayCacheDisk, error)
public static GatewayCacheDisk Get(string name, Input<string> id, GatewayCacheDiskState? state, CustomResourceOptions? opts = null)
public static GatewayCacheDisk get(String name, Output<String> id, GatewayCacheDiskState state, CustomResourceOptions options)
resources:  _:    type: alicloud:cloudstoragegateway:GatewayCacheDisk    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
CacheDiskCategory Changes to this property will trigger replacement. string
The type of the cache disk. Valid values: cloud_efficiency, cloud_ssd, cloud_essd. NOTE: From version 1.227.0, cache_disk_category can be set to cloud_essd.
CacheDiskSizeInGb int
The capacity of the cache disk.
CacheId string
The ID of the cache disk.
GatewayId Changes to this property will trigger replacement. string
The ID of the gateway.
LocalFilePath string
The path of the cache disk.
PerformanceLevel Changes to this property will trigger replacement. string
The performance level (PL) of the Enterprise SSD (ESSD). Valid values: PL1, PL2, PL3. NOTE: If cache_disk_category is set to cloud_essd, performance_level is required.
Status int
The status of the Gateway Cache Disk.
CacheDiskCategory Changes to this property will trigger replacement. string
The type of the cache disk. Valid values: cloud_efficiency, cloud_ssd, cloud_essd. NOTE: From version 1.227.0, cache_disk_category can be set to cloud_essd.
CacheDiskSizeInGb int
The capacity of the cache disk.
CacheId string
The ID of the cache disk.
GatewayId Changes to this property will trigger replacement. string
The ID of the gateway.
LocalFilePath string
The path of the cache disk.
PerformanceLevel Changes to this property will trigger replacement. string
The performance level (PL) of the Enterprise SSD (ESSD). Valid values: PL1, PL2, PL3. NOTE: If cache_disk_category is set to cloud_essd, performance_level is required.
Status int
The status of the Gateway Cache Disk.
cacheDiskCategory Changes to this property will trigger replacement. String
The type of the cache disk. Valid values: cloud_efficiency, cloud_ssd, cloud_essd. NOTE: From version 1.227.0, cache_disk_category can be set to cloud_essd.
cacheDiskSizeInGb Integer
The capacity of the cache disk.
cacheId String
The ID of the cache disk.
gatewayId Changes to this property will trigger replacement. String
The ID of the gateway.
localFilePath String
The path of the cache disk.
performanceLevel Changes to this property will trigger replacement. String
The performance level (PL) of the Enterprise SSD (ESSD). Valid values: PL1, PL2, PL3. NOTE: If cache_disk_category is set to cloud_essd, performance_level is required.
status Integer
The status of the Gateway Cache Disk.
cacheDiskCategory Changes to this property will trigger replacement. string
The type of the cache disk. Valid values: cloud_efficiency, cloud_ssd, cloud_essd. NOTE: From version 1.227.0, cache_disk_category can be set to cloud_essd.
cacheDiskSizeInGb number
The capacity of the cache disk.
cacheId string
The ID of the cache disk.
gatewayId Changes to this property will trigger replacement. string
The ID of the gateway.
localFilePath string
The path of the cache disk.
performanceLevel Changes to this property will trigger replacement. string
The performance level (PL) of the Enterprise SSD (ESSD). Valid values: PL1, PL2, PL3. NOTE: If cache_disk_category is set to cloud_essd, performance_level is required.
status number
The status of the Gateway Cache Disk.
cache_disk_category Changes to this property will trigger replacement. str
The type of the cache disk. Valid values: cloud_efficiency, cloud_ssd, cloud_essd. NOTE: From version 1.227.0, cache_disk_category can be set to cloud_essd.
cache_disk_size_in_gb int
The capacity of the cache disk.
cache_id str
The ID of the cache disk.
gateway_id Changes to this property will trigger replacement. str
The ID of the gateway.
local_file_path str
The path of the cache disk.
performance_level Changes to this property will trigger replacement. str
The performance level (PL) of the Enterprise SSD (ESSD). Valid values: PL1, PL2, PL3. NOTE: If cache_disk_category is set to cloud_essd, performance_level is required.
status int
The status of the Gateway Cache Disk.
cacheDiskCategory Changes to this property will trigger replacement. String
The type of the cache disk. Valid values: cloud_efficiency, cloud_ssd, cloud_essd. NOTE: From version 1.227.0, cache_disk_category can be set to cloud_essd.
cacheDiskSizeInGb Number
The capacity of the cache disk.
cacheId String
The ID of the cache disk.
gatewayId Changes to this property will trigger replacement. String
The ID of the gateway.
localFilePath String
The path of the cache disk.
performanceLevel Changes to this property will trigger replacement. String
The performance level (PL) of the Enterprise SSD (ESSD). Valid values: PL1, PL2, PL3. NOTE: If cache_disk_category is set to cloud_essd, performance_level is required.
status Number
The status of the Gateway Cache Disk.

Import

Cloud Storage Gateway Gateway Cache Disk can be imported using the id, e.g.

$ pulumi import alicloud:cloudstoragegateway/gatewayCacheDisk:GatewayCacheDisk example <gateway_id>:<cache_id>:<local_file_path>
Copy

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

Package Details

Repository
Alibaba Cloud pulumi/pulumi-alicloud
License
Apache-2.0
Notes
This Pulumi package is based on the alicloud Terraform Provider.
Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-alicloud