security_configs

Creates, updates, deletes, gets or lists a security_configs resource.

Overview

Name	security_configs
Type	Resource
Id	aws.opensearchserverless.security_configs

Fields

The following fields are returned by SELECT queries:

get_security_config

Name	Datatype	Description
id	string	The unique identifier of the security configuration.
config_version	string	The version of the security configuration. (pattern: <code>([0-9a-zA-Z+/]{4})*(([0-9a-zA-Z+/]{2}==)|([0-9a-zA-Z+/]{3}=))?</code>)
created_date	integer (int64)	The date the configuration was created.
description	string	The description of the security configuration.
iam_federation_options	object	Describes IAM federation options in the form of a key-value map. Contains configuration details about how OpenSearch Serverless integrates with external identity providers through federation.
iam_identity_center_options	object	Describes IAM Identity Center options in the form of a key-value map.
last_modified_date	integer (int64)	The timestamp of when the configuration was last modified.
saml_options	object	SAML options for the security configuration in the form of a key-value map.
type_	string	The type of security configuration. (saml, iamidentitycenter, iamfederation)

list_security_configs

Name	Datatype	Description
next_token	string	When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
security_config_summaries	array	Details about the security configurations in your account.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_security_config	select	region		Returns information about an OpenSearch Serverless security configuration. For more information, see SAML authentication for Amazon OpenSearch Serverless.
list_security_configs	select	region		Returns information about configured OpenSearch Serverless security configurations. For more information, see SAML authentication for Amazon OpenSearch Serverless.
create_security_config	insert	region, type, name		Specifies a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless.
update_security_config	update	region, id, configVersion		Updates a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless.
delete_security_config	delete	region		Deletes a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_security_config

Returns information about an OpenSearch Serverless security configuration. For more information, see SAML authentication for Amazon OpenSearch Serverless.

SELECT
id,
config_version,
created_date,
description,
iam_federation_options,
iam_identity_center_options,
last_modified_date,
saml_options,
type_
FROM aws.opensearchserverless.security_configs
WHERE region = '{{ region }}' -- required
;

list_security_configs

Returns information about configured OpenSearch Serverless security configurations. For more information, see SAML authentication for Amazon OpenSearch Serverless.

SELECT
next_token,
security_config_summaries
FROM aws.opensearchserverless.security_configs
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_security_config

Specifies a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless.

INSERT INTO aws.opensearchserverless.security_configs (
type,
name,
description,
samlOptions,
iamIdentityCenterOptions,
iamFederationOptions,
clientToken,
region
)
SELECT 
'{{ type }}' /* required */,
'{{ name }}' /* required */,
'{{ description }}',
'{{ samlOptions }}',
'{{ iamIdentityCenterOptions }}',
'{{ iamFederationOptions }}',
'{{ clientToken }}',
'{{ region }}'
RETURNING
security_config_detail
;

Manifest

# Description fields are for documentation purposes
- name: security_configs
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the security_configs resource.
  - name: type
    value: "{{ type }}"
    description: |
      The type of security configuration.
    valid_values: ['saml', 'iamidentitycenter', 'iamfederation']
  - name: name
    value: "{{ name }}"
    description: |
      The name of the security configuration.
  - name: description
    value: "{{ description }}"
    description: |
      A description of the security configuration.
  - name: samlOptions
    description: |
      Describes SAML options in the form of a key-value map. This field is required if you specify SAML for the type parameter.
    value:
      metadata: "{{ metadata }}"
      userAttribute: "{{ userAttribute }}"
      groupAttribute: "{{ groupAttribute }}"
      openSearchServerlessEntityId: "{{ openSearchServerlessEntityId }}"
      sessionTimeout: {{ sessionTimeout }}
  - name: iamIdentityCenterOptions
    description: |
      Describes IAM Identity Center options in the form of a key-value map. This field is required if you specify iamidentitycenter for the type parameter.
    value:
      instanceArn: "{{ instanceArn }}"
      userAttribute: "{{ userAttribute }}"
      groupAttribute: "{{ groupAttribute }}"
  - name: iamFederationOptions
    description: |
      Describes IAM federation options in the form of a key-value map. This field is required if you specify iamFederation for the type parameter.
    value:
      groupAttribute: "{{ groupAttribute }}"
      userAttribute: "{{ userAttribute }}"
  - name: clientToken
    value: "{{ clientToken }}"
    description: |
      Unique, case-sensitive identifier to ensure idempotency of the request.

UPDATE examples

update_security_config

Updates a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless.

UPDATE aws.opensearchserverless.security_configs
SET 
id = '{{ id }}',
configVersion = '{{ configVersion }}',
description = '{{ description }}',
samlOptions = '{{ samlOptions }}',
iamIdentityCenterOptionsUpdates = '{{ iamIdentityCenterOptionsUpdates }}',
iamFederationOptions = '{{ iamFederationOptions }}',
clientToken = '{{ clientToken }}'
WHERE 
region = '{{ region }}' --required
AND id = '{{ id }}' --required
AND configVersion = '{{ configVersion }}' --required
RETURNING
security_config_detail;

DELETE examples

delete_security_config

Deletes a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless.

DELETE FROM aws.opensearchserverless.security_configs
WHERE region = '{{ region }}' --required
;