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	awscc.bcmdataexports.exports

Fields

get (all properties)

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

list (identifiers only)

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

For more information, see AWS::BCMDataExports::Export.

Methods

Name	Resource	Accessible by	Required Params
create_resource	exports	INSERT	Export, region
delete_resource	exports	DELETE	Identifier, region
update_resource	exports	UPDATE	Identifier, PatchDocument, region
list_resources	exports_list_only	SELECT	region
get_resource	exports	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual export.

SELECT
  region,
  export,
  export_arn,
  tags
FROM awscc.bcmdataexports.exports
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ export_arn }}';

list (identifiers only)

Lists all exports in a region.

SELECT
  region,
  export_arn
FROM awscc.bcmdataexports.exports_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

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

All Properties

/*+ create */
INSERT INTO awscc.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

UPDATE example

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

/*+ update */
UPDATE awscc.bcmdataexports.exports
SET PatchDocument = string('{{ {
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ export_arn }}';

DELETE example

/*+ delete */
DELETE FROM awscc.bcmdataexports.exports
WHERE
  Identifier = '{{ export_arn }}' 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