Update Security Config

opensearchserviceserverless_update_security_config

R Documentation

Updates a security configuration for OpenSearch Serverless

Description

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

Usage

opensearchserviceserverless_update_security_config(clientToken,
  configVersion, description, iamIdentityCenterOptionsUpdates, id,
  samlOptions)

Arguments

clientToken

Unique, case-sensitive identifier to ensure idempotency of the request.

configVersion

[required] The version of the security configuration to be updated. You can find the most recent version of a security configuration using the get_security_policy command.

description

A description of the security configuration.

iamIdentityCenterOptionsUpdates

Describes IAM Identity Center options in the form of a key-value map.

id

[required] The security configuration identifier. For SAML the ID will be ⁠saml/<accountId>/<idpProviderName>⁠. For example, saml/123456789123/OKTADev.

samlOptions

SAML options in in the form of a key-value map.

Value

A list with the following syntax:

list(
  securityConfigDetail = list(
    configVersion = "string",
    createdDate = 123,
    description = "string",
    iamIdentityCenterOptions = list(
      applicationArn = "string",
      applicationDescription = "string",
      applicationName = "string",
      groupAttribute = "GroupId"|"GroupName",
      instanceArn = "string",
      userAttribute = "UserId"|"UserName"|"Email"
    ),
    id = "string",
    lastModifiedDate = 123,
    samlOptions = list(
      groupAttribute = "string",
      metadata = "string",
      sessionTimeout = 123,
      userAttribute = "string"
    ),
    type = "saml"|"iamidentitycenter"
  )
)

Request syntax

svc$update_security_config(
  clientToken = "string",
  configVersion = "string",
  description = "string",
  iamIdentityCenterOptionsUpdates = list(
    groupAttribute = "GroupId"|"GroupName",
    userAttribute = "UserId"|"UserName"|"Email"
  ),
  id = "string",
  samlOptions = list(
    groupAttribute = "string",
    metadata = "string",
    sessionTimeout = 123,
    userAttribute = "string"
  )
)