Module storagegateway

This page documents the language specification for the aws package. If you're looking for help working with the inputs, outputs, or functions of aws resources in a Pulumi program, please see the resource documentation for examples and API reference.

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-aws repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-aws repo.

Resources

Resource Cache

class Cache extends CustomResource

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

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,
});

constructor

new Cache(name: string, args: CacheArgs, opts?: pulumi.CustomResourceOptions)

Create a Cache resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: CacheState, opts?: pulumi.CustomResourceOptions): Cache

Get an existing Cache resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Cache

Returns true if the given object is an instance of Cache. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property diskId

public diskId: pulumi.Output<string>;

Local disk identifier. For example, pci-0000:03:00.0-scsi-0:0:0:0.

property gatewayArn

public gatewayArn: pulumi.Output<string>;

The Amazon Resource Name (ARN) of the gateway.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource CachesIscsiVolume

class CachesIscsiVolume extends CustomResource

Manages an AWS Storage Gateway cached iSCSI volume.

NOTE: The gateway must have cache added (e.g. via the aws.storagegateway.Cache resource) before creating volumes otherwise the Storage Gateway API will return an error.
NOTE: The gateway must have an upload buffer added (e.g. via the aws.storagegateway.UploadBuffer resource) before the volume is operational to clients, however the Storage Gateway API will allow volume creation without error in that case and return volume status as UPLOAD BUFFER NOT CONFIGURED.

Example Usage

Create Empty Cached iSCSI Volume

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.storagegateway.CachesIscsiVolume("example", {
    gatewayArn: aws_storagegateway_cache_example.gatewayArn,
    networkInterfaceId: aws_instance_example.privateIp,
    targetName: "example",
    volumeSizeInBytes: 5368709120, // 5 GB
});

Create Cached iSCSI Volume From Snapshot

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.storagegateway.CachesIscsiVolume("example", {
    gatewayArn: aws_storagegateway_cache_example.gatewayArn,
    networkInterfaceId: aws_instance_example.privateIp,
    snapshotId: aws_ebs_snapshot_example.id,
    targetName: "example",
    volumeSizeInBytes: aws_ebs_snapshot_example.volumeSize.apply(volumeSize => (((volumeSize * 1024) * 1024) * 1024)),
});

Create Cached iSCSI Volume From Source Volume

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.storagegateway.CachesIscsiVolume("example", {
    gatewayArn: aws_storagegateway_cache_example.gatewayArn,
    networkInterfaceId: aws_instance_example.privateIp,
    sourceVolumeArn: aws_storagegateway_cached_iscsi_volume_existing.arn,
    targetName: "example",
    volumeSizeInBytes: aws_storagegateway_cached_iscsi_volume_existing.volumeSizeInBytes,
});

constructor

new CachesIscsiVolume(name: string, args: CachesIscsiVolumeArgs, opts?: pulumi.CustomResourceOptions)

Create a CachesIscsiVolume resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: CachesIscsiVolumeState, opts?: pulumi.CustomResourceOptions): CachesIscsiVolume

Get an existing CachesIscsiVolume resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is CachesIscsiVolume

Returns true if the given object is an instance of CachesIscsiVolume. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

Volume Amazon Resource Name (ARN), e.g. arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-12345678/volume/vol-12345678.

property chapEnabled

public chapEnabled: pulumi.Output<boolean>;

Whether mutual CHAP is enabled for the iSCSI target.

property gatewayArn

public gatewayArn: pulumi.Output<string>;

The Amazon Resource Name (ARN) of the gateway.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property lunNumber

public lunNumber: pulumi.Output<number>;

Logical disk number.

property networkInterfaceId

public networkInterfaceId: pulumi.Output<string>;

The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted.

property networkInterfacePort

public networkInterfacePort: pulumi.Output<number>;

The port used to communicate with iSCSI targets.

property snapshotId

public snapshotId: pulumi.Output<string | undefined>;

The snapshot ID of the snapshot to restore as the new cached volume. e.g. snap-1122aabb.

property sourceVolumeArn

public sourceVolumeArn: pulumi.Output<string | undefined>;

The ARN for an existing volume. Specifying this ARN makes the new volume into an exact copy of the specified existing volume’s latest recovery point. The volumeSizeInBytes value for this new volume must be equal to or larger than the size of the existing volume, in bytes.

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

Key-value map of resource tags

property targetArn

public targetArn: pulumi.Output<string>;

Target Amazon Resource Name (ARN), e.g. arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-12345678/target/iqn.1997-05.com.amazon:TargetName.

property targetName

public targetName: pulumi.Output<string>;

The name of the iSCSI target used by initiators to connect to the target and as a suffix for the target ARN. The target name must be unique across all volumes of a gateway.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property volumeArn

public volumeArn: pulumi.Output<string>;

Volume Amazon Resource Name (ARN), e.g. arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-12345678/volume/vol-12345678.

property volumeId

