Skip to content

Create And Attach S3 Access Point

fsx_create_and_attach_s3_access_point R Documentation

Creates an S3 access point and attaches it to an Amazon FSx volume

Description

Creates an S3 access point and attaches it to an Amazon FSx volume. For FSx for OpenZFS file systems, the volume must be hosted on a high-availability file system, either Single-AZ or Multi-AZ. For more information, see Accessing your data using Amazon S3 access points. in the Amazon FSx for OpenZFS User Guide.

The requester requires the following permissions to perform these actions:

  • fsx:CreateAndAttachS3AccessPoint

  • s3:CreateAccessPoint

  • s3:GetAccessPoint

  • s3:PutAccessPointPolicy

  • s3:DeleteAccessPoint

The following actions are related to create_and_attach_s3_access_point:

  • describe_s3_access_point_attachments

  • detach_and_delete_s3_access_point

Usage

fsx_create_and_attach_s3_access_point(ClientRequestToken, Name, Type,
  OpenZFSConfiguration, OntapConfiguration, S3AccessPoint)

Arguments

ClientRequestToken

(Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.
Name

[required] The name you want to assign to this S3 access point.
Type

[required] The type of S3 access point you want to create. Only OpenZFS is supported.
OpenZFSConfiguration

Specifies the configuration to use when creating and attaching an S3 access point to an FSx for OpenZFS volume.
OntapConfiguration

Specifies the FSx for ONTAP volume that the S3 access point will be attached to, and the file system user identity.
S3AccessPoint

Specifies the virtual private cloud (VPC) configuration if you're creating an access point that is restricted to a VPC. For more information, see Creating access points restricted to a virtual private cloud.

Value

A list with the following syntax:

list(
  S3AccessPointAttachment = list(
    Lifecycle = "AVAILABLE"|"CREATING"|"DELETING"|"UPDATING"|"FAILED"|"MISCONFIGURED",
    LifecycleTransitionReason = list(
      Message = "string"
    ),
    CreationTime = as.POSIXct(
      "2015-01-01"
    ),
    Name = "string",
    Type = "OPENZFS"|"ONTAP",
    OpenZFSConfiguration = list(
      VolumeId = "string",
      FileSystemIdentity = list(
        Type = "POSIX",
        PosixUser = list(
          Uid = 123,
          Gid = 123,
          SecondaryGids = list(
            123
          )
        )
      )
    ),
    OntapConfiguration = list(
      VolumeId = "string",
      FileSystemIdentity = list(
        Type = "UNIX"|"WINDOWS",
        UnixUser = list(
          Name = "string"
        ),
        WindowsUser = list(
          Name = "string"
        )
      )
    ),
    S3AccessPoint = list(
      ResourceARN = "string",
      Alias = "string",
      VpcConfiguration = list(
        VpcId = "string"
      )
    )
  )
)

Request syntax

svc$create_and_attach_s3_access_point(
  ClientRequestToken = "string",
  Name = "string",
  Type = "OPENZFS"|"ONTAP",
  OpenZFSConfiguration = list(
    VolumeId = "string",
    FileSystemIdentity = list(
      Type = "POSIX",
      PosixUser = list(
        Uid = 123,
        Gid = 123,
        SecondaryGids = list(
          123
        )
      )
    )
  ),
  OntapConfiguration = list(
    VolumeId = "string",
    FileSystemIdentity = list(
      Type = "UNIX"|"WINDOWS",
      UnixUser = list(
        Name = "string"
      ),
      WindowsUser = list(
        Name = "string"
      )
    )
  ),
  S3AccessPoint = list(
    VpcConfiguration = list(
      VpcId = "string"
    ),
    Policy = "string"
  )
)