storagegateway

package
v0.18.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 5, 2019 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Cache 

type Cache struct {
	// contains filtered or unexported fields
}

Manages an AWS Storage Gateway cache.

> **NOTE:** The Storage Gateway API provides no method to remove a cache disk. Destroying this Terraform resource does not perform any Storage Gateway actions.

func GetCache 

func GetCache(ctx *pulumi.Context,
	name string, id pulumi.ID, state *CacheState, opts ...pulumi.ResourceOpt) (*Cache, error)

GetCache gets an existing Cache resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewCache 

func NewCache(ctx *pulumi.Context,
	name string, args *CacheArgs, opts ...pulumi.ResourceOpt) (*Cache, error)

NewCache registers a new resource with the given unique name, arguments, and options.

func (*Cache) DiskId 

func (r *Cache) DiskId() *pulumi.StringOutput

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

func (*Cache) GatewayArn 

func (r *Cache) GatewayArn() *pulumi.StringOutput

The Amazon Resource Name (ARN) of the gateway.

func (*Cache) ID 

func (r *Cache) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*Cache) URN 

func (r *Cache) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

type CacheArgs 

type CacheArgs struct {
	// Local disk identifier. For example, `pci-0000:03:00.0-scsi-0:0:0:0`.
	DiskId interface{}
	// The Amazon Resource Name (ARN) of the gateway.
	GatewayArn interface{}
}

The set of arguments for constructing a Cache resource.

type CacheState 

type CacheState struct {
	// Local disk identifier. For example, `pci-0000:03:00.0-scsi-0:0:0:0`.
	DiskId interface{}
	// The Amazon Resource Name (ARN) of the gateway.
	GatewayArn interface{}
}

Input properties used for looking up and filtering Cache resources.

type CachesIscsiVolume 

type CachesIscsiVolume struct {
	// contains filtered or unexported fields
}

Manages an AWS Storage Gateway cached iSCSI volume.