public volumeId: pulumi.Output<string>;

Volume ID, e.g. vol-12345678.

property volumeSizeInBytes

public volumeSizeInBytes: pulumi.Output<number>;

The size of the volume in bytes.

Resource Gateway

class Gateway extends CustomResource

Manages an AWS Storage Gateway file, tape, or volume gateway in the provider region.

NOTE: The Storage Gateway API requires the gateway to be connected to properly return information after activation. If you are receiving The specified gateway is not connected errors during resource creation (gateway activation), ensure your gateway instance meets the Storage Gateway requirements.

Example Usage

File Gateway

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.storagegateway.Gateway("example", {
    gatewayIpAddress: "1.2.3.4",
    gatewayName: "example",
    gatewayTimezone: "GMT",
    gatewayType: "FILE_S3",
});

Tape Gateway

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.storagegateway.Gateway("example", {
    gatewayIpAddress: "1.2.3.4",
    gatewayName: "example",
    gatewayTimezone: "GMT",
    gatewayType: "VTL",
    mediaChangerType: "AWS-Gateway-VTL",
    tapeDriveType: "IBM-ULT3580-TD5",
});

Volume Gateway (Cached)

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.storagegateway.Gateway("example", {
    gatewayIpAddress: "1.2.3.4",
    gatewayName: "example",
    gatewayTimezone: "GMT",
    gatewayType: "CACHED",
});

Volume Gateway (Stored)

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.storagegateway.Gateway("example", {
    gatewayIpAddress: "1.2.3.4",
    gatewayName: "example",
    gatewayTimezone: "GMT",
    gatewayType: "STORED",
});

constructor

new Gateway(name: string, args: GatewayArgs, opts?: pulumi.CustomResourceOptions)

Create a Gateway resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: GatewayState, opts?: pulumi.CustomResourceOptions): Gateway

Get an existing Gateway resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Gateway

Returns true if the given object is an instance of Gateway. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property activationKey

public activationKey: pulumi.Output<string>;

Gateway activation key during resource creation. Conflicts with gatewayIpAddress. Additional information is available in the Storage Gateway User Guide.

property arn

public arn: pulumi.Output<string>;

Amazon Resource Name (ARN) of the gateway.

property cloudwatchLogGroupArn

public cloudwatchLogGroupArn: pulumi.Output<string | undefined>;

The Amazon Resource Name (ARN) of the Amazon CloudWatch log group to use to monitor and log events in the gateway.

property gatewayId

public gatewayId: pulumi.Output<string>;

Identifier of the gateway.

property gatewayIpAddress

public gatewayIpAddress: pulumi.Output<string>;

Gateway IP address to retrieve activation key during resource creation. Conflicts with activationKey. Gateway must be accessible on port 80 from where this provider is running. Additional information is available in the Storage Gateway User Guide.

property gatewayName

public gatewayName: pulumi.Output<string>;

Name of the gateway.

property gatewayTimezone

public gatewayTimezone: pulumi.Output<string>;

Time zone for the gateway. The time zone is of the format “GMT”, “GMT-hr:mm”, or “GMT+hr:mm”. For example, GMT-4:00 indicates the time is 4 hours behind GMT. The time zone is used, for example, for scheduling snapshots and your gateway’s maintenance schedule.

property gatewayType

public gatewayType: pulumi.Output<string | undefined>;

Type of the gateway. The default value is STORED. Valid values: CACHED, FILE_S3, STORED, VTL.

property gatewayVpcEndpoint

public gatewayVpcEndpoint: pulumi.Output<string | undefined>;

VPC endpoint address to be used when activating your gateway. This should be used when your instance is in a private subnet. Requires HTTP access from client computer running Pulumi. More info on what ports are required by your VPC Endpoint Security group in Activating a Gateway in a Virtual Private Cloud.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property mediumChangerType

public mediumChangerType: pulumi.Output<string | undefined>;

property smbActiveDirectorySettings

public smbActiveDirectorySettings: pulumi.Output<GatewaySmbActiveDirectorySettings | undefined>;

Nested argument with Active Directory domain join information for Server Message Block (SMB) file shares. Only valid for FILE_S3 gateway type. Must be set before creating ActiveDirectory authentication SMB file shares. More details below.

property smbGuestPassword

public smbGuestPassword: pulumi.Output<string | undefined>;

Guest password for Server Message Block (SMB) file shares. Only valid for FILE_S3 gateway type. Must be set before creating GuestAccess authentication SMB file shares. This provider can only detect drift of the existence of a guest password, not its actual value from the gateway. This provider can however update the password with changing the argument.

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

Key-value mapping of resource tags

property tapeDriveType

public tapeDriveType: pulumi.Output<string | undefined>;

Type of tape drive to use for tape gateway. This provider cannot detect drift of this argument. Valid values: IBM-ULT3580-TD5.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource NfsFileShare

class NfsFileShare extends CustomResource

