and_attach_s3_access_points

Creates, updates, deletes, gets or lists an and_attach_s3_access_points resource.

Overview

Name	and_attach_s3_access_points
Type	Resource
Id	aws.fsx.and_attach_s3_access_points

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
create_and_attach_s3_access_point	insert	region, Name, Type		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 CreateAndAttachS3AccessPoint: DescribeS3AccessPointAttachments DetachAndDeleteS3AccessPoint

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

INSERT examples

create_and_attach_s3_access_point

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 CreateAndAttachS3AccessPoint: DescribeS3AccessPointAttachments DetachAndDeleteS3AccessPoint

INSERT INTO aws.fsx.and_attach_s3_access_points (
ClientRequestToken,
Name,
Type,
OpenZFSConfiguration,
OntapConfiguration,
S3AccessPoint,
region
)
SELECT 
'{{ ClientRequestToken }}',
'{{ Name }}' /* required */,
'{{ Type }}' /* required */,
'{{ OpenZFSConfiguration }}',
'{{ OntapConfiguration }}',
'{{ S3AccessPoint }}',
'{{ region }}'
RETURNING
s3_access_point_attachment
;

Manifest

# Description fields are for documentation purposes
- name: and_attach_s3_access_points
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the and_attach_s3_access_points resource.
  - name: ClientRequestToken
    value: "{{ ClientRequestToken }}"
    description: |
      (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: Name
    value: "{{ Name }}"
    description: |
      The name you want to assign to this S3 access point.
  - name: Type
    value: "{{ Type }}"
    description: |
      The type of S3 access point you want to create. Only OpenZFS is supported.
    valid_values: ['OPENZFS', 'ONTAP']
  - name: OpenZFSConfiguration
    description: |
      Specifies the configuration to use when creating and attaching an S3 access point to an FSx for OpenZFS volume.
    value:
      VolumeId: "{{ VolumeId }}"
      FileSystemIdentity:
        Type: "{{ Type }}"
        PosixUser:
          Uid: {{ Uid }}
          Gid: {{ Gid }}
          SecondaryGids:
            - {{ SecondaryGids }}
  - name: OntapConfiguration
    description: |
      Specifies the FSx for ONTAP volume that the S3 access point will be attached to, and the file system user identity.
    value:
      VolumeId: "{{ VolumeId }}"
      FileSystemIdentity:
        Type: "{{ Type }}"
        UnixUser:
          Name: "{{ Name }}"
        WindowsUser:
          Name: "{{ Name }}"
  - name: S3AccessPoint
    description: |
      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:
      VpcConfiguration:
        VpcId: "{{ VpcId }}"
      Policy: "{{ Policy }}"