location_s3s

Creates, updates, deletes or gets a location_s3 resource or lists location_s3s in a region

Overview

Name	location_s3s
Type	Resource
Description	Resource schema for AWS::DataSync::LocationS3
Id	awscc.datasync.location_s3s

Fields

get (all properties)

Name	Datatype	Description
▶s3_config	object	The Amazon Resource Name (ARN) of the AWS IAM role that is used to access an Amazon S3 bucket.
s3_bucket_arn	string	The Amazon Resource Name (ARN) of the Amazon S3 bucket.
subdirectory	string	A subdirectory in the Amazon S3 bucket. This subdirectory in Amazon S3 is used to read data from the S3 source location or write data to the S3 destination.
s3_storage_class	string	The Amazon S3 storage class you want to store your files in when this location is used as a task destination.
▶tags	array	An array of key-value pairs to apply to this resource.
location_arn	string	The Amazon Resource Name (ARN) of the Amazon S3 bucket location.
location_uri	string	The URL of the S3 location that was described.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
location_arn	string	The Amazon Resource Name (ARN) of the Amazon S3 bucket location.
region	string	AWS region.

For more information, see AWS::DataSync::LocationS3.

Methods

Name	Resource	Accessible by	Required Params
create_resource	location_s3s	INSERT	S3Config, region
delete_resource	location_s3s	DELETE	Identifier, region
update_resource	location_s3s	UPDATE	Identifier, PatchDocument, region
list_resources	location_s3s_list_only	SELECT	region
get_resource	location_s3s	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual location_s3.

SELECT
  region,
  s3_config,
  s3_bucket_arn,
  subdirectory,
  s3_storage_class,
  tags,
  location_arn,
  location_uri
FROM awscc.datasync.location_s3s
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ location_arn }}';

list (identifiers only)

Lists all location_s3s in a region.

SELECT
  region,
  location_arn
FROM awscc.datasync.location_s3s_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.datasync.location_s3s (
  S3Config,
  region
)
SELECT
  '{{ s3_config }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.datasync.location_s3s (
  S3Config,
  S3BucketArn,
  Subdirectory,
  S3StorageClass,
  Tags,
  region
)
SELECT
  '{{ s3_config }}',
  '{{ s3_bucket_arn }}',
  '{{ subdirectory }}',
  '{{ s3_storage_class }}',
  '{{ tags }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: location_s3
    props:
      - name: s3_config
        value:
          bucket_access_role_arn: '{{ bucket_access_role_arn }}'
      - name: s3_bucket_arn
        value: '{{ s3_bucket_arn }}'
      - name: subdirectory
        value: '{{ subdirectory }}'
      - name: s3_storage_class
        value: '{{ s3_storage_class }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.datasync.location_s3s
SET PatchDocument = string('{{ {
    "S3Config": s3_config,
    "Subdirectory": subdirectory,
    "S3StorageClass": s3_storage_class,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ location_arn }}';

DELETE example

/*+ delete */
DELETE FROM awscc.datasync.location_s3s
WHERE
  Identifier = '{{ location_arn }}' AND
  region = 'us-east-1';

Permissions

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

Create

datasync:CreateLocationS3,
datasync:DescribeLocationS3,
datasync:ListTagsForResource,
datasync:TagResource,
s3:ListAllMyBuckets,
s3:ListBucket,
iam:GetRole,
iam:PassRole

Read

datasync:DescribeLocationS3,
datasync:ListTagsForResource

Update

datasync:DescribeLocationS3,
datasync:ListTagsForResource,
datasync:TagResource,
datasync:UntagResource,
datasync:UpdateLocationS3,
iam:PassRole

Delete

datasync:DeleteLocation

List

datasync:ListLocations