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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:15.605Z")
 @Stability(value=Stable)
public class CfnComponent
extends CfnResource
implements IInspectable

A CloudFormation `AWS::AmplifyUIBuilder::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 Example:
static interface	CfnComponent.ComponentBindingPropertiesValueProperty Example:
static interface	CfnComponent.ComponentChildProperty Example:
static interface	CfnComponent.ComponentConditionPropertyProperty Example:
static interface	CfnComponent.ComponentDataConfigurationProperty Example:
static interface	CfnComponent.ComponentOverridesProperty Example:
static interface	CfnComponent.ComponentOverridesValueProperty Example:
static interface	CfnComponent.ComponentPropertiesProperty Example:
static interface	CfnComponent.ComponentPropertyBindingPropertiesProperty Example:
static interface	CfnComponent.ComponentPropertyProperty Example:
static interface	CfnComponent.ComponentVariantProperty Example:
static interface	CfnComponent.ComponentVariantValuesProperty Example:
static interface	CfnComponent.FormBindingsProperty Example:
static interface	CfnComponent.PredicateProperty Example:
static interface	CfnComponent.SortPropertyProperty Example:

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

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.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(software.constructs.Construct scope, String id) Create a new `AWS::AmplifyUIBuilder::Component`.
	CfnComponent(software.constructs.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()
String	getAttrCreatedAt()
String	getAttrEnvironmentName()
String	getAttrId()
String	getAttrModifiedAt()
Object	getBindingProperties() `AWS::AmplifyUIBuilder::Component.BindingProperties`.
protected Map<String,Object>	getCfnProperties()
Object	getChildren() `AWS::AmplifyUIBuilder::Component.Children`.
Object	getCollectionProperties() `AWS::AmplifyUIBuilder::Component.CollectionProperties`.
String	getComponentType() `AWS::AmplifyUIBuilder::Component.ComponentType`.
String	getName() `AWS::AmplifyUIBuilder::Component.Name`.
Object	getOverrides() `AWS::AmplifyUIBuilder::Component.Overrides`.
Object	getProperties() `AWS::AmplifyUIBuilder::Component.Properties`.
String	getSourceId() `AWS::AmplifyUIBuilder::Component.SourceId`.
TagManager	getTags() `AWS::AmplifyUIBuilder::Component.Tags`.
Object	getVariants() `AWS::AmplifyUIBuilder::Component.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) `AWS::AmplifyUIBuilder::Component.BindingProperties`.
void	setBindingProperties(Map<String,Object> value) `AWS::AmplifyUIBuilder::Component.BindingProperties`.
void	setChildren(IResolvable value) `AWS::AmplifyUIBuilder::Component.Children`.
void	setChildren(List<Object> value) `AWS::AmplifyUIBuilder::Component.Children`.
void	setCollectionProperties(IResolvable value) `AWS::AmplifyUIBuilder::Component.CollectionProperties`.
void	setCollectionProperties(Map<String,Object> value) `AWS::AmplifyUIBuilder::Component.CollectionProperties`.
void	setComponentType(String value) `AWS::AmplifyUIBuilder::Component.ComponentType`.
void	setName(String value) `AWS::AmplifyUIBuilder::Component.Name`.
void	setOverrides(IResolvable value) `AWS::AmplifyUIBuilder::Component.Overrides`.
void	setOverrides(Map<String,Object> value) `AWS::AmplifyUIBuilder::Component.Overrides`.
void	setProperties(IResolvable value) `AWS::AmplifyUIBuilder::Component.Properties`.
void	setProperties(Map<String,Object> value) `AWS::AmplifyUIBuilder::Component.Properties`.
void	setSourceId(String value) `AWS::AmplifyUIBuilder::Component.SourceId`.
void	setVariants(IResolvable value) `AWS::AmplifyUIBuilder::Component.Variants`.
void	setVariants(List<Object> value) `AWS::AmplifyUIBuilder::Component.Variants`.

Methods inherited from class software.amazon.awscdk.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.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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
                                             software.constructs.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
                                             software.constructs.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()

getAttrCreatedAt

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

getAttrEnvironmentName

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

getAttrId

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

getAttrModifiedAt

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

getBindingProperties

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

`AWS::AmplifyUIBuilder::Component.BindingProperties`.

setBindingProperties

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

`AWS::AmplifyUIBuilder::Component.BindingProperties`.

setBindingProperties

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

`AWS::AmplifyUIBuilder::Component.BindingProperties`.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getChildren

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

`AWS::AmplifyUIBuilder::Component.Children`.

setChildren

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

`AWS::AmplifyUIBuilder::Component.Children`.

setChildren

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

`AWS::AmplifyUIBuilder::Component.Children`.

getCollectionProperties

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

`AWS::AmplifyUIBuilder::Component.CollectionProperties`.

setCollectionProperties

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

`AWS::AmplifyUIBuilder::Component.CollectionProperties`.

setCollectionProperties

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

`AWS::AmplifyUIBuilder::Component.CollectionProperties`.

getComponentType

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

`AWS::AmplifyUIBuilder::Component.ComponentType`.

setComponentType

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

`AWS::AmplifyUIBuilder::Component.ComponentType`.

getName

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

`AWS::AmplifyUIBuilder::Component.Name`.

setName

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

`AWS::AmplifyUIBuilder::Component.Name`.

getOverrides

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

`AWS::AmplifyUIBuilder::Component.Overrides`.

setOverrides

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

`AWS::AmplifyUIBuilder::Component.Overrides`.

setOverrides

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

`AWS::AmplifyUIBuilder::Component.Overrides`.

getProperties

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

`AWS::AmplifyUIBuilder::Component.Properties`.

setProperties

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

`AWS::AmplifyUIBuilder::Component.Properties`.

setProperties

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

`AWS::AmplifyUIBuilder::Component.Properties`.

getSourceId

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

`AWS::AmplifyUIBuilder::Component.SourceId`.

setSourceId

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

`AWS::AmplifyUIBuilder::Component.SourceId`.

getTags

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

`AWS::AmplifyUIBuilder::Component.Tags`.

getVariants

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

`AWS::AmplifyUIBuilder::Component.Variants`.

setVariants

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

`AWS::AmplifyUIBuilder::Component.Variants`.

setVariants

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

`AWS::AmplifyUIBuilder::Component.Variants`.