Create Security Config
opensearchserviceserverless_create_security_config | R Documentation |
Specifies a security configuration for OpenSearch Serverless¶
Description¶
Specifies a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless.
Usage¶
opensearchserviceserverless_create_security_config(type, name,
description, samlOptions, iamIdentityCenterOptions, clientToken)
Arguments¶
type
[required] The type of security configuration.
name
[required] The name of the security configuration.
description
A description of the security configuration.
samlOptions
Describes SAML options in in the form of a key-value map. This field is required if you specify
saml
for thetype
parameter.iamIdentityCenterOptions
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.
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$create_security_config(
type = "saml"|"iamidentitycenter",
name = "string",
description = "string",
samlOptions = list(
metadata = "string",
userAttribute = "string",
groupAttribute = "string",
openSearchServerlessEntityId = "string",
sessionTimeout = 123
),
iamIdentityCenterOptions = list(
instanceArn = "string",
userAttribute = "UserId"|"UserName"|"Email",
groupAttribute = "GroupId"|"GroupName"
),
clientToken = "string"
)