Class: AWSCDK::OpenSearchService::CfnDomain::MasterUserOptionsProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
open_search_service/cfn_domain.rb

Overview

Specifies information about the master user.

Required if InternalUserDatabaseEnabled is true in AdvancedSecurityOptions .

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(master_user_arn: nil, master_user_name: nil, master_user_password: nil) ⇒ MasterUserOptionsProperty

Returns a new instance of MasterUserOptionsProperty.

Parameters:

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

    Amazon Resource Name (ARN) for the master user.

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

    Username for the master user. Only specify if InternalUserDatabaseEnabled is true in AdvancedSecurityOptionsInput .

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

    Password for the master user. Only specify if InternalUserDatabaseEnabled is true in AdvancedSecurityOptionsInput .



1958
1959
1960
1961
1962
1963
1964
1965
 
# File 'open_search_service/cfn_domain.rb', line 1958

def initialize(master_user_arn: nil, master_user_name: nil, master_user_password: nil)
  @master_user_arn = master_user_arn
  Jsii::Type.check_type(@master_user_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "masterUserArn") unless @master_user_arn.nil?
  @master_user_name = master_user_name
  Jsii::Type.check_type(@master_user_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "masterUserName") unless @master_user_name.nil?
  @master_user_password = master_user_password
  Jsii::Type.check_type(@master_user_password, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "masterUserPassword") unless @master_user_password.nil?
end

Instance Attribute Details

#master_user_arn ⇒ String? (readonly)

Amazon Resource Name (ARN) for the master user.

The ARN can point to an IAM user or role. This property is required for Amazon Cognito to work, and it must match the role configured for Cognito. Only specify if InternalUserDatabaseEnabled is false in AdvancedSecurityOptionsInput .

Returns:

  • (String, nil)

See Also:



1973
1974
1975
 
# File 'open_search_service/cfn_domain.rb', line 1973

def master_user_arn
  @master_user_arn
end

#master_user_name ⇒ String? (readonly)

Username for the master user. Only specify if InternalUserDatabaseEnabled is true in AdvancedSecurityOptionsInput .

If you don't want to specify this value directly within the template, you can use a dynamic reference instead.

Returns:

  • (String, nil)

See Also:



1980
1981
1982
 
# File 'open_search_service/cfn_domain.rb', line 1980

def master_user_name
  @master_user_name
end

#master_user_password ⇒ String? (readonly)

Password for the master user. Only specify if InternalUserDatabaseEnabled is true in AdvancedSecurityOptionsInput .

If you don't want to specify this value directly within the template, you can use a dynamic reference instead.

Returns:

  • (String, nil)

See Also:



1987
1988
1989
 
# File 'open_search_service/cfn_domain.rb', line 1987

def master_user_password
  @master_user_password
end

Class Method Details

.jsii_properties ⇒ Object 



1989
1990
1991
1992
1993
1994
1995
 
# File 'open_search_service/cfn_domain.rb', line 1989

def self.jsii_properties
  {
    :master_user_arn => "masterUserArn",
    :master_user_name => "masterUserName",
    :master_user_password => "masterUserPassword",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1997
1998
1999
2000
2001
2002
2003
2004
2005
 
# File 'open_search_service/cfn_domain.rb', line 1997

def to_jsii
  result = {}
  result.merge!({
    "masterUserArn" => @master_user_arn,
    "masterUserName" => @master_user_name,
    "masterUserPassword" => @master_user_password,
  })
  result.compact
end