> **NOTE:** The gateway must have cache added (e.g. via the [`aws_storagegateway_cache`](https://www.terraform.io/docs/providers/aws/r/storagegateway_cache.html) 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_upload_buffer`](https://www.terraform.io/docs/providers/aws/r/storagegateway_upload_buffer.html) 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

> **NOTE:** These examples are referencing the [`aws_storagegateway_cache`](https://www.terraform.io/docs/providers/aws/r/storagegateway_cache.html) resource `gateway_arn` attribute to ensure Terraform properly adds cache before creating the volume. If you are not using this method, you may need to declare an expicit dependency (e.g. via `depends_on = ["aws_storagegateway_cache.example"]`) to ensure proper ordering.

func GetCachesIscsiVolume 

func GetCachesIscsiVolume(ctx *pulumi.Context,
	name string, id pulumi.ID, state *CachesIscsiVolumeState, opts ...pulumi.ResourceOpt) (*CachesIscsiVolume, error)

GetCachesIscsiVolume gets an existing CachesIscsiVolume resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewCachesIscsiVolume 

func NewCachesIscsiVolume(ctx *pulumi.Context,
	name string, args *CachesIscsiVolumeArgs, opts ...pulumi.ResourceOpt) (*CachesIscsiVolume, error)

NewCachesIscsiVolume registers a new resource with the given unique name, arguments, and options.

func (*CachesIscsiVolume) Arn 

func (r *CachesIscsiVolume) Arn() *pulumi.StringOutput

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

func (*CachesIscsiVolume) ChapEnabled 

func (r *CachesIscsiVolume) ChapEnabled() *pulumi.BoolOutput

Whether mutual CHAP is enabled for the iSCSI target.

func (*CachesIscsiVolume) GatewayArn 

func (r *CachesIscsiVolume) GatewayArn() *pulumi.StringOutput

The Amazon Resource Name (ARN) of the gateway.

func (*CachesIscsiVolume) ID 

func (r *CachesIscsiVolume) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*CachesIscsiVolume) LunNumber 

func (r *CachesIscsiVolume) LunNumber() *pulumi.IntOutput

Logical disk number.

func (*CachesIscsiVolume) NetworkInterfaceId 

func (r *CachesIscsiVolume) NetworkInterfaceId() *pulumi.StringOutput

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

func (*CachesIscsiVolume) NetworkInterfacePort 

func (r *CachesIscsiVolume) NetworkInterfacePort() *pulumi.IntOutput

The port used to communicate with iSCSI targets.

func (*CachesIscsiVolume) SnapshotId 

func (r *CachesIscsiVolume) SnapshotId() *pulumi.StringOutput

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

func (*CachesIscsiVolume) SourceVolumeArn 

func (r *CachesIscsiVolume) SourceVolumeArn() *pulumi.StringOutput

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 `volume_size_in_bytes` value for this new volume must be equal to or larger than the size of the existing volume, in bytes.

func (*CachesIscsiVolume) TargetArn 

func (r *CachesIscsiVolume) TargetArn() *pulumi.StringOutput

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

func (*CachesIscsiVolume) TargetName 

func (r *CachesIscsiVolume) TargetName() *pulumi.StringOutput

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.

func (*CachesIscsiVolume) URN 

func (r *CachesIscsiVolume) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

func (*CachesIscsiVolume) VolumeArn 

func (r *CachesIscsiVolume) VolumeArn() *pulumi.StringOutput

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

func (*CachesIscsiVolume) VolumeId 

func (r *CachesIscsiVolume) VolumeId() *pulumi.StringOutput

Volume ID, e.g. `vol-12345678`.

func (*CachesIscsiVolume) VolumeSizeInBytes 

func (r *CachesIscsiVolume) VolumeSizeInBytes() *pulumi.IntOutput

The size of the volume in bytes.

type CachesIscsiVolumeArgs 

type CachesIscsiVolumeArgs struct {
	// The Amazon Resource Name (ARN) of the gateway.
	GatewayArn interface{}
	// The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted.
	NetworkInterfaceId interface{}
	// The snapshot ID of the snapshot to restore as the new cached volume. e.g. `snap-1122aabb`.
	SnapshotId interface{}
	// 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 `volume_size_in_bytes` value for this new volume must be equal to or larger than the size of the existing volume, in bytes.
	SourceVolumeArn interface{}
	// 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.
	TargetName interface{}
	// The size of the volume in bytes.
	VolumeSizeInBytes interface{}
}

The set of arguments for constructing a CachesIscsiVolume resource.

type CachesIscsiVolumeState 

type CachesIscsiVolumeState struct {
	// Volume Amazon Resource Name (ARN), e.g. `arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-12345678/volume/vol-12345678`.
	Arn interface{}
	// Whether mutual CHAP is enabled for the iSCSI target.
	ChapEnabled interface{}
	// The Amazon Resource Name (ARN) of the gateway.
	GatewayArn interface{}
	// Logical disk number.
	LunNumber interface{}
	// The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted.
	NetworkInterfaceId interface{}
	// The port used to communicate with iSCSI targets.
	NetworkInterfacePort interface{}
	// The snapshot ID of the snapshot to restore as the new cached volume. e.g. `snap-1122aabb`.
	SnapshotId interface{}
	// 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 `volume_size_in_bytes` value for this new volume must be equal to or larger than the size of the existing volume, in bytes.
	SourceVolumeArn interface{}
	// Target Amazon Resource Name (ARN), e.g. `arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-12345678/target/iqn.1997-05.com.amazon:TargetName`.
	TargetArn interface{}
	// 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.
	TargetName interface{}
	// Volume Amazon Resource Name (ARN), e.g. `arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-12345678/volume/vol-12345678`.
	VolumeArn interface{}
	// Volume ID, e.g. `vol-12345678`.
	VolumeId interface{}
	// The size of the volume in bytes.
	VolumeSizeInBytes interface{}
}

Input properties used for looking up and filtering CachesIscsiVolume resources.

type Gateway 

type Gateway struct {
	// contains filtered or unexported fields
}

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](https://docs.aws.amazon.com/storagegateway/latest/userguide/Requirements.html).

func GetGateway 

func GetGateway(ctx *pulumi.Context,
	name string, id pulumi.ID, state *GatewayState, opts ...pulumi.ResourceOpt) (*Gateway, error)

GetGateway gets an existing Gateway resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewGateway 

func NewGateway(ctx *pulumi.Context,
	name string, args *GatewayArgs, opts ...pulumi.ResourceOpt) (*Gateway, error)

NewGateway registers a new resource with the given unique name, arguments, and options.

func (*Gateway) ActivationKey 

func (r *Gateway) ActivationKey() *pulumi.StringOutput

Gateway activation key during resource creation. Conflicts with `gateway_ip_address`. Additional information is available in the [Storage Gateway User Guide](https://docs.aws.amazon.com/storagegateway/latest/userguide/get-activation-key.html).

func (*Gateway) Arn 

func (r *Gateway) Arn() *pulumi.StringOutput

Amazon Resource Name (ARN) of the gateway.

func (*Gateway) GatewayId 

func (r *Gateway) GatewayId() *pulumi.StringOutput

Identifier of the gateway.

func (*Gateway) GatewayIpAddress 

func (r *Gateway) GatewayIpAddress() *pulumi.StringOutput

Gateway IP address to retrieve activation key during resource creation. Conflicts with `activation_key`. Gateway must be accessible on port 80 from where Terraform is running. Additional information is available in the [Storage Gateway User Guide](https://docs.aws.amazon.com/storagegateway/latest/userguide/get-activation-key.html).

func (*Gateway) GatewayName 

func (r *Gateway) GatewayName() *pulumi.StringOutput

Name of the gateway.

func (*Gateway) GatewayTimezone 

func (r *Gateway) GatewayTimezone() *pulumi.StringOutput

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.

func (*Gateway) GatewayType 

func (r *Gateway) GatewayType() *pulumi.StringOutput

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

func (*Gateway) ID 

func (r *Gateway) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*Gateway) MediumChangerType 

func (r *Gateway) MediumChangerType() *pulumi.StringOutput

func (*Gateway) SmbActiveDirectorySettings 

func (r *Gateway) SmbActiveDirectorySettings() *pulumi.Output

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.

func (*Gateway) SmbGuestPassword 

func (r *Gateway) SmbGuestPassword() *pulumi.StringOutput

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. Terraform can only detect drift of the existence of a guest password, not its actual value from the gateway. Terraform can however update the password with changing the argument.

func (*Gateway) TapeDriveType 

func (r *Gateway) TapeDriveType() *pulumi.StringOutput

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

func (*Gateway) URN 

func (r *Gateway) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

type GatewayArgs 

type GatewayArgs struct {
	// Gateway activation key during resource creation. Conflicts with `gateway_ip_address`. Additional information is available in the [Storage Gateway User Guide](https://docs.aws.amazon.com/storagegateway/latest/userguide/get-activation-key.html).
	ActivationKey interface{}
	// Gateway IP address to retrieve activation key during resource creation. Conflicts with `activation_key`. Gateway must be accessible on port 80 from where Terraform is running. Additional information is available in the [Storage Gateway User Guide](https://docs.aws.amazon.com/storagegateway/latest/userguide/get-activation-key.html).
	GatewayIpAddress interface{}
	// Name of the gateway.
	GatewayName interface{}
	// 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.
	GatewayTimezone interface{}
	// Type of the gateway. The default value is `STORED`. Valid values: `CACHED`, `FILE_S3`, `STORED`, `VTL`.
	GatewayType       interface{}
	MediumChangerType interface{}
	// 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.
	SmbActiveDirectorySettings interface{}
	// 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. Terraform can only detect drift of the existence of a guest password, not its actual value from the gateway. Terraform can however update the password with changing the argument.
	SmbGuestPassword interface{}
	// Type of tape drive to use for tape gateway. Terraform cannot detect drift of this argument. Valid values: `IBM-ULT3580-TD5`.
	TapeDriveType interface{}
}

The set of arguments for constructing a Gateway resource.

type GatewayState 

type GatewayState struct {
	// Gateway activation key during resource creation. Conflicts with `gateway_ip_address`. Additional information is available in the [Storage Gateway User Guide](https://docs.aws.amazon.com/storagegateway/latest/userguide/get-activation-key.html).
	ActivationKey interface{}
	// Amazon Resource Name (ARN) of the gateway.
	Arn interface{}
	// Identifier of the gateway.
	GatewayId interface{}
	// Gateway IP address to retrieve activation key during resource creation. Conflicts with `activation_key`. Gateway must be accessible on port 80 from where Terraform is running. Additional information is available in the [Storage Gateway User Guide](https://docs.aws.amazon.com/storagegateway/latest/userguide/get-activation-key.html).
	GatewayIpAddress interface{}
	// Name of the gateway.
	GatewayName interface{}
	// 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.
	GatewayTimezone interface{}
	// Type of the gateway. The default value is `STORED`. Valid values: `CACHED`, `FILE_S3`, `STORED`, `VTL`.
	GatewayType       interface{}
	MediumChangerType interface{}
	// 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.
	SmbActiveDirectorySettings interface{}
	// 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. Terraform can only detect drift of the existence of a guest password, not its actual value from the gateway. Terraform can however update the password with changing the argument.
	SmbGuestPassword interface{}
	// Type of tape drive to use for tape gateway. Terraform cannot detect drift of this argument. Valid values: `IBM-ULT3580-TD5`.
	TapeDriveType interface{}
}

Input properties used for looking up and filtering Gateway resources.

type GetLocalDiskArgs 

type GetLocalDiskArgs struct {
	// The device node of the local disk to retrieve. For example, `/dev/sdb`.
	DiskNode interface{}
	// The device path of the local disk to retrieve. For example, `/dev/xvdb` or `/dev/nvme1n1`.
	DiskPath interface{}
	// The Amazon Resource Name (ARN) of the gateway.
	GatewayArn interface{}
}

A collection of arguments for invoking getLocalDisk.

type GetLocalDiskResult 

type GetLocalDiskResult struct {
	// The disk identifier. e.g. `pci-0000:03:00.0-scsi-0:0:0:0`
	DiskId interface{}
	// id is the provider-assigned unique ID for this managed resource.
	Id interface{}
}

A collection of values returned by getLocalDisk.

func LookupLocalDisk 

func LookupLocalDisk(ctx *pulumi.Context, args *GetLocalDiskArgs) (*GetLocalDiskResult, error)

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.

type NfsFileShare 

type NfsFileShare struct {
	// contains filtered or unexported fields
}

Manages an AWS Storage Gateway NFS File Share.

func GetNfsFileShare 

func GetNfsFileShare(ctx *pulumi.Context,
	name string, id pulumi.ID, state *NfsFileShareState, opts ...pulumi.ResourceOpt) (*NfsFileShare, error)

GetNfsFileShare gets an existing NfsFileShare resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewNfsFileShare 

func NewNfsFileShare(ctx *pulumi.Context,
	name string, args *NfsFileShareArgs, opts ...pulumi.ResourceOpt) (*NfsFileShare, error)

NewNfsFileShare registers a new resource with the given unique name, arguments, and options.

func (*NfsFileShare) Arn 

func (r *NfsFileShare) Arn() *pulumi.StringOutput

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

func (*NfsFileShare) ClientLists 

func (r *NfsFileShare) ClientLists() *pulumi.ArrayOutput

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.

func (*NfsFileShare) DefaultStorageClass 

func (r *NfsFileShare) DefaultStorageClass() *pulumi.StringOutput

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

func (*NfsFileShare) FileshareId 

func (r *NfsFileShare) FileshareId() *pulumi.StringOutput

ID of the NFS File Share.

func (*NfsFileShare) GatewayArn 

func (r *NfsFileShare) GatewayArn() *pulumi.StringOutput

Amazon Resource Name (ARN) of the file gateway.

func (*NfsFileShare) GuessMimeTypeEnabled 

func (r *NfsFileShare) GuessMimeTypeEnabled() *pulumi.BoolOutput

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

func (*NfsFileShare) ID 

func (r *NfsFileShare) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*NfsFileShare) KmsEncrypted 

func (r *NfsFileShare) KmsEncrypted() *pulumi.BoolOutput

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

func (*NfsFileShare) KmsKeyArn 

func (r *NfsFileShare) KmsKeyArn() *pulumi.StringOutput

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

func (*NfsFileShare) LocationArn 

func (r *NfsFileShare) LocationArn() *pulumi.StringOutput

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

func (*NfsFileShare) NfsFileShareDefaults 

func (r *NfsFileShare) NfsFileShareDefaults() *pulumi.Output

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

func (*NfsFileShare) ObjectAcl 

func (r *NfsFileShare) ObjectAcl() *pulumi.StringOutput

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

func (*NfsFileShare) ReadOnly 

func (r *NfsFileShare) ReadOnly() *pulumi.BoolOutput

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

func (*NfsFileShare) RequesterPays 

func (r *NfsFileShare) RequesterPays() *pulumi.BoolOutput

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

func (*NfsFileShare) RoleArn 

func (r *NfsFileShare) RoleArn() *pulumi.StringOutput

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

func (*NfsFileShare) Squash 

func (r *NfsFileShare) Squash() *pulumi.StringOutput

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)

func (*NfsFileShare) URN 

func (r *NfsFileShare) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

type NfsFileShareArgs 

type NfsFileShareArgs struct {
	// 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.
	ClientLists interface{}
	// 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`.
	DefaultStorageClass interface{}
	// Amazon Resource Name (ARN) of the file gateway.
	GatewayArn interface{}
	// Boolean value that enables guessing of the MIME type for uploaded objects based on file extensions. Defaults to `true`.
	GuessMimeTypeEnabled interface{}
	// 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`.
	KmsEncrypted interface{}
	// Amazon Resource Name (ARN) for KMS key used for Amazon S3 server side encryption. This value can only be set when `kms_encrypted` is true.
	KmsKeyArn interface{}
	// The ARN of the backed storage used for storing file data.
	LocationArn interface{}
	// Nested argument with file share default values. More information below.
	NfsFileShareDefaults interface{}
	// Access Control List permission for S3 bucket objects. Defaults to `private`.
	ObjectAcl interface{}
	// Boolean to indicate write status of file share. File share does not accept writes if `true`. Defaults to `false`.
	ReadOnly interface{}
	// 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`.
	RequesterPays interface{}
	// The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.
	RoleArn interface{}
	// 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)
	Squash interface{}
}

The set of arguments for constructing a NfsFileShare resource.

type NfsFileShareState 

type NfsFileShareState struct {
	// Amazon Resource Name (ARN) of the NFS File Share.
	Arn interface{}
	// 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.
	ClientLists interface{}
	// 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`.
	DefaultStorageClass interface{}
	// ID of the NFS File Share.
	FileshareId interface{}
	// Amazon Resource Name (ARN) of the file gateway.
	GatewayArn interface{}
	// Boolean value that enables guessing of the MIME type for uploaded objects based on file extensions. Defaults to `true`.
	GuessMimeTypeEnabled interface{}
	// 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`.
	KmsEncrypted interface{}
	// Amazon Resource Name (ARN) for KMS key used for Amazon S3 server side encryption. This value can only be set when `kms_encrypted` is true.
	KmsKeyArn interface{}
	// The ARN of the backed storage used for storing file data.
	LocationArn interface{}
	// Nested argument with file share default values. More information below.
	NfsFileShareDefaults interface{}
	// Access Control List permission for S3 bucket objects. Defaults to `private`.
	ObjectAcl interface{}
	// Boolean to indicate write status of file share. File share does not accept writes if `true`. Defaults to `false`.
	ReadOnly interface{}
	// 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`.
	RequesterPays interface{}
	// The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.
	RoleArn interface{}
	// 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)
	Squash interface{}
}

Input properties used for looking up and filtering NfsFileShare resources.

type SmbFileShare 

type SmbFileShare struct {
	// contains filtered or unexported fields
}

Manages an AWS Storage Gateway SMB File Share.

func GetSmbFileShare 

func GetSmbFileShare(ctx *pulumi.Context,
	name string, id pulumi.ID, state *SmbFileShareState, opts ...pulumi.ResourceOpt) (*SmbFileShare, error)

GetSmbFileShare gets an existing SmbFileShare resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewSmbFileShare 

func NewSmbFileShare(ctx *pulumi.Context,
	name string, args *SmbFileShareArgs, opts ...pulumi.ResourceOpt) (*SmbFileShare, error)

NewSmbFileShare registers a new resource with the given unique name, arguments, and options.

func (*SmbFileShare) Arn 

func (r *SmbFileShare) Arn() *pulumi.StringOutput

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

func (*SmbFileShare) Authentication 

func (r *SmbFileShare) Authentication() *pulumi.StringOutput

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

func (*SmbFileShare) DefaultStorageClass 

func (r *SmbFileShare) DefaultStorageClass() *pulumi.StringOutput

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

func (*SmbFileShare) FileshareId 

func (r *SmbFileShare) FileshareId() *pulumi.StringOutput

ID of the SMB File Share.

func (*SmbFileShare) GatewayArn 

func (r *SmbFileShare) GatewayArn() *pulumi.StringOutput

Amazon Resource Name (ARN) of the file gateway.

func (*SmbFileShare) GuessMimeTypeEnabled 

func (r *SmbFileShare) GuessMimeTypeEnabled() *pulumi.BoolOutput

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

func (*SmbFileShare) ID 

func (r *SmbFileShare) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*SmbFileShare) InvalidUserLists 

