Class: AWSCDK::QBusiness::CfnPlugin::BasicAuthConfigurationProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::QBusiness::CfnPlugin::BasicAuthConfigurationProperty

Defined in:

q_business/cfn_plugin.rb

Overview

Information about the basic authentication credentials used to configure a plugin.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-basicauthconfiguration.html

Instance Attribute Summary

• #role_arn ⇒ String readonly

  The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.

• #secret_arn ⇒ String readonly

  The ARN of the Secrets Manager secret that stores the basic authentication credentials used for plugin configuration..

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(role_arn:, secret_arn:) ⇒ BasicAuthConfigurationProperty constructor

  A new instance of BasicAuthConfigurationProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(role_arn:, secret_arn:) ⇒ BasicAuthConfigurationProperty

Returns a new instance of BasicAuthConfigurationProperty.

Parameters:

• role_arn (String) —

  The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.

• secret_arn (String) —

  The ARN of the Secrets Manager secret that stores the basic authentication credentials used for plugin configuration..

# File 'q_business/cfn_plugin.rb', line 692

def initialize(role_arn:, secret_arn:)
  @role_arn = role_arn
  Jsii::Type.check_type(@role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "roleArn")
  @secret_arn = secret_arn
  Jsii::Type.check_type(@secret_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "secretArn")
end

Instance Attribute Details

#role_arn ⇒ String (readonly)

The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-basicauthconfiguration.html#cfn-qbusiness-plugin-basicauthconfiguration-rolearn

# File 'q_business/cfn_plugin.rb', line 703

def role_arn
  @role_arn
end

#secret_arn ⇒ String (readonly)

The ARN of the Secrets Manager secret that stores the basic authentication credentials used for plugin configuration..

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-qbusiness-plugin-basicauthconfiguration.html#cfn-qbusiness-plugin-basicauthconfiguration-secretarn

# File 'q_business/cfn_plugin.rb', line 708

def secret_arn
  @secret_arn
end

Class Method Details

.jsii_properties ⇒ Object

# File 'q_business/cfn_plugin.rb', line 710

def self.jsii_properties
  {
    :role_arn => "roleArn",
    :secret_arn => "secretArn",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'q_business/cfn_plugin.rb', line 717

def to_jsii
  result = {}
  result.merge!({
    "roleArn" => @role_arn,
    "secretArn" => @secret_arn,
  })
  result.compact
end