Package com.pulumi.aws.storagegateway

Class NfsFileShare

  • public class NfsFileShare
extends com.pulumi.resources.CustomResource
    Manages an AWS Storage Gateway NFS File Share. ## Example Usage <!--Start PulumiCodeChooser --> ```java 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(exampleAwsStoragegatewayGateway.arn()) .locationArn(exampleAwsS3Bucket.arn()) .roleArn(exampleAwsIamRole.arn()) .build()); } } ``` <!--End PulumiCodeChooser --> ## Import Using `pulumi import`, import `aws_storagegateway_nfs_file_share` using the NFS File Share Amazon Resource Name (ARN). For example: ```sh $ pulumi import aws:storagegateway/nfsFileShare:NfsFileShare example arn:aws:storagegateway:us-east-1:123456789012:share/share-12345678 ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> auditDestinationArn()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> bucketRegion()  
      com.pulumi.core.Output<java.util.Optional<NfsFileShareCacheAttributes>> cacheAttributes()  
      com.pulumi.core.Output<java.util.List<java.lang.String>> clientLists()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> defaultStorageClass()  
      com.pulumi.core.Output<java.lang.String> fileshareId()  
      com.pulumi.core.Output<java.lang.String> fileShareName()  
      com.pulumi.core.Output<java.lang.String> gatewayArn()  
      static NfsFileShare get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, NfsFileShareState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> guessMimeTypeEnabled()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> kmsEncrypted()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> kmsKeyArn()  
      com.pulumi.core.Output<java.lang.String> locationArn()  
      com.pulumi.core.Output<java.util.Optional<NfsFileShareNfsFileShareDefaults>> nfsFileShareDefaults()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> notificationPolicy()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> objectAcl()  
      com.pulumi.core.Output<java.lang.String> path()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> readOnly()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> requesterPays()  
      com.pulumi.core.Output<java.lang.String> roleArn()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> squash()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> vpcEndpointDnsName()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • NfsFileShare

        public NfsFileShare​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • NfsFileShare

        public NfsFileShare​(java.lang.String name,
                    NfsFileShareArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • NfsFileShare

        public NfsFileShare​(java.lang.String name,
                    NfsFileShareArgs args,
                    @Nullable
                    com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        Amazon Resource Name (ARN) of the NFS File Share.

      • auditDestinationArn

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> auditDestinationArn()
        Returns:
        The Amazon Resource Name (ARN) of the storage used for audit logs.

      • bucketRegion

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> bucketRegion()
        Returns:
        The region of the S3 bucket used by the file share. Required when specifying `vpc_endpoint_dns_name`.

      • cacheAttributes

        public com.pulumi.core.Output<java.util.Optional<NfsFileShareCacheAttributes>> cacheAttributes()
        Returns:
        Refresh cache information. see Cache Attributes for more details.

      • clientLists

        public com.pulumi.core.Output<java.util.List<java.lang.String>> clientLists()
        Returns:
        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

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> defaultStorageClass()
        Returns:
        The default [storage class](https://docs.aws.amazon.com/storagegateway/latest/APIReference/API_CreateNFSFileShare.html#StorageGateway-CreateNFSFileShare-request-DefaultStorageClass) for objects put into an Amazon S3 bucket by the file gateway. Defaults to `S3_STANDARD`.

      • fileShareName

        public com.pulumi.core.Output<java.lang.String> fileShareName()
        Returns:
        The name of the file share. Must be set if an S3 prefix name is set in `location_arn`.

      • fileshareId

        public com.pulumi.core.Output<java.lang.String> fileshareId()
        Returns:
        ID of the NFS File Share.

      • gatewayArn

        public com.pulumi.core.Output<java.lang.String> gatewayArn()
        Returns:
        Amazon Resource Name (ARN) of the file gateway.

      • guessMimeTypeEnabled

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> guessMimeTypeEnabled()
        Returns:
        Boolean value that enables guessing of the MIME type for uploaded objects based on file extensions. Defaults to `true`.

      • kmsEncrypted

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> kmsEncrypted()
        Returns:
        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

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> kmsKeyArn()
        Returns:
        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

        public com.pulumi.core.Output<java.lang.String> locationArn()
        Returns:
        The ARN of the backed storage used for storing file data.

      • nfsFileShareDefaults

        public com.pulumi.core.Output<java.util.Optional<NfsFileShareNfsFileShareDefaults>> nfsFileShareDefaults()
        Returns:
        Nested argument with file share default values. More information below. see NFS File Share Defaults for more details.

      • notificationPolicy

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> notificationPolicy()
        Returns:
        The notification policy of the file share. For more information see the [AWS Documentation](https://docs.aws.amazon.com/storagegateway/latest/APIReference/API_CreateNFSFileShare.html#StorageGateway-CreateNFSFileShare-request-NotificationPolicy). Default value is `{}`.

      • objectAcl

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> objectAcl()
        Returns:
        Access Control List permission for S3 objects. Defaults to `private`.

      • path

        public com.pulumi.core.Output<java.lang.String> path()
        Returns:
        File share path used by the NFS client to identify the mount point.

      • readOnly

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> readOnly()
        Returns:
        Boolean to indicate write status of file share. File share does not accept writes if `true`. Defaults to `false`.

      • requesterPays

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> requesterPays()
        Returns:
        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

        public com.pulumi.core.Output<java.lang.String> roleArn()
        Returns:
        The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.

      • squash

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> squash()
        Returns:
        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

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        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.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        A map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.

      • vpcEndpointDnsName

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> vpcEndpointDnsName()
        Returns:
        The DNS name of the VPC endpoint for S3 PrivateLink.

      • get

        public static NfsFileShare get​(java.lang.String name,
                               com.pulumi.core.Output<java.lang.String> id,
                               @Nullable
                               NfsFileShareState state,
                               @Nullable
                               com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.