CfnComponent.Builder

java.lang.Object
- software.amazon.awscdk.services.amplifyuibuilder.CfnComponent.Builder

Enclosing class:: CfnComponent

public static final class CfnComponent.Builder
extends java.lang.Object

A fluent builder for CfnComponent.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CfnComponent.Builder`	`bindingProperties(IResolvable bindingProperties)` The information to connect a component's properties to data at runtime.
`CfnComponent.Builder`	`bindingProperties(java.util.Map<java.lang.String,? extends java.lang.Object> bindingProperties)` The information to connect a component's properties to data at runtime.
`CfnComponent`	`build()`
`CfnComponent.Builder`	`children(IResolvable children)` A list of the component's `ComponentChild` instances.
`CfnComponent.Builder`	`children(java.util.List<? extends java.lang.Object> children)` A list of the component's `ComponentChild` instances.
`CfnComponent.Builder`	`collectionProperties(IResolvable collectionProperties)` The data binding configuration for the component's properties.
`CfnComponent.Builder`	`collectionProperties(java.util.Map<java.lang.String,? extends java.lang.Object> collectionProperties)` The data binding configuration for the component's properties.
`CfnComponent.Builder`	`componentType(java.lang.String componentType)` The type of the component.
`static CfnComponent.Builder`	`create(Construct scope, java.lang.String id)`
`CfnComponent.Builder`	`events(IResolvable events)` Describes the events that can be raised on the component.
`CfnComponent.Builder`	`events(java.util.Map<java.lang.String,? extends java.lang.Object> events)` Describes the events that can be raised on the component.
`CfnComponent.Builder`	`name(java.lang.String name)` The name of the component.
`CfnComponent.Builder`	`overrides(IResolvable overrides)` Describes the component's properties that can be overriden in a customized instance of the component.
`CfnComponent.Builder`	`overrides(java.util.Map<java.lang.String,? extends java.lang.Object> overrides)` Describes the component's properties that can be overriden in a customized instance of the component.
`CfnComponent.Builder`	`properties(IResolvable properties)` Describes the component's properties.
`CfnComponent.Builder`	`properties(java.util.Map<java.lang.String,? extends java.lang.Object> properties)` Describes the component's properties.
`CfnComponent.Builder`	`schemaVersion(java.lang.String schemaVersion)` The schema version of the component when it was imported.
`CfnComponent.Builder`	`sourceId(java.lang.String sourceId)` The unique ID of the component in its original source system, such as Figma.
`CfnComponent.Builder`	`tags(java.util.Map<java.lang.String,java.lang.String> tags)` One or more key-value pairs to use when tagging the component.
`CfnComponent.Builder`	`variants(IResolvable variants)` A list of the component's variants.
`CfnComponent.Builder`	`variants(java.util.List<? extends java.lang.Object> variants)` A list of the component's variants.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - create
```
public static CfnComponent.Builder create(Construct scope,
                                          java.lang.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.ActionParametersProperty.Builder.
  - bindingProperties
```
public CfnComponent.Builder bindingProperties(java.util.Map<java.lang.String,? extends java.lang.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
```
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
```
public CfnComponent.Builder componentType(java.lang.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
```
public CfnComponent.Builder name(java.lang.String name)
```
    The name of the component.
    
    Parameters:
    
    name - The name of the component. This parameter is required.
    
    Returns:
    
    this
  - overrides
```
public CfnComponent.Builder overrides(IResolvable 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
  - overrides
```
public CfnComponent.Builder overrides(java.util.Map<java.lang.String,? extends java.lang.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
```
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
```
public CfnComponent.Builder properties(java.util.Map<java.lang.String,? extends java.lang.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
```
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
```
public CfnComponent.Builder variants(java.util.List<? extends java.lang.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
  - children
```
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
```
public CfnComponent.Builder children(java.util.List<? extends java.lang.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
```
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
```
public CfnComponent.Builder collectionProperties(java.util.Map<java.lang.String,? extends java.lang.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
  - events
```
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
```
public CfnComponent.Builder events(java.util.Map<java.lang.String,? extends java.lang.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
```
public CfnComponent.Builder schemaVersion(java.lang.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
```
public CfnComponent.Builder sourceId(java.lang.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
```
public CfnComponent.Builder tags(java.util.Map<java.lang.String,java.lang.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
```
public CfnComponent build()
```

Class CfnComponent.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

bindingProperties

bindingProperties

componentType

name

overrides

overrides

properties

properties

variants

variants

children

children

collectionProperties

collectionProperties

events

events

schemaVersion

sourceId

tags

build