access_policies

Creates, updates, deletes or gets an access_policy resource or lists access_policies in a region

Overview

Name	access_policies
Type	Resource
Description	Amazon OpenSearchServerless access policy resource
Id	awscc.opensearchserverless.access_policies

Fields

get (all properties)

Name	Datatype	Description
name	string	The name of the policy
type	string	The possible types for the access policy
description	string	The description of the policy
policy	string	The JSON policy document that is the content for the policy
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
name	string	The name of the policy
type	string	The possible types for the access policy
region	string	AWS region.

For more information, see AWS::OpenSearchServerless::AccessPolicy.

Methods

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

SELECT examples

get (all properties)

Gets all properties from an individual access_policy.

SELECT
  region,
  name,
  type,
  description,
  policy
FROM awscc.opensearchserverless.access_policies
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ type }}|{{ name }}';

list (identifiers only)

Lists all access_policies in a region.

SELECT
  region,
  type,
  name
FROM awscc.opensearchserverless.access_policies_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.opensearchserverless.access_policies (
  Name,
  Type,
  Policy,
  region
)
SELECT
  '{{ name }}',
  '{{ type }}',
  '{{ policy }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.opensearchserverless.access_policies (
  Name,
  Type,
  Description,
  Policy,
  region
)
SELECT
  '{{ name }}',
  '{{ type }}',
  '{{ description }}',
  '{{ policy }}',
  '{{ 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: access_policy
  props:
    - name: name
      value: '{{ name }}'
    - name: type
      value: '{{ type }}'
    - name: description
      value: '{{ description }}'
    - name: policy
      value: '{{ policy }}'

UPDATE example

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

/*+ update */
UPDATE awscc.opensearchserverless.access_policies
SET PatchDocument = string('{{ {
    "Description": description,
    "Policy": policy
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ type }}|{{ name }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

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

Create

aoss:CreateAccessPolicy,
aoss:GetAccessPolicy

Read

aoss:GetAccessPolicy

Update

aoss:UpdateAccessPolicy,
aoss:GetAccessPolicy

Delete

aoss:DeleteAccessPolicy,
aoss:GetAccessPolicy

List

aoss:ListAccessPolicies