pulumi-aws-kotlin/com.pulumi.aws.storagegateway.kotlin/NfsFileShare

NfsFileShare

class NfsFileShare : KotlinCustomResource

Manages an AWS Storage Gateway NFS File Share.

Example Usage

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.storagegateway.NfsFileShare;
import com.pulumi.aws.storagegateway.NfsFileShareArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var example = new NfsFileShare("example", NfsFileShareArgs.builder()
            .clientLists("0.0.0.0/0")
            .gatewayArn(aws_storagegateway_gateway.example().arn())
            .locationArn(aws_s3_bucket.example().arn())
            .roleArn(aws_iam_role.example().arn())
            .build());
    }
}

Import

aws_storagegateway_nfs_file_share can be imported by using the NFS File Share Amazon Resource Name (ARN), e.g.,

$ pulumi import aws:storagegateway/nfsFileShare:NfsFileShare example arn:aws:storagegateway:us-east-1:123456789012:share/share-12345678

Properties

arn

val arn: Output<String>

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

auditDestinationArn

val auditDestinationArn: Output<String>?

The Amazon Resource Name (ARN) of the storage used for audit logs.

bucketRegion

val bucketRegion: Output<String>?

The region of the S3 bucket used by the file share. Required when specifying vpc_endpoint_dns_name.

cacheAttributes

val cacheAttributes: Output<NfsFileShareCacheAttributes>?

Refresh cache information. see Cache Attributes for more details.

clientLists

val clientLists: Output<List<String>>

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

defaultStorageClass

val defaultStorageClass: Output<String>?

The default storage class for objects put into an Amazon S3 bucket by the file gateway. Defaults to S3_STANDARD.

fileshareId

val fileshareId: Output<String>

ID of the NFS File Share.

fileShareName

val fileShareName: Output<String>

The name of the file share. Must be set if an S3 prefix name is set in location_arn.

gatewayArn

val gatewayArn: Output<String>

Amazon Resource Name (ARN) of the file gateway.

guessMimeTypeEnabled

val guessMimeTypeEnabled: Output<Boolean>?

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

val id: Output<String>

kmsEncrypted

val kmsEncrypted: Output<Boolean>?

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

kmsKeyArn

val kmsKeyArn: Output<String>?

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.

locationArn

val locationArn: Output<String>

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

nfsFileShareDefaults

val nfsFileShareDefaults: Output<NfsFileShareNfsFileShareDefaults>?

Nested argument with file share default values. More information below. see NFS File Share Defaults for more details.

notificationPolicy

val notificationPolicy: Output<String>?

The notification policy of the file share. For more information see the AWS Documentation. Default value is {}.

objectAcl

val objectAcl: Output<String>?

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

path

val path: Output<String>

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

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

readOnly

val readOnly: Output<Boolean>?

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

requesterPays

val requesterPays: Output<Boolean>?

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

roleArn

val roleArn: Output<String>

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

squash

val squash: Output<String>?

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)