func (r *SmbFileShare) InvalidUserLists() *pulumi.ArrayOutput

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

func (*SmbFileShare) KmsEncrypted 

func (r *SmbFileShare) KmsEncrypted() *pulumi.BoolOutput

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

func (*SmbFileShare) KmsKeyArn 

func (r *SmbFileShare) KmsKeyArn() *pulumi.StringOutput

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

func (*SmbFileShare) LocationArn 

func (r *SmbFileShare) LocationArn() *pulumi.StringOutput

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

func (*SmbFileShare) ObjectAcl 

func (r *SmbFileShare) ObjectAcl() *pulumi.StringOutput

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

func (*SmbFileShare) ReadOnly 

func (r *SmbFileShare) ReadOnly() *pulumi.BoolOutput

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

func (*SmbFileShare) RequesterPays 

func (r *SmbFileShare) RequesterPays() *pulumi.BoolOutput

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

func (*SmbFileShare) RoleArn 

func (r *SmbFileShare) RoleArn() *pulumi.StringOutput

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

func (*SmbFileShare) URN 

func (r *SmbFileShare) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

func (*SmbFileShare) ValidUserLists 

func (r *SmbFileShare) ValidUserLists() *pulumi.ArrayOutput

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

type SmbFileShareArgs 

type SmbFileShareArgs struct {
	// The authentication method that users use to access the file share. Defaults to `ActiveDirectory`. Valid values: `ActiveDirectory`, `GuestAccess`.
	Authentication interface{}
	// 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`.
	DefaultStorageClass interface{}
	// Amazon Resource Name (ARN) of the file gateway.
	GatewayArn interface{}
	// Boolean value that enables guessing of the MIME type for uploaded objects based on file extensions. Defaults to `true`.
	GuessMimeTypeEnabled interface{}
	// 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`.
	InvalidUserLists interface{}
	// 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`.
	KmsEncrypted interface{}
	// Amazon Resource Name (ARN) for KMS key used for Amazon S3 server side encryption. This value can only be set when `kms_encrypted` is true.
	KmsKeyArn interface{}
	// The ARN of the backed storage used for storing file data.
	LocationArn interface{}
	// Access Control List permission for S3 bucket objects. Defaults to `private`.
	ObjectAcl interface{}
	// Boolean to indicate write status of file share. File share does not accept writes if `true`. Defaults to `false`.
	ReadOnly interface{}
	// 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`.
	RequesterPays interface{}
	// The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.
	RoleArn interface{}
	// A list of users in the Active Directory that are allowed to access the file share. Only valid if `authentication` is set to `ActiveDirectory`.
	ValidUserLists interface{}
}

