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

SmbFileShareArgs

data class SmbFileShareArgs(val accessBasedEnumeration: Output<Boolean>? = null, val adminUserLists: Output<List<String>>? = null, val auditDestinationArn: Output<String>? = null, val authentication: Output<String>? = null, val bucketRegion: Output<String>? = null, val cacheAttributes: Output<SmbFileShareCacheAttributesArgs>? = null, val caseSensitivity: Output<String>? = null, val defaultStorageClass: Output<String>? = null, val fileShareName: Output<String>? = null, val gatewayArn: Output<String>? = null, val guessMimeTypeEnabled: Output<Boolean>? = null, val invalidUserLists: Output<List<String>>? = null, val kmsEncrypted: Output<Boolean>? = null, val kmsKeyArn: Output<String>? = null, val locationArn: Output<String>? = null, val notificationPolicy: Output<String>? = null, val objectAcl: Output<String>? = null, val oplocksEnabled: Output<Boolean>? = null, val readOnly: Output<Boolean>? = null, val requesterPays: Output<Boolean>? = null, val roleArn: Output<String>? = null, val smbAclEnabled: Output<Boolean>? = null, val tags: Output<Map<String, String>>? = null, val validUserLists: Output<List<String>>? = null, val vpcEndpointDnsName: Output<String>? = null) : ConvertibleToJava<SmbFileShareArgs>

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_settings in the aws.storagegateway.Gateway resource.

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.storagegateway.SmbFileShare("example", {
    authentication: "ActiveDirectory",
    gatewayArn: exampleAwsStoragegatewayGateway.arn,
    locationArn: exampleAwsS3Bucket.arn,
    roleArn: exampleAwsIamRole.arn,
});

import pulumi
import pulumi_aws as aws
example = aws.storagegateway.SmbFileShare("example",
    authentication="ActiveDirectory",
    gateway_arn=example_aws_storagegateway_gateway["arn"],
    location_arn=example_aws_s3_bucket["arn"],
    role_arn=example_aws_iam_role["arn"])

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
    var example = new Aws.StorageGateway.SmbFileShare("example", new()
    {
        Authentication = "ActiveDirectory",
        GatewayArn = exampleAwsStoragegatewayGateway.Arn,
        LocationArn = exampleAwsS3Bucket.Arn,
        RoleArn = exampleAwsIamRole.Arn,
    });
});

package main
import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/storagegateway"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := storagegateway.NewSmbFileShare(ctx, "example", &storagegateway.SmbFileShareArgs{
			Authentication: pulumi.String("ActiveDirectory"),
			GatewayArn:     pulumi.Any(exampleAwsStoragegatewayGateway.Arn),
			LocationArn:    pulumi.Any(exampleAwsS3Bucket.Arn),
			RoleArn:        pulumi.Any(exampleAwsIamRole.Arn),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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(exampleAwsStoragegatewayGateway.arn())
            .locationArn(exampleAwsS3Bucket.arn())
            .roleArn(exampleAwsIamRole.arn())
            .build());
    }
}

resources:
  example:
    type: aws:storagegateway:SmbFileShare
    properties:
      authentication: ActiveDirectory
      gatewayArn: ${exampleAwsStoragegatewayGateway.arn}
      locationArn: ${exampleAwsS3Bucket.arn}
      roleArn: ${exampleAwsIamRole.arn}

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_password in the aws.storagegateway.Gateway resource.

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.storagegateway.SmbFileShare("example", {
    authentication: "GuestAccess",
    gatewayArn: exampleAwsStoragegatewayGateway.arn,
    locationArn: exampleAwsS3Bucket.arn,
    roleArn: exampleAwsIamRole.arn,
});

import pulumi
import pulumi_aws as aws
example = aws.storagegateway.SmbFileShare("example",
    authentication="GuestAccess",
    gateway_arn=example_aws_storagegateway_gateway["arn"],
    location_arn=example_aws_s3_bucket["arn"],
    role_arn=example_aws_iam_role["arn"])

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
    var example = new Aws.StorageGateway.SmbFileShare("example", new()
    {
        Authentication = "GuestAccess",
        GatewayArn = exampleAwsStoragegatewayGateway.Arn,
        LocationArn = exampleAwsS3Bucket.Arn,
        RoleArn = exampleAwsIamRole.Arn,
    });
});

