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(id, configVersion,
description, samlOptions, iamIdentityCenterOptionsUpdates, clientToken)
Arguments¶
id
[required] The security configuration identifier. For SAML the ID will be
saml/<accountId>/<idpProviderName>
. For example,saml/123456789123/OKTADev
.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.
samlOptions
SAML options in in the form of a key-value map.
iamIdentityCenterOptionsUpdates
Describes IAM Identity Center options in the form of a key-value map.
clientToken
Unique, case-sensitive identifier to ensure idempotency of the request.
Value¶
A list with the following syntax:
list(
securityConfigDetail = list(
id = "string",
type = "saml"|"iamidentitycenter",
configVersion = "string",
description = "string",
samlOptions = list(
metadata = "string",
userAttribute = "string",
groupAttribute = "string",
openSearchServerlessEntityId = "string",
sessionTimeout = 123
),
iamIdentityCenterOptions = list(
instanceArn = "string",
applicationArn = "string",
applicationName = "string",
applicationDescription = "string",
userAttribute = "UserId"|"UserName"|"Email",
groupAttribute = "GroupId"|"GroupName"
),
createdDate = 123,
lastModifiedDate = 123
)
)
Request syntax¶
svc$update_security_config(
id = "string",
configVersion = "string",
description = "string",
samlOptions = list(
metadata = "string",
userAttribute = "string",
groupAttribute = "string",
openSearchServerlessEntityId = "string",
sessionTimeout = 123
),
iamIdentityCenterOptionsUpdates = list(
userAttribute = "UserId"|"UserName"|"Email",
groupAttribute = "GroupId"|"GroupName"
),
clientToken = "string"
)