Package com.pulumi.aws.storagegateway

Class SmbFileShareArgs.Builder

  • Enclosing class:
    SmbFileShareArgs
    public static final class SmbFileShareArgs.Builder
extends java.lang.Object

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • accessBasedEnumeration

        public SmbFileShareArgs.Builder accessBasedEnumeration​(@Nullable
                                                       com.pulumi.core.Output<java.lang.Boolean> accessBasedEnumeration)
        Parameters:
        accessBasedEnumeration - The files and folders on this share will only be visible to users with read access. Default value is `false`.
        Returns:
        builder

      • accessBasedEnumeration

        public SmbFileShareArgs.Builder accessBasedEnumeration​(java.lang.Boolean accessBasedEnumeration)
        Parameters:
        accessBasedEnumeration - The files and folders on this share will only be visible to users with read access. Default value is `false`.
        Returns:
        builder

      • adminUserLists

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

      • adminUserLists

        public SmbFileShareArgs.Builder adminUserLists​(java.util.List<java.lang.String> adminUserLists)
        Parameters:
        adminUserLists - A list of users in the Active Directory that have admin access to the file share. Only valid if `authentication` is set to `ActiveDirectory`.
        Returns:
        builder

      • adminUserLists

        public SmbFileShareArgs.Builder adminUserLists​(java.lang.String... adminUserLists)
        Parameters:
        adminUserLists - A list of users in the Active Directory that have admin access to the file share. Only valid if `authentication` is set to `ActiveDirectory`.
        Returns:
        builder

      • auditDestinationArn

        public SmbFileShareArgs.Builder auditDestinationArn​(@Nullable
                                                    com.pulumi.core.Output<java.lang.String> auditDestinationArn)
        Parameters:
        auditDestinationArn - ARN of the CloudWatch Log Group used for the audit logs.
        Returns:
        builder

      • auditDestinationArn

        public SmbFileShareArgs.Builder auditDestinationArn​(java.lang.String auditDestinationArn)
        Parameters:
        auditDestinationArn - ARN of the CloudWatch Log Group used for the audit logs.
        Returns:
        builder

      • authentication

        public SmbFileShareArgs.Builder authentication​(@Nullable
                                               com.pulumi.core.Output<java.lang.String> authentication)
        Parameters:
        authentication - The authentication method that users use to access the file share. Defaults to `ActiveDirectory`. Valid values: `ActiveDirectory`, `GuestAccess`.
        Returns:
        builder

      • authentication

        public SmbFileShareArgs.Builder authentication​(java.lang.String authentication)
        Parameters:
        authentication - The authentication method that users use to access the file share. Defaults to `ActiveDirectory`. Valid values: `ActiveDirectory`, `GuestAccess`.
        Returns:
        builder

      • bucketRegion

        public SmbFileShareArgs.Builder bucketRegion​(@Nullable
                                             com.pulumi.core.Output<java.lang.String> bucketRegion)
        Parameters:
        bucketRegion - The region of the S3 buck used by the file share. Required when specifying a `vpcEndpointDnsName`.
        Returns:
        builder

      • bucketRegion

        public SmbFileShareArgs.Builder bucketRegion​(java.lang.String bucketRegion)
        Parameters:
        bucketRegion - The region of the S3 buck used by the file share. Required when specifying a `vpcEndpointDnsName`.
        Returns:
        builder

      • caseSensitivity

        public SmbFileShareArgs.Builder caseSensitivity​(@Nullable
                                                com.pulumi.core.Output<java.lang.String> caseSensitivity)
        Parameters:
        caseSensitivity - 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`.
        Returns:
        builder

      • caseSensitivity

        public SmbFileShareArgs.Builder caseSensitivity​(java.lang.String caseSensitivity)
        Parameters:
        caseSensitivity - 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`.
        Returns:
        builder

      • defaultStorageClass

        public SmbFileShareArgs.Builder defaultStorageClass​(@Nullable
                                                    com.pulumi.core.Output<java.lang.String> defaultStorageClass)
        Parameters:
        defaultStorageClass - 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`.
        Returns:
        builder

      • defaultStorageClass

        public SmbFileShareArgs.Builder defaultStorageClass​(java.lang.String defaultStorageClass)
        Parameters:
        defaultStorageClass - 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`.
        Returns:
        builder

      • fileShareName

        public SmbFileShareArgs.Builder fileShareName​(@Nullable
                                              com.pulumi.core.Output<java.lang.String> fileShareName)
        Parameters:
        fileShareName - The name of the file share. Must be set if an S3 prefix name is set in `locationArn`.
        Returns:
        builder

      • fileShareName

        public SmbFileShareArgs.Builder fileShareName​(java.lang.String fileShareName)
        Parameters:
        fileShareName - The name of the file share. Must be set if an S3 prefix name is set in `locationArn`.
        Returns:
        builder

      • gatewayArn

        public SmbFileShareArgs.Builder gatewayArn​(com.pulumi.core.Output<java.lang.String> gatewayArn)
        Parameters:
        gatewayArn - ARN of the file gateway.
        Returns:
        builder

      • gatewayArn

        public SmbFileShareArgs.Builder gatewayArn​(java.lang.String gatewayArn)
        Parameters:
        gatewayArn - ARN of the file gateway.
        Returns:
        builder

      • guessMimeTypeEnabled

        public SmbFileShareArgs.Builder guessMimeTypeEnabled​(@Nullable
                                                     com.pulumi.core.Output<java.lang.Boolean> guessMimeTypeEnabled)
        Parameters:
        guessMimeTypeEnabled - Boolean value that enables guessing of the MIME type for uploaded objects based on file extensions. Defaults to `true`.
        Returns:
        builder

      • guessMimeTypeEnabled

        public SmbFileShareArgs.Builder guessMimeTypeEnabled​(java.lang.Boolean guessMimeTypeEnabled)
        Parameters:
        guessMimeTypeEnabled - Boolean value that enables guessing of the MIME type for uploaded objects based on file extensions. Defaults to `true`.
        Returns:
        builder

      • invalidUserLists

        public SmbFileShareArgs.Builder invalidUserLists​(@Nullable
                                                 com.pulumi.core.Output<java.util.List<java.lang.String>> invalidUserLists)
        Parameters:
        invalidUserLists - 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`.
        Returns:
        builder

      • invalidUserLists

        public SmbFileShareArgs.Builder invalidUserLists​(java.util.List<java.lang.String> invalidUserLists)
        Parameters:
        invalidUserLists - 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`.
        Returns:
        builder

      • invalidUserLists

        public SmbFileShareArgs.Builder invalidUserLists​(java.lang.String... invalidUserLists)
        Parameters:
        invalidUserLists - 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`.
        Returns:
        builder

      • kmsEncrypted

        public SmbFileShareArgs.Builder kmsEncrypted​(@Nullable
                                             com.pulumi.core.Output<java.lang.Boolean> kmsEncrypted)
        Parameters:
        kmsEncrypted - 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`.
        Returns:
        builder

      • kmsEncrypted

        public SmbFileShareArgs.Builder kmsEncrypted​(java.lang.Boolean kmsEncrypted)
        Parameters:
        kmsEncrypted - 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`.
        Returns:
        builder

      • kmsKeyArn

        public SmbFileShareArgs.Builder kmsKeyArn​(@Nullable
                                          com.pulumi.core.Output<java.lang.String> kmsKeyArn)
        Parameters:
        kmsKeyArn - ARN for KMS key used for Amazon S3 server side encryption. This value can only be set when `kmsEncrypted` is true.
        Returns:
        builder

      • kmsKeyArn

        public SmbFileShareArgs.Builder kmsKeyArn​(java.lang.String kmsKeyArn)
        Parameters:
        kmsKeyArn - ARN for KMS key used for Amazon S3 server side encryption. This value can only be set when `kmsEncrypted` is true.
        Returns:
        builder

      • locationArn

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

      • locationArn

        public SmbFileShareArgs.Builder locationArn​(java.lang.String locationArn)
        Parameters:
        locationArn - The ARN of the backed storage used for storing file data.
        Returns:
        builder

      • notificationPolicy

        public SmbFileShareArgs.Builder notificationPolicy​(@Nullable
                                                   com.pulumi.core.Output<java.lang.String> notificationPolicy)
        Parameters:
        notificationPolicy - 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 `{}`.
        Returns:
        builder

      • notificationPolicy

        public SmbFileShareArgs.Builder notificationPolicy​(java.lang.String notificationPolicy)
        Parameters:
        notificationPolicy - 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 `{}`.
        Returns:
        builder

      • objectAcl

        public SmbFileShareArgs.Builder objectAcl​(@Nullable
                                          com.pulumi.core.Output<java.lang.String> objectAcl)
        Parameters:
        objectAcl - Access Control List permission for S3 objects. Defaults to `private`.
        Returns:
        builder

      • objectAcl

        public SmbFileShareArgs.Builder objectAcl​(java.lang.String objectAcl)
        Parameters:
        objectAcl - Access Control List permission for S3 objects. Defaults to `private`.
        Returns:
        builder

      • oplocksEnabled

        public SmbFileShareArgs.Builder oplocksEnabled​(@Nullable
                                               com.pulumi.core.Output<java.lang.Boolean> oplocksEnabled)
        Parameters:
        oplocksEnabled - Boolean to indicate Opportunistic lock (oplock) status. Defaults to `true`.
        Returns:
        builder

      • oplocksEnabled

        public SmbFileShareArgs.Builder oplocksEnabled​(java.lang.Boolean oplocksEnabled)
        Parameters:
        oplocksEnabled - Boolean to indicate Opportunistic lock (oplock) status. Defaults to `true`.
        Returns:
        builder

      • readOnly

        public SmbFileShareArgs.Builder readOnly​(@Nullable
                                         com.pulumi.core.Output<java.lang.Boolean> readOnly)
        Parameters:
        readOnly - Boolean to indicate write status of file share. File share does not accept writes if `true`. Defaults to `false`.
        Returns:
        builder

      • readOnly

        public SmbFileShareArgs.Builder readOnly​(java.lang.Boolean readOnly)
        Parameters:
        readOnly - Boolean to indicate write status of file share. File share does not accept writes if `true`. Defaults to `false`.
        Returns:
        builder

      • region

        public SmbFileShareArgs.Builder region​(@Nullable
                                       com.pulumi.core.Output<java.lang.String> region)
        Parameters:
        region - 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.
        Returns:
        builder

      • region

        public SmbFileShareArgs.Builder region​(java.lang.String region)
        Parameters:
        region - 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.
        Returns:
        builder

      • requesterPays

        public SmbFileShareArgs.Builder requesterPays​(@Nullable
                                              com.pulumi.core.Output<java.lang.Boolean> requesterPays)
        Parameters:
        requesterPays - 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`.
        Returns:
        builder

      • requesterPays

        public SmbFileShareArgs.Builder requesterPays​(java.lang.Boolean requesterPays)
        Parameters:
        requesterPays - 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`.
        Returns:
        builder

      • roleArn

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

      • roleArn

        public SmbFileShareArgs.Builder roleArn​(java.lang.String roleArn)
        Parameters:
        roleArn - The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes when it accesses the underlying storage.
        Returns:
        builder

      • smbAclEnabled

        public SmbFileShareArgs.Builder smbAclEnabled​(@Nullable
                                              com.pulumi.core.Output<java.lang.Boolean> smbAclEnabled)
        Parameters:
        smbAclEnabled - 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.
        Returns:
        builder

      • smbAclEnabled

        public SmbFileShareArgs.Builder smbAclEnabled​(java.lang.Boolean smbAclEnabled)
        Parameters:
        smbAclEnabled - 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.
        Returns:
        builder

      • tags

        public SmbFileShareArgs.Builder tags​(@Nullable
                                     com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tags)
        Parameters:
        tags - 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.
        Returns:
        builder

      • tags

        public SmbFileShareArgs.Builder tags​(java.util.Map<java.lang.String,​java.lang.String> tags)
        Parameters:
        tags - 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.
        Returns:
        builder

      • validUserLists

        public SmbFileShareArgs.Builder validUserLists​(@Nullable
                                               com.pulumi.core.Output<java.util.List<java.lang.String>> validUserLists)
        Parameters:
        validUserLists - 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`.
        Returns:
        builder

      • validUserLists

        public SmbFileShareArgs.Builder validUserLists​(java.util.List<java.lang.String> validUserLists)
        Parameters:
        validUserLists - 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`.
        Returns:
        builder

      • validUserLists

        public SmbFileShareArgs.Builder validUserLists​(java.lang.String... validUserLists)
        Parameters:
        validUserLists - 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`.
        Returns:
        builder

      • vpcEndpointDnsName

        public SmbFileShareArgs.Builder vpcEndpointDnsName​(@Nullable
                                                   com.pulumi.core.Output<java.lang.String> vpcEndpointDnsName)
        Parameters:
        vpcEndpointDnsName - The DNS name of the VPC endpoint for S3 private link.
        Returns:
        builder

      • vpcEndpointDnsName

        public SmbFileShareArgs.Builder vpcEndpointDnsName​(java.lang.String vpcEndpointDnsName)
        Parameters:
        vpcEndpointDnsName - The DNS name of the VPC endpoint for S3 private link.
        Returns:
        builder