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	awscc.glue.usage_profiles

Fields

get (all properties)

Name	Datatype	Description
name	string	The name of the UsageProfile.
description	string	The description of the UsageProfile.
▶configuration	object	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.

list (identifiers only)

Name	Datatype	Description
name	string	The name of the UsageProfile.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	usage_profiles	INSERT	Name, region
delete_resource	usage_profiles	DELETE	Identifier, region
update_resource	usage_profiles	UPDATE	Identifier, PatchDocument, region
list_resources	usage_profiles_list_only	SELECT	region
get_resource	usage_profiles	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual usage_profile.

SELECT
  region,
  name,
  description,
  configuration,
  tags,
  created_on
FROM awscc.glue.usage_profiles
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ name }}';

list (identifiers only)

Lists all usage_profiles in a region.

SELECT
  region,
  name
FROM awscc.glue.usage_profiles_list_only
WHERE
  region = 'us-east-1';

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 awscc.glue.usage_profiles (
  Name,
  region
)
SELECT
  '{{ name }}',
  '{{ region }}';

All Properties

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

UPDATE example

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

/*+ update */
UPDATE awscc.glue.usage_profiles
SET PatchDocument = string('{{ {
    "Description": description,
    "Configuration": configuration,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ name }}';

DELETE example

/*+ delete */
DELETE FROM awscc.glue.usage_profiles
WHERE
  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