Class CfnComponent
A CloudFormation AWS::AmplifyUIBuilder::Component
.
Inherited Members
Namespace: Amazon.CDK.AWS.AmplifyUIBuilder
Assembly: Amazon.CDK.AWS.AmplifyUIBuilder.dll
Syntax (csharp)
public class CfnComponent : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnComponent
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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
.
CloudformationResource: AWS::AmplifyUIBuilder::Component
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.AmplifyUIBuilder;
ComponentChildProperty componentChildProperty_;
ComponentPropertyProperty componentPropertyProperty_;
var overrides;
PredicateProperty predicateProperty_;
var cfnComponent = new CfnComponent(this, "MyCfnComponent", new CfnComponentProps {
BindingProperties = new Dictionary<string, object> {
{ "bindingPropertiesKey", new ComponentBindingPropertiesValueProperty {
BindingProperties = new ComponentBindingPropertiesValuePropertiesProperty {
Bucket = "bucket",
DefaultValue = "defaultValue",
Field = "field",
Key = "key",
Model = "model",
Predicates = new [] { new PredicateProperty {
And = new [] { predicateProperty_ },
Field = "field",
Operand = "operand",
Operator = "operator",
Or = new [] { predicateProperty_ }
} },
UserAttribute = "userAttribute"
},
DefaultValue = "defaultValue",
Type = "type"
} }
},
ComponentType = "componentType",
Name = "name",
Overrides = overrides,
Properties = new Dictionary<string, object> {
{ "propertiesKey", new ComponentPropertyProperty {
BindingProperties = new ComponentPropertyBindingPropertiesProperty {
Property = "property",
// the properties below are optional
Field = "field"
},
Bindings = new Dictionary<string, object> {
{ "bindingsKey", new FormBindingElementProperty {
Element = "element",
Property = "property"
} }
},
CollectionBindingProperties = new ComponentPropertyBindingPropertiesProperty {
Property = "property",
// the properties below are optional
Field = "field"
},
ComponentName = "componentName",
Concat = new [] { componentPropertyProperty_ },
Condition = new ComponentConditionPropertyProperty {
Else = componentPropertyProperty_,
Field = "field",
Operand = "operand",
OperandType = "operandType",
Operator = "operator",
Property = "property",
Then = componentPropertyProperty_
},
Configured = false,
DefaultValue = "defaultValue",
Event = "event",
ImportedValue = "importedValue",
Model = "model",
Property = "property",
Type = "type",
UserAttribute = "userAttribute",
Value = "value"
} }
},
Variants = new [] { new ComponentVariantProperty {
Overrides = overrides,
VariantValues = new Dictionary<string, string> {
{ "variantValuesKey", "variantValues" }
}
} },
// the properties below are optional
AppId = "appId",
Children = new [] { new ComponentChildProperty {
ComponentType = "componentType",
Name = "name",
Properties = new Dictionary<string, object> {
{ "propertiesKey", new ComponentPropertyProperty {
BindingProperties = new ComponentPropertyBindingPropertiesProperty {
Property = "property",
// the properties below are optional
Field = "field"
},
Bindings = new Dictionary<string, object> {
{ "bindingsKey", new FormBindingElementProperty {
Element = "element",
Property = "property"
} }
},
CollectionBindingProperties = new ComponentPropertyBindingPropertiesProperty {
Property = "property",
// the properties below are optional
Field = "field"
},
ComponentName = "componentName",
Concat = new [] { componentPropertyProperty_ },
Condition = new ComponentConditionPropertyProperty {
Else = componentPropertyProperty_,
Field = "field",
Operand = "operand",
OperandType = "operandType",
Operator = "operator",
Property = "property",
Then = componentPropertyProperty_
},
Configured = false,
DefaultValue = "defaultValue",
Event = "event",
ImportedValue = "importedValue",
Model = "model",
Property = "property",
Type = "type",
UserAttribute = "userAttribute",
Value = "value"
} }
},
// the properties below are optional
Children = new [] { componentChildProperty_ },
Events = new Dictionary<string, object> {
{ "eventsKey", new ComponentEventProperty {
Action = "action",
Parameters = new ActionParametersProperty {
Anchor = new ComponentPropertyProperty {
BindingProperties = new ComponentPropertyBindingPropertiesProperty {
Property = "property",
// the properties below are optional
Field = "field"
},
Bindings = new Dictionary<string, object> {
{ "bindingsKey", new FormBindingElementProperty {
Element = "element",
Property = "property"
} }
},
CollectionBindingProperties = new ComponentPropertyBindingPropertiesProperty {
Property = "property",
// the properties below are optional
Field = "field"
},
ComponentName = "componentName",
Concat = new [] { componentPropertyProperty_ },
Condition = new ComponentConditionPropertyProperty {
Else = componentPropertyProperty_,
Field = "field",
Operand = "operand",
OperandType = "operandType",
Operator = "operator",
Property = "property",
Then = componentPropertyProperty_
},
Configured = false,
DefaultValue = "defaultValue",
Event = "event",
ImportedValue = "importedValue",
Model = "model",
Property = "property",
Type = "type",
UserAttribute = "userAttribute",
Value = "value"
},
Fields = new Dictionary<string, object> {
{ "fieldsKey", new ComponentPropertyProperty {
BindingProperties = new ComponentPropertyBindingPropertiesProperty {
Property = "property",
// the properties below are optional
Field = "field"
},
Bindings = new Dictionary<string, object> {
{ "bindingsKey", new FormBindingElementProperty {
Element = "element",
Property = "property"
} }
},
CollectionBindingProperties = new ComponentPropertyBindingPropertiesProperty {
Property = "property",
// the properties below are optional
Field = "field"
},
ComponentName = "componentName",
Concat = new [] { componentPropertyProperty_ },
Condition = new ComponentConditionPropertyProperty {
Else = componentPropertyProperty_,
Field = "field",
Operand = "operand",
OperandType = "operandType",
Operator = "operator",
Property = "property",
Then = componentPropertyProperty_
},
Configured = false,
DefaultValue = "defaultValue",
Event = "event",
ImportedValue = "importedValue",
Model = "model",
Property = "property",
Type = "type",
UserAttribute = "userAttribute",
Value = "value"
} }
},
Global = new ComponentPropertyProperty {
BindingProperties = new ComponentPropertyBindingPropertiesProperty {
Property = "property",
// the properties below are optional
Field = "field"
},
Bindings = new Dictionary<string, object> {
{ "bindingsKey", new FormBindingElementProperty {
Element = "element",
Property = "property"
} }
},
CollectionBindingProperties = new ComponentPropertyBindingPropertiesProperty {
Property = "property",
// the properties below are optional
Field = "field"
},
ComponentName = "componentName",
Concat = new [] { componentPropertyProperty_ },
Condition = new ComponentConditionPropertyProperty {
Else = componentPropertyProperty_,
Field = "field",
Operand = "operand",
OperandType = "operandType",
Operator = "operator",
Property = "property",
Then = componentPropertyProperty_
},
Configured = false,
DefaultValue = "defaultValue",
Event = "event",
ImportedValue = "importedValue",
Model = "model",
Property = "property",
Type = "type",
UserAttribute = "userAttribute",
Value = "value"
},
Id = new ComponentPropertyProperty {
BindingProperties = new ComponentPropertyBindingPropertiesProperty {
Property = "property",
// the properties below are optional
Field = "field"
},
Bindings = new Dictionary<string, object> {
{ "bindingsKey", new FormBindingElementProperty {
Element = "element",
Property = "property"
} }
},
CollectionBindingProperties = new ComponentPropertyBindingPropertiesProperty {
Property = "property",
// the properties below are optional
Field = "field"
},
ComponentName = "componentName",
Concat = new [] { componentPropertyProperty_ },
Condition = new ComponentConditionPropertyProperty {
Else = componentPropertyProperty_,
Field = "field",
Operand = "operand",
OperandType = "operandType",
Operator = "operator",
Property = "property",
Then = componentPropertyProperty_
},
Configured = false,
DefaultValue = "defaultValue",
Event = "event",
ImportedValue = "importedValue",
Model = "model",
Property = "property",
Type = "type",
UserAttribute = "userAttribute",
Value = "value"
},
Model = "model",
State = new MutationActionSetStateParameterProperty {
ComponentName = "componentName",
Property = "property",
Set = new ComponentPropertyProperty {
BindingProperties = new ComponentPropertyBindingPropertiesProperty {
Property = "property",
// the properties below are optional
Field = "field"
},
Bindings = new Dictionary<string, object> {
{ "bindingsKey", new FormBindingElementProperty {
Element = "element",
Property = "property"
} }
},
CollectionBindingProperties = new ComponentPropertyBindingPropertiesProperty {
Property = "property",
// the properties below are optional
Field = "field"
},
ComponentName = "componentName",
Concat = new [] { componentPropertyProperty_ },
Condition = new ComponentConditionPropertyProperty {
Else = componentPropertyProperty_,
Field = "field",
Operand = "operand",
OperandType = "operandType",
Operator = "operator",
Property = "property",
Then = componentPropertyProperty_
},
Configured = false,
DefaultValue = "defaultValue",
Event = "event",
ImportedValue = "importedValue",
Model = "model",
Property = "property",
Type = "type",
UserAttribute = "userAttribute",
Value = "value"
}
},
Target = new ComponentPropertyProperty {
BindingProperties = new ComponentPropertyBindingPropertiesProperty {
Property = "property",
// the properties below are optional
Field = "field"
},
Bindings = new Dictionary<string, object> {
{ "bindingsKey", new FormBindingElementProperty {
Element = "element",
Property = "property"
} }
},
CollectionBindingProperties = new ComponentPropertyBindingPropertiesProperty {
Property = "property",
// the properties below are optional
Field = "field"
},
ComponentName = "componentName",
Concat = new [] { componentPropertyProperty_ },
Condition = new ComponentConditionPropertyProperty {
Else = componentPropertyProperty_,
Field = "field",
Operand = "operand",
OperandType = "operandType",
Operator = "operator",
Property = "property",
Then = componentPropertyProperty_
},
Configured = false,
DefaultValue = "defaultValue",
Event = "event",
ImportedValue = "importedValue",
Model = "model",
Property = "property",
Type = "type",
UserAttribute = "userAttribute",
Value = "value"
},
Type = new ComponentPropertyProperty {
BindingProperties = new ComponentPropertyBindingPropertiesProperty {
Property = "property",
// the properties below are optional
Field = "field"
},
Bindings = new Dictionary<string, object> {
{ "bindingsKey", new FormBindingElementProperty {
Element = "element",
Property = "property"
} }
},
CollectionBindingProperties = new ComponentPropertyBindingPropertiesProperty {
Property = "property",
// the properties below are optional
Field = "field"
},
ComponentName = "componentName",
Concat = new [] { componentPropertyProperty_ },
Condition = new ComponentConditionPropertyProperty {
Else = componentPropertyProperty_,
Field = "field",
Operand = "operand",
OperandType = "operandType",
Operator = "operator",
Property = "property",
Then = componentPropertyProperty_
},
Configured = false,
DefaultValue = "defaultValue",
Event = "event",
ImportedValue = "importedValue",
Model = "model",
Property = "property",
Type = "type",
UserAttribute = "userAttribute",
Value = "value"
},
Url = new ComponentPropertyProperty {
BindingProperties = new ComponentPropertyBindingPropertiesProperty {
Property = "property",
// the properties below are optional
Field = "field"
},
Bindings = new Dictionary<string, object> {
{ "bindingsKey", new FormBindingElementProperty {
Element = "element",
Property = "property"
} }
},
CollectionBindingProperties = new ComponentPropertyBindingPropertiesProperty {
Property = "property",
// the properties below are optional
Field = "field"
},
ComponentName = "componentName",
Concat = new [] { componentPropertyProperty_ },
Condition = new ComponentConditionPropertyProperty {
Else = componentPropertyProperty_,
Field = "field",
Operand = "operand",
OperandType = "operandType",
Operator = "operator",
Property = "property",
Then = componentPropertyProperty_
},
Configured = false,
DefaultValue = "defaultValue",
Event = "event",
ImportedValue = "importedValue",
Model = "model",
Property = "property",
Type = "type",
UserAttribute = "userAttribute",
Value = "value"
}
}
} }
}
} },
CollectionProperties = new Dictionary<string, object> {
{ "collectionPropertiesKey", new ComponentDataConfigurationProperty {
Model = "model",
// the properties below are optional
Identifiers = new [] { "identifiers" },
Predicate = new PredicateProperty {
And = new [] { predicateProperty_ },
Field = "field",
Operand = "operand",
Operator = "operator",
Or = new [] { predicateProperty_ }
},
Sort = new [] { new SortPropertyProperty {
Direction = "direction",
Field = "field"
} }
} }
},
EnvironmentName = "environmentName",
Events = new Dictionary<string, object> {
{ "eventsKey", new ComponentEventProperty {
Action = "action",
Parameters = new ActionParametersProperty {
Anchor = new ComponentPropertyProperty {
BindingProperties = new ComponentPropertyBindingPropertiesProperty {
Property = "property",
// the properties below are optional
Field = "field"
},
Bindings = new Dictionary<string, object> {
{ "bindingsKey", new FormBindingElementProperty {
Element = "element",
Property = "property"
} }
},
CollectionBindingProperties = new ComponentPropertyBindingPropertiesProperty {
Property = "property",
// the properties below are optional
Field = "field"
},
ComponentName = "componentName",
Concat = new [] { componentPropertyProperty_ },
Condition = new ComponentConditionPropertyProperty {
Else = componentPropertyProperty_,
Field = "field",
Operand = "operand",
OperandType = "operandType",
Operator = "operator",
Property = "property",
Then = componentPropertyProperty_
},
Configured = false,
DefaultValue = "defaultValue",
Event = "event",
ImportedValue = "importedValue",
Model = "model",
Property = "property",
Type = "type",
UserAttribute = "userAttribute",
Value = "value"
},
Fields = new Dictionary<string, object> {
{ "fieldsKey", new ComponentPropertyProperty {
BindingProperties = new ComponentPropertyBindingPropertiesProperty {
Property = "property",
// the properties below are optional
Field = "field"
},
Bindings = new Dictionary<string, object> {
{ "bindingsKey", new FormBindingElementProperty {
Element = "element",
Property = "property"
} }
},
CollectionBindingProperties = new ComponentPropertyBindingPropertiesProperty {
Property = "property",
// the properties below are optional
Field = "field"
},
ComponentName = "componentName",
Concat = new [] { componentPropertyProperty_ },
Condition = new ComponentConditionPropertyProperty {
Else = componentPropertyProperty_,
Field = "field",
Operand = "operand",
OperandType = "operandType",
Operator = "operator",
Property = "property",
Then = componentPropertyProperty_
},
Configured = false,
DefaultValue = "defaultValue",
Event = "event",
ImportedValue = "importedValue",
Model = "model",
Property = "property",
Type = "type",
UserAttribute = "userAttribute",
Value = "value"
} }
},
Global = new ComponentPropertyProperty {
BindingProperties = new ComponentPropertyBindingPropertiesProperty {
Property = "property",
// the properties below are optional
Field = "field"
},
Bindings = new Dictionary<string, object> {
{ "bindingsKey", new FormBindingElementProperty {
Element = "element",
Property = "property"
} }
},
CollectionBindingProperties = new ComponentPropertyBindingPropertiesProperty {
Property = "property",
// the properties below are optional
Field = "field"
},
ComponentName = "componentName",
Concat = new [] { componentPropertyProperty_ },
Condition = new ComponentConditionPropertyProperty {
Else = componentPropertyProperty_,
Field = "field",
Operand = "operand",
OperandType = "operandType",
Operator = "operator",
Property = "property",
Then = componentPropertyProperty_
},
Configured = false,
DefaultValue = "defaultValue",
Event = "event",
ImportedValue = "importedValue",
Model = "model",
Property = "property",
Type = "type",
UserAttribute = "userAttribute",
Value = "value"
},
Id = new ComponentPropertyProperty {
BindingProperties = new ComponentPropertyBindingPropertiesProperty {
Property = "property",
// the properties below are optional
Field = "field"
},
Bindings = new Dictionary<string, object> {
{ "bindingsKey", new FormBindingElementProperty {
Element = "element",
Property = "property"
} }
},
CollectionBindingProperties = new ComponentPropertyBindingPropertiesProperty {
Property = "property",
// the properties below are optional
Field = "field"
},
ComponentName = "componentName",
Concat = new [] { componentPropertyProperty_ },
Condition = new ComponentConditionPropertyProperty {
Else = componentPropertyProperty_,
Field = "field",
Operand = "operand",
OperandType = "operandType",
Operator = "operator",
Property = "property",
Then = componentPropertyProperty_
},
Configured = false,
DefaultValue = "defaultValue",
Event = "event",
ImportedValue = "importedValue",
Model = "model",
Property = "property",
Type = "type",
UserAttribute = "userAttribute",
Value = "value"
},
Model = "model",
State = new MutationActionSetStateParameterProperty {
ComponentName = "componentName",
Property = "property",
Set = new ComponentPropertyProperty {
BindingProperties = new ComponentPropertyBindingPropertiesProperty {
Property = "property",
// the properties below are optional
Field = "field"
},
Bindings = new Dictionary<string, object> {
{ "bindingsKey", new FormBindingElementProperty {
Element = "element",
Property = "property"
} }
},
CollectionBindingProperties = new ComponentPropertyBindingPropertiesProperty {
Property = "property",
// the properties below are optional
Field = "field"
},
ComponentName = "componentName",
Concat = new [] { componentPropertyProperty_ },
Condition = new ComponentConditionPropertyProperty {
Else = componentPropertyProperty_,
Field = "field",
Operand = "operand",
OperandType = "operandType",
Operator = "operator",
Property = "property",
Then = componentPropertyProperty_
},
Configured = false,
DefaultValue = "defaultValue",
Event = "event",
ImportedValue = "importedValue",
Model = "model",
Property = "property",
Type = "type",
UserAttribute = "userAttribute",
Value = "value"
}
},
Target = new ComponentPropertyProperty {
BindingProperties = new ComponentPropertyBindingPropertiesProperty {
Property = "property",
// the properties below are optional
Field = "field"
},
Bindings = new Dictionary<string, object> {
{ "bindingsKey", new FormBindingElementProperty {
Element = "element",
Property = "property"
} }
},
CollectionBindingProperties = new ComponentPropertyBindingPropertiesProperty {
Property = "property",
// the properties below are optional
Field = "field"
},
ComponentName = "componentName",
Concat = new [] { componentPropertyProperty_ },
Condition = new ComponentConditionPropertyProperty {
Else = componentPropertyProperty_,
Field = "field",
Operand = "operand",
OperandType = "operandType",
Operator = "operator",
Property = "property",
Then = componentPropertyProperty_
},
Configured = false,
DefaultValue = "defaultValue",
Event = "event",
ImportedValue = "importedValue",
Model = "model",
Property = "property",
Type = "type",
UserAttribute = "userAttribute",
Value = "value"
},
Type = new ComponentPropertyProperty {
BindingProperties = new ComponentPropertyBindingPropertiesProperty {
Property = "property",
// the properties below are optional
Field = "field"
},
Bindings = new Dictionary<string, object> {
{ "bindingsKey", new FormBindingElementProperty {
Element = "element",
Property = "property"
} }
},
CollectionBindingProperties = new ComponentPropertyBindingPropertiesProperty {
Property = "property",
// the properties below are optional
Field = "field"
},
ComponentName = "componentName",
Concat = new [] { componentPropertyProperty_ },
Condition = new ComponentConditionPropertyProperty {
Else = componentPropertyProperty_,
Field = "field",
Operand = "operand",
OperandType = "operandType",
Operator = "operator",
Property = "property",
Then = componentPropertyProperty_
},
Configured = false,
DefaultValue = "defaultValue",
Event = "event",
ImportedValue = "importedValue",
Model = "model",
Property = "property",
Type = "type",
UserAttribute = "userAttribute",
Value = "value"
},
Url = new ComponentPropertyProperty {
BindingProperties = new ComponentPropertyBindingPropertiesProperty {
Property = "property",
// the properties below are optional
Field = "field"
},
Bindings = new Dictionary<string, object> {
{ "bindingsKey", new FormBindingElementProperty {
Element = "element",
Property = "property"
} }
},
CollectionBindingProperties = new ComponentPropertyBindingPropertiesProperty {
Property = "property",
// the properties below are optional
Field = "field"
},
ComponentName = "componentName",
Concat = new [] { componentPropertyProperty_ },
Condition = new ComponentConditionPropertyProperty {
Else = componentPropertyProperty_,
Field = "field",
Operand = "operand",
OperandType = "operandType",
Operator = "operator",
Property = "property",
Then = componentPropertyProperty_
},
Configured = false,
DefaultValue = "defaultValue",
Event = "event",
ImportedValue = "importedValue",
Model = "model",
Property = "property",
Type = "type",
UserAttribute = "userAttribute",
Value = "value"
}
}
} }
},
SchemaVersion = "schemaVersion",
SourceId = "sourceId",
Tags = new Dictionary<string, string> {
{ "tagsKey", "tags" }
}
});
Synopsis
Constructors
CfnComponent(Construct, String, ICfnComponentProps) | Create a new |
CfnComponent(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnComponent(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AppId |
|
AttrId | The unique ID of the component. |
BindingProperties | The information to connect a component's properties to data at runtime. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Children | A list of the component's |
CollectionProperties | The data binding configuration for the component's properties. |
ComponentType | The type of the component. |
EnvironmentName |
|
Events | Describes the events that can be raised on the component. |
Name | The name of the component. |
Overrides | Describes the component's properties that can be overriden in a customized instance of the component. |
Properties | Describes the component's properties. |
SchemaVersion | The schema version of the component when it was imported. |
SourceId | The unique ID of the component in its original source system, such as Figma. |
Tags | One or more key-value pairs to use when tagging the component. |
Variants | A list of the component's variants. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnComponent(Construct, String, ICfnComponentProps)
Create a new AWS::AmplifyUIBuilder::Component
.
public CfnComponent(Construct scope, string id, ICfnComponentProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnComponentProps
- resource properties.
CfnComponent(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnComponent(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnComponent(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnComponent(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AppId
AWS::AmplifyUIBuilder::Component.AppId
.
public virtual string AppId { get; set; }
Property Value
System.String
Remarks
AttrId
The unique ID of the component.
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
BindingProperties
The information to connect a component's properties to data at runtime.
public virtual object BindingProperties { get; set; }
Property Value
System.Object
Remarks
You can't specify tags
as a valid property for bindingProperties
.
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Children
A list of the component's ComponentChild
instances.
public virtual object Children { get; set; }
Property Value
System.Object
Remarks
CollectionProperties
The data binding configuration for the component's properties.
public virtual object CollectionProperties { get; set; }
Property Value
System.Object
Remarks
Use this for a collection component. You can't specify tags
as a valid property for collectionProperties
.
ComponentType
The type of the component.
public virtual string ComponentType { get; set; }
Property Value
System.String
Remarks
This can be an Amplify custom UI component or another custom component.
EnvironmentName
AWS::AmplifyUIBuilder::Component.EnvironmentName
.
public virtual string EnvironmentName { get; set; }
Property Value
System.String
Remarks
Events
Describes the events that can be raised on the component.
public virtual object Events { get; set; }
Property Value
System.Object
Remarks
Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.
Name
The name of the component.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
Overrides
Describes the component's properties that can be overriden in a customized instance of the component.
public virtual object Overrides { get; set; }
Property Value
System.Object
Remarks
You can't specify tags
as a valid property for overrides
.
Properties
Describes the component's properties.
public virtual object Properties { get; set; }
Property Value
System.Object
Remarks
You can't specify tags
as a valid property for properties
.
SchemaVersion
The schema version of the component when it was imported.
public virtual string SchemaVersion { get; set; }
Property Value
System.String
Remarks
SourceId
The unique ID of the component in its original source system, such as Figma.
public virtual string SourceId { get; set; }
Property Value
System.String
Remarks
Tags
One or more key-value pairs to use when tagging the component.
public virtual TagManager Tags { get; }
Property Value
Remarks
Variants
A list of the component's variants.
public virtual object Variants { get; set; }
Property Value
System.Object
Remarks
A variant is a unique style configuration of a main component.
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>