AWS::S3Files::MountTarget - AWS CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::S3Files::MountTarget

The AWS::S3Files::MountTarget resource specifies a mount target for an Amazon S3 Files file system. Mount targets provide network access to the file system from compute resources in a specific Availability Zone and VPC.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::S3Files::MountTarget",
  "Properties" : {
      "FileSystemId" : String,
      "IpAddressType" : String,
      "Ipv4Address" : String,
      "Ipv6Address" : String,
      "SecurityGroups" : [ String, ... ],
      "SubnetId" : String
    }
}

YAML

Type: AWS::S3Files::MountTarget
Properties:
  FileSystemId: String
  IpAddressType: String
  Ipv4Address: String
  Ipv6Address: String
  SecurityGroups: 
    - String
  SubnetId: String

Properties

FileSystemId

The ID of the S3 Files file system for which to create the mount target.

Required: Yes

Type: String

Pattern: ^(arn:aws[-a-z]*:s3files:[0-9a-z-:]+:file-system/fs-[0-9a-f]{17,40}|fs-[0-9a-f]{17,40})$

Maximum: 128

Update requires: Replacement

IpAddressType

The type of IP address used by the mount target. Valid values are IPV4_ONLY, IPV6_ONLY, and DUAL_STACK.

Required: No

Type: String

Allowed values: IPV4_ONLY | IPV6_ONLY | DUAL_STACK

Update requires: Replacement

Ipv4Address

The IPv4 address of the mount target.

Required: No

Type: String

Pattern: ^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}$

Minimum: 7

Maximum: 15

Update requires: Replacement

Ipv6Address

The IPv6 address of the mount target.

Required: No

Type: String

Minimum: 3

Maximum: 39

Update requires: Replacement

SecurityGroups

Up to 100 VPC security group IDs that control network access to the mount target.

Required: No

Type: Array of String

Minimum: 11

Maximum: 43 | 100

Update requires: No interruption

SubnetId

The ID of the subnet where the mount target is located.

Required: Yes

Type: String

Pattern: ^subnet-[0-9a-f]{8,40}$

Minimum: 15

Maximum: 47

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the mount target ID.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

AvailabilityZoneId

The ID of the Availability Zone in which the mount target is located.

MountTargetId

The ID of the mount target.

NetworkInterfaceId

The ID of the network interface that Amazon S3 Files created when it created the mount target.

OwnerId

The AWS account ID of the mount target owner.

Status

The current status of the mount target.

StatusMessage

Additional information about the mount target status.

VpcId

The ID of the VPC in which the mount target is located.