Package software.amazon.awscdk.services.amplifyuibuilder

Class CfnComponent.Builder

java.lang.Object
software.amazon.awscdk.services.amplifyuibuilder.CfnComponent.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnComponent>
Enclosing class:
CfnComponent
@Stability(Stable) public static final class CfnComponent.Builder extends Object implements software.amazon.jsii.Builder<CfnComponent>
A fluent builder for CfnComponent.

  • Method Details

    • create

      @Stability(Stable) public static CfnComponent.Builder create(Construct scope, String id)
      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      Returns:
      a new instance of CfnComponent.Builder.

    • bindingProperties

      @Stability(Stable) public CfnComponent.Builder bindingProperties(Map<String,? extends Object> bindingProperties)
      The information to connect a component's properties to data at runtime.

      You can't specify tags as a valid property for bindingProperties .

      Parameters:
      bindingProperties - The information to connect a component's properties to data at runtime. This parameter is required.
      Returns:
      this

    • bindingProperties

      @Stability(Stable) public CfnComponent.Builder bindingProperties(IResolvable bindingProperties)
      The information to connect a component's properties to data at runtime.

      You can't specify tags as a valid property for bindingProperties .

      Parameters:
      bindingProperties - The information to connect a component's properties to data at runtime. This parameter is required.
      Returns:
      this

    • componentType

      @Stability(Stable) public CfnComponent.Builder componentType(String componentType)
      The type of the component.

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

      Parameters:
      componentType - The type of the component. This parameter is required.
      Returns:
      this

    • name

      @Stability(Stable) public CfnComponent.Builder name(String name)
      The name of the component.

      Parameters:
      name - The name of the component. This parameter is required.
      Returns:
      this

    • overrides

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

      You can't specify tags as a valid property for overrides .

      Parameters:
      overrides - Describes the component's properties that can be overriden in a customized instance of the component. This parameter is required.
      Returns:
      this

    • properties

      @Stability(Stable) public CfnComponent.Builder properties(IResolvable properties)
      Describes the component's properties.

      You can't specify tags as a valid property for properties .

      Parameters:
      properties - Describes the component's properties. This parameter is required.
      Returns:
      this

    • properties

      @Stability(Stable) public CfnComponent.Builder properties(Map<String,? extends Object> properties)
      Describes the component's properties.

      You can't specify tags as a valid property for properties .

      Parameters:
      properties - Describes the component's properties. This parameter is required.
      Returns:
      this

    • variants

      @Stability(Stable) public CfnComponent.Builder variants(IResolvable variants)
      A list of the component's variants.

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

      Parameters:
      variants - A list of the component's variants. This parameter is required.
      Returns:
      this

    • variants

      @Stability(Stable) public CfnComponent.Builder variants(List<? extends Object> variants)
      A list of the component's variants.

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

      Parameters:
      variants - A list of the component's variants. This parameter is required.
      Returns:
      this

    • appId

      @Stability(Stable) public CfnComponent.Builder appId(String appId)
      AWS::AmplifyUIBuilder::Component.AppId.

      Parameters:
      appId - AWS::AmplifyUIBuilder::Component.AppId. This parameter is required.
      Returns:
      this

    • children

      @Stability(Stable) public CfnComponent.Builder children(IResolvable children)
      A list of the component's ComponentChild instances.

      Parameters:
      children - A list of the component's ComponentChild instances. This parameter is required.
      Returns:
      this

    • children

      @Stability(Stable) public CfnComponent.Builder children(List<? extends Object> children)
      A list of the component's ComponentChild instances.

      Parameters:
      children - A list of the component's ComponentChild instances. This parameter is required.
      Returns:
      this

    • collectionProperties

      @Stability(Stable) public CfnComponent.Builder collectionProperties(IResolvable collectionProperties)
      The data binding configuration for the component's properties.

      Use this for a collection component. You can't specify tags as a valid property for collectionProperties .

      Parameters:
      collectionProperties - The data binding configuration for the component's properties. This parameter is required.
      Returns:
      this

    • collectionProperties

      @Stability(Stable) public CfnComponent.Builder collectionProperties(Map<String,? extends Object> collectionProperties)
      The data binding configuration for the component's properties.

      Use this for a collection component. You can't specify tags as a valid property for collectionProperties .

      Parameters:
      collectionProperties - The data binding configuration for the component's properties. This parameter is required.
      Returns:
      this

    • environmentName

      @Stability(Stable) public CfnComponent.Builder environmentName(String environmentName)
      AWS::AmplifyUIBuilder::Component.EnvironmentName.

      Parameters:
      environmentName - AWS::AmplifyUIBuilder::Component.EnvironmentName. This parameter is required.
      Returns:
      this

    • events

      @Stability(Stable) public CfnComponent.Builder events(IResolvable events)
      Describes the events that can be raised on the component.

      Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.

      Parameters:
      events - Describes the events that can be raised on the component. This parameter is required.
      Returns:
      this

    • events

      @Stability(Stable) public CfnComponent.Builder events(Map<String,? extends Object> events)
      Describes the events that can be raised on the component.

      Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.

      Parameters:
      events - Describes the events that can be raised on the component. This parameter is required.
      Returns:
      this

    • schemaVersion

      @Stability(Stable) public CfnComponent.Builder schemaVersion(String schemaVersion)
      The schema version of the component when it was imported.

      Parameters:
      schemaVersion - The schema version of the component when it was imported. This parameter is required.
      Returns:
      this

    • sourceId

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

      Parameters:
      sourceId - The unique ID of the component in its original source system, such as Figma. This parameter is required.
      Returns:
      this

    • tags

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

      Parameters:
      tags - One or more key-value pairs to use when tagging the component. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public CfnComponent build()
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnComponent>
      Returns:
      a newly built instance of CfnComponent.