access_points

Creates, updates, deletes or gets an access_point resource or lists access_points in a region

Overview

Name	access_points
Type	Resource
Description	The AWS::S3ObjectLambda::AccessPoint resource is an Amazon S3ObjectLambda resource type that you can use to add computation to S3 actions
Id	awscc.s3objectlambda.access_points

Fields

get (all properties)

Name	Datatype	Description
name	string	The name you want to assign to this Object lambda Access Point.
▶alias	object
arn	string
creation_date	string	The date and time when the Object lambda Access Point was created.
▶public_access_block_configuration	object	The PublicAccessBlock configuration that you want to apply to this Access Point. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status 'The Meaning of Public' in the Amazon Simple Storage Service Developer Guide.
▶policy_status	object
▶object_lambda_configuration	object	The Object lambda Access Point Configuration that configures transformations to be applied on the objects on specified S3 Actions
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
name	string	The name you want to assign to this Object lambda Access Point.
region	string	AWS region.

For more information, see AWS::S3ObjectLambda::AccessPoint.

Methods

Name	Resource	Accessible by	Required Params
create_resource	access_points	INSERT	ObjectLambdaConfiguration, region
delete_resource	access_points	DELETE	Identifier, region
update_resource	access_points	UPDATE	Identifier, PatchDocument, region
list_resources	access_points_list_only	SELECT	region
get_resource	access_points	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual access_point.

SELECT
  region,
  name,
  alias,
  arn,
  creation_date,
  public_access_block_configuration,
  policy_status,
  object_lambda_configuration
FROM awscc.s3objectlambda.access_points
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ name }}';

list (identifiers only)

Lists all access_points in a region.

SELECT
  region,
  name
FROM awscc.s3objectlambda.access_points_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.s3objectlambda.access_points (
  ObjectLambdaConfiguration,
  region
)
SELECT
  '{{ object_lambda_configuration }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.s3objectlambda.access_points (
  Name,
  ObjectLambdaConfiguration,
  region
)
SELECT
  '{{ name }}',
  '{{ object_lambda_configuration }}',
  '{{ 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: access_point
  props:
    - name: name
      value: '{{ name }}'
    - name: object_lambda_configuration
      value:
        supporting_access_point: '{{ supporting_access_point }}'
        allowed_features:
          - '{{ allowed_features[0] }}'
        cloud_watch_metrics_enabled: '{{ cloud_watch_metrics_enabled }}'
        transformation_configurations:
          - actions:
              - '{{ actions[0] }}'
            content_transformation: {}

UPDATE example

Use the following StackQL query and manifest file to update a access_point resource, using stack-deploy.

/*+ update */
UPDATE awscc.s3objectlambda.access_points
SET PatchDocument = string('{{ {
    "ObjectLambdaConfiguration": object_lambda_configuration
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ name }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.s3objectlambda.access_points
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 access_points resource, the following permissions are required:

Create

s3:CreateAccessPointForObjectLambda,
s3:PutAccessPointConfigurationForObjectLambda,
s3:GetAccessPointForObjectLambda,
s3:GetAccessPointPolicyStatusForObjectLambda,
s3:GetAccessPointConfigurationForObjectLambda

Read

s3:GetAccessPointForObjectLambda,
s3:GetAccessPointPolicyStatusForObjectLambda,
s3:GetAccessPointConfigurationForObjectLambda

Update

s3:PutAccessPointConfigurationForObjectLambda,
s3:GetAccessPointForObjectLambda,
s3:GetAccessPointPolicyStatusForObjectLambda,
s3:GetAccessPointConfigurationForObjectLambda

Delete

s3:DeleteAccessPointForObjectLambda

List

s3:ListAccessPointsForObjectLambda