software.amazon.awscdk.services.amplifyuibuilder

Class CfnComponent

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.amplifyuibuilder.CfnComponent

All Implemented Interfaces:

IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.50.0 (build d1830a4)",
           date="2022-01-04T15:39:01.420Z")
 @Stability(value=Stable)
public class CfnComponent
extends CfnResource
implements IInspectable

A CloudFormation `AWS::AmplifyUIBuilder::Component`.

The AWS::AmplifyUIBuilder::Component resource specifies a component within an Amplify app. A component is a user interface (UI) element that you can customize. Use ComponentChild to configure an instance of a Component . A ComponentChild instance inherits the configuration of the main Component .

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.*;
 ComponentChildProperty componentChildProperty_;
 ComponentPropertyProperty componentPropertyProperty_;
 PredicateProperty predicateProperty_;
 CfnComponent cfnComponent = CfnComponent.Builder.create(this, "MyCfnComponent")
         .bindingProperties(Map.of(
                 "bindingPropertiesKey", ComponentBindingPropertiesValueProperty.builder()
                         .bindingProperties(ComponentBindingPropertiesValuePropertiesProperty.builder()
                                 .bucket("bucket")
                                 .defaultValue("defaultValue")
                                 .field("field")
                                 .key("key")
                                 .model("model")
                                 .predicates(List.of(PredicateProperty.builder()
                                         .and(List.of(predicateProperty_))
                                         .field("field")
                                         .operand("operand")
                                         .operator("operator")
                                         .or(List.of(predicateProperty_))
                                         .build()))
                                 .userAttribute("userAttribute")
                                 .build())
                         .defaultValue("defaultValue")
                         .type("type")
                         .build()))
         .children(List.of(ComponentChildProperty.builder()
                 .componentType("componentType")
                 .name("name")
                 .properties(ComponentPropertiesProperty.builder().build())
                 // the properties below are optional
                 .children(List.of(componentChildProperty_))
                 .build()))
         .collectionProperties(Map.of(
                 "collectionPropertiesKey", ComponentDataConfigurationProperty.builder()
                         .model("model")
                         // the properties below are optional
                         .identifiers(List.of("identifiers"))
                         .predicate(PredicateProperty.builder()
                                 .and(List.of(predicateProperty_))
                                 .field("field")
                                 .operand("operand")
                                 .operator("operator")
                                 .or(List.of(predicateProperty_))
                                 .build())
                         .sort(List.of(SortPropertyProperty.builder()
                                 .direction("direction")
                                 .field("field")
                                 .build()))
                         .build()))
         .componentType("componentType")
         .name("name")
         .overrides(Map.of(
                 "overridesKey", ComponentOverridesValueProperty.builder().build()))
         .properties(Map.of(
                 "propertiesKey", ComponentPropertyProperty.builder()
                         .bindingProperties(ComponentPropertyBindingPropertiesProperty.builder()
                                 .property("property")
                                 // the properties below are optional
                                 .field("field")
                                 .build())
                         .bindings(FormBindingsProperty.builder().build())
                         .collectionBindingProperties(ComponentPropertyBindingPropertiesProperty.builder()
                                 .property("property")
                                 // the properties below are optional
                                 .field("field")
                                 .build())
                         .concat(List.of(componentPropertyProperty_))
                         .condition(ComponentConditionPropertyProperty.builder()
                                 .else(componentPropertyProperty_)
                                 .field("field")
                                 .operand("operand")
                                 .operator("operator")
                                 .property("property")
                                 .then(componentPropertyProperty_)
                                 .build())
                         .configured(false)
                         .defaultValue("defaultValue")
                         .event("event")
                         .importedValue("importedValue")
                         .model("model")
                         .type("type")
                         .userAttribute("userAttribute")
                         .value("value")
                         .build()))
         .sourceId("sourceId")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .variants(List.of(ComponentVariantProperty.builder()
                 .overrides(ComponentOverridesProperty.builder().build())
                 .variantValues(ComponentVariantValuesProperty.builder().build())
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnComponent.Builder A fluent builder for CfnComponent.
static interface	CfnComponent.ComponentBindingPropertiesValuePropertiesProperty The `ComponentBindingPropertiesValueProperties` property specifies the data binding configuration for a specific property using data stored in AWS .
static interface	CfnComponent.ComponentBindingPropertiesValueProperty The `ComponentBindingPropertiesValue` property specifies the data binding configuration for a component at runtime.
static interface	CfnComponent.ComponentChildProperty The `ComponentChild` property specifies a nested UI configuration within a parent `Component` .
static interface	CfnComponent.ComponentConditionPropertyProperty The `ComponentConditionProperty` property specifies a conditional expression for setting a component property.
static interface	CfnComponent.ComponentDataConfigurationProperty The `ComponentDataConfiguration` property specifies the configuration for binding a component's properties to data.
static interface	CfnComponent.ComponentOverridesProperty The `ComponentOverrides` property specifies the component's properties that can be overriden in a customized instance of the component.
static interface	CfnComponent.ComponentOverridesValueProperty The `ComponentOverridesValue` property specifies the value of the component's properties that can be overriden in a customized instance of the component.
static interface	CfnComponent.ComponentPropertiesProperty The `ComponentProperties` property specifies the component's properties.
static interface	CfnComponent.ComponentPropertyBindingPropertiesProperty The `ComponentPropertyBindingProperties` property specifies a component property to associate with a binding property.
static interface	CfnComponent.ComponentPropertyProperty The `ComponentProperty` property specifies the configuration for all of a component's properties.
static interface	CfnComponent.ComponentVariantProperty The `ComponentVariant` property specifies the style configuration of a unique variation of a main component.
static interface	CfnComponent.ComponentVariantValuesProperty The `ComponentVariantValues` property specifies the combination of variants that comprise a `ComponentVariant` .
static interface	CfnComponent.FormBindingsProperty The `FormBindings` property specifies how to bind a component's properties to form data.
static interface	CfnComponent.PredicateProperty The `Predicate` property specifies information for generating Amplify DataStore queries.
static interface	CfnComponent.SortPropertyProperty The `SortProperty` property specifies how to sort the data that you bind to a component.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnComponent(Construct scope, String id) Create a new `AWS::AmplifyUIBuilder::Component`.
	CfnComponent(Construct scope, String id, CfnComponentProps props) Create a new `AWS::AmplifyUIBuilder::Component`.
protected	CfnComponent(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnComponent(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrAppId() The unique ID for the Amplify app.
String	getAttrCreatedAt() The time that the component was created.
String	getAttrEnvironmentName() The name of the backend environment that is a part of the Amplify app.
String	getAttrId() The unique ID of the component.
String	getAttrModifiedAt() The time that the component was modified.
Object	getBindingProperties() The information to connect a component's properties to data at runtime.
protected Map<String,Object>	getCfnProperties()
Object	getChildren() A list of the component's `ComponentChild` instances.
Object	getCollectionProperties() The data binding configuration for the component's properties.
String	getComponentType() The type of the component.
String	getName() The name of the component.
Object	getOverrides() Describes the component's properties that can be overriden in a customized instance of the component.
Object	getProperties() Describes the component's properties.
String	getSourceId() The unique ID of the component in its original source system, such as Figma.
TagManager	getTags() One or more key-value pairs to use when tagging the component.
Object	getVariants() A list of the component's variants.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setBindingProperties(IResolvable value) The information to connect a component's properties to data at runtime.
void	setBindingProperties(Map<String,Object> value) The information to connect a component's properties to data at runtime.
void	setChildren(IResolvable value) A list of the component's `ComponentChild` instances.
void	setChildren(List<Object> value) A list of the component's `ComponentChild` instances.
void	setCollectionProperties(IResolvable value) The data binding configuration for the component's properties.
void	setCollectionProperties(Map<String,Object> value) The data binding configuration for the component's properties.
void	setComponentType(String value) The type of the component.
void	setName(String value) The name of the component.
void	setOverrides(IResolvable value) Describes the component's properties that can be overriden in a customized instance of the component.
void	setOverrides(Map<String,Object> value) Describes the component's properties that can be overriden in a customized instance of the component.
void	setProperties(IResolvable value) Describes the component's properties.
void	setProperties(Map<String,Object> value) Describes the component's properties.
void	setSourceId(String value) The unique ID of the component in its original source system, such as Figma.
void	setVariants(IResolvable value) A list of the component's variants.
void	setVariants(List<Object> value) A list of the component's variants.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnComponent

protected CfnComponent(software.amazon.jsii.JsiiObjectRef objRef)

CfnComponent

protected CfnComponent(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnComponent

@Stability(value=Stable)
public CfnComponent(@NotNull
                                             Construct scope,
                                             @NotNull
                                             String id,
                                             @Nullable
                                             CfnComponentProps props)

Create a new `AWS::AmplifyUIBuilder::Component`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties.

CfnComponent

@Stability(value=Stable)
public CfnComponent(@NotNull
                                             Construct scope,
                                             @NotNull
                                             String id)

Create a new `AWS::AmplifyUIBuilder::Component`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrAppId

@Stability(value=Stable)
 @NotNull
public String getAttrAppId()

The unique ID for the Amplify app.

getAttrCreatedAt

@Stability(value=Stable)
 @NotNull
public String getAttrCreatedAt()

The time that the component was created.

getAttrEnvironmentName

@Stability(value=Stable)
 @NotNull
public String getAttrEnvironmentName()

The name of the backend environment that is a part of the Amplify app.

getAttrId

@Stability(value=Stable)
 @NotNull
public String getAttrId()

The unique ID of the component.

getAttrModifiedAt

@Stability(value=Stable)
 @NotNull
public String getAttrModifiedAt()

The time that the component was modified.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

One or more key-value pairs to use when tagging the component.

getBindingProperties

@Stability(value=Stable)
 @Nullable
public Object getBindingProperties()

The information to connect a component's properties to data at runtime.

setBindingProperties

@Stability(value=Stable)
public void setBindingProperties(@Nullable
                                                          IResolvable value)

The information to connect a component's properties to data at runtime.

setBindingProperties

@Stability(value=Stable)
public void setBindingProperties(@Nullable
                                                          Map<String,Object> value)

The information to connect a component's properties to data at runtime.

getChildren

@Stability(value=Stable)
 @Nullable
public Object getChildren()

A list of the component's `ComponentChild` instances.

setChildren

@Stability(value=Stable)
public void setChildren(@Nullable
                                                 IResolvable value)

A list of the component's `ComponentChild` instances.

setChildren

@Stability(value=Stable)
public void setChildren(@Nullable
                                                 List<Object> value)

A list of the component's `ComponentChild` instances.

getCollectionProperties

@Stability(value=Stable)
 @Nullable
public Object getCollectionProperties()

The data binding configuration for the component's properties.

Use this for a collection component.

setCollectionProperties

@Stability(value=Stable)
public void setCollectionProperties(@Nullable
                                                             IResolvable value)

The data binding configuration for the component's properties.

Use this for a collection component.

setCollectionProperties

@Stability(value=Stable)
public void setCollectionProperties(@Nullable
                                                             Map<String,Object> value)

The data binding configuration for the component's properties.

Use this for a collection component.

getComponentType

@Stability(value=Stable)
 @Nullable
public String getComponentType()

The type of the component.

This can be an Amplify custom UI component or another custom component.

setComponentType

@Stability(value=Stable)
public void setComponentType(@Nullable
                                                      String value)

The type of the component.

This can be an Amplify custom UI component or another custom component.

getName

@Stability(value=Stable)
 @Nullable
public String getName()

The name of the component.

setName

@Stability(value=Stable)
public void setName(@Nullable
                                             String value)

The name of the component.

getOverrides

@Stability(value=Stable)
 @Nullable
public Object getOverrides()

Describes the component's properties that can be overriden in a customized instance of the component.

setOverrides

@Stability(value=Stable)
public void setOverrides(@Nullable
                                                  IResolvable value)

Describes the component's properties that can be overriden in a customized instance of the component.

setOverrides

@Stability(value=Stable)
public void setOverrides(@Nullable
                                                  Map<String,Object> value)

Describes the component's properties that can be overriden in a customized instance of the component.

getProperties

@Stability(value=Stable)
 @Nullable
public Object getProperties()

Describes the component's properties.

setProperties

@Stability(value=Stable)
public void setProperties(@Nullable
                                                   IResolvable value)

Describes the component's properties.

setProperties

@Stability(value=Stable)
public void setProperties(@Nullable
                                                   Map<String,Object> value)

Describes the component's properties.

getSourceId

@Stability(value=Stable)
 @Nullable
public String getSourceId()

The unique ID of the component in its original source system, such as Figma.

setSourceId

@Stability(value=Stable)
public void setSourceId(@Nullable
                                                 String value)

The unique ID of the component in its original source system, such as Figma.

getVariants

@Stability(value=Stable)
 @Nullable
public Object getVariants()

A list of the component's variants.

A variant is a unique style configuration of a main component.

setVariants

@Stability(value=Stable)
public void setVariants(@Nullable
                                                 IResolvable value)

A list of the component's variants.

A variant is a unique style configuration of a main component.

setVariants

@Stability(value=Stable)
public void setVariants(@Nullable
                                                 List<Object> value)

A list of the component's variants.

A variant is a unique style configuration of a main component.