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

NfsFileShareArgs

data class NfsFileShareArgs(val auditDestinationArn: Output<String>? = null, val bucketRegion: Output<String>? = null, val cacheAttributes: Output<NfsFileShareCacheAttributesArgs>? = null, val clientLists: Output<List<String>>? = null, val defaultStorageClass: Output<String>? = null, val fileShareName: Output<String>? = null, val gatewayArn: Output<String>? = null, val guessMimeTypeEnabled: Output<Boolean>? = null, val kmsEncrypted: Output<Boolean>? = null, val kmsKeyArn: Output<String>? = null, val locationArn: Output<String>? = null, val nfsFileShareDefaults: Output<NfsFileShareNfsFileShareDefaultsArgs>? = null, val notificationPolicy: Output<String>? = null, val objectAcl: Output<String>? = null, val readOnly: Output<Boolean>? = null, val requesterPays: Output<Boolean>? = null, val roleArn: Output<String>? = null, val squash: Output<String>? = null, val tags: Output<Map<String, String>>? = null, val vpcEndpointDnsName: Output<String>? = null) : ConvertibleToJava<NfsFileShareArgs>

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());
    }
}
Content copied to clipboard

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
Content copied to clipboard

Constructors

Link copied to clipboard
fun NfsFileShareArgs(auditDestinationArn: Output<String>? = null, bucketRegion: Output<String>? = null, cacheAttributes: Output<NfsFileShareCacheAttributesArgs>? = null, clientLists: Output<List<String>>? = null, defaultStorageClass: Output<String>? = null, fileShareName: Output<String>? = null, gatewayArn: Output<String>? = null, guessMimeTypeEnabled: Output<Boolean>? = null, kmsEncrypted: Output<Boolean>? = null, kmsKeyArn: Output<String>? = null, locationArn: Output<String>? = null, nfsFileShareDefaults: Output<NfsFileShareNfsFileShareDefaultsArgs>? = null, notificationPolicy: Output<String>? = null, objectAcl: Output<String>? = null, readOnly: Output<Boolean>? = null, requesterPays: Output<Boolean>? = null, roleArn: Output<String>? = null, squash: Output<String>? = null, tags: Output<Map<String, String>>? = null, vpcEndpointDnsName: Output<String>? = null)

Functions

Link copied to clipboard
open override fun toJava(): NfsFileShareArgs

Properties

Link copied to clipboard
val auditDestinationArn: Output<String>? = null

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

Link copied to clipboard
val bucketRegion: Output<String>? = null

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

Link copied to clipboard
val cacheAttributes: Output<NfsFileShareCacheAttributesArgs>? = null

Refresh cache information. see Cache Attributes for more details.

Link copied to clipboard
val clientLists: Output<List<String>>? = null

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&#46;0&#46;0&#46;0/0"] to not limit access. Minimum 1 item. Maximum 100 items.

Link copied to clipboard
val defaultStorageClass: Output<String>? = null

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

Link copied to clipboard
val fileShareName: Output<String>? = null

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

Link copied to clipboard
val gatewayArn: Output<String>? = null

Amazon Resource Name (ARN) of the file gateway.

Link copied to clipboard
val guessMimeTypeEnabled: Output<Boolean>? = null

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

Link copied to clipboard
val kmsEncrypted: Output<Boolean>? = null

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.

Link copied to clipboard
val kmsKeyArn: Output<String>? = null

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.

Link copied to clipboard
val locationArn: Output<String>? = null

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

Link copied to clipboard
val nfsFileShareDefaults: Output<NfsFileShareNfsFileShareDefaultsArgs>? = null

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

Link copied to clipboard
val notificationPolicy: Output<String>? = null

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

Link copied to clipboard
val objectAcl: Output<String>? = null

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

Link copied to clipboard
val readOnly: Output<Boolean>? = null

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

Link copied to clipboard
val requesterPays: Output<Boolean>? = null

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.

Link copied to clipboard
val roleArn: Output<String>? = null

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

Link copied to clipboard
val squash: Output<String>? = null

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)

Link copied to clipboard
val tags: Output<Map<String, String>>? = null

Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Link copied to clipboard
val vpcEndpointDnsName: Output<String>? = null

The DNS name of the VPC endpoint for S3 PrivateLink.