accounts

Creates, updates, deletes or gets an account resource or lists accounts in a region

Overview

Name	accounts
Type	Resource
Description	The ``AWS::ApiGateway::Account`` resource specifies the IAM role that Amazon API Gateway uses to write API logs to Amazon CloudWatch Logs. To avoid overwriting other roles, you should only have one ``AWS::ApiGateway::Account`` resource per region per account.
Id	awscc.apigateway.accounts

Fields

Name	Datatype	Description
id	string
cloud_watch_role_arn	string
region	string	AWS region.

For more information, see AWS::ApiGateway::Account.

Methods

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

SELECT examples

Gets all properties from an individual account.

SELECT
  region,
  id,
  cloud_watch_role_arn
FROM awscc.apigateway.accounts
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ id }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.apigateway.accounts (
  CloudWatchRoleArn,
  region
)
SELECT
  '{{ cloud_watch_role_arn }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.apigateway.accounts (
  CloudWatchRoleArn,
  region
)
SELECT
  '{{ cloud_watch_role_arn }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: account
    props:
      - name: cloud_watch_role_arn
        value: '{{ cloud_watch_role_arn }}'

UPDATE example

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

/*+ update */
UPDATE awscc.apigateway.accounts
SET PatchDocument = string('{{ {
    "CloudWatchRoleArn": cloud_watch_role_arn
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}';

DELETE example

/*+ delete */
DELETE FROM awscc.apigateway.accounts
WHERE
  Identifier = '{{ id }}' AND
  region = 'us-east-1';

Permissions

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

Read

apigateway:GET

Create

apigateway:PATCH,
iam:GetRole,
iam:PassRole

Update

apigateway:PATCH,
iam:GetRole,
iam:PassRole

Delete

apigateway:PATCH