profiles

Creates, updates, deletes or gets a profile resource or lists profiles in a region

Overview

Name	profiles
Type	Resource
Description	Definition of AWS::B2BI::Profile Resource Type
Id	aws.b2bi.profiles

Fields

Name	Datatype	Description
business_name	string
created_at	string
email	string
log_group_name	string
logging	string
modified_at	string
name	string
phone	string
profile_arn	string
profile_id	string
tags	array
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	BusinessName, Logging, Name, Phone, 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 profiles in a region.

SELECT
region,
business_name,
created_at,
email,
log_group_name,
logging,
modified_at,
name,
phone,
profile_arn,
profile_id,
tags
FROM aws.b2bi.profiles
WHERE region = 'us-east-1';

Gets all properties from an individual profile.

SELECT
region,
business_name,
created_at,
email,
log_group_name,
logging,
modified_at,
name,
phone,
profile_arn,
profile_id,
tags
FROM aws.b2bi.profiles
WHERE region = 'us-east-1' AND data__Identifier = '<ProfileId>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.b2bi.profiles (
 BusinessName,
 Logging,
 Name,
 Phone,
 region
)
SELECT 
'{{ BusinessName }}',
 '{{ Logging }}',
 '{{ Name }}',
 '{{ Phone }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.b2bi.profiles (
 BusinessName,
 Email,
 Logging,
 Name,
 Phone,
 Tags,
 region
)
SELECT 
 '{{ BusinessName }}',
 '{{ Email }}',
 '{{ Logging }}',
 '{{ Name }}',
 '{{ Phone }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: profile
    props:
      - name: BusinessName
        value: '{{ BusinessName }}'
      - name: Email
        value: '{{ Email }}'
      - name: Logging
        value: '{{ Logging }}'
      - name: Name
        value: '{{ Name }}'
      - name: Phone
        value: '{{ Phone }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

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

Permissions

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

Create

b2bi:CreateProfile,
b2bi:TagResource,
logs:CreateLogDelivery,
logs:CreateLogGroup,
logs:CreateLogStream,
logs:DescribeLogGroups,
logs:DescribeLogStreams,
logs:DescribeResourcePolicies,
logs:ListLogDeliveries,
logs:PutLogEvents,
logs:PutResourcePolicy

Read

b2bi:GetProfile,
b2bi:ListTagsForResource

Update

b2bi:TagResource,
b2bi:UntagResource,
b2bi:UpdateProfile

Delete

b2bi:DeleteProfile,
logs:DeleteLogDelivery,
logs:ListLogDeliveries

List

b2bi:ListProfiles