Package software.amazon.awscdk.services.amplifyuibuilder

Interface CfnComponent.ComponentPropertyProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnComponent.ComponentPropertyProperty.Jsii$Proxy

Enclosing class:

CfnComponent

@Stability(Stable)
public static interface CfnComponent.ComponentPropertyProperty
extends software.amazon.jsii.JsiiSerializable

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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.amplifyuibuilder.*;
 ComponentPropertyProperty componentPropertyProperty_;
 ComponentPropertyProperty componentPropertyProperty = ComponentPropertyProperty.builder()
         .bindingProperties(ComponentPropertyBindingPropertiesProperty.builder()
                 .property("property")
                 // the properties below are optional
                 .field("field")
                 .build())
         .bindings(Map.of(
                 "bindingsKey", FormBindingElementProperty.builder()
                         .element("element")
                         .property("property")
                         .build()))
         .collectionBindingProperties(ComponentPropertyBindingPropertiesProperty.builder()
                 .property("property")
                 // the properties below are optional
                 .field("field")
                 .build())
         .componentName("componentName")
         .concat(List.of(componentPropertyProperty_))
         .condition(ComponentConditionPropertyProperty.builder()
                 .else(componentPropertyProperty_)
                 .field("field")
                 .operand("operand")
                 .operandType("operandType")
                 .operator("operator")
                 .property("property")
                 .then(componentPropertyProperty_)
                 .build())
         .configured(false)
         .defaultValue("defaultValue")
         .event("event")
         .importedValue("importedValue")
         .model("model")
         .property("property")
         .type("type")
         .userAttribute("userAttribute")
         .value("value")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnComponent.ComponentPropertyProperty.Builder	A builder for CfnComponent.ComponentPropertyProperty
static final class	CfnComponent.ComponentPropertyProperty.Jsii$Proxy	An implementation for CfnComponent.ComponentPropertyProperty

Method Summary

Modifier and Type	Method	Description
static CfnComponent.ComponentPropertyProperty.Builder	builder()
default Object	getBindingProperties()	The information to bind the component property to data at runtime.
default Object	getBindings()	The information to bind the component property to form data.
default Object	getCollectionBindingProperties()	The information to bind the component property to data at runtime.
default String	getComponentName()	The name of the component that is affected by an event.
default Object	getConcat()	A list of component properties to concatenate to create the value to assign to this component property.
default Object	getCondition()	The conditional expression to use to assign a value to the component property.
default Object	getConfigured()	Specifies whether the user configured the property in Amplify Studio after importing it.
default String	getDefaultValue()	The default value to assign to the component property.
default String	getEvent()	An event that occurs in your app.
default String	getImportedValue()	The default value assigned to the property when the component is imported into an app.
default String	getModel()	The data model to use to assign a value to the component property.
default String	getProperty()	The name of the component's property that is affected by an event.
default String	getType()	The component type.
default String	getUserAttribute()	An authenticated user attribute to use to assign a value to the component property.
default String	getValue()	The value to assign to the component property.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBindingProperties

@Stability(Stable)
@Nullable
default Object getBindingProperties()

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

Returns union: either IResolvable or CfnComponent.ComponentPropertyBindingPropertiesProperty

See Also:

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

getBindings

@Stability(Stable)
@Nullable
default Object getBindings()

The information to bind the component property to form data.

Returns union: either IResolvable or Mapinvalid input: '<'String, either IResolvable or CfnComponent.FormBindingElementProperty>

See Also:

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

getCollectionBindingProperties

@Stability(Stable)
@Nullable
default Object getCollectionBindingProperties()

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

Use this for collection components.

Returns union: either IResolvable or CfnComponent.ComponentPropertyBindingPropertiesProperty

See Also:

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

getComponentName

@Stability(Stable)
@Nullable
default String getComponentName()

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

See Also:

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

getConcat

@Stability(Stable)
@Nullable
default Object getConcat()

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

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnComponent.ComponentPropertyProperty>

See Also:

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

getCondition

@Stability(Stable)
@Nullable
default Object getCondition()

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

Returns union: either IResolvable or CfnComponent.ComponentConditionPropertyProperty

See Also:

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

getConfigured

@Stability(Stable)
@Nullable
default Object getConfigured()

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

Returns union: either Boolean or IResolvable

See Also:

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

getDefaultValue

@Stability(Stable)
@Nullable
default String getDefaultValue()

The default value to assign to the component property.

See Also:

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

getEvent

@Stability(Stable)
@Nullable
default String getEvent()

An event that occurs in your app.

Use this for workflow data binding.

See Also:

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

getImportedValue

@Stability(Stable)
@Nullable
default String getImportedValue()

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

See Also:

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

getModel

@Stability(Stable)
@Nullable
default String getModel()

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

See Also:

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

getProperty

@Stability(Stable)
@Nullable
default String getProperty()

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

See Also:

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

getType

@Stability(Stable)
@Nullable
default String getType()

The component type.

See Also:

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

getUserAttribute

@Stability(Stable)
@Nullable
default String getUserAttribute()

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

See Also:

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

getValue

@Stability(Stable)
@Nullable
default String getValue()

The value to assign to the component property.

See Also:

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

builder

@Stability(Stable)
static CfnComponent.ComponentPropertyProperty.Builder builder()

Returns:

a CfnComponent.ComponentPropertyProperty.Builder of CfnComponent.ComponentPropertyProperty