The set of arguments for constructing a SmbFileShare resource.

type SmbFileShareState 

type SmbFileShareState struct {
	// Amazon Resource Name (ARN) of the SMB File Share.
	Arn interface{}
	// The authentication method that users use to access the file share. Defaults to `ActiveDirectory`. Valid values: `ActiveDirectory`, `GuestAccess`.
	Authentication interface{}
	// 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`.
	DefaultStorageClass interface{}
	// ID of the SMB File Share.
	FileshareId interface{}
	// Amazon Resource Name (ARN) of the file gateway.
	GatewayArn interface{}
	// Boolean value that enables guessing of the MIME type for uploaded objects based on file extensions. Defaults to `true`.
	GuessMimeTypeEnabled interface{}
	// 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`.
	InvalidUserLists interface{}
	// 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`.
	KmsEncrypted interface{}
	// Amazon Resource Name (ARN) for KMS key used for Amazon S3 server side encryption. This value can only be set when `kms_encrypted` is true.
	KmsKeyArn interface{}
	// The ARN of the backed storage used for storing file data.
	LocationArn interface{}
	// Access Control List permission for S3 bucket objects. Defaults to `private`.
	ObjectAcl interface{}
	// Boolean to indicate write status of file share. File share does not accept writes if `true`. Defaults to `false`.
	ReadOnly interface{}
	// 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`.
	RequesterPays interface{}
	// The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.
	RoleArn interface{}
	// A list of users in the Active Directory that are allowed to access the file share. Only valid if `authentication` is set to `ActiveDirectory`.
	ValidUserLists interface{}
}