Manages an AWS Storage Gateway NFS File Share.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.storagegateway.NfsFileShare("example", {
    clientLists: ["0.0.0.0/0"],
    gatewayArn: aws_storagegateway_gateway_example.arn,
    locationArn: aws_s3_bucket_example.arn,
    roleArn: aws_iam_role_example.arn,
});

constructor

new NfsFileShare(name: string, args: NfsFileShareArgs, opts?: pulumi.CustomResourceOptions)

Create a NfsFileShare resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: NfsFileShareState, opts?: pulumi.CustomResourceOptions): NfsFileShare

Get an existing NfsFileShare resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is NfsFileShare

Returns true if the given object is an instance of NfsFileShare. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

Amazon Resource Name (ARN) of the NFS File Share.

property clientLists

public clientLists: pulumi.Output<string[]>;

The list of clients that are allowed to access the file gateway. The list must contain either valid IP addresses or valid CIDR blocks. Set to ["0.0.0.0/0"] to not limit access. Minimum 1 item. Maximum 100 items.

property defaultStorageClass

public defaultStorageClass: pulumi.Output<string | undefined>;

The default storage class for objects put into an Amazon S3 bucket by the file gateway. Defaults to S3_STANDARD. Valid values: S3_STANDARD, S3_STANDARD_IA, S3_ONEZONE_IA.

property fileshareId

public fileshareId: pulumi.Output<string>;

ID of the NFS File Share.

property gatewayArn

public gatewayArn: pulumi.Output<string>;

Amazon Resource Name (ARN) of the file gateway.

property guessMimeTypeEnabled

public guessMimeTypeEnabled: pulumi.Output<boolean | undefined>;

Boolean value that enables guessing of the MIME type for uploaded objects based on file extensions. Defaults to true.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property kmsEncrypted

public kmsEncrypted: pulumi.Output<boolean | undefined>;

Boolean value if true to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Defaults to false.

property kmsKeyArn

public kmsKeyArn: pulumi.Output<string | undefined>;

Amazon Resource Name (ARN) for KMS key used for Amazon S3 server side encryption. This value can only be set when kmsEncrypted is true.

property locationArn

public locationArn: pulumi.Output<string>;

The ARN of the backed storage used for storing file data.

property nfsFileShareDefaults

public nfsFileShareDefaults: pulumi.Output<NfsFileShareNfsFileShareDefaults | undefined>;

Nested argument with file share default values. More information below.

property objectAcl

public objectAcl: pulumi.Output<string | undefined>;

Access Control List permission for S3 bucket objects. Defaults to private.

property path

public path: pulumi.Output<string>;

File share path used by the NFS client to identify the mount point.

property readOnly

public readOnly: pulumi.Output<boolean | undefined>;

Boolean to indicate write status of file share. File share does not accept writes if true. Defaults to false.

property requesterPays

public requesterPays: pulumi.Output<boolean | undefined>;

Boolean who pays the cost of the request and the data download from the Amazon S3 bucket. Set this value to true if you want the requester to pay instead of the bucket owner. Defaults to false.

property roleArn

public roleArn: pulumi.Output<string>;

The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.

property squash

public squash: pulumi.Output<string | undefined>;

Maps a user to anonymous user. Defaults to RootSquash. Valid values: RootSquash (only root is mapped to anonymous user), NoSquash (no one is mapped to anonymous user), AllSquash (everyone is mapped to anonymous user)

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

Key-value map of resource tags

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource SmbFileShare

class SmbFileShare extends CustomResource

Manages an AWS Storage Gateway SMB File Share.

Example Usage

Active Directory Authentication

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.storagegateway.SmbFileShare("example", {
    authentication: "ActiveDirectory",
    gatewayArn: aws_storagegateway_gateway_example.arn,
    locationArn: aws_s3_bucket_example.arn,
    roleArn: aws_iam_role_example.arn,
});

Guest Authentication

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.storagegateway.SmbFileShare("example", {
    authentication: "GuestAccess",
    gatewayArn: aws_storagegateway_gateway_example.arn,
    locationArn: aws_s3_bucket_example.arn,
    roleArn: aws_iam_role_example.arn,
});

constructor

new SmbFileShare(name: string, args: SmbFileShareArgs, opts?: pulumi.CustomResourceOptions)

Create a SmbFileShare resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: SmbFileShareState, opts?: pulumi.CustomResourceOptions): SmbFileShare

Get an existing SmbFileShare resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is SmbFileShare

Returns true if the given object is an instance of SmbFileShare. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

Amazon Resource Name (ARN) of the SMB File Share.

property authentication

public authentication: pulumi.Output<string | undefined>;

The authentication method that users use to access the file share. Defaults to ActiveDirectory. Valid values: ActiveDirectory, GuestAccess.

property defaultStorageClass

public defaultStorageClass: pulumi.Output<string | undefined>;

The default storage class for objects put into an Amazon S3 bucket by the file gateway. Defaults to S3_STANDARD. Valid values: S3_STANDARD, S3_STANDARD_IA, S3_ONEZONE_IA.

