Class: Aws::OpenSearchServerless::Types::CreateSecurityConfigRequest

Inherits:

Struct

• Object
• Struct
• Aws::OpenSearchServerless::Types::CreateSecurityConfigRequest

Includes:

Structure

Defined in:

lib/aws-sdk-opensearchserverless/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #client_token ⇒ String

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

• #description ⇒ String

  A description of the security configuration.

• #name ⇒ String

  The name of the security configuration.

• #saml_options ⇒ Types::SamlConfigOptions

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

• #type ⇒ String

  The type of security configuration.

Instance Attribute Details

#client_token ⇒ String

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

**A suitable default value is auto-generated.** You should normally not need to pass this option.

Returns:

• (String)

# File 'lib/aws-sdk-opensearchserverless/types.rb', line 697

class CreateSecurityConfigRequest < Struct.new(
  :client_token,
  :description,
  :name,
  :saml_options,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A description of the security configuration.

Returns:

• (String)

# File 'lib/aws-sdk-opensearchserverless/types.rb', line 697

class CreateSecurityConfigRequest < Struct.new(
  :client_token,
  :description,
  :name,
  :saml_options,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the security configuration.

Returns:

• (String)

# File 'lib/aws-sdk-opensearchserverless/types.rb', line 697

class CreateSecurityConfigRequest < Struct.new(
  :client_token,
  :description,
  :name,
  :saml_options,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#saml_options ⇒ Types::SamlConfigOptions

Describes SAML options in in the form of a key-value map. This field is required if you specify ‘saml` for the `type` parameter.

Returns:

• (Types::SamlConfigOptions)

# File 'lib/aws-sdk-opensearchserverless/types.rb', line 697

class CreateSecurityConfigRequest < Struct.new(
  :client_token,
  :description,
  :name,
  :saml_options,
  :type)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The type of security configuration.

Returns:

• (String)

# File 'lib/aws-sdk-opensearchserverless/types.rb', line 697

class CreateSecurityConfigRequest < Struct.new(
  :client_token,
  :description,
  :name,
  :saml_options,
  :type)
  SENSITIVE = []
  include Aws::Structure
end