S3Files / Client / create_mount_target

create_mount_target

S3Files.Client.create_mount_target(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.create_mount_target(
    fileSystemId='string',
    subnetId='string',
    ipv4Address='string',
    ipv6Address='string',
    ipAddressType='IPV4_ONLY'|'IPV6_ONLY'|'DUAL_STACK',
    securityGroups=[
        'string',
    ]
)
Parameters:

  • fileSystemId (string) –

    [REQUIRED]

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

  • subnetId (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.

  • ipv4Address (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.

  • ipv6Address (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.

  • ipAddressType (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.

  • securityGroups (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.

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'availabilityZoneId': 'string',
    'ownerId': 'string',
    'mountTargetId': 'string',
    'fileSystemId': 'string',
    'subnetId': 'string',
    'ipv4Address': 'string',
    'ipv6Address': 'string',
    'networkInterfaceId': 'string',
    'vpcId': 'string',
    'securityGroups': [
        'string',
    ],
    'status': 'available'|'creating'|'deleting'|'deleted'|'error'|'updating',
    'statusMessage': 'string'
}

Response Structure

  • (dict) –

    • 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.

    • 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.

    • fileSystemId (string) –

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

    • subnetId (string) –

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

    • ipv4Address (string) –

      The IPv4 address assigned to the mount target.

    • ipv6Address (string) –

      The IPv6 address assigned to the mount target.

    • 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.

      • (string) –

    • 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).

    • statusMessage (string) –

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

Exceptions