Class: AWSCDK::Bedrock::CfnKnowledgeBase::RedshiftProvisionedAuthConfigurationProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Bedrock::CfnKnowledgeBase::RedshiftProvisionedAuthConfigurationProperty

Defined in:

bedrock/cfn_knowledge_base.rb

Overview

Contains configurations for authentication to an Amazon Redshift provisioned data warehouse.

Specify the type of authentication to use in the type field and include the corresponding field. If you specify IAM authentication, you don't need to include another field.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-redshiftprovisionedauthconfiguration.html

Instance Attribute Summary

• #database_user ⇒ String^? readonly

  The database username for authentication to an Amazon Redshift provisioned data warehouse.

• #type ⇒ String readonly

  The type of authentication to use.

• #username_password_secret_arn ⇒ String^? readonly

  The ARN of an Secrets Manager secret for authentication.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(type:, database_user: nil, username_password_secret_arn: nil) ⇒ RedshiftProvisionedAuthConfigurationProperty constructor

  A new instance of RedshiftProvisionedAuthConfigurationProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(type:, database_user: nil, username_password_secret_arn: nil) ⇒ RedshiftProvisionedAuthConfigurationProperty

Returns a new instance of RedshiftProvisionedAuthConfigurationProperty.

Parameters:

• type (String) —

  The type of authentication to use.

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

  The database username for authentication to an Amazon Redshift provisioned data warehouse.

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

  The ARN of an Secrets Manager secret for authentication.

# File 'bedrock/cfn_knowledge_base.rb', line 2086

def initialize(type:, database_user: nil, username_password_secret_arn: nil)
  @type = type
  Jsii::Type.check_type(@type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type")
  @database_user = database_user
  Jsii::Type.check_type(@database_user, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "databaseUser") unless @database_user.nil?
  @username_password_secret_arn = username_password_secret_arn
  Jsii::Type.check_type(@username_password_secret_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "usernamePasswordSecretArn") unless @username_password_secret_arn.nil?
end

Instance Attribute Details

#database_user ⇒ String^? (readonly)

The database username for authentication to an Amazon Redshift provisioned data warehouse.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-redshiftprovisionedauthconfiguration.html#cfn-bedrock-knowledgebase-redshiftprovisionedauthconfiguration-databaseuser

# File 'bedrock/cfn_knowledge_base.rb', line 2104

def database_user
  @database_user
end

#type ⇒ String (readonly)

The type of authentication to use.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-redshiftprovisionedauthconfiguration.html#cfn-bedrock-knowledgebase-redshiftprovisionedauthconfiguration-type

# File 'bedrock/cfn_knowledge_base.rb', line 2099

def type
  @type
end

#username_password_secret_arn ⇒ String^? (readonly)

The ARN of an Secrets Manager secret for authentication.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-redshiftprovisionedauthconfiguration.html#cfn-bedrock-knowledgebase-redshiftprovisionedauthconfiguration-usernamepasswordsecretarn

# File 'bedrock/cfn_knowledge_base.rb', line 2109

def username_password_secret_arn
  @username_password_secret_arn
end

Class Method Details

.jsii_properties ⇒ Object

# File 'bedrock/cfn_knowledge_base.rb', line 2111

def self.jsii_properties
  {
    :type => "type",
    :database_user => "databaseUser",
    :username_password_secret_arn => "usernamePasswordSecretArn",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'bedrock/cfn_knowledge_base.rb', line 2119

def to_jsii
  result = {}
  result.merge!({
    "type" => @type,
    "databaseUser" => @database_user,
    "usernamePasswordSecretArn" => @username_password_secret_arn,
  })
  result.compact
end