property fileshareId

public fileshareId: pulumi.Output<string>;

ID of the SMB File Share.

property gatewayArn

public gatewayArn: pulumi.Output<string>;

Amazon Resource Name (ARN) of the file gateway.

property guessMimeTypeEnabled

public guessMimeTypeEnabled: pulumi.Output<boolean | undefined>;

Boolean value that enables guessing of the MIME type for uploaded objects based on file extensions. Defaults to true.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property invalidUserLists

public invalidUserLists: pulumi.Output<string[] | undefined>;

A list of users in the Active Directory that are not allowed to access the file share. Only valid if authentication is set to ActiveDirectory.

property kmsEncrypted

public kmsEncrypted: pulumi.Output<boolean | undefined>;

Boolean value if true to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Defaults to false.

property kmsKeyArn

public kmsKeyArn: pulumi.Output<string | undefined>;

Amazon Resource Name (ARN) for KMS key used for Amazon S3 server side encryption. This value can only be set when kmsEncrypted is true.

property locationArn

public locationArn: pulumi.Output<string>;

The ARN of the backed storage used for storing file data.

property objectAcl

public objectAcl: pulumi.Output<string | undefined>;

Access Control List permission for S3 bucket objects. Defaults to private.

property path

public path: pulumi.Output<string>;

File share path used by the NFS client to identify the mount point.

property readOnly

public readOnly: pulumi.Output<boolean | undefined>;

Boolean to indicate write status of file share. File share does not accept writes if true. Defaults to false.

property requesterPays

public requesterPays: pulumi.Output<boolean | undefined>;

Boolean who pays the cost of the request and the data download from the Amazon S3 bucket. Set this value to true if you want the requester to pay instead of the bucket owner. Defaults to false.

property roleArn

public roleArn: pulumi.Output<string>;

The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

Key-value map of resource tags

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property validUserLists

public validUserLists: pulumi.Output<string[] | undefined>;

A list of users in the Active Directory that are allowed to access the file share. Only valid if authentication is set to ActiveDirectory.

Resource UploadBuffer

class UploadBuffer extends CustomResource

Manages an AWS Storage Gateway upload buffer.

NOTE: The Storage Gateway API provides no method to remove an upload buffer disk. Destroying this resource does not perform any Storage Gateway actions.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.storagegateway.UploadBuffer("example", {
    diskId: aws_storagegateway_local_disk_example.id,
    gatewayArn: aws_storagegateway_gateway_example.arn,
});

constructor

new UploadBuffer(name: string, args: UploadBufferArgs, opts?: pulumi.CustomResourceOptions)

Create a UploadBuffer resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: UploadBufferState, opts?: pulumi.CustomResourceOptions): UploadBuffer

Get an existing UploadBuffer resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is UploadBuffer

Returns true if the given object is an instance of UploadBuffer. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property diskId

public diskId: pulumi.Output<string>;

Local disk identifier. For example, pci-0000:03:00.0-scsi-0:0:0:0.

property gatewayArn

public gatewayArn: pulumi.Output<string>;

The Amazon Resource Name (ARN) of the gateway.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource WorkingStorage

class WorkingStorage extends CustomResource

Manages an AWS Storage Gateway working storage.

NOTE: The Storage Gateway API provides no method to remove a working storage disk. Destroying this resource does not perform any Storage Gateway actions.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.storagegateway.WorkingStorage("example", {
    diskId: aws_storagegateway_local_disk_example.id,
    gatewayArn: aws_storagegateway_gateway_example.arn,
});

constructor

new WorkingStorage(name: string, args: WorkingStorageArgs, opts?: pulumi.CustomResourceOptions)

Create a WorkingStorage resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: WorkingStorageState, opts?: pulumi.CustomResourceOptions): WorkingStorage

Get an existing WorkingStorage resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is WorkingStorage

Returns true if the given object is an instance of WorkingStorage. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property diskId

public diskId: pulumi.Output<string>;

Local disk identifier. For example, pci-0000:03:00.0-scsi-0:0:0:0.

property gatewayArn

public gatewayArn: pulumi.Output<string>;

The Amazon Resource Name (ARN) of the gateway.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Functions

Function getLocalDisk

getLocalDisk(args: GetLocalDiskArgs, opts?: pulumi.InvokeOptions): Promise<GetLocalDiskResult>

Retrieve information about a Storage Gateway local disk. The disk identifier is useful for adding the disk as a cache or upload buffer to a gateway.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const test = pulumi.all([aws_volume_attachment_test.deviceName, aws_storagegateway_gateway_test.arn]).apply(([deviceName, arn]) => aws.storagegateway.getLocalDisk({
    diskPath: deviceName,
    gatewayArn: arn,
}, { async: true }));

Others

interface CacheArgs

interface CacheArgs

The set of arguments for constructing a Cache resource.

property diskId

diskId: pulumi.Input<string>;

