Class: AWSCDK::AmplifyUIBuilder::CfnComponent::ComponentPropertyProperty

Inherits:

Jsii::Struct

Object
Jsii::Struct
AWSCDK::AmplifyUIBuilder::CfnComponent::ComponentPropertyProperty

show all

Defined in:: amplify_ui_builder/cfn_component.rb

Overview

The ComponentProperty property specifies the configuration for all of a component's properties.

Use ComponentProperty to specify the values to render or bind by default.

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html

Instance Attribute Summary collapse

#binding_properties ⇒ AWSCDK::IResolvable, ... readonly
The information to bind the component property to data at runtime.
#bindings ⇒ AWSCDK::IResolvable, ... readonly
The information to bind the component property to form data.
#collection_binding_properties ⇒ AWSCDK::IResolvable, ... readonly
The information to bind the component property to data at runtime.
#component_name ⇒ String^? readonly
The name of the component that is affected by an event.
#concat ⇒ AWSCDK::IResolvable, ... readonly
A list of component properties to concatenate to create the value to assign to this component property.
#condition ⇒ AWSCDK::IResolvable, ... readonly
The conditional expression to use to assign a value to the component property.
#configured ⇒ Boolean, ... readonly
Specifies whether the user configured the property in Amplify Studio after importing it.
#default_value ⇒ String^? readonly
The default value to assign to the component property.
#event ⇒ String^? readonly
An event that occurs in your app.
#imported_value ⇒ String^? readonly
The default value assigned to the property when the component is imported into an app.
#model ⇒ String^? readonly
The data model to use to assign a value to the component property.
#property ⇒ String^? readonly
The name of the component's property that is affected by an event.
#type ⇒ String^? readonly
The component type.
#user_attribute ⇒ String^? readonly
An authenticated user attribute to use to assign a value to the component property.
#value ⇒ String^? readonly
The value to assign to the component property.

Class Method Summary collapse

.jsii_properties ⇒ Object

Instance Method Summary collapse

#initialize(binding_properties: nil, bindings: nil, collection_binding_properties: nil, component_name: nil, concat: nil, condition: nil, configured: nil, default_value: nil, event: nil, imported_value: nil, model: nil, property: nil, type: nil, user_attribute: nil, value: nil) ⇒ ComponentPropertyProperty constructor
A new instance of ComponentPropertyProperty.
#to_jsii ⇒ Object

Constructor Details

#initialize(binding_properties: nil, bindings: nil, collection_binding_properties: nil, component_name: nil, concat: nil, condition: nil, configured: nil, default_value: nil, event: nil, imported_value: nil, model: nil, property: nil, type: nil, user_attribute: nil, value: nil) ⇒ `ComponentPropertyProperty`

Returns a new instance of ComponentPropertyProperty.

Parameters:

