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(clientToken,
  description, iamIdentityCenterOptions, name, samlOptions, type)

Arguments

clientToken

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

description

A description of the security configuration.

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.

name

[required] The name 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 the type parameter.

type

[required] The type of security configuration.

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$create_security_config(
  clientToken = "string",
  description = "string",
  iamIdentityCenterOptions = list(
    groupAttribute = "GroupId"|"GroupName",
    instanceArn = "string",
    userAttribute = "UserId"|"UserName"|"Email"
  ),
  name = "string",
  samlOptions = list(
    groupAttribute = "string",
    metadata = "string",
    sessionTimeout = 123,
    userAttribute = "string"
  ),
  type = "saml"|"iamidentitycenter"
)