Class: AWSCDK::S3Vectors::CfnVectorBucketProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
s3_vectors/cfn_vector_bucket_props.rb

Overview

Properties for defining a CfnVectorBucket.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(encryption_configuration: nil, tags: nil, vector_bucket_name: nil) ⇒ CfnVectorBucketProps

Returns a new instance of CfnVectorBucketProps.

Parameters:



12
13
14
15
16
17
18
19
 
# File 's3_vectors/cfn_vector_bucket_props.rb', line 12

def initialize(encryption_configuration: nil, tags: nil, vector_bucket_name: nil)
  @encryption_configuration = encryption_configuration.is_a?(Hash) ? ::AWSCDK::S3Vectors::CfnVectorBucket::EncryptionConfigurationProperty.new(**encryption_configuration.transform_keys(&:to_sym)) : encryption_configuration
  Jsii::Type.check_type(@encryption_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zM3ZlY3RvcnMuQ2ZuVmVjdG9yQnVja2V0LkVuY3J5cHRpb25Db25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "encryptionConfiguration") unless @encryption_configuration.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
  @vector_bucket_name = vector_bucket_name
  Jsii::Type.check_type(@vector_bucket_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "vectorBucketName") unless @vector_bucket_name.nil?
end

Instance Attribute Details

#encryption_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

The encryption configuration for the vector bucket.

Returns:

See Also:



25
26
27
 
# File 's3_vectors/cfn_vector_bucket_props.rb', line 25

def encryption_configuration
  @encryption_configuration
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

User tags (key-value pairs) to associate with the vector bucket.

Returns:

See Also:



30
31
32
 
# File 's3_vectors/cfn_vector_bucket_props.rb', line 30

def tags
  @tags
end

#vector_bucket_name ⇒ String? (readonly)

A name for the vector bucket.

The bucket name must contain only lowercase letters, numbers, and hyphens (-). The bucket name must be unique in the same AWS account for each AWS Region. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the bucket name.

The bucket name must be between 3 and 63 characters long and must not contain uppercase characters or underscores.

If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you need to replace the resource, specify a new name.

Returns:

  • (String, nil)

See Also:



41
42
43
 
# File 's3_vectors/cfn_vector_bucket_props.rb', line 41

def vector_bucket_name
  @vector_bucket_name
end

Class Method Details

.jsii_properties ⇒ Object 



43
44
45
46
47
48
49
 
# File 's3_vectors/cfn_vector_bucket_props.rb', line 43

def self.jsii_properties
  {
    :encryption_configuration => "encryptionConfiguration",
    :tags => "tags",
    :vector_bucket_name => "vectorBucketName",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



51
52
53
54
55
56
57
58
59
 
# File 's3_vectors/cfn_vector_bucket_props.rb', line 51

def to_jsii
  result = {}
  result.merge!({
    "encryptionConfiguration" => @encryption_configuration,
    "tags" => @tags,
    "vectorBucketName" => @vector_bucket_name,
  })
  result.compact
end