Class: AWSCDK::Bedrock::CfnDataSource

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, Interfaces::AWSBedrock::IDataSourceRef
Defined in:
bedrock/cfn_data_source.rb

Overview

Properties with __Update requires: Replacement__ can result in the creation of a new data source and deletion of the old one.

This can happen if you also change the Name of the data source.

Specifies a data source as a resource in a top-level template. Minimally, you must specify the following properties:

  • Name – Specify a name for the data source.
  • KnowledgeBaseId – Specify the ID of the knowledge base for the data source to belong to.
  • DataSourceConfiguration – Specify information about the Amazon S3 bucket containing the data source. The following sub-properties are required:
  • Type – Specify the value S3 .

For more information about setting up data sources in Amazon Bedrock , see Set up a data source for your knowledge base .

See the Properties section below for descriptions of both the required and optional properties.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnDataSource

Create a new AWS::Bedrock::DataSource.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::Bedrock::CfnDataSourceProps) —

    Resource properties.



30
31
32
33
34
35
36
 
# File 'bedrock/cfn_data_source.rb', line 30

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::Bedrock::CfnDataSourceProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYmVkcm9jay5DZm5EYXRhU291cmNlUHJvcHMifQ==")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


194
195
196
 
# File 'bedrock/cfn_data_source.rb', line 194

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_bedrock.CfnDataSource", "CFN_RESOURCE_TYPE_NAME")
end

.is_cfn_data_source(x) ⇒ Boolean

Checks whether the given object is a CfnDataSource.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


96
97
98
99
 
# File 'bedrock/cfn_data_source.rb', line 96

