s3access_point_attachments

Creates, updates, deletes or gets a s3access_point_attachment resource or lists s3access_point_attachments in a region

Overview

Name	s3access_point_attachments
Type	Resource
Description	Resource type definition for AWS::FSx::S3AccessPointAttachment
Id	awscc.fsx.s3access_point_attachments

Fields

get (all properties)

Name	Datatype	Description
name	string	The Name of the S3AccessPointAttachment
type	string
▶open_zf_sconfiguration	object
▶s3_access_point	object
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
name	string	The Name of the S3AccessPointAttachment
region	string	AWS region.

For more information, see AWS::FSx::S3AccessPointAttachment.

Methods

Name	Resource	Accessible by	Required Params
create_resource	s3access_point_attachments	INSERT	Name, Type, OpenZFSConfiguration, region
delete_resource	s3access_point_attachments	DELETE	Identifier, region
list_resources	s3access_point_attachments_list_only	SELECT	region
get_resource	s3access_point_attachments	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual s3access_point_attachment.

SELECT
  region,
  name,
  type,
  open_zf_sconfiguration,
  s3_access_point
FROM awscc.fsx.s3access_point_attachments
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ name }}';

list (identifiers only)

Lists all s3access_point_attachments in a region.

SELECT
  region,
  name
FROM awscc.fsx.s3access_point_attachments_list_only
WHERE
  region = '{{ region }}';

INSERT example

Use the following StackQL query and manifest file to create a new s3access_point_attachment resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.fsx.s3access_point_attachments (
  Name,
  Type,
  OpenZFSConfiguration,
  region
)
SELECT
  '{{ name }}',
  '{{ type }}',
  '{{ open_zf_sconfiguration }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.fsx.s3access_point_attachments (
  Name,
  Type,
  OpenZFSConfiguration,
  S3AccessPoint,
  region
)
SELECT
  '{{ name }}',
  '{{ type }}',
  '{{ open_zf_sconfiguration }}',
  '{{ s3_access_point }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: s3access_point_attachment
  props:
    - name: name
      value: '{{ name }}'
    - name: type
      value: '{{ type }}'
    - name: open_zf_sconfiguration
      value:
        volume_id: '{{ volume_id }}'
        file_system_identity:
          type: '{{ type }}'
          posix_user:
            uid: null
            gid: null
            secondary_gids:
              - gid: null
    - name: s3_access_point
      value:
        resource_arn: '{{ resource_arn }}'
        alias: '{{ alias }}'
        vpc_configuration:
          vpc_id: '{{ vpc_id }}'
        policy: {}

DELETE example

/*+ delete */
DELETE FROM awscc.fsx.s3access_point_attachments
WHERE
  Identifier = '{{ name }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

To operate on the s3access_point_attachments resource, the following permissions are required:

Create

fsx:CreateAndAttachS3AccessPoint,
fsx:DescribeS3AccessPointAttachments,
s3:CreateAccessPoint,
s3:GetAccessPoint,
s3:PutAccessPointPolicy

Read

fsx:DescribeS3AccessPointAttachments,
s3:GetAccessPoint

Delete

fsx:DescribeS3AccessPointAttachments,
fsx:DetachAndDeleteS3AccessPoint,
s3:DeleteAccessPoint,
s3:GetAccessPoint

List

fsx:DescribeS3AccessPointAttachments,
s3:GetAccessPoint