Class: Aws::OpenSearchServerless::Types::UpdateSecurityConfigRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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) 


2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 2710

class UpdateSecurityConfigRequest < Struct.new(
  :id,
  :config_version,
  :description,
  :saml_options,
  :iam_identity_center_options_updates,
  :iam_federation_options,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#config_version ⇒ String

The version of the security configuration to be updated. You can find the most recent version of a security configuration using the GetSecurityPolicy command.

Returns:

  • (String) 


2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 2710

class UpdateSecurityConfigRequest < Struct.new(
  :id,
  :config_version,
  :description,
  :saml_options,
  :iam_identity_center_options_updates,
  :iam_federation_options,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A description of the security configuration.

Returns:

  • (String) 


2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 2710

class UpdateSecurityConfigRequest < Struct.new(
  :id,
  :config_version,
  :description,
  :saml_options,
  :iam_identity_center_options_updates,
  :iam_federation_options,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#iam_federation_options ⇒ Types::IamFederationConfigOptions

Describes IAM federation options in the form of a key-value map for updating an existing security configuration. Use this field to modify IAM federation settings for the security configuration.

Returns:



2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 2710

class UpdateSecurityConfigRequest < Struct.new(
  :id,
  :config_version,
  :description,
  :saml_options,
  :iam_identity_center_options_updates,
  :iam_federation_options,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#iam_identity_center_options_updates ⇒ Types::UpdateIamIdentityCenterConfigOptions

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

Returns:



2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 2710

class UpdateSecurityConfigRequest < Struct.new(
  :id,
  :config_version,
  :description,
  :saml_options,
  :iam_identity_center_options_updates,
  :iam_federation_options,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

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

Returns:

  • (String) 


2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 2710

class UpdateSecurityConfigRequest < Struct.new(
  :id,
  :config_version,
  :description,
  :saml_options,
  :iam_identity_center_options_updates,
  :iam_federation_options,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#saml_options ⇒ Types::SamlConfigOptions

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

Returns:



2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/types.rb', line 2710

class UpdateSecurityConfigRequest < Struct.new(
  :id,
  :config_version,
  :description,
  :saml_options,
  :iam_identity_center_options_updates,
  :iam_federation_options,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end