approval_teams

Creates, updates, deletes or gets an approval_team resource or lists approval_teams in a region

Overview

Name	approval_teams
Type	Resource
Description	Resource Type definition for AWS::MPA::ApprovalTeam.
Id	awscc.mpa.approval_teams

Fields

get (all properties)

Name	Datatype	Description
▶approval_strategy	object
▶approvers	array
▶tags	array
▶policies	array
name	string
description	string
arn	string
version_id	string
update_session_arn	string
creation_time	string
number_of_approvers	integer
status	string
status_code	string
status_message	string
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
arn	string
region	string	AWS region.

For more information, see AWS::MPA::ApprovalTeam.

Methods

Name	Resource	Accessible by	Required Params
create_resource	approval_teams	INSERT	ApprovalStrategy, Approvers, Policies, Name, Description, region
delete_resource	approval_teams	DELETE	Identifier, region
update_resource	approval_teams	UPDATE	Identifier, PatchDocument, region
list_resources	approval_teams_list_only	SELECT	region
get_resource	approval_teams	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual approval_team.

SELECT
  region,
  approval_strategy,
  approvers,
  tags,
  policies,
  name,
  description,
  arn,
  version_id,
  update_session_arn,
  creation_time,
  last_update_time,
  number_of_approvers,
  status,
  status_code,
  status_message
FROM awscc.mpa.approval_teams
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all approval_teams in a region.

SELECT
  region,
  arn
FROM awscc.mpa.approval_teams_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.mpa.approval_teams (
  ApprovalStrategy,
  Approvers,
  Policies,
  Name,
  Description,
  region
)
SELECT
  '{{ approval_strategy }}',
  '{{ approvers }}',
  '{{ policies }}',
  '{{ name }}',
  '{{ description }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.mpa.approval_teams (
  ApprovalStrategy,
  Approvers,
  Tags,
  Policies,
  Name,
  Description,
  region
)
SELECT
  '{{ approval_strategy }}',
  '{{ approvers }}',
  '{{ tags }}',
  '{{ policies }}',
  '{{ name }}',
  '{{ description }}',
  '{{ 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: approval_team
  props:
    - name: approval_strategy
      value:
        mof_n:
          min_approvals_required: '{{ min_approvals_required }}'
    - name: approvers
      value:
        - primary_identity_id: '{{ primary_identity_id }}'
          primary_identity_source_arn: '{{ primary_identity_source_arn }}'
          approver_id: '{{ approver_id }}'
          response_time: '{{ response_time }}'
          primary_identity_status: '{{ primary_identity_status }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'
    - name: policies
      value:
        - null
    - name: name
      value: '{{ name }}'
    - name: description
      value: '{{ description }}'

UPDATE example

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

/*+ update */
UPDATE awscc.mpa.approval_teams
SET PatchDocument = string('{{ {
    "ApprovalStrategy": approval_strategy,
    "Tags": tags,
    "Description": description
} | 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.mpa.approval_teams
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 approval_teams resource, the following permissions are required:

Create

mpa:CreateApprovalTeam,
mpa:TagResource,
mpa:GetApprovalTeam,
mpa:ListTagsForResource

Read

mpa:GetApprovalTeam,
mpa:ListTagsForResource

Update

mpa:GetApprovalTeam,
mpa:UpdateApprovalTeam,
mpa:TagResource,
mpa:ListTagsForResource,
mpa:UntagResource

Delete

mpa:StartActiveApprovalTeamDeletion,
mpa:DeleteInactiveApprovalTeamVersion,
mpa:GetApprovalTeam,
mpa:UntagResource

List

mpa:ListApprovalTeams,
mpa:ListTagsForResource