Local disk identifier. For example, pci-0000:03:00.0-scsi-0:0:0:0.

property gatewayArn

gatewayArn: pulumi.Input<string>;

The Amazon Resource Name (ARN) of the gateway.

interface CachesIscsiVolumeArgs

interface CachesIscsiVolumeArgs

The set of arguments for constructing a CachesIscsiVolume resource.

property gatewayArn

gatewayArn: pulumi.Input<string>;

The Amazon Resource Name (ARN) of the gateway.

property networkInterfaceId

networkInterfaceId: pulumi.Input<string>;

The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted.

property snapshotId

snapshotId?: pulumi.Input<string>;

The snapshot ID of the snapshot to restore as the new cached volume. e.g. snap-1122aabb.

property sourceVolumeArn

sourceVolumeArn?: pulumi.Input<string>;

property tags

tags?: pulumi.Input<{[key: string]: any}>;

Key-value map of resource tags

property targetName

targetName: pulumi.Input<string>;

The name of the iSCSI target used by initiators to connect to the target and as a suffix for the target ARN. The target name must be unique across all volumes of a gateway.

property volumeSizeInBytes

volumeSizeInBytes: pulumi.Input<number>;

The size of the volume in bytes.

interface CachesIscsiVolumeState

interface CachesIscsiVolumeState

Input properties used for looking up and filtering CachesIscsiVolume resources.

property arn

arn?: pulumi.Input<string>;

Volume Amazon Resource Name (ARN), e.g. arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-12345678/volume/vol-12345678.

property chapEnabled

chapEnabled?: pulumi.Input<boolean>;

Whether mutual CHAP is enabled for the iSCSI target.

property gatewayArn

gatewayArn?: pulumi.Input<string>;

The Amazon Resource Name (ARN) of the gateway.

property lunNumber

lunNumber?: pulumi.Input<number>;

Logical disk number.

property networkInterfaceId

networkInterfaceId?: pulumi.Input<string>;

The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted.

property networkInterfacePort

networkInterfacePort?: pulumi.Input<number>;

The port used to communicate with iSCSI targets.

property snapshotId

snapshotId?: pulumi.Input<string>;

The snapshot ID of the snapshot to restore as the new cached volume. e.g. snap-1122aabb.

property sourceVolumeArn

sourceVolumeArn?: pulumi.Input<string>;

property tags

tags?: pulumi.Input<{[key: string]: any}>;

Key-value map of resource tags

property targetArn

targetArn?: pulumi.Input<string>;

Target Amazon Resource Name (ARN), e.g. arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-12345678/target/iqn.1997-05.com.amazon:TargetName.

property targetName

targetName?: pulumi.Input<string>;

The name of the iSCSI target used by initiators to connect to the target and as a suffix for the target ARN. The target name must be unique across all volumes of a gateway.

property volumeArn

volumeArn?: pulumi.Input<string>;

Volume Amazon Resource Name (ARN), e.g. arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-12345678/volume/vol-12345678.

property volumeId

volumeId?: pulumi.Input<string>;

Volume ID, e.g. vol-12345678.

property volumeSizeInBytes

volumeSizeInBytes?: pulumi.Input<number>;

The size of the volume in bytes.

interface CacheState

interface CacheState

Input properties used for looking up and filtering Cache resources.

property diskId

diskId?: pulumi.Input<string>;

Local disk identifier. For example, pci-0000:03:00.0-scsi-0:0:0:0.

property gatewayArn

gatewayArn?: pulumi.Input<string>;

The Amazon Resource Name (ARN) of the gateway.

interface GatewayArgs

interface GatewayArgs

The set of arguments for constructing a Gateway resource.

property activationKey

activationKey?: pulumi.Input<string>;

Gateway activation key during resource creation. Conflicts with gatewayIpAddress. Additional information is available in the Storage Gateway User Guide.

property cloudwatchLogGroupArn

cloudwatchLogGroupArn?: pulumi.Input<string>;

The Amazon Resource Name (ARN) of the Amazon CloudWatch log group to use to monitor and log events in the gateway.

property gatewayIpAddress

gatewayIpAddress?: pulumi.Input<string>;

property gatewayName

gatewayName: pulumi.Input<string>;

Name of the gateway.

property gatewayTimezone

gatewayTimezone: pulumi.Input<string>;

property gatewayType

gatewayType?: pulumi.Input<string>;

Type of the gateway. The default value is STORED. Valid values: CACHED, FILE_S3, STORED, VTL.

property gatewayVpcEndpoint

gatewayVpcEndpoint?: pulumi.Input<string>;

property mediumChangerType

mediumChangerType?: pulumi.Input<string>;

property smbActiveDirectorySettings

smbActiveDirectorySettings?: pulumi.Input<GatewaySmbActiveDirectorySettings>;

property smbGuestPassword

smbGuestPassword?: pulumi.Input<string>;

property tags

tags?: pulumi.Input<{[key: string]: any}>;

