storagegateway

class pulumi_aws.storagegateway.Cache(resource_name, opts=None, disk_id=None, gateway_arn=None, __name__=None, __opts__=None)

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.
Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • disk_id (pulumi.Input[str]) – Local disk identifier. For example, pci-0000:03:00.0-scsi-0:0:0:0.
  • gateway_arn (pulumi.Input[str]) – The Amazon Resource Name (ARN) of the gateway.
disk_id = None

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

gateway_arn = None

The Amazon Resource Name (ARN) of the gateway.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.storagegateway.CachesIscsiVolume(resource_name, opts=None, gateway_arn=None, network_interface_id=None, snapshot_id=None, source_volume_arn=None, target_name=None, volume_size_in_bytes=None, __name__=None, __opts__=None)

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.

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.
Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • gateway_arn (pulumi.Input[str]) – The Amazon Resource Name (ARN) of the gateway.
  • network_interface_id (pulumi.Input[str]) – The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted.
  • snapshot_id (pulumi.Input[str]) – The snapshot ID of the snapshot to restore as the new cached volume. e.g. snap-1122aabb.
  • source_volume_arn (pulumi.Input[str]) – 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.
  • target_name (pulumi.Input[str]) – 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.
  • volume_size_in_bytes (pulumi.Input[float]) – The size of the volume in bytes.
arn = None

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

chap_enabled = None

Whether mutual CHAP is enabled for the iSCSI target.

gateway_arn = None

The Amazon Resource Name (ARN) of the gateway.

lun_number = None

Logical disk number.

network_interface_id = None

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

network_interface_port = None

The port used to communicate with iSCSI targets.

snapshot_id = None

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

source_volume_arn = None

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.

target_arn = None

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

target_name = None

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.

volume_arn = None

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

volume_id = None

Volume ID, e.g. vol-12345678.

volume_size_in_bytes = None

The size of the volume in bytes.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.storagegateway.Gateway(resource_name, opts=None, activation_key=None, gateway_ip_address=None, gateway_name=None, gateway_timezone=None, gateway_type=None, medium_changer_type=None, smb_active_directory_settings=None, smb_guest_password=None, tape_drive_type=None, __name__=None, __opts__=None)

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.
Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • activation_key (pulumi.Input[str]) – Gateway activation key during resource creation. Conflicts with gateway_ip_address. Additional information is available in the Storage Gateway User Guide.
  • gateway_ip_address (pulumi.Input[str]) –

    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.

  • gateway_name (pulumi.Input[str]) – Name of the gateway.
  • gateway_timezone (pulumi.Input[str]) – 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.
  • gateway_type (pulumi.Input[str]) – Type of the gateway. The default value is STORED. Valid values: CACHED, FILE_S3, STORED, VTL.
  • smb_active_directory_settings (pulumi.Input[dict]) – 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.
  • smb_guest_password (pulumi.Input[str]) – 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.
  • tape_drive_type (pulumi.Input[str]) – Type of tape drive to use for tape gateway. Terraform cannot detect drift of this argument. Valid values: IBM-ULT3580-TD5.
activation_key = None

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

arn = None

Amazon Resource Name (ARN) of the gateway.

gateway_id = None

Identifier of the gateway.

gateway_ip_address = None

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.

gateway_name = None

Name of the gateway.

gateway_timezone = None

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.

gateway_type = None

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

smb_active_directory_settings = None

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.

smb_guest_password = None

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.

tape_drive_type = None

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

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.storagegateway.GetLocalDiskResult(disk_id=None, id=None)

A collection of values returned by getLocalDisk.

disk_id = None

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

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_aws.storagegateway.NfsFileShare(resource_name, opts=None, client_lists=None, default_storage_class=None, gateway_arn=None, guess_mime_type_enabled=None, kms_encrypted=None, kms_key_arn=None, location_arn=None, nfs_file_share_defaults=None, object_acl=None, read_only=None, requester_pays=None, role_arn=None, squash=None, __name__=None, __opts__=None)

Manages an AWS Storage Gateway NFS File Share.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • client_lists (pulumi.Input[list]) – 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.
  • default_storage_class (pulumi.Input[str]) – 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.
  • gateway_arn (pulumi.Input[str]) – Amazon Resource Name (ARN) of the file gateway.
  • guess_mime_type_enabled (pulumi.Input[bool]) – Boolean value that enables guessing of the MIME type for uploaded objects based on file extensions. Defaults to true.
  • kms_encrypted (pulumi.Input[bool]) – 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.
  • kms_key_arn (pulumi.Input[str]) – 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.
  • location_arn (pulumi.Input[str]) – The ARN of the backed storage used for storing file data.
  • nfs_file_share_defaults (pulumi.Input[dict]) – Nested argument with file share default values. More information below.
  • object_acl (pulumi.Input[str]) – Access Control List permission for S3 bucket objects. Defaults to private.
  • read_only (pulumi.Input[bool]) – Boolean to indicate write status of file share. File share does not accept writes if true. Defaults to false.
  • requester_pays (pulumi.Input[bool]) – 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.
  • role_arn (pulumi.Input[str]) – The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.
  • squash (pulumi.Input[str]) – 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)
