Class CfnComponentProps
Properties for defining a CfnComponent
.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.AmplifyUIBuilder
Assembly: Amazon.CDK.AWS.AmplifyUIBuilder.dll
Syntax (csharp)
public class CfnComponentProps : Object, ICfnComponentProps
Syntax (vb)
Public Class CfnComponentProps
Inherits Object
Implements ICfnComponentProps
Remarks
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 cfnComponentProps = 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
CfnComponentProps() |
Properties
AppId |
|
BindingProperties | The information to connect a component's properties to data at runtime. |
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. |
Constructors
CfnComponentProps()
public CfnComponentProps()
Properties
AppId
AWS::AmplifyUIBuilder::Component.AppId
.
public string AppId { get; set; }
Property Value
System.String
Remarks
BindingProperties
The information to connect a component's properties to data at runtime.
public object BindingProperties { get; set; }
Property Value
System.Object
Remarks
You can't specify tags
as a valid property for bindingProperties
.
Children
A list of the component's ComponentChild
instances.
public object Children { get; set; }
Property Value
System.Object
Remarks
CollectionProperties
The data binding configuration for the component's properties.
public 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 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 string EnvironmentName { get; set; }
Property Value
System.String
Remarks
Events
Describes the events that can be raised on the component.
public 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 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 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 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 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 string SourceId { get; set; }
Property Value
System.String
Remarks
Tags
One or more key-value pairs to use when tagging the component.
public IDictionary<string, string> Tags { get; set; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.String>
Remarks
Variants
A list of the component's variants.
public object Variants { get; set; }
Property Value
System.Object
Remarks
A variant is a unique style configuration of a main component.