exports

Creates, updates, deletes or gets an export resource or lists exports in a region

Overview

Name	exports
Type	Resource
Description	Definition of AWS::BCMDataExports::Export Resource Type
Id	aws.bcmdataexports.exports

Fields

Name	Datatype	Description
export	object	Definition of AWS::BCMDataExports::Export Resource Type
export_arn	string
tags	array
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Export, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all exports in a region.

SELECT
region,
export,
export_arn,
tags
FROM aws.bcmdataexports.exports
WHERE region = 'us-east-1';

Gets all properties from an individual export.

SELECT
region,
export,
export_arn,
tags
FROM aws.bcmdataexports.exports
WHERE region = 'us-east-1' AND data__Identifier = '<ExportArn>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.bcmdataexports.exports (
 Export,
 region
)
SELECT 
'{{ Export }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.bcmdataexports.exports (
 Export,
 Tags,
 region
)
SELECT 
 '{{ Export }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: export
    props:
      - name: Export
        value:
          Export: null
          Tags:
            - Key: '{{ Key }}'
              Value: '{{ Value }}'
      - name: Tags
        value:
          - null

DELETE example

/*+ delete */
DELETE FROM aws.bcmdataexports.exports
WHERE data__Identifier = '<ExportArn>'
AND region = 'us-east-1';

Permissions

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

Create

bcm-data-exports:CreateExport,
bcm-data-exports:GetExport,
bcm-data-exports:ListTagsForResource,
bcm-data-exports:TagResource,
cur:PutReportDefinition

Read

bcm-data-exports:GetExport,
bcm-data-exports:ListTagsForResource

Update

bcm-data-exports:UpdateExport,
bcm-data-exports:TagResource,
bcm-data-exports:UntagResource,
bcm-data-exports:GetExport,
bcm-data-exports:ListTagsForResource

Delete

bcm-data-exports:DeleteExport

List

bcm-data-exports:ListExports