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	awscc.b2bi.capabilities

Fields

get (all properties)

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

list (identifiers only)

Name	Datatype	Description
capability_id	string
region	string	AWS region.

For more information, see AWS::B2BI::Capability.

Methods

Name	Resource	Accessible by	Required Params
create_resource	capabilities	INSERT	Configuration, Name, Type, region
delete_resource	capabilities	DELETE	Identifier, region
update_resource	capabilities	UPDATE	Identifier, PatchDocument, region
list_resources	capabilities_list_only	SELECT	region
get_resource	capabilities	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual capability.

SELECT
  region,
  capability_arn,
  capability_id,
  configuration,
  created_at,
  instructions_documents,
  modified_at,
  name,
  tags,
  type
FROM awscc.b2bi.capabilities
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ capability_id }}';

list (identifiers only)

Lists all capabilities in a region.

SELECT
  region,
  capability_id
FROM awscc.b2bi.capabilities_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.b2bi.capabilities (
  Configuration,
  Name,
  Type,
  region
)
SELECT
  '{{ configuration }}',
  '{{ name }}',
  '{{ type }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.b2bi.capabilities (
  Configuration,
  InstructionsDocuments,
  Name,
  Tags,
  Type,
  region
)
SELECT
  '{{ configuration }}',
  '{{ instructions_documents }}',
  '{{ name }}',
  '{{ tags }}',
  '{{ type }}',
  '{{ 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: capability
  props:
    - name: configuration
      value: null
    - name: instructions_documents
      value:
        - bucket_name: '{{ bucket_name }}'
          key: '{{ key }}'
    - name: name
      value: '{{ name }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'
    - name: type
      value: '{{ type }}'

UPDATE example

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

/*+ update */
UPDATE awscc.b2bi.capabilities
SET PatchDocument = string('{{ {
    "Configuration": configuration,
    "InstructionsDocuments": instructions_documents,
    "Name": name,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ capability_id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.b2bi.capabilities
WHERE
  Identifier = '{{ capability_id }}' 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 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