create-mount-target¶

Description¶

Creates a mount target resource as an endpoint for mounting the S3 File System from compute resources in a specific Availability Zone and VPC. Mount targets provide network access to the file system.

Synopsis¶

  create-mount-target
--file-system-id <value>
--subnet-id <value>
[--ipv4-address <value>]
[--ipv6-address <value>]
[--ip-address-type <value>]
[--security-groups <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options¶

--file-system-id (string) [required]

The ID or Amazon Resource Name (ARN) of the S3 File System to create the mount target for.

Constraints:

min: 0

max: 128

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

--subnet-id (string) [required]

The ID of the subnet where the mount target will be created. The subnet must be in the same Amazon Web Services Region as the file system. For file systems with regional availability, you can create mount targets in any subnet within the Region. The subnet determines the Availability Zone where the mount target will be located.

Constraints:

min: 15

max: 47

pattern: subnet-[0-9a-f]{8,40}

--ipv4-address (string)

A specific IPv4 address to assign to the mount target. If not specified and the IP address type supports IPv4, an address is automatically assigned from the subnet’s available IPv4 address range. The address must be within the subnet’s CIDR block and not already in use.

Constraints:

min: 7

max: 15

pattern: [0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}

--ipv6-address (string)

A specific IPv6 address to assign to the mount target. If not specified and the IP address type supports IPv6, an address is automatically assigned from the subnet’s available IPv6 address range. The address must be within the subnet’s IPv6 CIDR block and not already in use.

Constraints:

min: 3

max: 39

--ip-address-type (string)

The IP address type for the mount target. If not specified, IPV4_ONLY is used. The IP address type must match the IP configuration of the specified subnet.

Possible values:

IPV4_ONLY

IPV6_ONLY

DUAL_STACK

--security-groups (list)

An array of VPC security group IDs to associate with the mount target’s network interface. These security groups control network access to the mount target. If not specified, the default security group for the subnet’s VPC is used. All security groups must belong to the same VPC as the subnet.

Constraints:

min: 0

max: 100

(string)

Constraints:

min: 11

max: 43

pattern: (sg-[0-9a-f]{8,40})

Syntax:

"string" "string" ...

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table
yaml
yaml-stream
off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

legacy
json
yaml
text
table
enhanced

Output¶

availabilityZoneId -> (string)

The unique and consistent identifier of the Availability Zone where the mount target is located. For example, use1-az1 is an Availability Zone ID for the us-east-1 Amazon Web Services Region, and it has the same location in every Amazon Web Services account.

ownerId -> (string)

The Amazon Web Services account ID of the mount target owner.

Constraints:

min: 0

max: 12

pattern: (\d{12})|(\d{4}-{4}-\d{4})

mountTargetId -> (string)

The ID of the mount target, assigned by S3 Files. This ID is used to reference the mount target in subsequent API calls.

Constraints:

min: 22

max: 45

pattern: fsmt-[0-9a-f]{17,40}

fileSystemId -> (string)

The ID of the S3 File System associated with the mount target.

Constraints:

min: 0

max: 128

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

subnetId -> (string)

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

Constraints:

min: 15

max: 47

pattern: subnet-[0-9a-f]{8,40}

ipv4Address -> (string)

The IPv4 address assigned to the mount target.

Constraints:

min: 7

max: 15

pattern: [0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}

ipv6Address -> (string)

The IPv6 address assigned to the mount target.

Constraints:

min: 3

max: 39

networkInterfaceId -> (string)

The ID of the network interface that S3 Files created when it created the mount target. This network interface is managed by the service.

vpcId -> (string)

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

securityGroups -> (list)

The security groups associated with the mount target’s network interface.

Constraints:

min: 0

max: 100

(string)

Constraints:

min: 11

max: 43

pattern: (sg-[0-9a-f]{8,40})

status -> (string)

The lifecycle state of the mount target. Valid values are: AVAILABLE (the mount target is available for use), CREATING (the mount target is being created), DELETING (the mount target is being deleted), DELETED (the mount target has been deleted), or ERROR (the mount target is in an error state), or UPDATING (the mount target is being updated).

Possible values:

available

creating

deleting

deleted

error

updating

statusMessage -> (string)

Additional information about the mount target status. This field provides more details when the status is ERROR , or during state transitions.

Table of Contents

Feedback

User Guide