Class: AWSCDK::OpenSearchServerless::CfnSecurityConfig::IAMIdentityCenterConfigOptionsProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
open_search_serverless/cfn_security_config.rb

Overview

Describes IAM Identity Center options for an OpenSearch Serverless security configuration in the form of a key-value map.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(instance_arn:, application_arn: nil, application_description: nil, application_name: nil, group_attribute: nil, user_attribute: nil) ⇒ IAMIdentityCenterConfigOptionsProperty

Returns a new instance of IAMIdentityCenterConfigOptionsProperty.

Parameters:

  • instance_arn (String) —

    The ARN of the IAM Identity Center instance used to integrate with OpenSearch Serverless.

  • application_arn (String, nil) (defaults to: nil) —

    The ARN of the IAM Identity Center application used to integrate with OpenSearch Serverless.

  • application_description (String, nil) (defaults to: nil) —

    The description of the IAM Identity Center application used to integrate with OpenSearch Serverless.

  • application_name (String, nil) (defaults to: nil) —

    The name of the IAM Identity Center application used to integrate with OpenSearch Serverless.

  • group_attribute (String, nil) (defaults to: nil) —

    The group attribute for this IAM Identity Center integration.

  • user_attribute (String, nil) (defaults to: nil) —

    The user attribute for this IAM Identity Center integration.



650
651
652
653
654
655
656
657
658
659
660
661
662
663
 
# File 'open_search_serverless/cfn_security_config.rb', line 650

def initialize(instance_arn:, application_arn: nil, application_description: nil, application_name: nil, group_attribute: nil, user_attribute: nil)
  @instance_arn = instance_arn
  Jsii::Type.check_type(@instance_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "instanceArn")
  @application_arn = application_arn
  Jsii::Type.check_type(@application_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "applicationArn") unless @application_arn.nil?
  @application_description = application_description
  Jsii::Type.check_type(@application_description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "applicationDescription") unless @application_description.nil?
  @application_name = application_name
  Jsii::Type.check_type(@application_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "applicationName") unless @application_name.nil?
  @group_attribute = group_attribute
  Jsii::Type.check_type(@group_attribute, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "groupAttribute") unless @group_attribute.nil?
  @user_attribute = user_attribute
  Jsii::Type.check_type(@user_attribute, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "userAttribute") unless @user_attribute.nil?
end

Instance Attribute Details

#application_arn ⇒ String? (readonly)

The ARN of the IAM Identity Center application used to integrate with OpenSearch Serverless.

Returns:

  • (String, nil)

See Also:



674
675
676
 
# File 'open_search_serverless/cfn_security_config.rb', line 674

def application_arn
  @application_arn
end

#application_description ⇒ String? (readonly)

The description of the IAM Identity Center application used to integrate with OpenSearch Serverless.

Returns:

  • (String, nil)

See Also:



679
680
681
 
# File 'open_search_serverless/cfn_security_config.rb', line 679

def application_description
  @application_description
end

#application_name ⇒ String? (readonly)

The name of the IAM Identity Center application used to integrate with OpenSearch Serverless.

Returns:

  • (String, nil)

See Also:



684
685
686
 
# File 'open_search_serverless/cfn_security_config.rb', line 684

def application_name
  @application_name
end

#group_attribute ⇒ String? (readonly)

The group attribute for this IAM Identity Center integration.

Defaults to GroupId .

Returns:

  • (String, nil)

See Also:



691
692
693
 
# File 'open_search_serverless/cfn_security_config.rb', line 691

def group_attribute
  @group_attribute
end

#instance_arn ⇒ String (readonly)

The ARN of the IAM Identity Center instance used to integrate with OpenSearch Serverless.

Returns:

  • (String)

See Also:



669
670
671
 
# File 'open_search_serverless/cfn_security_config.rb', line 669

def instance_arn
  @instance_arn
end

#user_attribute ⇒ String? (readonly)

The user attribute for this IAM Identity Center integration.

Defaults to UserId

Returns:

  • (String, nil)

See Also:



698
699
700
 
# File 'open_search_serverless/cfn_security_config.rb', line 698

def user_attribute
  @user_attribute
end

Class Method Details

.jsii_properties ⇒ Object 



700
701
702
703
704
705
706
707
708
709
 
# File 'open_search_serverless/cfn_security_config.rb', line 700

def self.jsii_properties
  {
    :instance_arn => "instanceArn",
    :application_arn => "applicationArn",
    :application_description => "applicationDescription",
    :application_name => "applicationName",
    :group_attribute => "groupAttribute",
    :user_attribute => "userAttribute",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



711
712
713
714
715
716
717
718
719
720
721
722
 
# File 'open_search_serverless/cfn_security_config.rb', line 711

def to_jsii
  result = {}
  result.merge!({
    "instanceArn" => @instance_arn,
    "applicationArn" => @application_arn,
    "applicationDescription" => @application_description,
    "applicationName" => @application_name,
    "groupAttribute" => @group_attribute,
    "userAttribute" => @user_attribute,
  })
  result.compact
end