Key-value mapping of resource tags

property tapeDriveType

tapeDriveType?: pulumi.Input<string>;

Type of tape drive to use for tape gateway. This provider cannot detect drift of this argument. Valid values: IBM-ULT3580-TD5.

interface GatewayState

interface GatewayState

Input properties used for looking up and filtering Gateway resources.

property activationKey

activationKey?: pulumi.Input<string>;

Gateway activation key during resource creation. Conflicts with gatewayIpAddress. Additional information is available in the Storage Gateway User Guide.

property arn

arn?: pulumi.Input<string>;

Amazon Resource Name (ARN) of the gateway.

property cloudwatchLogGroupArn

cloudwatchLogGroupArn?: pulumi.Input<string>;

The Amazon Resource Name (ARN) of the Amazon CloudWatch log group to use to monitor and log events in the gateway.

property gatewayId

gatewayId?: pulumi.Input<string>;

Identifier of the gateway.

property gatewayIpAddress

gatewayIpAddress?: pulumi.Input<string>;

property gatewayName

gatewayName?: pulumi.Input<string>;

Name of the gateway.

property gatewayTimezone

gatewayTimezone?: pulumi.Input<string>;

property gatewayType

gatewayType?: pulumi.Input<string>;

Type of the gateway. The default value is STORED. Valid values: CACHED, FILE_S3, STORED, VTL.

property gatewayVpcEndpoint

gatewayVpcEndpoint?: pulumi.Input<string>;

property mediumChangerType

mediumChangerType?: pulumi.Input<string>;

property smbActiveDirectorySettings

smbActiveDirectorySettings?: pulumi.Input<GatewaySmbActiveDirectorySettings>;

property smbGuestPassword

smbGuestPassword?: pulumi.Input<string>;

property tags

tags?: pulumi.Input<{[key: string]: any}>;

Key-value mapping of resource tags

property tapeDriveType

tapeDriveType?: pulumi.Input<string>;

Type of tape drive to use for tape gateway. This provider cannot detect drift of this argument. Valid values: IBM-ULT3580-TD5.

interface GetLocalDiskArgs

interface GetLocalDiskArgs

A collection of arguments for invoking getLocalDisk.

property diskNode

diskNode?: undefined | string;

The device node of the local disk to retrieve. For example, /dev/sdb.

property diskPath

diskPath?: undefined | string;

The device path of the local disk to retrieve. For example, /dev/xvdb or /dev/nvme1n1.

property gatewayArn

gatewayArn: string;

The Amazon Resource Name (ARN) of the gateway.

interface GetLocalDiskResult

interface GetLocalDiskResult

A collection of values returned by getLocalDisk.

property diskId

diskId: string;

The disk identifier. e.g. pci-0000:03:00.0-scsi-0:0:0:0

property diskNode

diskNode?: undefined | string;

property diskPath

diskPath?: undefined | string;

property gatewayArn

gatewayArn: string;

property id

id: string;

The provider-assigned unique ID for this managed resource.

interface NfsFileShareArgs

interface NfsFileShareArgs

The set of arguments for constructing a NfsFileShare resource.

property clientLists

clientLists: pulumi.Input<pulumi.Input<string>[]>;

property defaultStorageClass

defaultStorageClass?: pulumi.Input<string>;

The default storage class for objects put into an Amazon S3 bucket by the file gateway. Defaults to S3_STANDARD. Valid values: S3_STANDARD, S3_STANDARD_IA, S3_ONEZONE_IA.

property gatewayArn

gatewayArn: pulumi.Input<string>;

Amazon Resource Name (ARN) of the file gateway.

property guessMimeTypeEnabled

guessMimeTypeEnabled?: pulumi.Input<boolean>;

Boolean value that enables guessing of the MIME type for uploaded objects based on file extensions. Defaults to true.

property kmsEncrypted

kmsEncrypted?: pulumi.Input<boolean>;

Boolean value if true to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Defaults to false.

property kmsKeyArn

kmsKeyArn?: pulumi.Input<string>;

Amazon Resource Name (ARN) for KMS key used for Amazon S3 server side encryption. This value can only be set when kmsEncrypted is true.

property locationArn

locationArn: pulumi.Input<string>;

The ARN of the backed storage used for storing file data.

property nfsFileShareDefaults

nfsFileShareDefaults?: pulumi.Input<NfsFileShareNfsFileShareDefaults>;

Nested argument with file share default values. More information below.

property objectAcl

objectAcl?: pulumi.Input<string>;

Access Control List permission for S3 bucket objects. Defaults to private.

property readOnly

readOnly?: pulumi.Input<boolean>;

Boolean to indicate write status of file share. File share does not accept writes if true. Defaults to false.

property requesterPays

requesterPays?: pulumi.Input<boolean>;

Boolean who pays the cost of the request and the data download from the Amazon S3 bucket. Set this value to true if you want the requester to pay instead of the bucket owner. Defaults to false.

