Package software.amazon.awscdk.services.amplifyuibuilder

Class CfnComponent

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.amplifyuibuilder.CfnComponent
All Implemented Interfaces:
IInspectable, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)", date="2024-07-12T19:33:56.569Z") @Stability(Stable) public class CfnComponent extends CfnResource implements IInspectable, ITaggable
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:

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnComponent

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

    • CfnComponent

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

    • CfnComponent

      @Stability(Stable) public CfnComponent(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnComponentProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties.

    • CfnComponent

      @Stability(Stable) public CfnComponent(@NotNull software.constructs.Construct scope, @NotNull String id)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.

  • Method Details

    • inspect

      @Stability(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(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrCreatedAt

      @Stability(Stable) @NotNull public String getAttrCreatedAt()
      The time that the component was created.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The unique ID of the component.

    • getAttrModifiedAt

      @Stability(Stable) @NotNull public String getAttrModifiedAt()
      The time that the component was modified.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getAppId

      @Stability(Stable) @Nullable public String getAppId()
      The unique ID of the Amplify app associated with the component.

    • setAppId

      @Stability(Stable) public void setAppId(@Nullable String value)
      The unique ID of the Amplify app associated with the component.

    • getBindingProperties

      @Stability(Stable) @Nullable public Object getBindingProperties()
      The information to connect a component's properties to data at runtime.

    • setBindingProperties

      @Stability(Stable) public void setBindingProperties(@Nullable IResolvable value)
      The information to connect a component's properties to data at runtime.

    • setBindingProperties

      @Stability(Stable) public void setBindingProperties(@Nullable Map<String,Object> value)
      The information to connect a component's properties to data at runtime.

    • getChildren

      @Stability(Stable) @Nullable public Object getChildren()
      A list of the component's ComponentChild instances.

    • setChildren

      @Stability(Stable) public void setChildren(@Nullable IResolvable value)
      A list of the component's ComponentChild instances.

    • setChildren

      @Stability(Stable) public void setChildren(@Nullable List<Object> value)
      A list of the component's ComponentChild instances.

    • getCollectionProperties

      @Stability(Stable) @Nullable public Object getCollectionProperties()
      The data binding configuration for the component's properties.

    • setCollectionProperties

      @Stability(Stable) public void setCollectionProperties(@Nullable IResolvable value)
      The data binding configuration for the component's properties.

    • setCollectionProperties

      @Stability(Stable) public void setCollectionProperties(@Nullable Map<String,Object> value)
      The data binding configuration for the component's properties.

    • getComponentType

      @Stability(Stable) @Nullable public String getComponentType()
      The type of the component.

    • setComponentType

      @Stability(Stable) public void setComponentType(@Nullable String value)
      The type of the component.

    • getEnvironmentName

      @Stability(Stable) @Nullable public String getEnvironmentName()
      The name of the backend environment that is a part of the Amplify app.

    • setEnvironmentName

      @Stability(Stable) public void setEnvironmentName(@Nullable String value)
      The name of the backend environment that is a part of the Amplify app.

    • getEvents

      @Stability(Stable) @Nullable public Object getEvents()
      Describes the events that can be raised on the component.

    • setEvents

      @Stability(Stable) public void setEvents(@Nullable IResolvable value)
      Describes the events that can be raised on the component.

    • setEvents

      @Stability(Stable) public void setEvents(@Nullable Map<String,Object> value)
      Describes the events that can be raised on the component.

    • getName

      @Stability(Stable) @Nullable public String getName()
      The name of the component.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      The name of the component.

    • getOverrides

      @Stability(Stable) @Nullable public Object getOverrides()
      Describes the component's properties that can be overriden in a customized instance of the component.

    • setOverrides

      @Stability(Stable) public void setOverrides(@Nullable Object value)
      Describes the component's properties that can be overriden in a customized instance of the component.

    • getProperties

      @Stability(Stable) @Nullable public Object getProperties()
      Describes the component's properties.

    • setProperties

      @Stability(Stable) public void setProperties(@Nullable IResolvable value)
      Describes the component's properties.

    • setProperties

      @Stability(Stable) public void setProperties(@Nullable Map<String,Object> value)
      Describes the component's properties.

    • getSchemaVersion

      @Stability(Stable) @Nullable public String getSchemaVersion()
      The schema version of the component when it was imported.

    • setSchemaVersion

      @Stability(Stable) public void setSchemaVersion(@Nullable String value)
      The schema version of the component when it was imported.

    • getSourceId

      @Stability(Stable) @Nullable public String getSourceId()
      The unique ID of the component in its original source system, such as Figma.

    • setSourceId

      @Stability(Stable) public void setSourceId(@Nullable String value)
      The unique ID of the component in its original source system, such as Figma.

    • getTagsRaw

      @Stability(Stable) @Nullable public Map<String,String> getTagsRaw()
      One or more key-value pairs to use when tagging the component.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable Map<String,String> value)
      One or more key-value pairs to use when tagging the component.

    • getVariants

      @Stability(Stable) @Nullable public Object getVariants()
      A list of the component's variants.

    • setVariants

      @Stability(Stable) public void setVariants(@Nullable IResolvable value)
      A list of the component's variants.

    • setVariants

      @Stability(Stable) public void setVariants(@Nullable List<Object> value)
      A list of the component's variants.