Cache
Manages an AWS Storage Gateway cache.
NOTE: The Storage Gateway API provides no method to remove a cache disk. Destroying this resource does not perform any Storage Gateway actions.
Example Usage
using Pulumi;
using Aws = Pulumi.Aws;
class MyStack : Stack
{
public MyStack()
{
var example = new Aws.StorageGateway.Cache("example", new Aws.StorageGateway.CacheArgs
{
DiskId = data.Aws_storagegateway_local_disk.Example.Id,
GatewayArn = aws_storagegateway_gateway.Example.Arn,
});
}
}
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v2/go/aws/storagegateway"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := storagegateway.NewCache(ctx, "example", &storagegateway.CacheArgs{
DiskId: pulumi.String(data.Aws_storagegateway_local_disk.Example.Id),
GatewayArn: pulumi.String(aws_storagegateway_gateway.Example.Arn),
})
if err != nil {
return err
}
return nil
})
}import pulumi
import pulumi_aws as aws
example = aws.storagegateway.Cache("example",
disk_id=data["aws_storagegateway_local_disk"]["example"]["id"],
gateway_arn=aws_storagegateway_gateway["example"]["arn"])import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.storagegateway.Cache("example", {
diskId: aws_storagegateway_local_disk_example.id,
gatewayArn: aws_storagegateway_gateway_example.arn,
});Create a Cache Resource
new Cache(name: string, args: CacheArgs, opts?: CustomResourceOptions);def Cache(resource_name, opts=None, disk_id=None, gateway_arn=None, __props__=None);public Cache(string name, CacheArgs args, CustomResourceOptions? opts = null)- name string
- The unique name of the resource.
- args CacheArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- opts ResourceOptions
- A bag of options that control this resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args CacheArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CacheArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
Cache Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.
Inputs
The Cache resource accepts the following input properties:
- Disk
Id string Local disk identifier. For example,
pci-0000:03:00.0-scsi-0:0:0:0.- Gateway
Arn string The Amazon Resource Name (ARN) of the gateway.
- Disk
Id string Local disk identifier. For example,
pci-0000:03:00.0-scsi-0:0:0:0.- Gateway
Arn string The Amazon Resource Name (ARN) of the gateway.
- disk
Id string Local disk identifier. For example,
pci-0000:03:00.0-scsi-0:0:0:0.- gateway
Arn string The Amazon Resource Name (ARN) of the gateway.
- disk_
id str Local disk identifier. For example,
pci-0000:03:00.0-scsi-0:0:0:0.- gateway_
arn str The Amazon Resource Name (ARN) of the gateway.
Outputs
All input properties are implicitly available as output properties. Additionally, the Cache resource produces the following output properties:
Look up an Existing Cache Resource
Get an existing Cache 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?: CacheState, opts?: CustomResourceOptions): Cachestatic get(resource_name, id, opts=None, disk_id=None, gateway_arn=None, __props__=None);func GetCache(ctx *Context, name string, id IDInput, state *CacheState, opts ...ResourceOption) (*Cache, error)public static Cache Get(string name, Input<string> id, CacheState? state, CustomResourceOptions? opts = null)- 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.
The following state arguments are supported:
- Disk
Id string Local disk identifier. For example,
pci-0000:03:00.0-scsi-0:0:0:0.- Gateway
Arn string The Amazon Resource Name (ARN) of the gateway.
- Disk
Id string Local disk identifier. For example,
pci-0000:03:00.0-scsi-0:0:0:0.- Gateway
Arn string The Amazon Resource Name (ARN) of the gateway.
- disk
Id string Local disk identifier. For example,
pci-0000:03:00.0-scsi-0:0:0:0.- gateway
Arn string The Amazon Resource Name (ARN) of the gateway.
- disk_
id str Local disk identifier. For example,
pci-0000:03:00.0-scsi-0:0:0:0.- gateway_
arn str The Amazon Resource Name (ARN) of the gateway.
Package Details
- Repository
- https://github.com/pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
awsTerraform Provider.