property roleArn

roleArn: pulumi.Input<string>;

The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.

property squash

squash?: pulumi.Input<string>;

property tags

tags?: pulumi.Input<{[key: string]: any}>;

Key-value map of resource tags

interface NfsFileShareState

interface NfsFileShareState

Input properties used for looking up and filtering NfsFileShare resources.

property arn

arn?: pulumi.Input<string>;

Amazon Resource Name (ARN) of the NFS File Share.

property clientLists

clientLists?: pulumi.Input<pulumi.Input<string>[]>;

property defaultStorageClass

defaultStorageClass?: pulumi.Input<string>;

The default storage class for objects put into an Amazon S3 bucket by the file gateway. Defaults to S3_STANDARD. Valid values: S3_STANDARD, S3_STANDARD_IA, S3_ONEZONE_IA.

property fileshareId

fileshareId?: pulumi.Input<string>;

ID of the NFS File Share.

property gatewayArn

gatewayArn?: pulumi.Input<string>;

Amazon Resource Name (ARN) of the file gateway.

property guessMimeTypeEnabled

guessMimeTypeEnabled?: pulumi.Input<boolean>;

Boolean value that enables guessing of the MIME type for uploaded objects based on file extensions. Defaults to true.

property kmsEncrypted

kmsEncrypted?: pulumi.Input<boolean>;

Boolean value if true to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Defaults to false.

property kmsKeyArn

kmsKeyArn?: pulumi.Input<string>;

Amazon Resource Name (ARN) for KMS key used for Amazon S3 server side encryption. This value can only be set when kmsEncrypted is true.

property locationArn

locationArn?: pulumi.Input<string>;

The ARN of the backed storage used for storing file data.

property nfsFileShareDefaults

nfsFileShareDefaults?: pulumi.Input<NfsFileShareNfsFileShareDefaults>;

Nested argument with file share default values. More information below.

property objectAcl

objectAcl?: pulumi.Input<string>;

Access Control List permission for S3 bucket objects. Defaults to private.

property path

path?: pulumi.Input<string>;

File share path used by the NFS client to identify the mount point.

property readOnly

readOnly?: pulumi.Input<boolean>;

Boolean to indicate write status of file share. File share does not accept writes if true. Defaults to false.

property requesterPays

requesterPays?: pulumi.Input<boolean>;

Boolean who pays the cost of the request and the data download from the Amazon S3 bucket. Set this value to true if you want the requester to pay instead of the bucket owner. Defaults to false.

property roleArn

roleArn?: pulumi.Input<string>;

The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.

property squash

squash?: pulumi.Input<string>;

property tags

tags?: pulumi.Input<{[key: string]: any}>;

Key-value map of resource tags

interface SmbFileShareArgs

interface SmbFileShareArgs

The set of arguments for constructing a SmbFileShare resource.

property authentication

authentication?: pulumi.Input<string>;

The authentication method that users use to access the file share. Defaults to ActiveDirectory. Valid values: ActiveDirectory, GuestAccess.

property defaultStorageClass

defaultStorageClass?: pulumi.Input<string>;

The default storage class for objects put into an Amazon S3 bucket by the file gateway. Defaults to S3_STANDARD. Valid values: S3_STANDARD, S3_STANDARD_IA, S3_ONEZONE_IA.

property gatewayArn

gatewayArn: pulumi.Input<string>;

Amazon Resource Name (ARN) of the file gateway.

property guessMimeTypeEnabled

guessMimeTypeEnabled?: pulumi.Input<boolean>;

Boolean value that enables guessing of the MIME type for uploaded objects based on file extensions. Defaults to true.

property invalidUserLists

invalidUserLists?: pulumi.Input<pulumi.Input<string>[]>;

A list of users in the Active Directory that are not allowed to access the file share. Only valid if authentication is set to ActiveDirectory.

property kmsEncrypted

kmsEncrypted?: pulumi.Input<boolean>;

Boolean value if true to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Defaults to false.

property kmsKeyArn

kmsKeyArn?: pulumi.Input<string>;

Amazon Resource Name (ARN) for KMS key used for Amazon S3 server side encryption. This value can only be set when kmsEncrypted is true.

property locationArn

locationArn: pulumi.Input<string>;

The ARN of the backed storage used for storing file data.

property objectAcl

objectAcl?: pulumi.Input<string>;

Access Control List permission for S3 bucket objects. Defaults to private.

property readOnly

readOnly?: pulumi.Input<boolean>;

Boolean to indicate write status of file share. File share does not accept writes if true. Defaults to false.

property requesterPays

requesterPays?: pulumi.Input<boolean>;

Boolean who pays the cost of the request and the data download from the Amazon S3 bucket. Set this value to true if you want the requester to pay instead of the bucket owner. Defaults to false.

property roleArn

roleArn: pulumi.Input<string>;

The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

Key-value map of resource tags

property validUserLists

validUserLists?: pulumi.Input<pulumi.Input<string>[]>;

