AWS::StorageGateway::SMBFileShare

StorageGateway SMBFileShare

Resource Type definition for AWS::StorageGateway::SMBFileShare. An SMB file share exposes an Amazon S3 bucket through a Storage Gateway file gateway, so clients read and write objects as files over SMB. The share's variant is fixed by its resource type rather than by a property: the service constructs the two variants with different APIs, and a property carrying the choice would belong to neither API's input.

Properties

26 configurable properties. 3 required. Click a row to see details.

Filter:
PropertyTypeFlags
GatewayARN
string
RequiredCreate-only
LocationARN
string
RequiredCreate-only
Role
string
RequiredCreate-only
AccessBasedEnumeration
boolean
AdminUserList
Array<string>
AuditDestinationARN
string
Authentication
string
Create-only
BucketRegion
string
Create-only
CacheAttributes
CacheAttributes
CaseSensitivity
string
DefaultStorageClass
string
EncryptionType
string
FileShareName
string
GuessMIMETypeEnabled
boolean
InvalidUserList
Array<string>
KMSEncrypted
boolean
KMSKey
string
NotificationPolicy
string
ObjectACL
string
OplocksEnabled
boolean
ReadOnly
boolean
RequesterPays
boolean
SMBACLEnabled
boolean
Tags
Array<Tag>
ValidUserList
Array<string>
VPCEndpointDNSName
string
Create-only

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

AttributeTypeDescription
FileShareARNstringThe ARN of the file share.
FileShareIdstringThe ID of the file share.
FileShareStatusstringThe status of the file share. The service reports CREATING, UPDATING, AVAILABLE, DELETING and FORCE_DELETING; it is a length-bounded string in the API model rather than an enumeration.
PathstringThe export path the share is mounted or mapped at.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::StorageGateway::SMBFileShare

Resources:
  MyResource:
    Type: AWS::StorageGateway::SMBFileShare
    Properties:
      GatewayARN: "arn:aws:service:region:account:resource"
      Role: "value"
      LocationARN: "arn:aws:service:region:account:resource"
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

iam:PassRolelogs:CreateLogDeliverylogs:DeleteLogDeliverylogs:GetLogDeliverylogs:ListLogDeliverieslogs:UpdateLogDeliverystoragegateway:AddTagsToResourcestoragegateway:CreateSMBFileSharestoragegateway:DescribeSMBFileShares

read

storagegateway:DescribeSMBFileSharesstoragegateway:ListTagsForResource

update

logs:CreateLogDeliverylogs:DeleteLogDeliverylogs:GetLogDeliverylogs:ListLogDeliverieslogs:UpdateLogDeliverystoragegateway:AddTagsToResourcestoragegateway:DescribeSMBFileSharesstoragegateway:ListTagsForResourcestoragegateway:RemoveTagsFromResourcestoragegateway:UpdateSMBFileShare

delete

logs:CreateLogDeliverylogs:DeleteLogDeliverylogs:GetLogDeliverylogs:ListLogDeliverieslogs:UpdateLogDeliverystoragegateway:DeleteFileSharestoragegateway:DescribeSMBFileSharesstoragegateway:ListTagsForResource

list

storagegateway:ListFileShares

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceStorageGateway
Properties30
Required3
TaggingSupported
Primary IDFileShareARN

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

GatewayARNRoleLocationARNBucketRegionVPCEndpointDNSNameAuthentication

Related Resources

External Links