security_configs

Creates, updates, deletes or gets a security_config resource or lists security_configs in a region

Overview

Name	security_configs
Type	Resource
Description	Amazon OpenSearchServerless security config resource
Id	aws.opensearchserverless.security_configs

Fields

Name	Datatype	Description
description	string	Security config description
id	string	The identifier of the security config
name	string	The friendly name of the security config
saml_options	object	Describes saml options in form of key value map
type	string	Config type for security config
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all security_configs in a region.

SELECT
region,
description,
id,
name,
saml_options,
type
FROM aws.opensearchserverless.security_configs
WHERE region = 'us-east-1';

Gets all properties from an individual security_config.

SELECT
region,
description,
id,
name,
saml_options,
type
FROM aws.opensearchserverless.security_configs
WHERE region = 'us-east-1' AND data__Identifier = '<Id>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.opensearchserverless.security_configs (
 Description,
 Name,
 SamlOptions,
 Type,
 region
)
SELECT 
'{{ Description }}',
 '{{ Name }}',
 '{{ SamlOptions }}',
 '{{ Type }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.opensearchserverless.security_configs (
 Description,
 Name,
 SamlOptions,
 Type,
 region
)
SELECT 
 '{{ Description }}',
 '{{ Name }}',
 '{{ SamlOptions }}',
 '{{ Type }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: security_config
    props:
      - name: Description
        value: '{{ Description }}'
      - name: Name
        value: '{{ Name }}'
      - name: SamlOptions
        value:
          Metadata: '{{ Metadata }}'
          UserAttribute: '{{ UserAttribute }}'
          GroupAttribute: '{{ GroupAttribute }}'
          SessionTimeout: '{{ SessionTimeout }}'
      - name: Type
        value: '{{ Type }}'

DELETE example

/*+ delete */
DELETE FROM aws.opensearchserverless.security_configs
WHERE data__Identifier = '<Id>'
AND region = 'us-east-1';

Permissions

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

Create

aoss:CreateSecurityConfig

Read

aoss:GetSecurityConfig

Update

aoss:GetSecurityConfig,
aoss:UpdateSecurityConfig

Delete

aoss:DeleteSecurityConfig

List

aoss:ListSecurityConfigs