usage_profiles

Creates, updates, deletes or gets an usage_profile resource or lists usage_profiles in a region

Overview

Name	usage_profiles
Type	Resource
Description	This creates a Resource of UsageProfile type.
Id	aws.glue.usage_profiles

Fields

Name	Datatype	Description
name	string	The name of the UsageProfile.
description	string	The description of the UsageProfile.
configuration	undefined	UsageProfile configuration for supported service ex: (Jobs, Sessions).
tags	array	The tags to be applied to this UsageProfiles.
created_on	string	Creation time.
region	string	AWS region.

For more information, see AWS::Glue::UsageProfile.

Methods

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

SELECT
region,
name,
description,
configuration,
tags,
created_on
FROM aws.glue.usage_profiles
WHERE region = 'us-east-1';

Gets all properties from an individual usage_profile.

SELECT
region,
name,
description,
configuration,
tags,
created_on
FROM aws.glue.usage_profiles
WHERE region = 'us-east-1' AND data__Identifier = '<Name>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.glue.usage_profiles (
 Name,
 region
)
SELECT 
'{{ Name }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.glue.usage_profiles (
 Name,
 Description,
 Configuration,
 Tags,
 region
)
SELECT 
 '{{ Name }}',
 '{{ Description }}',
 '{{ Configuration }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

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

DELETE example

/*+ delete */
DELETE FROM aws.glue.usage_profiles
WHERE data__Identifier = '<Name>'
AND region = 'us-east-1';

Permissions

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

Create

glue:CreateUsageProfile,
glue:GetUsageProfile,
glue:GetTags,
glue:TagResource

Read

glue:GetUsageProfile,
glue:GetTags

Update

glue:UpdateUsageProfile,
glue:GetUsageProfile,
glue:TagResource,
glue:UntagResource,
glue:GetTags

Delete

glue:DeleteUsageProfile,
glue:GetUsageProfile

List

glue:ListUsageProfiles