Class: AWSCDK::AmplifyUIBuilder::CfnComponent::ComponentDataConfigurationProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
amplify_ui_builder/cfn_component.rb

Overview

The ComponentDataConfiguration property specifies the configuration for binding a component's properties to data.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(model:, identifiers: nil, predicate: nil, sort: nil) ⇒ ComponentDataConfigurationProperty

Returns a new instance of ComponentDataConfigurationProperty.

Parameters:



1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
 
# File 'amplify_ui_builder/cfn_component.rb', line 1170

def initialize(model:, identifiers: nil, predicate: nil, sort: nil)
  @model = model
  Jsii::Type.check_type(@model, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "model")
  @identifiers = identifiers
  Jsii::Type.check_type(@identifiers, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "identifiers") unless @identifiers.nil?
  @predicate = predicate.is_a?(Hash) ? ::AWSCDK::AmplifyUIBuilder::CfnComponent::PredicateProperty.new(**predicate.transform_keys(&:to_sym)) : predicate
  Jsii::Type.check_type(@predicate, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hbXBsaWZ5dWlidWlsZGVyLkNmbkNvbXBvbmVudC5QcmVkaWNhdGVQcm9wZXJ0eSJ9XX19")), "predicate") unless @predicate.nil?
  @sort = sort
  Jsii::Type.check_type(@sort, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYW1wbGlmeXVpYnVpbGRlci5DZm5Db21wb25lbnQuU29ydFByb3BlcnR5UHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "sort") unless @sort.nil?
end

Instance Attribute Details

#identifiers ⇒ Array<String>? (readonly)

A list of IDs to use to bind data to a component.

Use this property to bind specifically chosen data, rather than data retrieved from a query.

Returns:

  • (Array<String>, nil)

See Also:



1192
1193
1194
 
# File 'amplify_ui_builder/cfn_component.rb', line 1192

def identifiers
  @identifiers
end

#model ⇒ String (readonly)

The name of the data model to use to bind data to a component.

Returns:

  • (String)

See Also:



1185
1186
1187
 
# File 'amplify_ui_builder/cfn_component.rb', line 1185

def model
  @model
end

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

Represents the conditional logic to use when binding data to a component.

Use this property to retrieve only a subset of the data in a collection.

Returns:

See Also:



1199
1200
1201
 
# File 'amplify_ui_builder/cfn_component.rb', line 1199

def predicate
  @predicate
end

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

Describes how to sort the component's properties.

Returns:

See Also:



1204
1205
1206
 
# File 'amplify_ui_builder/cfn_component.rb', line 1204

def sort
  @sort
end

Class Method Details

.jsii_properties ⇒ Object 



1206
1207
1208
1209
1210
1211
1212
1213
 
# File 'amplify_ui_builder/cfn_component.rb', line 1206

def self.jsii_properties
  {
    :model => "model",
    :identifiers => "identifiers",
    :predicate => "predicate",
    :sort => "sort",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
 
# File 'amplify_ui_builder/cfn_component.rb', line 1215

def to_jsii
  result = {}
  result.merge!({
    "model" => @model,
    "identifiers" => @identifiers,
    "predicate" => @predicate,
    "sort" => @sort,
  })
  result.compact
end