views

Creates, updates, deletes or gets a view resource or lists views in a region

Overview

Name	views
Type	Resource
Description	Definition of AWS::ResourceExplorer2::View Resource Type
Id	awscc.resourceexplorer2.views

Fields

get (all properties)

Name	Datatype	Description
▶filters	object
▶included_properties	array
scope	string
tags	object
view_arn	string
view_name	string
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
view_arn	string
region	string	AWS region.

For more information, see AWS::ResourceExplorer2::View.

Methods

Name	Resource	Accessible by	Required Params
create_resource	views	INSERT	ViewName, region
delete_resource	views	DELETE	Identifier, region
update_resource	views	UPDATE	Identifier, PatchDocument, region
list_resources	views_list_only	SELECT	region
get_resource	views	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual view.

SELECT
  region,
  filters,
  included_properties,
  scope,
  tags,
  view_arn,
  view_name
FROM awscc.resourceexplorer2.views
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ view_arn }}';

list (identifiers only)

Lists all views in a region.

SELECT
  region,
  view_arn
FROM awscc.resourceexplorer2.views_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.resourceexplorer2.views (
  ViewName,
  region
)
SELECT
  '{{ view_name }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.resourceexplorer2.views (
  Filters,
  IncludedProperties,
  Scope,
  Tags,
  ViewName,
  region
)
SELECT
  '{{ filters }}',
  '{{ included_properties }}',
  '{{ scope }}',
  '{{ tags }}',
  '{{ view_name }}',
  '{{ 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: view
  props:
    - name: filters
      value:
        filter_string: '{{ filter_string }}'
    - name: included_properties
      value:
        - name: '{{ name }}'
    - name: scope
      value: '{{ scope }}'
    - name: tags
      value: {}
    - name: view_name
      value: '{{ view_name }}'

UPDATE example

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

/*+ update */
UPDATE awscc.resourceexplorer2.views
SET PatchDocument = string('{{ {
    "Filters": filters,
    "IncludedProperties": included_properties,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ view_arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

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

Create

resource-explorer-2:CreateView,
resource-explorer-2:TagResource

Read

resource-explorer-2:GetView

Update

resource-explorer-2:UpdateView,
resource-explorer-2:TagResource,
resource-explorer-2:UntagResource,
resource-explorer-2:ListTagsForResource

Delete

resource-explorer-2:DeleteView,
resource-explorer-2:GetView,
resource-explorer-2:UntagResource

List

resource-explorer-2:ListViews