Input properties used for looking up and filtering SmbFileShare resources.

type UploadBuffer 

type UploadBuffer struct {
	// contains filtered or unexported fields
}

Manages an AWS Storage Gateway upload buffer.

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

func GetUploadBuffer 

func GetUploadBuffer(ctx *pulumi.Context,
	name string, id pulumi.ID, state *UploadBufferState, opts ...pulumi.ResourceOpt) (*UploadBuffer, error)

GetUploadBuffer gets an existing UploadBuffer resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewUploadBuffer 

func NewUploadBuffer(ctx *pulumi.Context,
	name string, args *UploadBufferArgs, opts ...pulumi.ResourceOpt) (*UploadBuffer, error)

NewUploadBuffer registers a new resource with the given unique name, arguments, and options.

func (*UploadBuffer) DiskId 

func (r *UploadBuffer) DiskId() *pulumi.StringOutput

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

func (*UploadBuffer) GatewayArn 

func (r *UploadBuffer) GatewayArn() *pulumi.StringOutput

The Amazon Resource Name (ARN) of the gateway.

func (*UploadBuffer) ID 

func (r *UploadBuffer) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*UploadBuffer) URN 

func (r *UploadBuffer) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

type UploadBufferArgs 

type UploadBufferArgs struct {
	// Local disk identifier. For example, `pci-0000:03:00.0-scsi-0:0:0:0`.
	DiskId interface{}
	// The Amazon Resource Name (ARN) of the gateway.
	GatewayArn interface{}
}

