permissions

Creates, updates, deletes or gets a permission resource or lists permissions in a region

Overview

Name	permissions
Type	Resource
Description	Resource type definition for AWS::RAM::Permission
Id	awscc.ram.permissions

Fields

get (all properties)

Name	Datatype	Description
arn	string
name	string	The name of the permission.
version	string	Version of the permission.
is_resource_type_default	boolean	Set to true to use this as the default permission.
permission_type	string
resource_type	string	The resource type this permission can be used with.
policy_template	object	Policy template for the permission.
▶tags	array
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
arn	string
region	string	AWS region.

For more information, see AWS::RAM::Permission.

Methods

Name	Resource	Accessible by	Required Params
create_resource	permissions	INSERT	Name, ResourceType, PolicyTemplate, region
delete_resource	permissions	DELETE	Identifier, region
update_resource	permissions	UPDATE	Identifier, PatchDocument, region
list_resources	permissions_list_only	SELECT	region
get_resource	permissions	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual permission.

SELECT
  region,
  arn,
  name,
  version,
  is_resource_type_default,
  permission_type,
  resource_type,
  policy_template,
  tags
FROM awscc.ram.permissions
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all permissions in a region.

SELECT
  region,
  arn
FROM awscc.ram.permissions_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.ram.permissions (
  Name,
  ResourceType,
  PolicyTemplate,
  region
)
SELECT
  '{{ name }}',
  '{{ resource_type }}',
  '{{ policy_template }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.ram.permissions (
  Name,
  ResourceType,
  PolicyTemplate,
  Tags,
  region
)
SELECT
  '{{ name }}',
  '{{ resource_type }}',
  '{{ policy_template }}',
  '{{ tags }}',
  '{{ 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: permission
  props:
    - name: name
      value: '{{ name }}'
    - name: resource_type
      value: '{{ resource_type }}'
    - name: policy_template
      value: {}
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.ram.permissions
SET PatchDocument = string('{{ {
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.ram.permissions
WHERE
  Identifier = '{{ arn }}' 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 permissions resource, the following permissions are required:

Create

ram:CreatePermission,
ram:TagResource

Read

ram:GetPermission

Update

ram:CreatePermissionVersion,
ram:DeletePermissionVersion,
ram:SetDefaultPermissionVersion,
ram:GetPermission,
ram:ReplacePermissionAssociations,
ram:ListReplacePermissionAssociationsWork,
ram:ListPermissionVersions,
ram:UntagResource,
ram:TagResource

Delete

ram:DeletePermissionVersion,
ram:DeletePermission

List

ram:ListPermissions,
ram:ListPermissionVersions