A list of users in the Active Directory that are allowed to access the file share. Only valid if authentication is set to ActiveDirectory.

interface SmbFileShareState

interface SmbFileShareState

Input properties used for looking up and filtering SmbFileShare resources.

property arn

arn?: pulumi.Input<string>;

Amazon Resource Name (ARN) of the SMB File Share.

property authentication

authentication?: pulumi.Input<string>;

The authentication method that users use to access the file share. Defaults to ActiveDirectory. Valid values: ActiveDirectory, GuestAccess.

property defaultStorageClass

defaultStorageClass?: pulumi.Input<string>;

The default storage class for objects put into an Amazon S3 bucket by the file gateway. Defaults to S3_STANDARD. Valid values: S3_STANDARD, S3_STANDARD_IA, S3_ONEZONE_IA.

property fileshareId

fileshareId?: pulumi.Input<string>;

ID of the SMB File Share.

property gatewayArn

gatewayArn?: pulumi.Input<string>;

Amazon Resource Name (ARN) of the file gateway.

property guessMimeTypeEnabled

guessMimeTypeEnabled?: pulumi.Input<boolean>;

Boolean value that enables guessing of the MIME type for uploaded objects based on file extensions. Defaults to true.

property invalidUserLists

invalidUserLists?: pulumi.Input<pulumi.Input<string>[]>;

A list of users in the Active Directory that are not allowed to access the file share. Only valid if authentication is set to ActiveDirectory.

property kmsEncrypted

kmsEncrypted?: pulumi.Input<boolean>;

Boolean value if true to use Amazon S3 server side encryption with your own AWS KMS key, or false to use a key managed by Amazon S3. Defaults to false.

property kmsKeyArn

kmsKeyArn?: pulumi.Input<string>;

Amazon Resource Name (ARN) for KMS key used for Amazon S3 server side encryption. This value can only be set when kmsEncrypted is true.

property locationArn

locationArn?: pulumi.Input<string>;

The ARN of the backed storage used for storing file data.

property objectAcl

objectAcl?: pulumi.Input<string>;

Access Control List permission for S3 bucket objects. Defaults to private.

property path

path?: pulumi.Input<string>;

File share path used by the NFS client to identify the mount point.

property readOnly

readOnly?: pulumi.Input<boolean>;

Boolean to indicate write status of file share. File share does not accept writes if true. Defaults to false.

property requesterPays

requesterPays?: pulumi.Input<boolean>;

Boolean who pays the cost of the request and the data download from the Amazon S3 bucket. Set this value to true if you want the requester to pay instead of the bucket owner. Defaults to false.

property roleArn

roleArn?: pulumi.Input<string>;

The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

Key-value map of resource tags

property validUserLists

validUserLists?: pulumi.Input<pulumi.Input<string>[]>;

A list of users in the Active Directory that are allowed to access the file share. Only valid if authentication is set to ActiveDirectory.

interface UploadBufferArgs

interface UploadBufferArgs

The set of arguments for constructing a UploadBuffer resource.

property diskId

diskId: pulumi.Input<string>;

Local disk identifier. For example, pci-0000:03:00.0-scsi-0:0:0:0.

property gatewayArn

gatewayArn: pulumi.Input<string>;

The Amazon Resource Name (ARN) of the gateway.

interface UploadBufferState

interface UploadBufferState

Input properties used for looking up and filtering UploadBuffer resources.

property diskId

diskId?: pulumi.Input<string>;

Local disk identifier. For example, pci-0000:03:00.0-scsi-0:0:0:0.

property gatewayArn

gatewayArn?: pulumi.Input<string>;

The Amazon Resource Name (ARN) of the gateway.

interface WorkingStorageArgs

interface WorkingStorageArgs

The set of arguments for constructing a WorkingStorage resource.

property diskId

diskId: pulumi.Input<string>;

Local disk identifier. For example, pci-0000:03:00.0-scsi-0:0:0:0.

property gatewayArn

gatewayArn: pulumi.Input<string>;

The Amazon Resource Name (ARN) of the gateway.

interface WorkingStorageState

interface WorkingStorageState

Input properties used for looking up and filtering WorkingStorage resources.

property diskId

diskId?: pulumi.Input<string>;

Local disk identifier. For example, pci-0000:03:00.0-scsi-0:0:0:0.

property gatewayArn

gatewayArn?: pulumi.Input<string>;

The Amazon Resource Name (ARN) of the gateway.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

Module storagegateway

Resources

Functions

Others

Resources

Example Usage

Example Usage

Create Empty Cached iSCSI Volume

Create Cached iSCSI Volume From Snapshot

Create Cached iSCSI Volume From Source Volume

Example Usage

File Gateway

Tape Gateway

Volume Gateway (Cached)

Volume Gateway (Stored)

Example Usage

Example Usage

Active Directory Authentication

Guest Authentication

Example Usage

Example Usage

Functions

Example Usage

Others