binding_properties (AWSCDK::IResolvable, AWSCDK::AmplifyUIBuilder::CfnComponent::ComponentPropertyBindingPropertiesProperty, nil) (defaults to: nil) —
The information to bind the component property to data at runtime.
bindings (AWSCDK::IResolvable, Hash{String => AWSCDK::IResolvable, AWSCDK::AmplifyUIBuilder::CfnComponent::FormBindingElementProperty}, nil) (defaults to: nil) —
The information to bind the component property to form data.
collection_binding_properties (AWSCDK::IResolvable, AWSCDK::AmplifyUIBuilder::CfnComponent::ComponentPropertyBindingPropertiesProperty, nil) (defaults to: nil) —
The information to bind the component property to data at runtime.
component_name (String, nil) (defaults to: nil) —
The name of the component that is affected by an event.
concat (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::AmplifyUIBuilder::CfnComponent::ComponentPropertyProperty>, nil) (defaults to: nil) —
A list of component properties to concatenate to create the value to assign to this component property.
condition (AWSCDK::IResolvable, AWSCDK::AmplifyUIBuilder::CfnComponent::ComponentConditionPropertyProperty, nil) (defaults to: nil) —
The conditional expression to use to assign a value to the component property.
configured (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —
Specifies whether the user configured the property in Amplify Studio after importing it.
default_value (String, nil) (defaults to: nil) —
The default value to assign to the component property.
event (String, nil) (defaults to: nil) —
An event that occurs in your app.
imported_value (String, nil) (defaults to: nil) —
The default value assigned to the property when the component is imported into an app.
model (String, nil) (defaults to: nil) —
The data model to use to assign a value to the component property.
property (String, nil) (defaults to: nil) —
The name of the component's property that is affected by an event.
type (String, nil) (defaults to: nil) —
The component type.
user_attribute (String, nil) (defaults to: nil) —
An authenticated user attribute to use to assign a value to the component property.
value (String, nil) (defaults to: nil) —
The value to assign to the component property.

# File 'amplify_ui_builder/cfn_component.rb', line 1352

def initialize(binding_properties: nil, bindings: nil, collection_binding_properties: nil, component_name: nil, concat: nil, condition: nil, configured: nil, default_value: nil, event: nil, imported_value: nil, model: nil, property: nil, type: nil, user_attribute: nil, value: nil)
  @binding_properties = binding_properties.is_a?(Hash) ? ::AWSCDK::AmplifyUIBuilder::CfnComponent::ComponentPropertyBindingPropertiesProperty.new(**binding_properties.transform_keys(&:to_sym)) : binding_properties
  Jsii::Type.check_type(@binding_properties, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hbXBsaWZ5dWlidWlsZGVyLkNmbkNvbXBvbmVudC5Db21wb25lbnRQcm9wZXJ0eUJpbmRpbmdQcm9wZXJ0aWVzUHJvcGVydHkifV19fQ==")), "bindingProperties") unless @binding_properties.nil?
  @bindings = bindings
  Jsii::Type.check_type(@bindings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYW1wbGlmeXVpYnVpbGRlci5DZm5Db21wb25lbnQuRm9ybUJpbmRpbmdFbGVtZW50UHJvcGVydHkifV19fSwia2luZCI6Im1hcCJ9fV19fQ==")), "bindings") unless @bindings.nil?
  @collection_binding_properties = collection_binding_properties.is_a?(Hash) ? ::AWSCDK::AmplifyUIBuilder::CfnComponent::ComponentPropertyBindingPropertiesProperty.new(**collection_binding_properties.transform_keys(&:to_sym)) : collection_binding_properties
  Jsii::Type.check_type(@collection_binding_properties, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hbXBsaWZ5dWlidWlsZGVyLkNmbkNvbXBvbmVudC5Db21wb25lbnRQcm9wZXJ0eUJpbmRpbmdQcm9wZXJ0aWVzUHJvcGVydHkifV19fQ==")), "collectionBindingProperties") unless @collection_binding_properties.nil?
  @component_name = component_name
  Jsii::Type.check_type(@component_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "componentName") unless @component_name.nil?
  @concat = concat
  Jsii::Type.check_type(@concat, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYW1wbGlmeXVpYnVpbGRlci5DZm5Db21wb25lbnQuQ29tcG9uZW50UHJvcGVydHlQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "concat") unless @concat.nil?
  @condition = condition.is_a?(Hash) ? ::AWSCDK::AmplifyUIBuilder::CfnComponent::ComponentConditionPropertyProperty.new(**condition.transform_keys(&:to_sym)) : condition
  Jsii::Type.check_type(@condition, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hbXBsaWZ5dWlidWlsZGVyLkNmbkNvbXBvbmVudC5Db21wb25lbnRDb25kaXRpb25Qcm9wZXJ0eVByb3BlcnR5In1dfX0=")), "condition") unless @condition.nil?
  @configured = configured
  Jsii::Type.check_type(@configured, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "configured") unless @configured.nil?
  @default_value = default_value
  Jsii::Type.check_type(@default_value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "defaultValue") unless @default_value.nil?
  @event = event
  Jsii::Type.check_type(@event, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "event") unless @event.nil?
  @imported_value = imported_value
  Jsii::Type.check_type(@imported_value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "importedValue") unless @imported_value.nil?
  @model = model
  Jsii::Type.check_type(@model, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "model") unless @model.nil?
  @property = property
  Jsii::Type.check_type(@property, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "property") unless @property.nil?
  @type = type
  Jsii::Type.check_type(@type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type") unless @type.nil?
  @user_attribute = user_attribute
  Jsii::Type.check_type(@user_attribute, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "userAttribute") unless @user_attribute.nil?
  @value = value
  Jsii::Type.check_type(@value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "value") unless @value.nil?
end

Instance Attribute Details

#binding_properties ⇒ `AWSCDK::IResolvable`, ... (readonly)

The information to bind the component property to data at runtime.

Returns:

(AWSCDK::IResolvable, AWSCDK::AmplifyUIBuilder::CfnComponent::ComponentPropertyBindingPropertiesProperty, nil)

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html#cfn-amplifyuibuilder-component-componentproperty-bindingproperties



1389
1390
1391

# File 'amplify_ui_builder/cfn_component.rb', line 1389

def binding_properties
  @binding_properties
end

#bindings ⇒ `AWSCDK::IResolvable`, ... (readonly)

The information to bind the component property to form data.

Returns:

(AWSCDK::IResolvable, Hash{String => AWSCDK::IResolvable, AWSCDK::AmplifyUIBuilder::CfnComponent::FormBindingElementProperty}, nil)

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html#cfn-amplifyuibuilder-component-componentproperty-bindings



1394
1395
1396

# File 'amplify_ui_builder/cfn_component.rb', line 1394

def bindings
  @bindings
end

#collection_binding_properties ⇒ `AWSCDK::IResolvable`, ... (readonly)

The information to bind the component property to data at runtime.

Use this for collection components.

Returns:

(AWSCDK::IResolvable, AWSCDK::AmplifyUIBuilder::CfnComponent::ComponentPropertyBindingPropertiesProperty, nil)

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html#cfn-amplifyuibuilder-component-componentproperty-collectionbindingproperties



1401
1402
1403

# File 'amplify_ui_builder/cfn_component.rb', line 1401

def collection_binding_properties
  @collection_binding_properties
end

#component_name ⇒ `String`^? (readonly)

The name of the component that is affected by an event.

Returns:

(String, nil)

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html#cfn-amplifyuibuilder-component-componentproperty-componentname



1406
1407
1408

# File 'amplify_ui_builder/cfn_component.rb', line 1406

def component_name
  @component_name
end

#concat ⇒ `AWSCDK::IResolvable`, ... (readonly)

A list of component properties to concatenate to create the value to assign to this component property.

Returns:

(AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::AmplifyUIBuilder::CfnComponent::ComponentPropertyProperty>, nil)

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html#cfn-amplifyuibuilder-component-componentproperty-concat



1411
1412
1413

# File 'amplify_ui_builder/cfn_component.rb', line 1411

def concat
  @concat
end

#condition ⇒ `AWSCDK::IResolvable`, ... (readonly)

The conditional expression to use to assign a value to the component property.

Returns:

(AWSCDK::IResolvable, AWSCDK::AmplifyUIBuilder::CfnComponent::ComponentConditionPropertyProperty, nil)

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html#cfn-amplifyuibuilder-component-componentproperty-condition



1416
1417
1418

# File 'amplify_ui_builder/cfn_component.rb', line 1416

def condition
  @condition
end

#configured ⇒ `Boolean`, ... (readonly)

Specifies whether the user configured the property in Amplify Studio after importing it.

Returns:

(Boolean, AWSCDK::IResolvable, nil)

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html#cfn-amplifyuibuilder-component-componentproperty-configured



1421
1422
1423

# File 'amplify_ui_builder/cfn_component.rb', line 1421

def configured
  @configured
end

#default_value ⇒ `String`^? (readonly)

The default value to assign to the component property.

Returns:

(String, nil)

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html#cfn-amplifyuibuilder-component-componentproperty-defaultvalue



1426
1427
1428

# File 'amplify_ui_builder/cfn_component.rb', line 1426

def default_value
  @default_value
end

#event ⇒ `String`^? (readonly)

An event that occurs in your app.

Use this for workflow data binding.

Returns:

(String, nil)

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html#cfn-amplifyuibuilder-component-componentproperty-event



1433
1434
1435

# File 'amplify_ui_builder/cfn_component.rb', line 1433

def event
  @event
end

#imported_value ⇒ `String`^? (readonly)

The default value assigned to the property when the component is imported into an app.

Returns:

(String, nil)

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html#cfn-amplifyuibuilder-component-componentproperty-importedvalue



1438
1439
1440

# File 'amplify_ui_builder/cfn_component.rb', line 1438

def imported_value
  @imported_value
end

#model ⇒ `String`^? (readonly)

The data model to use to assign a value to the component property.

Returns:

(String, nil)

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html#cfn-amplifyuibuilder-component-componentproperty-model



1443
1444
1445

# File 'amplify_ui_builder/cfn_component.rb', line 1443

def model
  @model
end

#property ⇒ `String`^? (readonly)

The name of the component's property that is affected by an event.

Returns:

(String, nil)

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html#cfn-amplifyuibuilder-component-componentproperty-property



1448
1449
1450

# File 'amplify_ui_builder/cfn_component.rb', line 1448

def property
  @property
end

#type ⇒ `String`^? (readonly)

The component type.

Returns:

(String, nil)

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html#cfn-amplifyuibuilder-component-componentproperty-type



1453
1454
1455

# File 'amplify_ui_builder/cfn_component.rb', line 1453

def type
  @type
end

#user_attribute ⇒ `String`^? (readonly)

An authenticated user attribute to use to assign a value to the component property.

Returns:

(String, nil)

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html#cfn-amplifyuibuilder-component-componentproperty-userattribute



1458
1459
1460

# File 'amplify_ui_builder/cfn_component.rb', line 1458

def user_attribute
  @user_attribute
end

#value ⇒ `String`^? (readonly)

The value to assign to the component property.

Returns:

(String, nil)

See Also:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html#cfn-amplifyuibuilder-component-componentproperty-value



1463
1464
1465

# File 'amplify_ui_builder/cfn_component.rb', line 1463

def value
  @value
end

Class Method Details

.jsii_properties ⇒ `Object`

# File 'amplify_ui_builder/cfn_component.rb', line 1465

def self.jsii_properties
  {
    :binding_properties => "bindingProperties",
    :bindings => "bindings",
    :collection_binding_properties => "collectionBindingProperties",
    :component_name => "componentName",
    :concat => "concat",
    :condition => "condition",
    :configured => "configured",
    :default_value => "defaultValue",
    :event => "event",
    :imported_value => "importedValue",
    :model => "model",
    :property => "property",
    :type => "type",
    :user_attribute => "userAttribute",
    :value => "value",
  }
end

Instance Method Details

#to_jsii ⇒ `Object`

# File 'amplify_ui_builder/cfn_component.rb', line 1485

def to_jsii
  result = {}
  result.merge!({
    "bindingProperties" => @binding_properties,
    "bindings" => @bindings,
    "collectionBindingProperties" => @collection_binding_properties,
    "componentName" => @component_name,
    "concat" => @concat,
    "condition" => @condition,
    "configured" => @configured,
    "defaultValue" => @default_value,
    "event" => @event,
    "importedValue" => @imported_value,
    "model" => @model,
    "property" => @property,
    "type" => @type,
    "userAttribute" => @user_attribute,
    "value" => @value,
  })
  result.compact
end

Class: AWSCDK::AmplifyUIBuilder::CfnComponent::ComponentPropertyProperty

Overview

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

Instance Attribute Details

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

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

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

#component_name ⇒ String? (readonly)

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

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

#configured ⇒ Boolean, ... (readonly)

#default_value ⇒ String? (readonly)

#event ⇒ String? (readonly)

#imported_value ⇒ String? (readonly)

#model ⇒ String? (readonly)

#property ⇒ String? (readonly)

#type ⇒ String? (readonly)

#user_attribute ⇒ String? (readonly)

#value ⇒ String? (readonly)

Class Method Details

.jsii_properties ⇒ Object

Instance Method Details

#to_jsii ⇒ Object

#binding_properties ⇒ `AWSCDK::IResolvable`, ... (readonly)

#bindings ⇒ `AWSCDK::IResolvable`, ... (readonly)

#collection_binding_properties ⇒ `AWSCDK::IResolvable`, ... (readonly)

#component_name ⇒ `String`^? (readonly)

#concat ⇒ `AWSCDK::IResolvable`, ... (readonly)

#condition ⇒ `AWSCDK::IResolvable`, ... (readonly)

#configured ⇒ `Boolean`, ... (readonly)

#default_value ⇒ `String`^? (readonly)

#event ⇒ `String`^? (readonly)

#imported_value ⇒ `String`^? (readonly)

#model ⇒ `String`^? (readonly)

#property ⇒ `String`^? (readonly)

#type ⇒ `String`^? (readonly)

#user_attribute ⇒ `String`^? (readonly)

#value ⇒ `String`^? (readonly)

.jsii_properties ⇒ `Object`

#to_jsii ⇒ `Object`