Class: AWSCDK::QBusiness::CfnPlugin::S3Property

Inherits:

Jsii::Struct

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

Defined in:

q_business/cfn_plugin.rb

Overview

Information required for Amazon Q Business to find a specific file in an Amazon S3 bucket.

See Also:

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

Instance Attribute Summary

• #bucket ⇒ String readonly

  The name of the S3 bucket that contains the file.

• #key ⇒ String readonly

  The name of the file.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(bucket:, key:) ⇒ S3Property constructor

  A new instance of S3Property.

• #to_jsii ⇒ Object

Constructor Details

#initialize(bucket:, key:) ⇒ S3Property

Returns a new instance of S3Property.

Parameters:

• bucket (String) —

  The name of the S3 bucket that contains the file.

• key (String) —

  The name of the file.

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

def initialize(bucket:, key:)
  @bucket = bucket
  Jsii::Type.check_type(@bucket, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "bucket")
  @key = key
  Jsii::Type.check_type(@key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
end

Instance Attribute Details

#bucket ⇒ String (readonly)

The name of the S3 bucket that contains the file.

Returns:

• (String)

See Also:

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

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

def bucket
  @bucket
end

#key ⇒ String (readonly)

The name of the file.

Returns:

• (String)

See Also:

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

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

def key
  @key
end

Class Method Details

.jsii_properties ⇒ Object

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

def self.jsii_properties
  {
    :bucket => "bucket",
    :key => "key",
  }
end

Instance Method Details

#to_jsii ⇒ Object

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

def to_jsii
  result = {}
  result.merge!({
    "bucket" => @bucket,
    "key" => @key,
  })
  result.compact
end