def self.is_cfn_data_source(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_bedrock.CfnDataSource", "isCfnDataSource", [x])
end

.jsii_overridable_methods ⇒ Object 



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'bedrock/cfn_data_source.rb', line 38

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_created_at => { kind: :property, name: "attrCreatedAt", is_optional: false },
    :attr_data_source_configuration_web_configuration_crawler_configuration_user_agent_header => { kind: :property, name: "attrDataSourceConfigurationWebConfigurationCrawlerConfigurationUserAgentHeader", is_optional: false },
    :attr_data_source_id => { kind: :property, name: "attrDataSourceId", is_optional: false },
    :attr_data_source_status => { kind: :property, name: "attrDataSourceStatus", is_optional: false },
    :attr_failure_reasons => { kind: :property, name: "attrFailureReasons", is_optional: false },
    :attr_updated_at => { kind: :property, name: "attrUpdatedAt", is_optional: false },
    :data_source_ref => { kind: :property, name: "dataSourceRef", is_optional: false },
    :data_source_configuration => { kind: :property, name: "dataSourceConfiguration", is_optional: false },
    :knowledge_base_id => { kind: :property, name: "knowledgeBaseId", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :data_deletion_policy => { kind: :property, name: "dataDeletionPolicy", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :server_side_encryption_configuration => { kind: :property, name: "serverSideEncryptionConfiguration", is_optional: true },
    :vector_ingestion_configuration => { kind: :property, name: "vectorIngestionConfiguration", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



375
376
377
378
 
# File 'bedrock/cfn_data_source.rb', line 375

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



387
388
389
390
 
# File 'bedrock/cfn_data_source.rb', line 387

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



397
398
399
400
 
# File 'bedrock/cfn_data_source.rb', line 397

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



408
409
410
411
412
 
# File 'bedrock/cfn_data_source.rb', line 408

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


465
466
467
468
469
 
# File 'bedrock/cfn_data_source.rb', line 465

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



475
476
477
478
 
# File 'bedrock/cfn_data_source.rb', line 475

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



487
488
489
490
491
 
# File 'bedrock/cfn_data_source.rb', line 487

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



500
501
502
503
 
# File 'bedrock/cfn_data_source.rb', line 500

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



522
523
524
525
526
527
 
# File 'bedrock/cfn_data_source.rb', line 522

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_created_at ⇒ String

The time at which the data source was created.

Returns:

  • (String) 


201
202
203
 
# File 'bedrock/cfn_data_source.rb', line 201

def attr_created_at()
  jsii_get_property("attrCreatedAt")
end

#attr_data_source_configuration_web_configuration_crawler_configuration_user_agent_header ⇒ String

A string used for identifying the crawler or bot when it accesses a web server.

The user agent header value consists of the bedrockbot , UUID, and a user agent suffix for your crawler (if one is provided). By default, it is set to bedrockbot_UUID . You can optionally append a custom suffix to bedrockbot_UUID to allowlist a specific user agent permitted to access your source URLs.

Returns:

  • (String) 


210
211
212
 
# File 'bedrock/cfn_data_source.rb', line 210

def attr_data_source_configuration_web_configuration_crawler_configuration_user_agent_header()
  jsii_get_property("attrDataSourceConfigurationWebConfigurationCrawlerConfigurationUserAgentHeader")
end

#attr_data_source_id ⇒ String

The unique identifier of the data source.

Returns:

  • (String) 


217
218
219
 
# File 'bedrock/cfn_data_source.rb', line 217

def attr_data_source_id()
  jsii_get_property("attrDataSourceId")
end

#attr_data_source_status ⇒ String

The status of the data source. The following statuses are possible:.

  • Available – The data source has been created and is ready for ingestion into the knowledge base.
  • Deleting – The data source is being deleted.

Returns:

  • (String) 


227
228
229
 
# File 'bedrock/cfn_data_source.rb', line 227

def attr_data_source_status()
  jsii_get_property("attrDataSourceStatus")
end

#attr_failure_reasons ⇒ Array<String>

The detailed reasons on the failure to delete a data source.

Returns:

  • (Array<String>) 


234
235
236
 
# File 'bedrock/cfn_data_source.rb', line 234

def attr_failure_reasons()
  jsii_get_property("attrFailureReasons")
end

#attr_updated_at ⇒ String

The time at which the data source was last updated.

Returns:

  • (String) 


241
242
243
 
# File 'bedrock/cfn_data_source.rb', line 241

def attr_updated_at()
  jsii_get_property("attrUpdatedAt")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



147
148
149
 
# File 'bedrock/cfn_data_source.rb', line 147

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


152
153
154
 
# File 'bedrock/cfn_data_source.rb', line 152

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


531
532
533
534
 
# File 'bedrock/cfn_data_source.rb', line 531

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


157
158
159
 
# File 'bedrock/cfn_data_source.rb', line 157

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


164
165
166
 
# File 'bedrock/cfn_data_source.rb', line 164

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


109
110
111
 
# File 'bedrock/cfn_data_source.rb', line 109

def creation_stack()
  jsii_get_property("creationStack")
end

#data_deletion_policy ⇒ String?

The data deletion policy for the data source.

Returns:

  • (String, nil) 


292
293
294
 
# File 'bedrock/cfn_data_source.rb', line 292

def data_deletion_policy()
  jsii_get_property("dataDeletionPolicy")
end

#data_deletion_policy=(value) ⇒ Object 



296
297
298
299
 
# File 'bedrock/cfn_data_source.rb', line 296

def data_deletion_policy=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dataDeletionPolicy") unless value.nil?
  jsii_set_property("dataDeletionPolicy", value)
end

#data_source_configuration ⇒ AWSCDK::IResolvable, AWSCDK::Bedrock::CfnDataSource::DataSourceConfigurationProperty

The connection configuration for the data source.

Returns:



255
256
257
 
# File 'bedrock/cfn_data_source.rb', line 255

def data_source_configuration()
  jsii_get_property("dataSourceConfiguration")
end

#data_source_configuration=(value) ⇒ Object 



259
260
261
262
263
 
# File 'bedrock/cfn_data_source.rb', line 259

def data_source_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Bedrock::CfnDataSource::DataSourceConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iZWRyb2NrLkNmbkRhdGFTb3VyY2UuRGF0YVNvdXJjZUNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "dataSourceConfiguration")
  jsii_set_property("dataSourceConfiguration", value)
end

#data_source_ref ⇒ AWSCDK::Interfaces::AWSBedrock::DataSourceReference

A reference to a DataSource resource.

Returns:



248
249
250
 
# File 'bedrock/cfn_data_source.rb', line 248

def data_source_ref()
  jsii_get_property("dataSourceRef")
end

#description ⇒ String?

The description of the data source.

Returns:

  • (String, nil) 


304
305
306
 
# File 'bedrock/cfn_data_source.rb', line 304

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



308
309
310
311
 
# File 'bedrock/cfn_data_source.rb', line 308

def description=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless value.nil?
  jsii_set_property("description", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



169
170
171
 
# File 'bedrock/cfn_data_source.rb', line 169

def env()
  jsii_get_property("env")
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



544
545
546
547
548
 
# File 'bedrock/cfn_data_source.rb', line 544

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



555
556
557
558
 
# File 'bedrock/cfn_data_source.rb', line 555

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



625
626
627
628
 
# File 'bedrock/cfn_data_source.rb', line 625

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#knowledge_base_id ⇒ String

The unique identifier of the knowledge base to which the data source belongs.

Returns:

  • (String) 


268
269
270
 
# File 'bedrock/cfn_data_source.rb', line 268

def knowledge_base_id()
  jsii_get_property("knowledgeBaseId")
end

#knowledge_base_id=(value) ⇒ Object 



272
273
274
275
 
# File 'bedrock/cfn_data_source.rb', line 272

def knowledge_base_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "knowledgeBaseId")
  jsii_set_property("knowledgeBaseId", value)
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


121
122
123
 
# File 'bedrock/cfn_data_source.rb', line 121

def logical_id()
  jsii_get_property("logicalId")
end

#name ⇒ String

The name of the data source.

Returns:

  • (String) 


280
281
282
 
# File 'bedrock/cfn_data_source.rb', line 280

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



284
285
286
287
 
# File 'bedrock/cfn_data_source.rb', line 284

def name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  jsii_set_property("name", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


104
105
106
 
# File 'bedrock/cfn_data_source.rb', line 104

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



566
567
568
 
# File 'bedrock/cfn_data_source.rb', line 566

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



573
574
575
 
# File 'bedrock/cfn_data_source.rb', line 573

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



366
367
368
369
 
# File 'bedrock/cfn_data_source.rb', line 366

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


140
141
142
 
# File 'bedrock/cfn_data_source.rb', line 140

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



584
585
586
587
 
# File 'bedrock/cfn_data_source.rb', line 584

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


591
592
593
594
 
# File 'bedrock/cfn_data_source.rb', line 591

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



601
602
603
604
605
 
# File 'bedrock/cfn_data_source.rb', line 601

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#server_side_encryption_configuration ⇒ AWSCDK::IResolvable, ...

Contains details about the configuration of the server-side encryption.

Returns:



316
317
318
 
# File 'bedrock/cfn_data_source.rb', line 316

def server_side_encryption_configuration()
  jsii_get_property("serverSideEncryptionConfiguration")
end

#server_side_encryption_configuration=(value) ⇒ Object 



320
321
322
323
324
 
# File 'bedrock/cfn_data_source.rb', line 320

def server_side_encryption_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Bedrock::CfnDataSource::ServerSideEncryptionConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iZWRyb2NrLkNmbkRhdGFTb3VyY2UuU2VydmVyU2lkZUVuY3J5cHRpb25Db25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "serverSideEncryptionConfiguration") unless value.nil?
  jsii_set_property("serverSideEncryptionConfiguration", value)
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



610
611
612
 
# File 'bedrock/cfn_data_source.rb', line 610

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



130
131
132
 
# File 'bedrock/cfn_data_source.rb', line 130

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



342
343
344
 
# File 'bedrock/cfn_data_source.rb', line 342

def to_string()
  jsii_call_method("toString", [])
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


177
178
179
 
# File 'bedrock/cfn_data_source.rb', line 177

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


187
188
189
 
# File 'bedrock/cfn_data_source.rb', line 187

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


616
617
618
619
 
# File 'bedrock/cfn_data_source.rb', line 616

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#vector_ingestion_configuration ⇒ AWSCDK::IResolvable, ...

Contains details about how to ingest the documents in the data source.

Returns:



329
330
331
 
# File 'bedrock/cfn_data_source.rb', line 329

def vector_ingestion_configuration()
  jsii_get_property("vectorIngestionConfiguration")
end

#vector_ingestion_configuration=(value) ⇒ Object 



333
334
335
336
337
 
# File 'bedrock/cfn_data_source.rb', line 333

def vector_ingestion_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::Bedrock::CfnDataSource::VectorIngestionConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iZWRyb2NrLkNmbkRhdGFTb3VyY2UuVmVjdG9ySW5nZXN0aW9uQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "vectorIngestionConfiguration") unless value.nil?
  jsii_set_property("vectorIngestionConfiguration", value)
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


355
356
357
358
359
360
 
# File 'bedrock/cfn_data_source.rb', line 355

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end