profile_permissions

Creates, updates, deletes or gets a profile_permission resource or lists profile_permissions in a region

Overview

Name	profile_permissions
Type	Resource
Description	An example resource schema demonstrating some basic constructs and validation rules.
Id	awscc.signer.profile_permissions

Fields

get (all properties)

Name	Datatype	Description
profile_name	string
profile_version	string
action	string
principal	string
statement_id	string
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
profile_name	string
statement_id	string
region	string	AWS region.

For more information, see AWS::Signer::ProfilePermission.

Methods

Name	Resource	Accessible by	Required Params
create_resource	profile_permissions	INSERT	ProfileName, Action, Principal, StatementId, region
delete_resource	profile_permissions	DELETE	Identifier, region
list_resources	profile_permissions_list_only	SELECT	region
get_resource	profile_permissions	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual profile_permission.

SELECT
  region,
  profile_name,
  profile_version,
  action,
  principal,
  statement_id
FROM awscc.signer.profile_permissions
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ statement_id }}|{{ profile_name }}';

list (identifiers only)

Lists all profile_permissions in a region.

SELECT
  region,
  statement_id,
  profile_name
FROM awscc.signer.profile_permissions_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.signer.profile_permissions (
  ProfileName,
  Action,
  Principal,
  StatementId,
  region
)
SELECT
  '{{ profile_name }}',
  '{{ action }}',
  '{{ principal }}',
  '{{ statement_id }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.signer.profile_permissions (
  ProfileName,
  ProfileVersion,
  Action,
  Principal,
  StatementId,
  region
)
SELECT
  '{{ profile_name }}',
  '{{ profile_version }}',
  '{{ action }}',
  '{{ principal }}',
  '{{ statement_id }}',
  '{{ 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: profile_permission
  props:
    - name: profile_name
      value: '{{ profile_name }}'
    - name: profile_version
      value: '{{ profile_version }}'
    - name: action
      value: '{{ action }}'
    - name: principal
      value: '{{ principal }}'
    - name: statement_id
      value: '{{ statement_id }}'

DELETE example

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

Create

signer:AddProfilePermission,
signer:ListProfilePermissions

Read

signer:ListProfilePermissions

Delete

signer:RemoveProfilePermission,
signer:ListProfilePermissions

List

signer:ListProfilePermissions,
signer:GetSigningProfile