capabilities

Creates, updates, deletes or gets a capability resource or lists capabilities in a region

Overview

Name	capabilities
Type	Resource
Description	Definition of AWS::B2BI::Capability Resource Type
Id	aws.b2bi.capabilities

Fields

Name	Datatype	Description
capability_arn	string
capability_id	string
configuration	undefined
created_at	string
instructions_documents	array
modified_at	string
name	string
tags	array
type	string
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Configuration, Name, Type, 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 capabilities in a region.

SELECT
region,
capability_arn,
capability_id,
configuration,
created_at,
instructions_documents,
modified_at,
name,
tags,
type
FROM aws.b2bi.capabilities
WHERE region = 'us-east-1';

Gets all properties from an individual capability.

SELECT
region,
capability_arn,
capability_id,
configuration,
created_at,
instructions_documents,
modified_at,
name,
tags,
type
FROM aws.b2bi.capabilities
WHERE region = 'us-east-1' AND data__Identifier = '<CapabilityId>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.b2bi.capabilities (
 Configuration,
 Name,
 Type,
 region
)
SELECT 
'{{ Configuration }}',
 '{{ Name }}',
 '{{ Type }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.b2bi.capabilities (
 Configuration,
 InstructionsDocuments,
 Name,
 Tags,
 Type,
 region
)
SELECT 
 '{{ Configuration }}',
 '{{ InstructionsDocuments }}',
 '{{ Name }}',
 '{{ Tags }}',
 '{{ Type }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: capability
    props:
      - name: Configuration
        value: null
      - name: InstructionsDocuments
        value:
          - BucketName: '{{ BucketName }}'
            Key: '{{ Key }}'
      - name: Name
        value: '{{ Name }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'
      - name: Type
        value: '{{ Type }}'

DELETE example

/*+ delete */
DELETE FROM aws.b2bi.capabilities
WHERE data__Identifier = '<CapabilityId>'
AND region = 'us-east-1';

Permissions

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

Create

b2bi:CreateCapability,
b2bi:TagResource,
events:ListRules,
events:PutRule,
events:PutTargets,
logs:CreateLogDelivery,
logs:CreateLogGroup,
logs:CreateLogStream,
logs:DescribeLogGroups,
logs:DescribeLogStreams,
logs:DescribeResourcePolicies,
logs:ListLogDeliveries,
logs:PutLogEvents,
logs:PutResourcePolicy,
s3:GetObject,
s3:ListBucket

Read

b2bi:GetCapability,
b2bi:ListTagsForResource

Update

b2bi:TagResource,
b2bi:UntagResource,
b2bi:UpdateCapability

Delete

b2bi:DeleteCapability

List

b2bi:ListCapabilities