analyzers

Creates, updates, deletes or gets an analyzer resource or lists analyzers in a region

Overview

Name	analyzers
Type	Resource
Description	The AWS::AccessAnalyzer::Analyzer type specifies an analyzer of the user's account
Id	awscc.accessanalyzer.analyzers

Fields

get (all properties)

Name	Datatype	Description
analyzer_name	string	Analyzer name
▶archive_rules	array
arn	string	Amazon Resource Name (ARN) of the analyzer
▶tags	array	An array of key-value pairs to apply to this resource.
type	string	The type of the analyzer, must be one of ACCOUNT, ORGANIZATION, ACCOUNT_INTERNAL_ACCESS, ORGANIZATION_INTERNAL_ACCESS, ACCOUNT_UNUSED_ACCESS and ORGANIZATION_UNUSED_ACCESS
▶analyzer_configuration	object	The configuration for the analyzer
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
arn	string	Amazon Resource Name (ARN) of the analyzer
region	string	AWS region.

For more information, see AWS::AccessAnalyzer::Analyzer.

Methods

Name	Resource	Accessible by	Required Params
create_resource	analyzers	INSERT	Type, region
delete_resource	analyzers	DELETE	Identifier, region
update_resource	analyzers	UPDATE	Identifier, PatchDocument, region
list_resources	analyzers_list_only	SELECT	region
get_resource	analyzers	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual analyzer.

SELECT
  region,
  analyzer_name,
  archive_rules,
  arn,
  tags,
  type,
  analyzer_configuration
FROM awscc.accessanalyzer.analyzers
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all analyzers in a region.

SELECT
  region,
  arn
FROM awscc.accessanalyzer.analyzers_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.accessanalyzer.analyzers (
  Type,
  region
)
SELECT
  '{{ type }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.accessanalyzer.analyzers (
  AnalyzerName,
  ArchiveRules,
  Tags,
  Type,
  AnalyzerConfiguration,
  region
)
SELECT
  '{{ analyzer_name }}',
  '{{ archive_rules }}',
  '{{ tags }}',
  '{{ type }}',
  '{{ analyzer_configuration }}',
  '{{ 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: analyzer
  props:
    - name: analyzer_name
      value: '{{ analyzer_name }}'
    - name: archive_rules
      value:
        - filter:
            - contains:
                - '{{ contains[0] }}'
              eq:
                - '{{ eq[0] }}'
              exists: '{{ exists }}'
              property: '{{ property }}'
              neq:
                - '{{ neq[0] }}'
          rule_name: '{{ rule_name }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'
    - name: type
      value: '{{ type }}'
    - name: analyzer_configuration
      value:
        unused_access_configuration:
          unused_access_age: '{{ unused_access_age }}'
          analysis_rule:
            exclusions:
              - account_ids:
                  - '{{ account_ids[0] }}'
                resource_tags:
                  - - null
        internal_access_configuration:
          internal_access_analysis_rule:
            inclusions:
              - account_ids:
                  - '{{ account_ids[0] }}'
                resource_arns:
                  - '{{ resource_arns[0] }}'
                resource_types:
                  - '{{ resource_types[0] }}'

UPDATE example

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

/*+ update */
UPDATE awscc.accessanalyzer.analyzers
SET PatchDocument = string('{{ {
    "ArchiveRules": archive_rules,
    "Tags": tags,
    "AnalyzerConfiguration": analyzer_configuration
} | 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.accessanalyzer.analyzers
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 analyzers resource, the following permissions are required:

Create

access-analyzer:CreateAnalyzer,
access-analyzer:TagResource,
iam:CreateServiceLinkedRole,
organizations:ListAWSServiceAccessForOrganization,
organizations:ListDelegatedAdministrators

Read

access-analyzer:ListAnalyzers,
access-analyzer:GetAnalyzer,
access-analyzer:ListArchiveRules

Update

access-analyzer:CreateArchiveRule,
access-analyzer:DeleteArchiveRule,
access-analyzer:ListAnalyzers,
access-analyzer:TagResource,
access-analyzer:UntagResource,
access-analyzer:UpdateAnalyzer,
access-analyzer:UpdateArchiveRule

Delete

access-analyzer:DeleteAnalyzer

List

access-analyzer:ListAnalyzers