The set of arguments for constructing a UploadBuffer resource.

type UploadBufferState 

type UploadBufferState struct {
	// Local disk identifier. For example, `pci-0000:03:00.0-scsi-0:0:0:0`.
	DiskId interface{}
	// The Amazon Resource Name (ARN) of the gateway.
	GatewayArn interface{}
}

Input properties used for looking up and filtering UploadBuffer resources.

type WorkingStorage 

type WorkingStorage struct {
	// contains filtered or unexported fields
}

Manages an AWS Storage Gateway working storage.

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

func GetWorkingStorage 

func GetWorkingStorage(ctx *pulumi.Context,
	name string, id pulumi.ID, state *WorkingStorageState, opts ...pulumi.ResourceOpt) (*WorkingStorage, error)

GetWorkingStorage gets an existing WorkingStorage resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewWorkingStorage 

func NewWorkingStorage(ctx *pulumi.Context,
	name string, args *WorkingStorageArgs, opts ...pulumi.ResourceOpt) (*WorkingStorage, error)

NewWorkingStorage registers a new resource with the given unique name, arguments, and options.

func (*WorkingStorage) DiskId 

func (r *WorkingStorage) DiskId() *pulumi.StringOutput

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

func (*WorkingStorage) GatewayArn 

func (r *WorkingStorage) GatewayArn() *pulumi.StringOutput

The Amazon Resource Name (ARN) of the gateway.

func (*WorkingStorage) ID 

func (r *WorkingStorage) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*WorkingStorage) URN 

func (r *WorkingStorage) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

type WorkingStorageArgs 

type WorkingStorageArgs struct {
	// Local disk identifier. For example, `pci-0000:03:00.0-scsi-0:0:0:0`.
	DiskId interface{}
	// The Amazon Resource Name (ARN) of the gateway.
	GatewayArn interface{}
}

The set of arguments for constructing a WorkingStorage resource.

type WorkingStorageState 

type WorkingStorageState struct {
	// Local disk identifier. For example, `pci-0000:03:00.0-scsi-0:0:0:0`.
	DiskId interface{}
	// The Amazon Resource Name (ARN) of the gateway.
	GatewayArn interface{}
}

Input properties used for looking up and filtering WorkingStorage resources.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.