Smb
Manages an AWS Storage Gateway SMB File Share.
Example Usage
Active Directory Authentication
NOTE: The gateway must have already joined the Active Directory domain prior to SMB file share creationE.g., via "SMB Settings" in the AWS Storage Gateway console or
smb_active_directory_settingsin theaws.storagegateway.Gatewayresource.
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.storagegateway.SmbFileShare;
import com.pulumi.aws.storagegateway.SmbFileShareArgs;
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 SmbFileShare("example", SmbFileShareArgs.builder()
.authentication("ActiveDirectory")
.gatewayArn(aws_storagegateway_gateway.example().arn())
.locationArn(aws_s3_bucket.example().arn())
.roleArn(aws_iam_role.example().arn())
.build());
}
}Guest Authentication
NOTE: The gateway must have already had the SMB guest password set prior to SMB file share creationE.g., via "SMB Settings" in the AWS Storage Gateway console or
smb_guest_passwordin theaws.storagegateway.Gatewayresource.
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.storagegateway.SmbFileShare;
import com.pulumi.aws.storagegateway.SmbFileShareArgs;
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 SmbFileShare("example", SmbFileShareArgs.builder()
.authentication("GuestAccess")
.gatewayArn(aws_storagegateway_gateway.example().arn())
.locationArn(aws_s3_bucket.example().arn())
.roleArn(aws_iam_role.example().arn())
.build());
}
}Import
aws_storagegateway_smb_file_share can be imported by using the SMB File Share Amazon Resource Name (ARN), e.g.,
$ pulumi import aws:storagegateway/smbFileShare:SmbFileShare example arn:aws:storagegateway:us-east-1:123456789012:share/share-12345678Constructors
Properties
The files and folders on this share will only be visible to users with read access. Default value is false.
A list of users in the Active Directory that have admin access to the file share. Only valid if authentication is set to ActiveDirectory.
The Amazon Resource Name (ARN) of the CloudWatch Log Group used for the audit logs.
The authentication method that users use to access the file share. Defaults to ActiveDirectory. Valid values: ActiveDirectory, GuestAccess.
The region of the S3 buck used by the file share. Required when specifying a vpc_endpoint_dns_name.
Refresh cache information. see Cache Attributes for more details.
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.
The default storage class for objects put into an Amazon S3 bucket by the file gateway. Defaults to S3_STANDARD.
The name of the file share. Must be set if an S3 prefix name is set in location_arn.
Amazon Resource Name (ARN) of the file gateway.
Boolean value that enables guessing of the MIME type for uploaded objects based on file extensions. Defaults to true.
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.
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.
The ARN of the backed storage used for storing file data.
The notification policy of the file share. For more information see the AWS Documentation. Default value is {}.
Boolean to indicate Opportunistic lock (oplock) status. Defaults to true.
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.
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.
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.
The DNS name of the VPC endpoint for S3 private link.