package main
import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/storagegateway"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := storagegateway.NewSmbFileShare(ctx, "example", &storagegateway.SmbFileShareArgs{
			Authentication: pulumi.String("GuestAccess"),
			GatewayArn:     pulumi.Any(exampleAwsStoragegatewayGateway.Arn),
			LocationArn:    pulumi.Any(exampleAwsS3Bucket.Arn),
			RoleArn:        pulumi.Any(exampleAwsIamRole.Arn),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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(exampleAwsStoragegatewayGateway.arn())
            .locationArn(exampleAwsS3Bucket.arn())
            .roleArn(exampleAwsIamRole.arn())
            .build());
    }
}

resources:
  example:
    type: aws:storagegateway:SmbFileShare
    properties:
      authentication: GuestAccess
      gatewayArn: ${exampleAwsStoragegatewayGateway.arn}
      locationArn: ${exampleAwsS3Bucket.arn}
      roleArn: ${exampleAwsIamRole.arn}

Import

Using pulumi import, import aws_storagegateway_smb_file_share using the SMB File Share Amazon Resource Name (ARN). For example:

$ pulumi import aws:storagegateway/smbFileShare:SmbFileShare example arn:aws:storagegateway:us-east-1:123456789012:share/share-12345678

Constructors

SmbFileShareArgs

fun SmbFileShareArgs(accessBasedEnumeration: Output<Boolean>? = null, adminUserLists: Output<List<String>>? = null, auditDestinationArn: Output<String>? = null, authentication: Output<String>? = null, bucketRegion: Output<String>? = null, cacheAttributes: Output<SmbFileShareCacheAttributesArgs>? = null, caseSensitivity: Output<String>? = null, defaultStorageClass: Output<String>? = null, fileShareName: Output<String>? = null, gatewayArn: Output<String>? = null, guessMimeTypeEnabled: Output<Boolean>? = null, invalidUserLists: Output<List<String>>? = null, kmsEncrypted: Output<Boolean>? = null, kmsKeyArn: Output<String>? = null, locationArn: Output<String>? = null, notificationPolicy: Output<String>? = null, objectAcl: Output<String>? = null, oplocksEnabled: Output<Boolean>? = null, readOnly: Output<Boolean>? = null, requesterPays: Output<Boolean>? = null, roleArn: Output<String>? = null, smbAclEnabled: Output<Boolean>? = null, tags: Output<Map<String, String>>? = null, validUserLists: Output<List<String>>? = null, vpcEndpointDnsName: Output<String>? = null)

Functions

toJava

open override fun toJava(): SmbFileShareArgs

Properties

accessBasedEnumeration

val accessBasedEnumeration: Output<Boolean>? = null

The files and folders on this share will only be visible to users with read access. Default value is false.

adminUserLists

val adminUserLists: Output<List<String>>? = null

A list of users in the Active Directory that have admin access to the file share. Only valid if authentication is set to ActiveDirectory.

auditDestinationArn

val auditDestinationArn: Output<String>? = null

The Amazon Resource Name (ARN) of the CloudWatch Log Group used for the audit logs.

authentication

val authentication: Output<String>? = null

The authentication method that users use to access the file share. Defaults to ActiveDirectory. Valid values: ActiveDirectory, GuestAccess.

bucketRegion

val bucketRegion: Output<String>? = null

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

cacheAttributes

val cacheAttributes: Output<SmbFileShareCacheAttributesArgs>? = null

Refresh cache information. see Cache Attributes for more details.

caseSensitivity

val caseSensitivity: Output<String>? = null

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

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.

fileShareName

val fileShareName: Output<String>? = null

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

gatewayArn

val gatewayArn: Output<String>? = null

Amazon Resource Name (ARN) of the file gateway.

guessMimeTypeEnabled

val guessMimeTypeEnabled: Output<Boolean>? = null

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

invalidUserLists

val invalidUserLists: Output<List<String>>? = null

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

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.

kmsKeyArn

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.

locationArn

val locationArn: Output<String>? = null

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

notificationPolicy

val notificationPolicy: Output<String>? = null

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

objectAcl

val objectAcl: Output<String>? = null

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

oplocksEnabled

val oplocksEnabled: Output<Boolean>? = null

Boolean to indicate Opportunistic lock (oplock) status. Defaults to true.

readOnly

val readOnly: Output<Boolean>? = null

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

requesterPays

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.

roleArn

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.

smbAclEnabled

val smbAclEnabled: Output<Boolean>? = null

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.