Package com.pulumi.aws.storagegateway.inputs

Class SmbFileShareState

  • public final class SmbFileShareState
extends com.pulumi.resources.ResourceArgs

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  SmbFileShareState.Builder  

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

        com.pulumi.resources.InputArgs.InputArgsInternal

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> accessBasedEnumeration()  
      java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> adminUserLists()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> arn()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> auditDestinationArn()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> authentication()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> bucketRegion()  
      static SmbFileShareState.Builder builder()  
      static SmbFileShareState.Builder builder​(SmbFileShareState defaults)  
      java.util.Optional<com.pulumi.core.Output<SmbFileShareCacheAttributesArgs>> cacheAttributes()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> caseSensitivity()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> defaultStorageClass()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> fileshareId()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> fileShareName()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> gatewayArn()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> guessMimeTypeEnabled()  
      java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> invalidUserLists()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> kmsEncrypted()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> kmsKeyArn()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> locationArn()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> notificationPolicy()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> objectAcl()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> oplocksEnabled()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> path()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> readOnly()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> region()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> requesterPays()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> roleArn()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> smbAclEnabled()  
      java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tagsAll()  
      java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> validUserLists()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> vpcEndpointDnsName()  

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

        validateMember

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • accessBasedEnumeration

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> accessBasedEnumeration()
        Returns:
        The files and folders on this share will only be visible to users with read access. Default value is `false`.

      • adminUserLists

        public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> adminUserLists()
        Returns:
        A list of users in the Active Directory that have admin access to the file share. Only valid if `authentication` is set to `ActiveDirectory`.

      • arn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> arn()
        Returns:
        ARN of the SMB File Share.

      • auditDestinationArn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> auditDestinationArn()
        Returns:
        ARN of the CloudWatch Log Group used for the audit logs.

      • authentication

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> authentication()
        Returns:
        The authentication method that users use to access the file share. Defaults to `ActiveDirectory`. Valid values: `ActiveDirectory`, `GuestAccess`.

      • bucketRegion

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

      • cacheAttributes

        public java.util.Optional<com.pulumi.core.Output<SmbFileShareCacheAttributesArgs>> cacheAttributes()
        Returns:
        Refresh cache information. see `cacheAttributes` Block for more details.

      • caseSensitivity

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> caseSensitivity()
        Returns:
        The case of an object name in an Amazon S3 bucket. For `ClientSpecified`, the client determines the case sensitivity. For `CaseSensitive`, the gateway determines the case sensitivity. The default value is `ClientSpecified`.

      • defaultStorageClass

        public java.util.Optional<com.pulumi.core.Output<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 java.util.Optional<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 `locationArn`.

      • fileshareId

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

      • gatewayArn

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

      • guessMimeTypeEnabled

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

      • invalidUserLists

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

      • kmsEncrypted

        public java.util.Optional<com.pulumi.core.Output<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 java.util.Optional<com.pulumi.core.Output<java.lang.String>> kmsKeyArn()
        Returns:
        ARN for KMS key used for Amazon S3 server side encryption. This value can only be set when `kmsEncrypted` is true.

      • locationArn

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

      • notificationPolicy

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

      • oplocksEnabled

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> oplocksEnabled()
        Returns:
        Boolean to indicate Opportunistic lock (oplock) status. Defaults to `true`.

      • path

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

      • readOnly

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

      • region

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • requesterPays

        public java.util.Optional<com.pulumi.core.Output<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 java.util.Optional<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.

      • smbAclEnabled

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> smbAclEnabled()
        Returns:
        Set this value to `true` to enable ACL (access control list) on the SMB fileshare. Set it to `false` to map file and directory permissions to the POSIX permissions. This setting applies only to `ActiveDirectory` authentication type.

      • tags

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Key-value map of resource tags. .If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. **Note:** If you have previously included a `cacheAttributes` block in your configuration, removing it will not reset the refresh cache value and the previous value will remain. You must explicitly set a new value to change it.

      • tagsAll

        public java.util.Optional<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 `defaultTags` configuration block.

      • validUserLists

        public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> validUserLists()
        Returns:
        A list of users in the Active Directory that are allowed to access the file share. If you need to specify an Active directory group, add '@' before the name of the group. It will be set on Allowed group in AWS console. Only valid if `authentication` is set to `ActiveDirectory`.

      • vpcEndpointDnsName

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