arn = None

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

client_lists = None

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.

default_storage_class = None

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.

fileshare_id = None

ID of the NFS File Share.

gateway_arn = None

Amazon Resource Name (ARN) of the file gateway.

guess_mime_type_enabled = None

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

kms_encrypted = None

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.

kms_key_arn = None

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.

location_arn = None

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

nfs_file_share_defaults = None

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

object_acl = None

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

read_only = None

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

requester_pays = None

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.

role_arn = None

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

squash = None

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)

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.storagegateway.SmbFileShare(resource_name, opts=None, authentication=None, default_storage_class=None, gateway_arn=None, guess_mime_type_enabled=None, invalid_user_lists=None, kms_encrypted=None, kms_key_arn=None, location_arn=None, object_acl=None, read_only=None, requester_pays=None, role_arn=None, valid_user_lists=None, __name__=None, __opts__=None)

Manages an AWS Storage Gateway SMB File Share.

Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • authentication (pulumi.Input[str]) – The authentication method that users use to access the file share. Defaults to ActiveDirectory. Valid values: ActiveDirectory, GuestAccess.
  • default_storage_class (pulumi.Input[str]) – 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.
  • gateway_arn (pulumi.Input[str]) – Amazon Resource Name (ARN) of the file gateway.
  • guess_mime_type_enabled (pulumi.Input[bool]) – Boolean value that enables guessing of the MIME type for uploaded objects based on file extensions. Defaults to true.
  • invalid_user_lists (pulumi.Input[list]) – 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.
  • kms_encrypted (pulumi.Input[bool]) – 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.
  • kms_key_arn (pulumi.Input[str]) – 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.
  • location_arn (pulumi.Input[str]) – The ARN of the backed storage used for storing file data.
  • object_acl (pulumi.Input[str]) – Access Control List permission for S3 bucket objects. Defaults to private.
  • read_only (pulumi.Input[bool]) – Boolean to indicate write status of file share. File share does not accept writes if true. Defaults to false.
  • requester_pays (pulumi.Input[bool]) – 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.
  • role_arn (pulumi.Input[str]) – The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.
  • valid_user_lists (pulumi.Input[list]) – A list of users in the Active Directory that are allowed to access the file share. Only valid if authentication is set to ActiveDirectory.
arn = None

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

authentication = None

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

default_storage_class = None

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.

fileshare_id = None

ID of the SMB File Share.

gateway_arn = None

Amazon Resource Name (ARN) of the file gateway.

guess_mime_type_enabled = None

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

invalid_user_lists = None

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.

kms_encrypted = None

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.

kms_key_arn = None

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.

location_arn = None

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

object_acl = None

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

read_only = None

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

requester_pays = None

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.

role_arn = None

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

valid_user_lists = None

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

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.storagegateway.UploadBuffer(resource_name, opts=None, disk_id=None, gateway_arn=None, __name__=None, __opts__=None)

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.
Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • disk_id (pulumi.Input[str]) – Local disk identifier. For example, pci-0000:03:00.0-scsi-0:0:0:0.
  • gateway_arn (pulumi.Input[str]) – The Amazon Resource Name (ARN) of the gateway.
disk_id = None

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

gateway_arn = None

The Amazon Resource Name (ARN) of the gateway.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
class pulumi_aws.storagegateway.WorkingStorage(resource_name, opts=None, disk_id=None, gateway_arn=None, __name__=None, __opts__=None)

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.
Parameters:
  • resource_name (str) – The name of the resource.
  • opts (pulumi.ResourceOptions) – Options for the resource.
  • disk_id (pulumi.Input[str]) – Local disk identifier. For example, pci-0000:03:00.0-scsi-0:0:0:0.
  • gateway_arn (pulumi.Input[str]) – The Amazon Resource Name (ARN) of the gateway.
disk_id = None

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

gateway_arn = None

The Amazon Resource Name (ARN) of the gateway.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters:prop (str) – A property name.
Returns:A potentially transformed property name.
Return type:str
pulumi_aws.storagegateway.get_local_disk(disk_node=None, disk_path=None, gateway_arn=None, opts=None)

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.