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.

storagegateway¶

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.

class pulumi_aws.storagegateway.AwaitableGetLocalDiskResult(disk_id=None, disk_node=None, disk_path=None, gateway_arn=None, id=None)¶

class pulumi_aws.storagegateway.Cache(resource_name, opts=None, disk_id=None, gateway_arn=None, __props__=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 resource does not perform any Storage Gateway actions.

import pulumi
import pulumi_aws as aws

example = aws.storagegateway.Cache("example",
    disk_id=data["aws_storagegateway_local_disk"]["example"]["id"],
    gateway_arn=aws_storagegateway_gateway["example"]["arn"])

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: pulumi.Output[str] = None¶: Local disk identifier. For example, pci-0000:03:00.0-scsi-0:0:0:0.

gateway_arn: pulumi.Output[str] = None¶: The Amazon Resource Name (ARN) of the gateway.

static get(resource_name, id, opts=None, disk_id=None, gateway_arn=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
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.

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, tags=None, target_name=None, volume_size_in_bytes=None, __props__=None, __name__=None, __opts__=None)¶

Manages an AWS Storage Gateway cached iSCSI volume.

NOTE: The gateway must have cache added (e.g. via the 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 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.

import pulumi
import pulumi_aws as aws

example = aws.storagegateway.CachesIscsiVolume("example",
    gateway_arn=aws_storagegateway_cache["example"]["gateway_arn"],
    network_interface_id=aws_instance["example"]["private_ip"],
    target_name="example",
    volume_size_in_bytes=5368709120)
# 5 GB

import pulumi
import pulumi_aws as aws

example = aws.storagegateway.CachesIscsiVolume("example",
    gateway_arn=aws_storagegateway_cache["example"]["gateway_arn"],
    network_interface_id=aws_instance["example"]["private_ip"],
    snapshot_id=aws_ebs_snapshot["example"]["id"],
    target_name="example",
    volume_size_in_bytes=aws_ebs_snapshot["example"]["volume_size"] * 1024 * 1024 * 1024)

import pulumi
import pulumi_aws as aws

example = aws.storagegateway.CachesIscsiVolume("example",
    gateway_arn=aws_storagegateway_cache["example"]["gateway_arn"],
    network_interface_id=aws_instance["example"]["private_ip"],
    source_volume_arn=aws_storagegateway_cached_iscsi_volume["existing"]["arn"],
    target_name="example",
    volume_size_in_bytes=aws_storagegateway_cached_iscsi_volume["existing"]["volume_size_in_bytes"])

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.
tags (pulumi.Input[dict]) – Key-value map of resource tags
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: pulumi.Output[str] = None¶: Volume Amazon Resource Name (ARN), e.g. arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-12345678/volume/vol-12345678.

chap_enabled: pulumi.Output[bool] = None¶: Whether mutual CHAP is enabled for the iSCSI target.

gateway_arn: pulumi.Output[str] = None¶: The Amazon Resource Name (ARN) of the gateway.

lun_number: pulumi.Output[float] = None¶: Logical disk number.

network_interface_id: pulumi.Output[str] = None¶: The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted.

network_interface_port: pulumi.Output[float] = None¶: The port used to communicate with iSCSI targets.

snapshot_id: pulumi.Output[str] = None¶: The snapshot ID of the snapshot to restore as the new cached volume. e.g. snap-1122aabb.

source_volume_arn: pulumi.Output[str] = 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.

tags: pulumi.Output[dict] = None¶: Key-value map of resource tags

target_arn: pulumi.Output[str] = 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: pulumi.Output[str] = 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: pulumi.Output[str] = None¶: Volume Amazon Resource Name (ARN), e.g. arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-12345678/volume/vol-12345678.

volume_id: pulumi.Output[str] = None¶: Volume ID, e.g. vol-12345678.

volume_size_in_bytes: pulumi.Output[float] = None¶: The size of the volume in bytes.

static get(resource_name, id, opts=None, arn=None, chap_enabled=None, gateway_arn=None, lun_number=None, network_interface_id=None, network_interface_port=None, snapshot_id=None, source_volume_arn=None, tags=None, target_arn=None, target_name=None, volume_arn=None, volume_id=None, volume_size_in_bytes=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
arn (pulumi.Input[str]) – Volume Amazon Resource Name (ARN), e.g. arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-12345678/volume/vol-12345678.
chap_enabled (pulumi.Input[bool]) – Whether mutual CHAP is enabled for the iSCSI target.
gateway_arn (pulumi.Input[str]) – The Amazon Resource Name (ARN) of the gateway.
lun_number (pulumi.Input[float]) – Logical disk number.
network_interface_id (pulumi.Input[str]) – The network interface of the gateway on which to expose the iSCSI target. Only IPv4 addresses are accepted.
network_interface_port (pulumi.Input[float]) – The port used to communicate with iSCSI targets.
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.
tags (pulumi.Input[dict]) – Key-value map of resource tags
target_arn (pulumi.Input[str]) – 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 (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_arn (pulumi.Input[str]) – Volume Amazon Resource Name (ARN), e.g. arn:aws:storagegateway:us-east-1:123456789012:gateway/sgw-12345678/volume/vol-12345678.
volume_id (pulumi.Input[str]) – Volume ID, e.g. vol-12345678.
volume_size_in_bytes (pulumi.Input[float]) – 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, cloudwatch_log_group_arn=None, gateway_ip_address=None, gateway_name=None, gateway_timezone=None, gateway_type=None, gateway_vpc_endpoint=None, medium_changer_type=None, smb_active_directory_settings=None, smb_guest_password=None, tags=None, tape_drive_type=None, __props__=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.

import pulumi
import pulumi_aws as aws

example = aws.storagegateway.Gateway("example",
    gateway_ip_address="1.2.3.4",
    gateway_name="example",
    gateway_timezone="GMT",
    gateway_type="FILE_S3")

import pulumi
import pulumi_aws as aws

example = aws.storagegateway.Gateway("example",
    gateway_ip_address="1.2.3.4",
    gateway_name="example",
    gateway_timezone="GMT",
    gateway_type="VTL",
    media_changer_type="AWS-Gateway-VTL",
    tape_drive_type="IBM-ULT3580-TD5")

import pulumi
import pulumi_aws as aws

example = aws.storagegateway.Gateway("example",
    gateway_ip_address="1.2.3.4",
    gateway_name="example",
    gateway_timezone="GMT",
    gateway_type="CACHED")

import pulumi
import pulumi_aws as aws

example = aws.storagegateway.Gateway("example",
    gateway_ip_address="1.2.3.4",
    gateway_name="example",
    gateway_timezone="GMT",
    gateway_type="STORED")

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.
cloudwatch_log_group_arn (pulumi.Input[str]) – The Amazon Resource Name (ARN) of the Amazon CloudWatch log group to use to monitor and log events in the gateway.
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 this provider 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.
gateway_vpc_endpoint (pulumi.Input[str]) – 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.
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. 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.
tags (pulumi.Input[dict]) – Key-value mapping of resource tags
tape_drive_type (pulumi.Input[str]) – Type of tape drive to use for tape gateway. This provider cannot detect drift of this argument. Valid values: IBM-ULT3580-TD5.

The smb_active_directory_settings object supports the following:

domain_name (pulumi.Input[str]) - The name of the domain that you want the gateway to join.
password (pulumi.Input[str]) - The password of the user who has permission to add the gateway to the Active Directory domain.
username (pulumi.Input[str]) - The user name of user who has permission to add the gateway to the Active Directory domain.

activation_key: pulumi.Output[str] = None¶: Gateway activation key during resource creation. Conflicts with gateway_ip_address. Additional information is available in the Storage Gateway User Guide.

arn: pulumi.Output[str] = None¶: Amazon Resource Name (ARN) of the gateway.

cloudwatch_log_group_arn: pulumi.Output[str] = None¶: The Amazon Resource Name (ARN) of the Amazon CloudWatch log group to use to monitor and log events in the gateway.

gateway_id: pulumi.Output[str] = None¶: Identifier of the gateway.

gateway_ip_address: pulumi.Output[str] = None¶: Gateway IP address to retrieve activation key during resource creation. Conflicts with activation_key. Gateway must be accessible on port 80 from where this provider is running. Additional information is available in the Storage Gateway User Guide.

gateway_name: pulumi.Output[str] = None¶: Name of the gateway.

gateway_timezone: pulumi.Output[str] = 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: pulumi.Output[str] = None¶: Type of the gateway. The default value is STORED. Valid values: CACHED, FILE_S3, STORED, VTL.

gateway_vpc_endpoint: pulumi.Output[str] = None¶: 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.

smb_active_directory_settings: pulumi.Output[dict] = 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.

domain_name (str) - The name of the domain that you want the gateway to join.
password (str) - The password of the user who has permission to add the gateway to the Active Directory domain.
username (str) - The user name of user who has permission to add the gateway to the Active Directory domain.

smb_guest_password: pulumi.Output[str] = 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. 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.

tags: pulumi.Output[dict] = None¶: Key-value mapping of resource tags

tape_drive_type: pulumi.Output[str] = None¶: Type of tape drive to use for tape gateway. This provider cannot detect drift of this argument. Valid values: IBM-ULT3580-TD5.

static get(resource_name, id, opts=None, activation_key=None, arn=None, cloudwatch_log_group_arn=None, gateway_id=None, gateway_ip_address=None, gateway_name=None, gateway_timezone=None, gateway_type=None, gateway_vpc_endpoint=None, medium_changer_type=None, smb_active_directory_settings=None, smb_guest_password=None, tags=None, tape_drive_type=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
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.
arn (pulumi.Input[str]) – Amazon Resource Name (ARN) of the gateway.
cloudwatch_log_group_arn (pulumi.Input[str]) – The Amazon Resource Name (ARN) of the Amazon CloudWatch log group to use to monitor and log events in the gateway.
gateway_id (pulumi.Input[str]) – Identifier of the gateway.
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 this provider 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.
gateway_vpc_endpoint (pulumi.Input[str]) –
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.
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. 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.
tags (pulumi.Input[dict]) – Key-value mapping of resource tags
tape_drive_type (pulumi.Input[str]) – Type of tape drive to use for tape gateway. This provider cannot detect drift of this argument. Valid values: IBM-ULT3580-TD5.

The smb_active_directory_settings object supports the following:

domain_name (pulumi.Input[str]) - The name of the domain that you want the gateway to join.
password (pulumi.Input[str]) - The password of the user who has permission to add the gateway to the Active Directory domain.
username (pulumi.Input[str]) - The user name of user who has permission to add the gateway to the Active Directory domain.

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, disk_node=None, disk_path=None, gateway_arn=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¶: 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, tags=None, __props__=None, __name__=None, __opts__=None)¶

Manages an AWS Storage Gateway NFS File Share.

import pulumi
import pulumi_aws as aws

example = aws.storagegateway.NfsFileShare("example",
    client_lists=["0.0.0.0/0"],
    gateway_arn=aws_storagegateway_gateway["example"]["arn"],
    location_arn=aws_s3_bucket["example"]["arn"],
    role_arn=aws_iam_role["example"]["arn"])

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)
tags (pulumi.Input[dict]) – Key-value map of resource tags

The nfs_file_share_defaults object supports the following:

directoryMode (pulumi.Input[str]) - The Unix directory mode in the string form “nnnn”. Defaults to "0777".
fileMode (pulumi.Input[str]) - The Unix file mode in the string form “nnnn”. Defaults to "0666".
groupId (pulumi.Input[float]) - The default group ID for the file share (unless the files have another group ID specified). Defaults to 65534 (nfsnobody). Valid values: 0 through 4294967294.
owner_id (pulumi.Input[float]) - The default owner ID for the file share (unless the files have another owner ID specified). Defaults to 65534 (nfsnobody). Valid values: 0 through 4294967294.

arn: pulumi.Output[str] = None¶: Amazon Resource Name (ARN) of the NFS File Share.

client_lists: pulumi.Output[list] = 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: pulumi.Output[str] = 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: pulumi.Output[str] = None¶: ID of the NFS File Share.

gateway_arn: pulumi.Output[str] = None¶: Amazon Resource Name (ARN) of the file gateway.

guess_mime_type_enabled: pulumi.Output[bool] = None¶: Boolean value that enables guessing of the MIME type for uploaded objects based on file extensions. Defaults to true.

kms_encrypted: pulumi.Output[bool] = 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: pulumi.Output[str] = 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: pulumi.Output[str] = None¶: The ARN of the backed storage used for storing file data.

nfs_file_share_defaults: pulumi.Output[dict] = None¶

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

directoryMode (str) - The Unix directory mode in the string form “nnnn”. Defaults to "0777".
fileMode (str) - The Unix file mode in the string form “nnnn”. Defaults to "0666".
groupId (float) - The default group ID for the file share (unless the files have another group ID specified). Defaults to 65534 (nfsnobody). Valid values: 0 through 4294967294.
owner_id (float) - The default owner ID for the file share (unless the files have another owner ID specified). Defaults to 65534 (nfsnobody). Valid values: 0 through 4294967294.

object_acl: pulumi.Output[str] = None¶: Access Control List permission for S3 bucket objects. Defaults to private.

path: pulumi.Output[str] = None¶: File share path used by the NFS client to identify the mount point.

read_only: pulumi.Output[bool] = None¶: Boolean to indicate write status of file share. File share does not accept writes if true. Defaults to false.

requester_pays: pulumi.Output[bool] = 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: pulumi.Output[str] = None¶: The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.

squash: pulumi.Output[str] = 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)

tags: pulumi.Output[dict] = None¶: Key-value map of resource tags

static get(resource_name, id, opts=None, arn=None, client_lists=None, default_storage_class=None, fileshare_id=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, path=None, read_only=None, requester_pays=None, role_arn=None, squash=None, tags=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
arn (pulumi.Input[str]) – Amazon Resource Name (ARN) of the NFS File Share.
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.
fileshare_id (pulumi.Input[str]) – ID of the NFS File Share.
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.
path (pulumi.Input[str]) – File share path used by the NFS client to identify the mount point.
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)
tags (pulumi.Input[dict]) – Key-value map of resource tags

The nfs_file_share_defaults object supports the following:

directoryMode (pulumi.Input[str]) - The Unix directory mode in the string form “nnnn”. Defaults to "0777".
fileMode (pulumi.Input[str]) - The Unix file mode in the string form “nnnn”. Defaults to "0666".
groupId (pulumi.Input[float]) - The default group ID for the file share (unless the files have another group ID specified). Defaults to 65534 (nfsnobody). Valid values: 0 through 4294967294.
owner_id (pulumi.Input[float]) - The default owner ID for the file share (unless the files have another owner ID specified). Defaults to 65534 (nfsnobody). Valid values: 0 through 4294967294.

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, tags=None, valid_user_lists=None, __props__=None, __name__=None, __opts__=None)¶

Manages an AWS Storage Gateway SMB File Share.

import pulumi
import pulumi_aws as aws

example = aws.storagegateway.SmbFileShare("example",
    authentication="ActiveDirectory",
    gateway_arn=aws_storagegateway_gateway["example"]["arn"],
    location_arn=aws_s3_bucket["example"]["arn"],
    role_arn=aws_iam_role["example"]["arn"])

import pulumi
import pulumi_aws as aws

example = aws.storagegateway.SmbFileShare("example",
    authentication="GuestAccess",
    gateway_arn=aws_storagegateway_gateway["example"]["arn"],
    location_arn=aws_s3_bucket["example"]["arn"],
    role_arn=aws_iam_role["example"]["arn"])

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.
tags (pulumi.Input[dict]) – Key-value map of resource tags
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: pulumi.Output[str] = None¶: Amazon Resource Name (ARN) of the SMB File Share.

authentication: pulumi.Output[str] = None¶: The authentication method that users use to access the file share. Defaults to ActiveDirectory. Valid values: ActiveDirectory, GuestAccess.

default_storage_class: pulumi.Output[str] = 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: pulumi.Output[str] = None¶: ID of the SMB File Share.

gateway_arn: pulumi.Output[str] = None¶: Amazon Resource Name (ARN) of the file gateway.

guess_mime_type_enabled: pulumi.Output[bool] = None¶: Boolean value that enables guessing of the MIME type for uploaded objects based on file extensions. Defaults to true.

invalid_user_lists: pulumi.Output[list] = 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: pulumi.Output[bool] = 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: pulumi.Output[str] = 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: pulumi.Output[str] = None¶: The ARN of the backed storage used for storing file data.

object_acl: pulumi.Output[str] = None¶: Access Control List permission for S3 bucket objects. Defaults to private.

path: pulumi.Output[str] = None¶: File share path used by the NFS client to identify the mount point.

read_only: pulumi.Output[bool] = None¶: Boolean to indicate write status of file share. File share does not accept writes if true. Defaults to false.

requester_pays: pulumi.Output[bool] = 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: pulumi.Output[str] = None¶: The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.

tags: pulumi.Output[dict] = None¶: Key-value map of resource tags

valid_user_lists: pulumi.Output[list] = 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.

static get(resource_name, id, opts=None, arn=None, authentication=None, default_storage_class=None, fileshare_id=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, path=None, read_only=None, requester_pays=None, role_arn=None, tags=None, valid_user_lists=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
arn (pulumi.Input[str]) – Amazon Resource Name (ARN) of the SMB File Share.
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.
fileshare_id (pulumi.Input[str]) – ID of the SMB File Share.
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.
path (pulumi.Input[str]) – File share path used by the NFS client to identify the mount point.
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.
tags (pulumi.Input[dict]) – Key-value map of resource tags
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.

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, __props__=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 resource does not perform any Storage Gateway actions.

import pulumi
import pulumi_aws as aws

example = aws.storagegateway.UploadBuffer("example",
    disk_id=data["aws_storagegateway_local_disk"]["example"]["id"],
    gateway_arn=aws_storagegateway_gateway["example"]["arn"])

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: pulumi.Output[str] = None¶: Local disk identifier. For example, pci-0000:03:00.0-scsi-0:0:0:0.

gateway_arn: pulumi.Output[str] = None¶: The Amazon Resource Name (ARN) of the gateway.

static get(resource_name, id, opts=None, disk_id=None, gateway_arn=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
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.

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, __props__=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 resource does not perform any Storage Gateway actions.

import pulumi
import pulumi_aws as aws

example = aws.storagegateway.WorkingStorage("example",
    disk_id=data["aws_storagegateway_local_disk"]["example"]["id"],
    gateway_arn=aws_storagegateway_gateway["example"]["arn"])

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: pulumi.Output[str] = None¶: Local disk identifier. For example, pci-0000:03:00.0-scsi-0:0:0:0.

gateway_arn: pulumi.Output[str] = None¶: The Amazon Resource Name (ARN) of the gateway.

static get(resource_name, id, opts=None, disk_id=None, gateway_arn=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
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.

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.

import pulumi
import pulumi_aws as aws

test = aws.storagegateway.get_local_disk(disk_path=aws_volume_attachment["test"]["device_name"],
    gateway_arn=aws_storagegateway_gateway["test"]["arn"])

Parameters

disk_node (str) – The device node of the local disk to retrieve. For example, /dev/sdb.
disk_path (str) – The device path of the local disk to retrieve. For example, /dev/xvdb or /dev/nvme1n1.
gateway_arn (str) – 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

storagegateway¶

On This Page