The highest tagged major version is
README
¶
AWS::AmplifyUIBuilder Construct Library
This module is part of the AWS Cloud Development Kit project.
import amplifyuibuilder "github.com/aws/aws-cdk-go/awscdk"
There are no official hand-written (L2) constructs for this service yet. Here are some suggestions on how to proceed:
- Search Construct Hub for AmplifyUIBuilder construct libraries
- Use the automatically generated L1 constructs, in the same way you would use the CloudFormation AWS::AmplifyUIBuilder resources directly.
There are no hand-written (L2) constructs for this service yet. However, you can still use the automatically generated L1 constructs, and use this service exactly as you would using CloudFormation directly.
For more information on the resources and properties available for this service, see the CloudFormation documentation for AWS::AmplifyUIBuilder.
(Read the CDK Contributing Guide and submit an RFC if you are interested in contributing to this construct library.)
Documentation
¶
Index ¶
- func CfnComponent_CFN_RESOURCE_TYPE_NAME() *string
- func CfnComponent_IsCfnElement(x interface{}) *bool
- func CfnComponent_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnComponent_IsConstruct(x interface{}) *bool
- func CfnForm_CFN_RESOURCE_TYPE_NAME() *string
- func CfnForm_IsCfnElement(x interface{}) *bool
- func CfnForm_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnForm_IsConstruct(x interface{}) *bool
- func CfnTheme_CFN_RESOURCE_TYPE_NAME() *string
- func CfnTheme_IsCfnElement(x interface{}) *bool
- func CfnTheme_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnTheme_IsConstruct(x interface{}) *bool
- func NewCfnComponent_Override(c CfnComponent, scope awscdk.Construct, id *string, props *CfnComponentProps)
- func NewCfnForm_Override(c CfnForm, scope awscdk.Construct, id *string, props *CfnFormProps)
- func NewCfnTheme_Override(c CfnTheme, scope awscdk.Construct, id *string, props *CfnThemeProps)
- type CfnComponent
- type CfnComponentProps
- type CfnComponent_ActionParametersProperty
- type CfnComponent_ComponentBindingPropertiesValuePropertiesProperty
- type CfnComponent_ComponentBindingPropertiesValueProperty
- type CfnComponent_ComponentChildProperty
- type CfnComponent_ComponentConditionPropertyProperty
- type CfnComponent_ComponentDataConfigurationProperty
- type CfnComponent_ComponentEventProperty
- type CfnComponent_ComponentPropertyBindingPropertiesProperty
- type CfnComponent_ComponentPropertyProperty
- type CfnComponent_ComponentVariantProperty
- type CfnComponent_FormBindingElementProperty
- type CfnComponent_MutationActionSetStateParameterProperty
- type CfnComponent_PredicateProperty
- type CfnComponent_SortPropertyProperty
- type CfnForm
- type CfnFormProps
- type CfnForm_FieldConfigProperty
- type CfnForm_FieldInputConfigProperty
- type CfnForm_FieldPositionProperty
- type CfnForm_FieldValidationConfigurationProperty
- type CfnForm_FormButtonProperty
- type CfnForm_FormCTAProperty
- type CfnForm_FormDataTypeConfigProperty
- type CfnForm_FormInputValuePropertyProperty
- type CfnForm_FormStyleConfigProperty
- type CfnForm_FormStyleProperty
- type CfnForm_SectionalElementProperty
- type CfnForm_ValueMappingProperty
- type CfnForm_ValueMappingsProperty
- type CfnTheme
- type CfnThemeProps
- type CfnTheme_ThemeValueProperty
- type CfnTheme_ThemeValuesProperty
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfnComponent_CFN_RESOURCE_TYPE_NAME ¶
func CfnComponent_CFN_RESOURCE_TYPE_NAME() *string
func CfnComponent_IsCfnElement ¶
func CfnComponent_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.
func CfnComponent_IsCfnResource ¶
func CfnComponent_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnComponent_IsConstruct ¶
func CfnComponent_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func CfnForm_CFN_RESOURCE_TYPE_NAME ¶
func CfnForm_CFN_RESOURCE_TYPE_NAME() *string
func CfnForm_IsCfnElement ¶
func CfnForm_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.
func CfnForm_IsCfnResource ¶
func CfnForm_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnForm_IsConstruct ¶
func CfnForm_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func CfnTheme_CFN_RESOURCE_TYPE_NAME ¶
func CfnTheme_CFN_RESOURCE_TYPE_NAME() *string
func CfnTheme_IsCfnElement ¶
func CfnTheme_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element. Experimental.
func CfnTheme_IsCfnResource ¶
func CfnTheme_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnTheme_IsConstruct ¶
func CfnTheme_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func NewCfnComponent_Override ¶
func NewCfnComponent_Override(c CfnComponent, scope awscdk.Construct, id *string, props *CfnComponentProps)
Create a new `AWS::AmplifyUIBuilder::Component`.
func NewCfnForm_Override ¶
func NewCfnForm_Override(c CfnForm, scope awscdk.Construct, id *string, props *CfnFormProps)
Create a new `AWS::AmplifyUIBuilder::Form`.
func NewCfnTheme_Override ¶
func NewCfnTheme_Override(c CfnTheme, scope awscdk.Construct, id *string, props *CfnThemeProps)
Create a new `AWS::AmplifyUIBuilder::Theme`.
Types ¶
type CfnComponent ¶
type CfnComponent interface {
awscdk.CfnResource
awscdk.IInspectable
// The unique ID for the Amplify app.
AttrAppId() *string
// The name of the backend environment that is a part of the Amplify app.
AttrEnvironmentName() *string
// The unique ID of the component.
AttrId() *string
// The information to connect a component's properties to data at runtime.
//
// You can't specify `tags` as a valid property for `bindingProperties` .
BindingProperties() interface{}
SetBindingProperties(val interface{})
// Options for this resource, such as condition, update policy etc.
// Experimental.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
// Experimental.
CfnResourceType() *string
// A list of the component's `ComponentChild` instances.
Children() interface{}
SetChildren(val interface{})
// 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` .
CollectionProperties() interface{}
SetCollectionProperties(val interface{})
// The type of the component.
//
// This can be an Amplify custom UI component or another custom component.
ComponentType() *string
SetComponentType(val *string)
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
// Experimental.
CreationStack() *[]*string
// 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.
Events() interface{}
SetEvents(val interface{})
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
// Experimental.
LogicalId() *string
// The name of the component.
Name() *string
SetName(val *string)
// The construct tree node associated with this construct.
// Experimental.
Node() awscdk.ConstructNode
// 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` .
Overrides() interface{}
SetOverrides(val interface{})
// Describes the component's properties.
//
// You can't specify `tags` as a valid property for `properties` .
Properties() interface{}
SetProperties(val interface{})
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
// Experimental.
Ref() *string
// The schema version of the component when it was imported.
SchemaVersion() *string
SetSchemaVersion(val *string)
// The unique ID of the component in its original source system, such as Figma.
SourceId() *string
SetSourceId(val *string)
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
// Experimental.
Stack() awscdk.Stack
// One or more key-value pairs to use when tagging the component.
Tags() awscdk.TagManager
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
// Experimental.
UpdatedProperites() *map[string]interface{}
// A list of the component's variants.
//
// A variant is a unique style configuration of a main component.
Variants() interface{}
SetVariants(val interface{})
// Syntactic sugar for `addOverride(path, undefined)`.
// Experimental.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
// Experimental.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
// Experimental.
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
// Experimental.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
// Experimental.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
// Experimental.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
// Experimental.
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
// Experimental.
GetAtt(attributeName *string) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
// Experimental.
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
OnPrepare()
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
OnSynthesize(session constructs.ISynthesisSession)
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
OnValidate() *[]*string
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
// Experimental.
ShouldSynthesize() *bool
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
Synthesize(session awscdk.ISynthesisSession)
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
// Experimental.
ToString() *string
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
Validate() *[]*string
// Experimental.
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::AmplifyUIBuilder::Component`.
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` .
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
var componentChildProperty_ componentChildProperty
var componentPropertyProperty_ componentPropertyProperty
var overrides interface{}
var predicateProperty_ predicateProperty
cfnComponent := awscdk.Aws_amplifyuibuilder.NewCfnComponent(this, jsii.String("MyCfnComponent"), &cfnComponentProps{
bindingProperties: map[string]interface{}{
"bindingPropertiesKey": &ComponentBindingPropertiesValueProperty{
"bindingProperties": &ComponentBindingPropertiesValuePropertiesProperty{
"bucket": jsii.String("bucket"),
"defaultValue": jsii.String("defaultValue"),
"field": jsii.String("field"),
"key": jsii.String("key"),
"model": jsii.String("model"),
"predicates": []interface{}{
&predicateProperty{
"and": []interface{}{
predicateProperty_,
},
"field": jsii.String("field"),
"operand": jsii.String("operand"),
"operator": jsii.String("operator"),
"or": []interface{}{
predicateProperty_,
},
},
},
"userAttribute": jsii.String("userAttribute"),
},
"defaultValue": jsii.String("defaultValue"),
"type": jsii.String("type"),
},
},
componentType: jsii.String("componentType"),
name: jsii.String("name"),
overrides: overrides,
properties: map[string]interface{}{
"propertiesKey": &componentPropertyProperty{
"bindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"bindings": map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
"collectionBindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"componentName": jsii.String("componentName"),
"concat": []interface{}{
componentPropertyProperty_,
},
"condition": &ComponentConditionPropertyProperty{
"else": componentPropertyProperty_,
"field": jsii.String("field"),
"operand": jsii.String("operand"),
"operandType": jsii.String("operandType"),
"operator": jsii.String("operator"),
"property": jsii.String("property"),
"then": componentPropertyProperty_,
},
"configured": jsii.Boolean(false),
"defaultValue": jsii.String("defaultValue"),
"event": jsii.String("event"),
"importedValue": jsii.String("importedValue"),
"model": jsii.String("model"),
"property": jsii.String("property"),
"type": jsii.String("type"),
"userAttribute": jsii.String("userAttribute"),
"value": jsii.String("value"),
},
},
variants: []interface{}{
&componentVariantProperty{
overrides: overrides,
variantValues: map[string]*string{
"variantValuesKey": jsii.String("variantValues"),
},
},
},
// the properties below are optional
children: []interface{}{
&componentChildProperty{
componentType: jsii.String("componentType"),
name: jsii.String("name"),
properties: map[string]interface{}{
"propertiesKey": &componentPropertyProperty{
"bindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"bindings": map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
"collectionBindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"componentName": jsii.String("componentName"),
"concat": []interface{}{
componentPropertyProperty_,
},
"condition": &ComponentConditionPropertyProperty{
"else": componentPropertyProperty_,
"field": jsii.String("field"),
"operand": jsii.String("operand"),
"operandType": jsii.String("operandType"),
"operator": jsii.String("operator"),
"property": jsii.String("property"),
"then": componentPropertyProperty_,
},
"configured": jsii.Boolean(false),
"defaultValue": jsii.String("defaultValue"),
"event": jsii.String("event"),
"importedValue": jsii.String("importedValue"),
"model": jsii.String("model"),
"property": jsii.String("property"),
"type": jsii.String("type"),
"userAttribute": jsii.String("userAttribute"),
"value": jsii.String("value"),
},
},
// the properties below are optional
children: []interface{}{
componentChildProperty_,
},
events: map[string]interface{}{
"eventsKey": &ComponentEventProperty{
"action": jsii.String("action"),
"parameters": &ActionParametersProperty{
"anchor": &componentPropertyProperty{
"bindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"bindings": map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
"collectionBindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"componentName": jsii.String("componentName"),
"concat": []interface{}{
componentPropertyProperty_,
},
"condition": &ComponentConditionPropertyProperty{
"else": componentPropertyProperty_,
"field": jsii.String("field"),
"operand": jsii.String("operand"),
"operandType": jsii.String("operandType"),
"operator": jsii.String("operator"),
"property": jsii.String("property"),
"then": componentPropertyProperty_,
},
"configured": jsii.Boolean(false),
"defaultValue": jsii.String("defaultValue"),
"event": jsii.String("event"),
"importedValue": jsii.String("importedValue"),
"model": jsii.String("model"),
"property": jsii.String("property"),
"type": jsii.String("type"),
"userAttribute": jsii.String("userAttribute"),
"value": jsii.String("value"),
},
"fields": map[string]interface{}{
"fieldsKey": &componentPropertyProperty{
"bindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"bindings": map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
"collectionBindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"componentName": jsii.String("componentName"),
"concat": []interface{}{
componentPropertyProperty_,
},
"condition": &ComponentConditionPropertyProperty{
"else": componentPropertyProperty_,
"field": jsii.String("field"),
"operand": jsii.String("operand"),
"operandType": jsii.String("operandType"),
"operator": jsii.String("operator"),
"property": jsii.String("property"),
"then": componentPropertyProperty_,
},
"configured": jsii.Boolean(false),
"defaultValue": jsii.String("defaultValue"),
"event": jsii.String("event"),
"importedValue": jsii.String("importedValue"),
"model": jsii.String("model"),
"property": jsii.String("property"),
"type": jsii.String("type"),
"userAttribute": jsii.String("userAttribute"),
"value": jsii.String("value"),
},
},
"global": &componentPropertyProperty{
"bindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"bindings": map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
"collectionBindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"componentName": jsii.String("componentName"),
"concat": []interface{}{
componentPropertyProperty_,
},
"condition": &ComponentConditionPropertyProperty{
"else": componentPropertyProperty_,
"field": jsii.String("field"),
"operand": jsii.String("operand"),
"operandType": jsii.String("operandType"),
"operator": jsii.String("operator"),
"property": jsii.String("property"),
"then": componentPropertyProperty_,
},
"configured": jsii.Boolean(false),
"defaultValue": jsii.String("defaultValue"),
"event": jsii.String("event"),
"importedValue": jsii.String("importedValue"),
"model": jsii.String("model"),
"property": jsii.String("property"),
"type": jsii.String("type"),
"userAttribute": jsii.String("userAttribute"),
"value": jsii.String("value"),
},
"id": &componentPropertyProperty{
"bindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"bindings": map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
"collectionBindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"componentName": jsii.String("componentName"),
"concat": []interface{}{
componentPropertyProperty_,
},
"condition": &ComponentConditionPropertyProperty{
"else": componentPropertyProperty_,
"field": jsii.String("field"),
"operand": jsii.String("operand"),
"operandType": jsii.String("operandType"),
"operator": jsii.String("operator"),
"property": jsii.String("property"),
"then": componentPropertyProperty_,
},
"configured": jsii.Boolean(false),
"defaultValue": jsii.String("defaultValue"),
"event": jsii.String("event"),
"importedValue": jsii.String("importedValue"),
"model": jsii.String("model"),
"property": jsii.String("property"),
"type": jsii.String("type"),
"userAttribute": jsii.String("userAttribute"),
"value": jsii.String("value"),
},
"model": jsii.String("model"),
"state": &MutationActionSetStateParameterProperty{
"componentName": jsii.String("componentName"),
"property": jsii.String("property"),
"set": &componentPropertyProperty{
"bindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"bindings": map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
"collectionBindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"componentName": jsii.String("componentName"),
"concat": []interface{}{
componentPropertyProperty_,
},
"condition": &ComponentConditionPropertyProperty{
"else": componentPropertyProperty_,
"field": jsii.String("field"),
"operand": jsii.String("operand"),
"operandType": jsii.String("operandType"),
"operator": jsii.String("operator"),
"property": jsii.String("property"),
"then": componentPropertyProperty_,
},
"configured": jsii.Boolean(false),
"defaultValue": jsii.String("defaultValue"),
"event": jsii.String("event"),
"importedValue": jsii.String("importedValue"),
"model": jsii.String("model"),
"property": jsii.String("property"),
"type": jsii.String("type"),
"userAttribute": jsii.String("userAttribute"),
"value": jsii.String("value"),
},
},
"target": &componentPropertyProperty{
"bindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"bindings": map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
"collectionBindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"componentName": jsii.String("componentName"),
"concat": []interface{}{
componentPropertyProperty_,
},
"condition": &ComponentConditionPropertyProperty{
"else": componentPropertyProperty_,
"field": jsii.String("field"),
"operand": jsii.String("operand"),
"operandType": jsii.String("operandType"),
"operator": jsii.String("operator"),
"property": jsii.String("property"),
"then": componentPropertyProperty_,
},
"configured": jsii.Boolean(false),
"defaultValue": jsii.String("defaultValue"),
"event": jsii.String("event"),
"importedValue": jsii.String("importedValue"),
"model": jsii.String("model"),
"property": jsii.String("property"),
"type": jsii.String("type"),
"userAttribute": jsii.String("userAttribute"),
"value": jsii.String("value"),
},
"type": &componentPropertyProperty{
"bindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"bindings": map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
"collectionBindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"componentName": jsii.String("componentName"),
"concat": []interface{}{
componentPropertyProperty_,
},
"condition": &ComponentConditionPropertyProperty{
"else": componentPropertyProperty_,
"field": jsii.String("field"),
"operand": jsii.String("operand"),
"operandType": jsii.String("operandType"),
"operator": jsii.String("operator"),
"property": jsii.String("property"),
"then": componentPropertyProperty_,
},
"configured": jsii.Boolean(false),
"defaultValue": jsii.String("defaultValue"),
"event": jsii.String("event"),
"importedValue": jsii.String("importedValue"),
"model": jsii.String("model"),
"property": jsii.String("property"),
"type": jsii.String("type"),
"userAttribute": jsii.String("userAttribute"),
"value": jsii.String("value"),
},
"url": &componentPropertyProperty{
"bindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"bindings": map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
"collectionBindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"componentName": jsii.String("componentName"),
"concat": []interface{}{
componentPropertyProperty_,
},
"condition": &ComponentConditionPropertyProperty{
"else": componentPropertyProperty_,
"field": jsii.String("field"),
"operand": jsii.String("operand"),
"operandType": jsii.String("operandType"),
"operator": jsii.String("operator"),
"property": jsii.String("property"),
"then": componentPropertyProperty_,
},
"configured": jsii.Boolean(false),
"defaultValue": jsii.String("defaultValue"),
"event": jsii.String("event"),
"importedValue": jsii.String("importedValue"),
"model": jsii.String("model"),
"property": jsii.String("property"),
"type": jsii.String("type"),
"userAttribute": jsii.String("userAttribute"),
"value": jsii.String("value"),
},
},
},
},
},
},
collectionProperties: map[string]interface{}{
"collectionPropertiesKey": &ComponentDataConfigurationProperty{
"model": jsii.String("model"),
// the properties below are optional
"identifiers": []*string{
jsii.String("identifiers"),
},
"predicate": &predicateProperty{
"and": []interface{}{
predicateProperty_,
},
"field": jsii.String("field"),
"operand": jsii.String("operand"),
"operator": jsii.String("operator"),
"or": []interface{}{
predicateProperty_,
},
},
"sort": []interface{}{
&SortPropertyProperty{
"direction": jsii.String("direction"),
"field": jsii.String("field"),
},
},
},
},
events: map[string]interface{}{
"eventsKey": &ComponentEventProperty{
"action": jsii.String("action"),
"parameters": &ActionParametersProperty{
"anchor": &componentPropertyProperty{
"bindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"bindings": map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
"collectionBindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"componentName": jsii.String("componentName"),
"concat": []interface{}{
componentPropertyProperty_,
},
"condition": &ComponentConditionPropertyProperty{
"else": componentPropertyProperty_,
"field": jsii.String("field"),
"operand": jsii.String("operand"),
"operandType": jsii.String("operandType"),
"operator": jsii.String("operator"),
"property": jsii.String("property"),
"then": componentPropertyProperty_,
},
"configured": jsii.Boolean(false),
"defaultValue": jsii.String("defaultValue"),
"event": jsii.String("event"),
"importedValue": jsii.String("importedValue"),
"model": jsii.String("model"),
"property": jsii.String("property"),
"type": jsii.String("type"),
"userAttribute": jsii.String("userAttribute"),
"value": jsii.String("value"),
},
"fields": map[string]interface{}{
"fieldsKey": &componentPropertyProperty{
"bindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"bindings": map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
"collectionBindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"componentName": jsii.String("componentName"),
"concat": []interface{}{
componentPropertyProperty_,
},
"condition": &ComponentConditionPropertyProperty{
"else": componentPropertyProperty_,
"field": jsii.String("field"),
"operand": jsii.String("operand"),
"operandType": jsii.String("operandType"),
"operator": jsii.String("operator"),
"property": jsii.String("property"),
"then": componentPropertyProperty_,
},
"configured": jsii.Boolean(false),
"defaultValue": jsii.String("defaultValue"),
"event": jsii.String("event"),
"importedValue": jsii.String("importedValue"),
"model": jsii.String("model"),
"property": jsii.String("property"),
"type": jsii.String("type"),
"userAttribute": jsii.String("userAttribute"),
"value": jsii.String("value"),
},
},
"global": &componentPropertyProperty{
"bindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"bindings": map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
"collectionBindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"componentName": jsii.String("componentName"),
"concat": []interface{}{
componentPropertyProperty_,
},
"condition": &ComponentConditionPropertyProperty{
"else": componentPropertyProperty_,
"field": jsii.String("field"),
"operand": jsii.String("operand"),
"operandType": jsii.String("operandType"),
"operator": jsii.String("operator"),
"property": jsii.String("property"),
"then": componentPropertyProperty_,
},
"configured": jsii.Boolean(false),
"defaultValue": jsii.String("defaultValue"),
"event": jsii.String("event"),
"importedValue": jsii.String("importedValue"),
"model": jsii.String("model"),
"property": jsii.String("property"),
"type": jsii.String("type"),
"userAttribute": jsii.String("userAttribute"),
"value": jsii.String("value"),
},
"id": &componentPropertyProperty{
"bindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"bindings": map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
"collectionBindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"componentName": jsii.String("componentName"),
"concat": []interface{}{
componentPropertyProperty_,
},
"condition": &ComponentConditionPropertyProperty{
"else": componentPropertyProperty_,
"field": jsii.String("field"),
"operand": jsii.String("operand"),
"operandType": jsii.String("operandType"),
"operator": jsii.String("operator"),
"property": jsii.String("property"),
"then": componentPropertyProperty_,
},
"configured": jsii.Boolean(false),
"defaultValue": jsii.String("defaultValue"),
"event": jsii.String("event"),
"importedValue": jsii.String("importedValue"),
"model": jsii.String("model"),
"property": jsii.String("property"),
"type": jsii.String("type"),
"userAttribute": jsii.String("userAttribute"),
"value": jsii.String("value"),
},
"model": jsii.String("model"),
"state": &MutationActionSetStateParameterProperty{
"componentName": jsii.String("componentName"),
"property": jsii.String("property"),
"set": &componentPropertyProperty{
"bindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"bindings": map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
"collectionBindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"componentName": jsii.String("componentName"),
"concat": []interface{}{
componentPropertyProperty_,
},
"condition": &ComponentConditionPropertyProperty{
"else": componentPropertyProperty_,
"field": jsii.String("field"),
"operand": jsii.String("operand"),
"operandType": jsii.String("operandType"),
"operator": jsii.String("operator"),
"property": jsii.String("property"),
"then": componentPropertyProperty_,
},
"configured": jsii.Boolean(false),
"defaultValue": jsii.String("defaultValue"),
"event": jsii.String("event"),
"importedValue": jsii.String("importedValue"),
"model": jsii.String("model"),
"property": jsii.String("property"),
"type": jsii.String("type"),
"userAttribute": jsii.String("userAttribute"),
"value": jsii.String("value"),
},
},
"target": &componentPropertyProperty{
"bindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"bindings": map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
"collectionBindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"componentName": jsii.String("componentName"),
"concat": []interface{}{
componentPropertyProperty_,
},
"condition": &ComponentConditionPropertyProperty{
"else": componentPropertyProperty_,
"field": jsii.String("field"),
"operand": jsii.String("operand"),
"operandType": jsii.String("operandType"),
"operator": jsii.String("operator"),
"property": jsii.String("property"),
"then": componentPropertyProperty_,
},
"configured": jsii.Boolean(false),
"defaultValue": jsii.String("defaultValue"),
"event": jsii.String("event"),
"importedValue": jsii.String("importedValue"),
"model": jsii.String("model"),
"property": jsii.String("property"),
"type": jsii.String("type"),
"userAttribute": jsii.String("userAttribute"),
"value": jsii.String("value"),
},
"type": &componentPropertyProperty{
"bindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"bindings": map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
"collectionBindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"componentName": jsii.String("componentName"),
"concat": []interface{}{
componentPropertyProperty_,
},
"condition": &ComponentConditionPropertyProperty{
"else": componentPropertyProperty_,
"field": jsii.String("field"),
"operand": jsii.String("operand"),
"operandType": jsii.String("operandType"),
"operator": jsii.String("operator"),
"property": jsii.String("property"),
"then": componentPropertyProperty_,
},
"configured": jsii.Boolean(false),
"defaultValue": jsii.String("defaultValue"),
"event": jsii.String("event"),
"importedValue": jsii.String("importedValue"),
"model": jsii.String("model"),
"property": jsii.String("property"),
"type": jsii.String("type"),
"userAttribute": jsii.String("userAttribute"),
"value": jsii.String("value"),
},
"url": &componentPropertyProperty{
"bindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"bindings": map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
"collectionBindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"componentName": jsii.String("componentName"),
"concat": []interface{}{
componentPropertyProperty_,
},
"condition": &ComponentConditionPropertyProperty{
"else": componentPropertyProperty_,
"field": jsii.String("field"),
"operand": jsii.String("operand"),
"operandType": jsii.String("operandType"),
"operator": jsii.String("operator"),
"property": jsii.String("property"),
"then": componentPropertyProperty_,
},
"configured": jsii.Boolean(false),
"defaultValue": jsii.String("defaultValue"),
"event": jsii.String("event"),
"importedValue": jsii.String("importedValue"),
"model": jsii.String("model"),
"property": jsii.String("property"),
"type": jsii.String("type"),
"userAttribute": jsii.String("userAttribute"),
"value": jsii.String("value"),
},
},
},
},
schemaVersion: jsii.String("schemaVersion"),
sourceId: jsii.String("sourceId"),
tags: map[string]*string{
"tagsKey": jsii.String("tags"),
},
})
func NewCfnComponent ¶
func NewCfnComponent(scope awscdk.Construct, id *string, props *CfnComponentProps) CfnComponent
Create a new `AWS::AmplifyUIBuilder::Component`.
type CfnComponentProps ¶
type CfnComponentProps struct {
// The information to connect a component's properties to data at runtime.
//
// You can't specify `tags` as a valid property for `bindingProperties` .
BindingProperties interface{} `field:"required" json:"bindingProperties" yaml:"bindingProperties"`
// The type of the component.
//
// This can be an Amplify custom UI component or another custom component.
ComponentType *string `field:"required" json:"componentType" yaml:"componentType"`
// The name of the component.
Name *string `field:"required" json:"name" yaml:"name"`
// 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` .
Overrides interface{} `field:"required" json:"overrides" yaml:"overrides"`
// Describes the component's properties.
//
// You can't specify `tags` as a valid property for `properties` .
Properties interface{} `field:"required" json:"properties" yaml:"properties"`
// A list of the component's variants.
//
// A variant is a unique style configuration of a main component.
Variants interface{} `field:"required" json:"variants" yaml:"variants"`
// A list of the component's `ComponentChild` instances.
Children interface{} `field:"optional" json:"children" yaml:"children"`
// 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` .
CollectionProperties interface{} `field:"optional" json:"collectionProperties" yaml:"collectionProperties"`
// 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.
Events interface{} `field:"optional" json:"events" yaml:"events"`
// The schema version of the component when it was imported.
SchemaVersion *string `field:"optional" json:"schemaVersion" yaml:"schemaVersion"`
// The unique ID of the component in its original source system, such as Figma.
SourceId *string `field:"optional" json:"sourceId" yaml:"sourceId"`
// One or more key-value pairs to use when tagging the component.
Tags *map[string]*string `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnComponent`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
var componentChildProperty_ componentChildProperty
var componentPropertyProperty_ componentPropertyProperty
var overrides interface{}
var predicateProperty_ predicateProperty
cfnComponentProps := &cfnComponentProps{
bindingProperties: map[string]interface{}{
"bindingPropertiesKey": &ComponentBindingPropertiesValueProperty{
"bindingProperties": &ComponentBindingPropertiesValuePropertiesProperty{
"bucket": jsii.String("bucket"),
"defaultValue": jsii.String("defaultValue"),
"field": jsii.String("field"),
"key": jsii.String("key"),
"model": jsii.String("model"),
"predicates": []interface{}{
&predicateProperty{
"and": []interface{}{
predicateProperty_,
},
"field": jsii.String("field"),
"operand": jsii.String("operand"),
"operator": jsii.String("operator"),
"or": []interface{}{
predicateProperty_,
},
},
},
"userAttribute": jsii.String("userAttribute"),
},
"defaultValue": jsii.String("defaultValue"),
"type": jsii.String("type"),
},
},
componentType: jsii.String("componentType"),
name: jsii.String("name"),
overrides: overrides,
properties: map[string]interface{}{
"propertiesKey": &componentPropertyProperty{
"bindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"bindings": map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
"collectionBindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"componentName": jsii.String("componentName"),
"concat": []interface{}{
componentPropertyProperty_,
},
"condition": &ComponentConditionPropertyProperty{
"else": componentPropertyProperty_,
"field": jsii.String("field"),
"operand": jsii.String("operand"),
"operandType": jsii.String("operandType"),
"operator": jsii.String("operator"),
"property": jsii.String("property"),
"then": componentPropertyProperty_,
},
"configured": jsii.Boolean(false),
"defaultValue": jsii.String("defaultValue"),
"event": jsii.String("event"),
"importedValue": jsii.String("importedValue"),
"model": jsii.String("model"),
"property": jsii.String("property"),
"type": jsii.String("type"),
"userAttribute": jsii.String("userAttribute"),
"value": jsii.String("value"),
},
},
variants: []interface{}{
&componentVariantProperty{
overrides: overrides,
variantValues: map[string]*string{
"variantValuesKey": jsii.String("variantValues"),
},
},
},
// the properties below are optional
children: []interface{}{
&componentChildProperty{
componentType: jsii.String("componentType"),
name: jsii.String("name"),
properties: map[string]interface{}{
"propertiesKey": &componentPropertyProperty{
"bindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"bindings": map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
"collectionBindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"componentName": jsii.String("componentName"),
"concat": []interface{}{
componentPropertyProperty_,
},
"condition": &ComponentConditionPropertyProperty{
"else": componentPropertyProperty_,
"field": jsii.String("field"),
"operand": jsii.String("operand"),
"operandType": jsii.String("operandType"),
"operator": jsii.String("operator"),
"property": jsii.String("property"),
"then": componentPropertyProperty_,
},
"configured": jsii.Boolean(false),
"defaultValue": jsii.String("defaultValue"),
"event": jsii.String("event"),
"importedValue": jsii.String("importedValue"),
"model": jsii.String("model"),
"property": jsii.String("property"),
"type": jsii.String("type"),
"userAttribute": jsii.String("userAttribute"),
"value": jsii.String("value"),
},
},
// the properties below are optional
children: []interface{}{
componentChildProperty_,
},
events: map[string]interface{}{
"eventsKey": &ComponentEventProperty{
"action": jsii.String("action"),
"parameters": &ActionParametersProperty{
"anchor": &componentPropertyProperty{
"bindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"bindings": map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
"collectionBindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"componentName": jsii.String("componentName"),
"concat": []interface{}{
componentPropertyProperty_,
},
"condition": &ComponentConditionPropertyProperty{
"else": componentPropertyProperty_,
"field": jsii.String("field"),
"operand": jsii.String("operand"),
"operandType": jsii.String("operandType"),
"operator": jsii.String("operator"),
"property": jsii.String("property"),
"then": componentPropertyProperty_,
},
"configured": jsii.Boolean(false),
"defaultValue": jsii.String("defaultValue"),
"event": jsii.String("event"),
"importedValue": jsii.String("importedValue"),
"model": jsii.String("model"),
"property": jsii.String("property"),
"type": jsii.String("type"),
"userAttribute": jsii.String("userAttribute"),
"value": jsii.String("value"),
},
"fields": map[string]interface{}{
"fieldsKey": &componentPropertyProperty{
"bindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"bindings": map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
"collectionBindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"componentName": jsii.String("componentName"),
"concat": []interface{}{
componentPropertyProperty_,
},
"condition": &ComponentConditionPropertyProperty{
"else": componentPropertyProperty_,
"field": jsii.String("field"),
"operand": jsii.String("operand"),
"operandType": jsii.String("operandType"),
"operator": jsii.String("operator"),
"property": jsii.String("property"),
"then": componentPropertyProperty_,
},
"configured": jsii.Boolean(false),
"defaultValue": jsii.String("defaultValue"),
"event": jsii.String("event"),
"importedValue": jsii.String("importedValue"),
"model": jsii.String("model"),
"property": jsii.String("property"),
"type": jsii.String("type"),
"userAttribute": jsii.String("userAttribute"),
"value": jsii.String("value"),
},
},
"global": &componentPropertyProperty{
"bindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"bindings": map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
"collectionBindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"componentName": jsii.String("componentName"),
"concat": []interface{}{
componentPropertyProperty_,
},
"condition": &ComponentConditionPropertyProperty{
"else": componentPropertyProperty_,
"field": jsii.String("field"),
"operand": jsii.String("operand"),
"operandType": jsii.String("operandType"),
"operator": jsii.String("operator"),
"property": jsii.String("property"),
"then": componentPropertyProperty_,
},
"configured": jsii.Boolean(false),
"defaultValue": jsii.String("defaultValue"),
"event": jsii.String("event"),
"importedValue": jsii.String("importedValue"),
"model": jsii.String("model"),
"property": jsii.String("property"),
"type": jsii.String("type"),
"userAttribute": jsii.String("userAttribute"),
"value": jsii.String("value"),
},
"id": &componentPropertyProperty{
"bindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"bindings": map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
"collectionBindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"componentName": jsii.String("componentName"),
"concat": []interface{}{
componentPropertyProperty_,
},
"condition": &ComponentConditionPropertyProperty{
"else": componentPropertyProperty_,
"field": jsii.String("field"),
"operand": jsii.String("operand"),
"operandType": jsii.String("operandType"),
"operator": jsii.String("operator"),
"property": jsii.String("property"),
"then": componentPropertyProperty_,
},
"configured": jsii.Boolean(false),
"defaultValue": jsii.String("defaultValue"),
"event": jsii.String("event"),
"importedValue": jsii.String("importedValue"),
"model": jsii.String("model"),
"property": jsii.String("property"),
"type": jsii.String("type"),
"userAttribute": jsii.String("userAttribute"),
"value": jsii.String("value"),
},
"model": jsii.String("model"),
"state": &MutationActionSetStateParameterProperty{
"componentName": jsii.String("componentName"),
"property": jsii.String("property"),
"set": &componentPropertyProperty{
"bindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"bindings": map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
"collectionBindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"componentName": jsii.String("componentName"),
"concat": []interface{}{
componentPropertyProperty_,
},
"condition": &ComponentConditionPropertyProperty{
"else": componentPropertyProperty_,
"field": jsii.String("field"),
"operand": jsii.String("operand"),
"operandType": jsii.String("operandType"),
"operator": jsii.String("operator"),
"property": jsii.String("property"),
"then": componentPropertyProperty_,
},
"configured": jsii.Boolean(false),
"defaultValue": jsii.String("defaultValue"),
"event": jsii.String("event"),
"importedValue": jsii.String("importedValue"),
"model": jsii.String("model"),
"property": jsii.String("property"),
"type": jsii.String("type"),
"userAttribute": jsii.String("userAttribute"),
"value": jsii.String("value"),
},
},
"target": &componentPropertyProperty{
"bindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"bindings": map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
"collectionBindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"componentName": jsii.String("componentName"),
"concat": []interface{}{
componentPropertyProperty_,
},
"condition": &ComponentConditionPropertyProperty{
"else": componentPropertyProperty_,
"field": jsii.String("field"),
"operand": jsii.String("operand"),
"operandType": jsii.String("operandType"),
"operator": jsii.String("operator"),
"property": jsii.String("property"),
"then": componentPropertyProperty_,
},
"configured": jsii.Boolean(false),
"defaultValue": jsii.String("defaultValue"),
"event": jsii.String("event"),
"importedValue": jsii.String("importedValue"),
"model": jsii.String("model"),
"property": jsii.String("property"),
"type": jsii.String("type"),
"userAttribute": jsii.String("userAttribute"),
"value": jsii.String("value"),
},
"type": &componentPropertyProperty{
"bindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"bindings": map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
"collectionBindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"componentName": jsii.String("componentName"),
"concat": []interface{}{
componentPropertyProperty_,
},
"condition": &ComponentConditionPropertyProperty{
"else": componentPropertyProperty_,
"field": jsii.String("field"),
"operand": jsii.String("operand"),
"operandType": jsii.String("operandType"),
"operator": jsii.String("operator"),
"property": jsii.String("property"),
"then": componentPropertyProperty_,
},
"configured": jsii.Boolean(false),
"defaultValue": jsii.String("defaultValue"),
"event": jsii.String("event"),
"importedValue": jsii.String("importedValue"),
"model": jsii.String("model"),
"property": jsii.String("property"),
"type": jsii.String("type"),
"userAttribute": jsii.String("userAttribute"),
"value": jsii.String("value"),
},
"url": &componentPropertyProperty{
"bindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"bindings": map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
"collectionBindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"componentName": jsii.String("componentName"),
"concat": []interface{}{
componentPropertyProperty_,
},
"condition": &ComponentConditionPropertyProperty{
"else": componentPropertyProperty_,
"field": jsii.String("field"),
"operand": jsii.String("operand"),
"operandType": jsii.String("operandType"),
"operator": jsii.String("operator"),
"property": jsii.String("property"),
"then": componentPropertyProperty_,
},
"configured": jsii.Boolean(false),
"defaultValue": jsii.String("defaultValue"),
"event": jsii.String("event"),
"importedValue": jsii.String("importedValue"),
"model": jsii.String("model"),
"property": jsii.String("property"),
"type": jsii.String("type"),
"userAttribute": jsii.String("userAttribute"),
"value": jsii.String("value"),
},
},
},
},
},
},
collectionProperties: map[string]interface{}{
"collectionPropertiesKey": &ComponentDataConfigurationProperty{
"model": jsii.String("model"),
// the properties below are optional
"identifiers": []*string{
jsii.String("identifiers"),
},
"predicate": &predicateProperty{
"and": []interface{}{
predicateProperty_,
},
"field": jsii.String("field"),
"operand": jsii.String("operand"),
"operator": jsii.String("operator"),
"or": []interface{}{
predicateProperty_,
},
},
"sort": []interface{}{
&SortPropertyProperty{
"direction": jsii.String("direction"),
"field": jsii.String("field"),
},
},
},
},
events: map[string]interface{}{
"eventsKey": &ComponentEventProperty{
"action": jsii.String("action"),
"parameters": &ActionParametersProperty{
"anchor": &componentPropertyProperty{
"bindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"bindings": map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
"collectionBindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"componentName": jsii.String("componentName"),
"concat": []interface{}{
componentPropertyProperty_,
},
"condition": &ComponentConditionPropertyProperty{
"else": componentPropertyProperty_,
"field": jsii.String("field"),
"operand": jsii.String("operand"),
"operandType": jsii.String("operandType"),
"operator": jsii.String("operator"),
"property": jsii.String("property"),
"then": componentPropertyProperty_,
},
"configured": jsii.Boolean(false),
"defaultValue": jsii.String("defaultValue"),
"event": jsii.String("event"),
"importedValue": jsii.String("importedValue"),
"model": jsii.String("model"),
"property": jsii.String("property"),
"type": jsii.String("type"),
"userAttribute": jsii.String("userAttribute"),
"value": jsii.String("value"),
},
"fields": map[string]interface{}{
"fieldsKey": &componentPropertyProperty{
"bindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"bindings": map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
"collectionBindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"componentName": jsii.String("componentName"),
"concat": []interface{}{
componentPropertyProperty_,
},
"condition": &ComponentConditionPropertyProperty{
"else": componentPropertyProperty_,
"field": jsii.String("field"),
"operand": jsii.String("operand"),
"operandType": jsii.String("operandType"),
"operator": jsii.String("operator"),
"property": jsii.String("property"),
"then": componentPropertyProperty_,
},
"configured": jsii.Boolean(false),
"defaultValue": jsii.String("defaultValue"),
"event": jsii.String("event"),
"importedValue": jsii.String("importedValue"),
"model": jsii.String("model"),
"property": jsii.String("property"),
"type": jsii.String("type"),
"userAttribute": jsii.String("userAttribute"),
"value": jsii.String("value"),
},
},
"global": &componentPropertyProperty{
"bindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"bindings": map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
"collectionBindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"componentName": jsii.String("componentName"),
"concat": []interface{}{
componentPropertyProperty_,
},
"condition": &ComponentConditionPropertyProperty{
"else": componentPropertyProperty_,
"field": jsii.String("field"),
"operand": jsii.String("operand"),
"operandType": jsii.String("operandType"),
"operator": jsii.String("operator"),
"property": jsii.String("property"),
"then": componentPropertyProperty_,
},
"configured": jsii.Boolean(false),
"defaultValue": jsii.String("defaultValue"),
"event": jsii.String("event"),
"importedValue": jsii.String("importedValue"),
"model": jsii.String("model"),
"property": jsii.String("property"),
"type": jsii.String("type"),
"userAttribute": jsii.String("userAttribute"),
"value": jsii.String("value"),
},
"id": &componentPropertyProperty{
"bindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"bindings": map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
"collectionBindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"componentName": jsii.String("componentName"),
"concat": []interface{}{
componentPropertyProperty_,
},
"condition": &ComponentConditionPropertyProperty{
"else": componentPropertyProperty_,
"field": jsii.String("field"),
"operand": jsii.String("operand"),
"operandType": jsii.String("operandType"),
"operator": jsii.String("operator"),
"property": jsii.String("property"),
"then": componentPropertyProperty_,
},
"configured": jsii.Boolean(false),
"defaultValue": jsii.String("defaultValue"),
"event": jsii.String("event"),
"importedValue": jsii.String("importedValue"),
"model": jsii.String("model"),
"property": jsii.String("property"),
"type": jsii.String("type"),
"userAttribute": jsii.String("userAttribute"),
"value": jsii.String("value"),
},
"model": jsii.String("model"),
"state": &MutationActionSetStateParameterProperty{
"componentName": jsii.String("componentName"),
"property": jsii.String("property"),
"set": &componentPropertyProperty{
"bindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"bindings": map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
"collectionBindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"componentName": jsii.String("componentName"),
"concat": []interface{}{
componentPropertyProperty_,
},
"condition": &ComponentConditionPropertyProperty{
"else": componentPropertyProperty_,
"field": jsii.String("field"),
"operand": jsii.String("operand"),
"operandType": jsii.String("operandType"),
"operator": jsii.String("operator"),
"property": jsii.String("property"),
"then": componentPropertyProperty_,
},
"configured": jsii.Boolean(false),
"defaultValue": jsii.String("defaultValue"),
"event": jsii.String("event"),
"importedValue": jsii.String("importedValue"),
"model": jsii.String("model"),
"property": jsii.String("property"),
"type": jsii.String("type"),
"userAttribute": jsii.String("userAttribute"),
"value": jsii.String("value"),
},
},
"target": &componentPropertyProperty{
"bindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"bindings": map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
"collectionBindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"componentName": jsii.String("componentName"),
"concat": []interface{}{
componentPropertyProperty_,
},
"condition": &ComponentConditionPropertyProperty{
"else": componentPropertyProperty_,
"field": jsii.String("field"),
"operand": jsii.String("operand"),
"operandType": jsii.String("operandType"),
"operator": jsii.String("operator"),
"property": jsii.String("property"),
"then": componentPropertyProperty_,
},
"configured": jsii.Boolean(false),
"defaultValue": jsii.String("defaultValue"),
"event": jsii.String("event"),
"importedValue": jsii.String("importedValue"),
"model": jsii.String("model"),
"property": jsii.String("property"),
"type": jsii.String("type"),
"userAttribute": jsii.String("userAttribute"),
"value": jsii.String("value"),
},
"type": &componentPropertyProperty{
"bindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"bindings": map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
"collectionBindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"componentName": jsii.String("componentName"),
"concat": []interface{}{
componentPropertyProperty_,
},
"condition": &ComponentConditionPropertyProperty{
"else": componentPropertyProperty_,
"field": jsii.String("field"),
"operand": jsii.String("operand"),
"operandType": jsii.String("operandType"),
"operator": jsii.String("operator"),
"property": jsii.String("property"),
"then": componentPropertyProperty_,
},
"configured": jsii.Boolean(false),
"defaultValue": jsii.String("defaultValue"),
"event": jsii.String("event"),
"importedValue": jsii.String("importedValue"),
"model": jsii.String("model"),
"property": jsii.String("property"),
"type": jsii.String("type"),
"userAttribute": jsii.String("userAttribute"),
"value": jsii.String("value"),
},
"url": &componentPropertyProperty{
"bindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"bindings": map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
"collectionBindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"componentName": jsii.String("componentName"),
"concat": []interface{}{
componentPropertyProperty_,
},
"condition": &ComponentConditionPropertyProperty{
"else": componentPropertyProperty_,
"field": jsii.String("field"),
"operand": jsii.String("operand"),
"operandType": jsii.String("operandType"),
"operator": jsii.String("operator"),
"property": jsii.String("property"),
"then": componentPropertyProperty_,
},
"configured": jsii.Boolean(false),
"defaultValue": jsii.String("defaultValue"),
"event": jsii.String("event"),
"importedValue": jsii.String("importedValue"),
"model": jsii.String("model"),
"property": jsii.String("property"),
"type": jsii.String("type"),
"userAttribute": jsii.String("userAttribute"),
"value": jsii.String("value"),
},
},
},
},
schemaVersion: jsii.String("schemaVersion"),
sourceId: jsii.String("sourceId"),
tags: map[string]*string{
"tagsKey": jsii.String("tags"),
},
}
type CfnComponent_ActionParametersProperty ¶
type CfnComponent_ActionParametersProperty struct {
// The HTML anchor link to the location to open.
//
// Specify this value for a navigation action.
Anchor interface{} `field:"optional" json:"anchor" yaml:"anchor"`
// A dictionary of key-value pairs mapping Amplify Studio properties to fields in a data model.
//
// Use when the action performs an operation on an Amplify DataStore model.
Fields interface{} `field:"optional" json:"fields" yaml:"fields"`
// Specifies whether the user should be signed out globally.
//
// Specify this value for an auth sign out action.
Global interface{} `field:"optional" json:"global" yaml:"global"`
// The unique ID of the component that the `ActionParameters` apply to.
Id interface{} `field:"optional" json:"id" yaml:"id"`
// The name of the data model.
//
// Use when the action performs an operation on an Amplify DataStore model.
Model *string `field:"optional" json:"model" yaml:"model"`
// A key-value pair that specifies the state property name and its initial value.
State interface{} `field:"optional" json:"state" yaml:"state"`
// The element within the same component to modify when the action occurs.
Target interface{} `field:"optional" json:"target" yaml:"target"`
// The type of navigation action.
//
// Valid values are `url` and `anchor` . This value is required for a navigation action.
Type interface{} `field:"optional" json:"type" yaml:"type"`
// The URL to the location to open.
//
// Specify this value for a navigation action.
Url interface{} `field:"optional" json:"url" yaml:"url"`
}
The `ActionParameters` property specifies the event action configuration for an element of a `Component` or `ComponentChild` .
Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components. `ActionParameters` defines the action that is performed when an event occurs on the component.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
var componentPropertyProperty_ componentPropertyProperty
actionParametersProperty := &actionParametersProperty{
anchor: &componentPropertyProperty{
bindingProperties: &componentPropertyBindingPropertiesProperty{
property: jsii.String("property"),
// the properties below are optional
field: jsii.String("field"),
},
bindings: map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
collectionBindingProperties: &componentPropertyBindingPropertiesProperty{
property: jsii.String("property"),
// the properties below are optional
field: jsii.String("field"),
},
componentName: jsii.String("componentName"),
concat: []interface{}{
componentPropertyProperty_,
},
condition: &componentConditionPropertyProperty{
else: componentPropertyProperty_,
field: jsii.String("field"),
operand: jsii.String("operand"),
operandType: jsii.String("operandType"),
operator: jsii.String("operator"),
property: jsii.String("property"),
then: componentPropertyProperty_,
},
configured: jsii.Boolean(false),
defaultValue: jsii.String("defaultValue"),
event: jsii.String("event"),
importedValue: jsii.String("importedValue"),
model: jsii.String("model"),
property: jsii.String("property"),
type: jsii.String("type"),
userAttribute: jsii.String("userAttribute"),
value: jsii.String("value"),
},
fields: map[string]interface{}{
"fieldsKey": &componentPropertyProperty{
"bindingProperties": &componentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"bindings": map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
"collectionBindingProperties": &componentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"componentName": jsii.String("componentName"),
"concat": []interface{}{
componentPropertyProperty_,
},
"condition": &componentConditionPropertyProperty{
"else": componentPropertyProperty_,
"field": jsii.String("field"),
"operand": jsii.String("operand"),
"operandType": jsii.String("operandType"),
"operator": jsii.String("operator"),
"property": jsii.String("property"),
"then": componentPropertyProperty_,
},
"configured": jsii.Boolean(false),
"defaultValue": jsii.String("defaultValue"),
"event": jsii.String("event"),
"importedValue": jsii.String("importedValue"),
"model": jsii.String("model"),
"property": jsii.String("property"),
"type": jsii.String("type"),
"userAttribute": jsii.String("userAttribute"),
"value": jsii.String("value"),
},
},
global: &componentPropertyProperty{
bindingProperties: &componentPropertyBindingPropertiesProperty{
property: jsii.String("property"),
// the properties below are optional
field: jsii.String("field"),
},
bindings: map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
collectionBindingProperties: &componentPropertyBindingPropertiesProperty{
property: jsii.String("property"),
// the properties below are optional
field: jsii.String("field"),
},
componentName: jsii.String("componentName"),
concat: []interface{}{
componentPropertyProperty_,
},
condition: &componentConditionPropertyProperty{
else: componentPropertyProperty_,
field: jsii.String("field"),
operand: jsii.String("operand"),
operandType: jsii.String("operandType"),
operator: jsii.String("operator"),
property: jsii.String("property"),
then: componentPropertyProperty_,
},
configured: jsii.Boolean(false),
defaultValue: jsii.String("defaultValue"),
event: jsii.String("event"),
importedValue: jsii.String("importedValue"),
model: jsii.String("model"),
property: jsii.String("property"),
type: jsii.String("type"),
userAttribute: jsii.String("userAttribute"),
value: jsii.String("value"),
},
id: &componentPropertyProperty{
bindingProperties: &componentPropertyBindingPropertiesProperty{
property: jsii.String("property"),
// the properties below are optional
field: jsii.String("field"),
},
bindings: map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
collectionBindingProperties: &componentPropertyBindingPropertiesProperty{
property: jsii.String("property"),
// the properties below are optional
field: jsii.String("field"),
},
componentName: jsii.String("componentName"),
concat: []interface{}{
componentPropertyProperty_,
},
condition: &componentConditionPropertyProperty{
else: componentPropertyProperty_,
field: jsii.String("field"),
operand: jsii.String("operand"),
operandType: jsii.String("operandType"),
operator: jsii.String("operator"),
property: jsii.String("property"),
then: componentPropertyProperty_,
},
configured: jsii.Boolean(false),
defaultValue: jsii.String("defaultValue"),
event: jsii.String("event"),
importedValue: jsii.String("importedValue"),
model: jsii.String("model"),
property: jsii.String("property"),
type: jsii.String("type"),
userAttribute: jsii.String("userAttribute"),
value: jsii.String("value"),
},
model: jsii.String("model"),
state: &mutationActionSetStateParameterProperty{
componentName: jsii.String("componentName"),
property: jsii.String("property"),
set: &componentPropertyProperty{
bindingProperties: &componentPropertyBindingPropertiesProperty{
property: jsii.String("property"),
// the properties below are optional
field: jsii.String("field"),
},
bindings: map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
collectionBindingProperties: &componentPropertyBindingPropertiesProperty{
property: jsii.String("property"),
// the properties below are optional
field: jsii.String("field"),
},
componentName: jsii.String("componentName"),
concat: []interface{}{
componentPropertyProperty_,
},
condition: &componentConditionPropertyProperty{
else: componentPropertyProperty_,
field: jsii.String("field"),
operand: jsii.String("operand"),
operandType: jsii.String("operandType"),
operator: jsii.String("operator"),
property: jsii.String("property"),
then: componentPropertyProperty_,
},
configured: jsii.Boolean(false),
defaultValue: jsii.String("defaultValue"),
event: jsii.String("event"),
importedValue: jsii.String("importedValue"),
model: jsii.String("model"),
property: jsii.String("property"),
type: jsii.String("type"),
userAttribute: jsii.String("userAttribute"),
value: jsii.String("value"),
},
},
target: &componentPropertyProperty{
bindingProperties: &componentPropertyBindingPropertiesProperty{
property: jsii.String("property"),
// the properties below are optional
field: jsii.String("field"),
},
bindings: map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
collectionBindingProperties: &componentPropertyBindingPropertiesProperty{
property: jsii.String("property"),
// the properties below are optional
field: jsii.String("field"),
},
componentName: jsii.String("componentName"),
concat: []interface{}{
componentPropertyProperty_,
},
condition: &componentConditionPropertyProperty{
else: componentPropertyProperty_,
field: jsii.String("field"),
operand: jsii.String("operand"),
operandType: jsii.String("operandType"),
operator: jsii.String("operator"),
property: jsii.String("property"),
then: componentPropertyProperty_,
},
configured: jsii.Boolean(false),
defaultValue: jsii.String("defaultValue"),
event: jsii.String("event"),
importedValue: jsii.String("importedValue"),
model: jsii.String("model"),
property: jsii.String("property"),
type: jsii.String("type"),
userAttribute: jsii.String("userAttribute"),
value: jsii.String("value"),
},
type: &componentPropertyProperty{
bindingProperties: &componentPropertyBindingPropertiesProperty{
property: jsii.String("property"),
// the properties below are optional
field: jsii.String("field"),
},
bindings: map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
collectionBindingProperties: &componentPropertyBindingPropertiesProperty{
property: jsii.String("property"),
// the properties below are optional
field: jsii.String("field"),
},
componentName: jsii.String("componentName"),
concat: []interface{}{
componentPropertyProperty_,
},
condition: &componentConditionPropertyProperty{
else: componentPropertyProperty_,
field: jsii.String("field"),
operand: jsii.String("operand"),
operandType: jsii.String("operandType"),
operator: jsii.String("operator"),
property: jsii.String("property"),
then: componentPropertyProperty_,
},
configured: jsii.Boolean(false),
defaultValue: jsii.String("defaultValue"),
event: jsii.String("event"),
importedValue: jsii.String("importedValue"),
model: jsii.String("model"),
property: jsii.String("property"),
type: jsii.String("type"),
userAttribute: jsii.String("userAttribute"),
value: jsii.String("value"),
},
url: &componentPropertyProperty{
bindingProperties: &componentPropertyBindingPropertiesProperty{
property: jsii.String("property"),
// the properties below are optional
field: jsii.String("field"),
},
bindings: map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
collectionBindingProperties: &componentPropertyBindingPropertiesProperty{
property: jsii.String("property"),
// the properties below are optional
field: jsii.String("field"),
},
componentName: jsii.String("componentName"),
concat: []interface{}{
componentPropertyProperty_,
},
condition: &componentConditionPropertyProperty{
else: componentPropertyProperty_,
field: jsii.String("field"),
operand: jsii.String("operand"),
operandType: jsii.String("operandType"),
operator: jsii.String("operator"),
property: jsii.String("property"),
then: componentPropertyProperty_,
},
configured: jsii.Boolean(false),
defaultValue: jsii.String("defaultValue"),
event: jsii.String("event"),
importedValue: jsii.String("importedValue"),
model: jsii.String("model"),
property: jsii.String("property"),
type: jsii.String("type"),
userAttribute: jsii.String("userAttribute"),
value: jsii.String("value"),
},
}
type CfnComponent_ComponentBindingPropertiesValuePropertiesProperty ¶
type CfnComponent_ComponentBindingPropertiesValuePropertiesProperty struct {
// An Amazon S3 bucket.
Bucket *string `field:"optional" json:"bucket" yaml:"bucket"`
// The default value to assign to the property.
DefaultValue *string `field:"optional" json:"defaultValue" yaml:"defaultValue"`
// The field to bind the data to.
Field *string `field:"optional" json:"field" yaml:"field"`
// The storage key for an Amazon S3 bucket.
Key *string `field:"optional" json:"key" yaml:"key"`
// An Amplify DataStore model.
Model *string `field:"optional" json:"model" yaml:"model"`
// A list of predicates for binding a component's properties to data.
Predicates interface{} `field:"optional" json:"predicates" yaml:"predicates"`
// An authenticated user attribute.
UserAttribute *string `field:"optional" json:"userAttribute" yaml:"userAttribute"`
}
The `ComponentBindingPropertiesValueProperties` property specifies the data binding configuration for a specific property using data stored in AWS .
For AWS connected properties, you can bind a property to data stored in an Amazon S3 bucket, an Amplify DataStore model or an authenticated user attribute.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
var predicateProperty_ predicateProperty
componentBindingPropertiesValuePropertiesProperty := &componentBindingPropertiesValuePropertiesProperty{
bucket: jsii.String("bucket"),
defaultValue: jsii.String("defaultValue"),
field: jsii.String("field"),
key: jsii.String("key"),
model: jsii.String("model"),
predicates: []interface{}{
&predicateProperty{
and: []interface{}{
predicateProperty_,
},
field: jsii.String("field"),
operand: jsii.String("operand"),
operator: jsii.String("operator"),
or: []interface{}{
predicateProperty_,
},
},
},
userAttribute: jsii.String("userAttribute"),
}
type CfnComponent_ComponentBindingPropertiesValueProperty ¶
type CfnComponent_ComponentBindingPropertiesValueProperty struct {
// Describes the properties to customize with data at runtime.
BindingProperties interface{} `field:"optional" json:"bindingProperties" yaml:"bindingProperties"`
// The default value of the property.
DefaultValue *string `field:"optional" json:"defaultValue" yaml:"defaultValue"`
// The property type.
Type *string `field:"optional" json:"type" yaml:"type"`
}
The `ComponentBindingPropertiesValue` property specifies the data binding configuration for a component at runtime.
You can use `ComponentBindingPropertiesValue` to add exposed properties to a component to allow different values to be entered when a component is reused in different places in an app.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
var predicateProperty_ predicateProperty
componentBindingPropertiesValueProperty := &componentBindingPropertiesValueProperty{
bindingProperties: &componentBindingPropertiesValuePropertiesProperty{
bucket: jsii.String("bucket"),
defaultValue: jsii.String("defaultValue"),
field: jsii.String("field"),
key: jsii.String("key"),
model: jsii.String("model"),
predicates: []interface{}{
&predicateProperty{
and: []interface{}{
predicateProperty_,
},
field: jsii.String("field"),
operand: jsii.String("operand"),
operator: jsii.String("operator"),
or: []interface{}{
predicateProperty_,
},
},
},
userAttribute: jsii.String("userAttribute"),
},
defaultValue: jsii.String("defaultValue"),
type: jsii.String("type"),
}
type CfnComponent_ComponentChildProperty ¶
type CfnComponent_ComponentChildProperty struct {
// The type of the child component.
ComponentType *string `field:"required" json:"componentType" yaml:"componentType"`
// The name of the child component.
Name *string `field:"required" json:"name" yaml:"name"`
// Describes the properties of the child component.
//
// You can't specify `tags` as a valid property for `properties` .
Properties interface{} `field:"required" json:"properties" yaml:"properties"`
// The list of `ComponentChild` instances for this component.
Children interface{} `field:"optional" json:"children" yaml:"children"`
// Describes the events that can be raised on the child component.
//
// Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components.
Events interface{} `field:"optional" json:"events" yaml:"events"`
}
The `ComponentChild` property specifies a nested UI configuration within a parent `Component` .
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
var componentChildProperty_ componentChildProperty
var componentPropertyProperty_ componentPropertyProperty
componentChildProperty := &componentChildProperty{
componentType: jsii.String("componentType"),
name: jsii.String("name"),
properties: map[string]interface{}{
"propertiesKey": &componentPropertyProperty{
"bindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"bindings": map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
"collectionBindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"componentName": jsii.String("componentName"),
"concat": []interface{}{
componentPropertyProperty_,
},
"condition": &ComponentConditionPropertyProperty{
"else": componentPropertyProperty_,
"field": jsii.String("field"),
"operand": jsii.String("operand"),
"operandType": jsii.String("operandType"),
"operator": jsii.String("operator"),
"property": jsii.String("property"),
"then": componentPropertyProperty_,
},
"configured": jsii.Boolean(false),
"defaultValue": jsii.String("defaultValue"),
"event": jsii.String("event"),
"importedValue": jsii.String("importedValue"),
"model": jsii.String("model"),
"property": jsii.String("property"),
"type": jsii.String("type"),
"userAttribute": jsii.String("userAttribute"),
"value": jsii.String("value"),
},
},
// the properties below are optional
children: []interface{}{
&componentChildProperty{
componentType: jsii.String("componentType"),
name: jsii.String("name"),
properties: map[string]interface{}{
"propertiesKey": &componentPropertyProperty{
"bindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"bindings": map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
"collectionBindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"componentName": jsii.String("componentName"),
"concat": []interface{}{
componentPropertyProperty_,
},
"condition": &ComponentConditionPropertyProperty{
"else": componentPropertyProperty_,
"field": jsii.String("field"),
"operand": jsii.String("operand"),
"operandType": jsii.String("operandType"),
"operator": jsii.String("operator"),
"property": jsii.String("property"),
"then": componentPropertyProperty_,
},
"configured": jsii.Boolean(false),
"defaultValue": jsii.String("defaultValue"),
"event": jsii.String("event"),
"importedValue": jsii.String("importedValue"),
"model": jsii.String("model"),
"property": jsii.String("property"),
"type": jsii.String("type"),
"userAttribute": jsii.String("userAttribute"),
"value": jsii.String("value"),
},
},
// the properties below are optional
children: []interface{}{
componentChildProperty_,
},
events: map[string]interface{}{
"eventsKey": &ComponentEventProperty{
"action": jsii.String("action"),
"parameters": &ActionParametersProperty{
"anchor": &componentPropertyProperty{
"bindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"bindings": map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
"collectionBindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"componentName": jsii.String("componentName"),
"concat": []interface{}{
componentPropertyProperty_,
},
"condition": &ComponentConditionPropertyProperty{
"else": componentPropertyProperty_,
"field": jsii.String("field"),
"operand": jsii.String("operand"),
"operandType": jsii.String("operandType"),
"operator": jsii.String("operator"),
"property": jsii.String("property"),
"then": componentPropertyProperty_,
},
"configured": jsii.Boolean(false),
"defaultValue": jsii.String("defaultValue"),
"event": jsii.String("event"),
"importedValue": jsii.String("importedValue"),
"model": jsii.String("model"),
"property": jsii.String("property"),
"type": jsii.String("type"),
"userAttribute": jsii.String("userAttribute"),
"value": jsii.String("value"),
},
"fields": map[string]interface{}{
"fieldsKey": &componentPropertyProperty{
"bindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"bindings": map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
"collectionBindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"componentName": jsii.String("componentName"),
"concat": []interface{}{
componentPropertyProperty_,
},
"condition": &ComponentConditionPropertyProperty{
"else": componentPropertyProperty_,
"field": jsii.String("field"),
"operand": jsii.String("operand"),
"operandType": jsii.String("operandType"),
"operator": jsii.String("operator"),
"property": jsii.String("property"),
"then": componentPropertyProperty_,
},
"configured": jsii.Boolean(false),
"defaultValue": jsii.String("defaultValue"),
"event": jsii.String("event"),
"importedValue": jsii.String("importedValue"),
"model": jsii.String("model"),
"property": jsii.String("property"),
"type": jsii.String("type"),
"userAttribute": jsii.String("userAttribute"),
"value": jsii.String("value"),
},
},
"global": &componentPropertyProperty{
"bindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"bindings": map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
"collectionBindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"componentName": jsii.String("componentName"),
"concat": []interface{}{
componentPropertyProperty_,
},
"condition": &ComponentConditionPropertyProperty{
"else": componentPropertyProperty_,
"field": jsii.String("field"),
"operand": jsii.String("operand"),
"operandType": jsii.String("operandType"),
"operator": jsii.String("operator"),
"property": jsii.String("property"),
"then": componentPropertyProperty_,
},
"configured": jsii.Boolean(false),
"defaultValue": jsii.String("defaultValue"),
"event": jsii.String("event"),
"importedValue": jsii.String("importedValue"),
"model": jsii.String("model"),
"property": jsii.String("property"),
"type": jsii.String("type"),
"userAttribute": jsii.String("userAttribute"),
"value": jsii.String("value"),
},
"id": &componentPropertyProperty{
"bindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"bindings": map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
"collectionBindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"componentName": jsii.String("componentName"),
"concat": []interface{}{
componentPropertyProperty_,
},
"condition": &ComponentConditionPropertyProperty{
"else": componentPropertyProperty_,
"field": jsii.String("field"),
"operand": jsii.String("operand"),
"operandType": jsii.String("operandType"),
"operator": jsii.String("operator"),
"property": jsii.String("property"),
"then": componentPropertyProperty_,
},
"configured": jsii.Boolean(false),
"defaultValue": jsii.String("defaultValue"),
"event": jsii.String("event"),
"importedValue": jsii.String("importedValue"),
"model": jsii.String("model"),
"property": jsii.String("property"),
"type": jsii.String("type"),
"userAttribute": jsii.String("userAttribute"),
"value": jsii.String("value"),
},
"model": jsii.String("model"),
"state": &MutationActionSetStateParameterProperty{
"componentName": jsii.String("componentName"),
"property": jsii.String("property"),
"set": &componentPropertyProperty{
"bindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"bindings": map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
"collectionBindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"componentName": jsii.String("componentName"),
"concat": []interface{}{
componentPropertyProperty_,
},
"condition": &ComponentConditionPropertyProperty{
"else": componentPropertyProperty_,
"field": jsii.String("field"),
"operand": jsii.String("operand"),
"operandType": jsii.String("operandType"),
"operator": jsii.String("operator"),
"property": jsii.String("property"),
"then": componentPropertyProperty_,
},
"configured": jsii.Boolean(false),
"defaultValue": jsii.String("defaultValue"),
"event": jsii.String("event"),
"importedValue": jsii.String("importedValue"),
"model": jsii.String("model"),
"property": jsii.String("property"),
"type": jsii.String("type"),
"userAttribute": jsii.String("userAttribute"),
"value": jsii.String("value"),
},
},
"target": &componentPropertyProperty{
"bindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"bindings": map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
"collectionBindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"componentName": jsii.String("componentName"),
"concat": []interface{}{
componentPropertyProperty_,
},
"condition": &ComponentConditionPropertyProperty{
"else": componentPropertyProperty_,
"field": jsii.String("field"),
"operand": jsii.String("operand"),
"operandType": jsii.String("operandType"),
"operator": jsii.String("operator"),
"property": jsii.String("property"),
"then": componentPropertyProperty_,
},
"configured": jsii.Boolean(false),
"defaultValue": jsii.String("defaultValue"),
"event": jsii.String("event"),
"importedValue": jsii.String("importedValue"),
"model": jsii.String("model"),
"property": jsii.String("property"),
"type": jsii.String("type"),
"userAttribute": jsii.String("userAttribute"),
"value": jsii.String("value"),
},
"type": &componentPropertyProperty{
"bindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"bindings": map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
"collectionBindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"componentName": jsii.String("componentName"),
"concat": []interface{}{
componentPropertyProperty_,
},
"condition": &ComponentConditionPropertyProperty{
"else": componentPropertyProperty_,
"field": jsii.String("field"),
"operand": jsii.String("operand"),
"operandType": jsii.String("operandType"),
"operator": jsii.String("operator"),
"property": jsii.String("property"),
"then": componentPropertyProperty_,
},
"configured": jsii.Boolean(false),
"defaultValue": jsii.String("defaultValue"),
"event": jsii.String("event"),
"importedValue": jsii.String("importedValue"),
"model": jsii.String("model"),
"property": jsii.String("property"),
"type": jsii.String("type"),
"userAttribute": jsii.String("userAttribute"),
"value": jsii.String("value"),
},
"url": &componentPropertyProperty{
"bindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"bindings": map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
"collectionBindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"componentName": jsii.String("componentName"),
"concat": []interface{}{
componentPropertyProperty_,
},
"condition": &ComponentConditionPropertyProperty{
"else": componentPropertyProperty_,
"field": jsii.String("field"),
"operand": jsii.String("operand"),
"operandType": jsii.String("operandType"),
"operator": jsii.String("operator"),
"property": jsii.String("property"),
"then": componentPropertyProperty_,
},
"configured": jsii.Boolean(false),
"defaultValue": jsii.String("defaultValue"),
"event": jsii.String("event"),
"importedValue": jsii.String("importedValue"),
"model": jsii.String("model"),
"property": jsii.String("property"),
"type": jsii.String("type"),
"userAttribute": jsii.String("userAttribute"),
"value": jsii.String("value"),
},
},
},
},
},
},
events: map[string]interface{}{
"eventsKey": &ComponentEventProperty{
"action": jsii.String("action"),
"parameters": &ActionParametersProperty{
"anchor": &componentPropertyProperty{
"bindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"bindings": map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
"collectionBindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"componentName": jsii.String("componentName"),
"concat": []interface{}{
componentPropertyProperty_,
},
"condition": &ComponentConditionPropertyProperty{
"else": componentPropertyProperty_,
"field": jsii.String("field"),
"operand": jsii.String("operand"),
"operandType": jsii.String("operandType"),
"operator": jsii.String("operator"),
"property": jsii.String("property"),
"then": componentPropertyProperty_,
},
"configured": jsii.Boolean(false),
"defaultValue": jsii.String("defaultValue"),
"event": jsii.String("event"),
"importedValue": jsii.String("importedValue"),
"model": jsii.String("model"),
"property": jsii.String("property"),
"type": jsii.String("type"),
"userAttribute": jsii.String("userAttribute"),
"value": jsii.String("value"),
},
"fields": map[string]interface{}{
"fieldsKey": &componentPropertyProperty{
"bindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"bindings": map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
"collectionBindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"componentName": jsii.String("componentName"),
"concat": []interface{}{
componentPropertyProperty_,
},
"condition": &ComponentConditionPropertyProperty{
"else": componentPropertyProperty_,
"field": jsii.String("field"),
"operand": jsii.String("operand"),
"operandType": jsii.String("operandType"),
"operator": jsii.String("operator"),
"property": jsii.String("property"),
"then": componentPropertyProperty_,
},
"configured": jsii.Boolean(false),
"defaultValue": jsii.String("defaultValue"),
"event": jsii.String("event"),
"importedValue": jsii.String("importedValue"),
"model": jsii.String("model"),
"property": jsii.String("property"),
"type": jsii.String("type"),
"userAttribute": jsii.String("userAttribute"),
"value": jsii.String("value"),
},
},
"global": &componentPropertyProperty{
"bindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"bindings": map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
"collectionBindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"componentName": jsii.String("componentName"),
"concat": []interface{}{
componentPropertyProperty_,
},
"condition": &ComponentConditionPropertyProperty{
"else": componentPropertyProperty_,
"field": jsii.String("field"),
"operand": jsii.String("operand"),
"operandType": jsii.String("operandType"),
"operator": jsii.String("operator"),
"property": jsii.String("property"),
"then": componentPropertyProperty_,
},
"configured": jsii.Boolean(false),
"defaultValue": jsii.String("defaultValue"),
"event": jsii.String("event"),
"importedValue": jsii.String("importedValue"),
"model": jsii.String("model"),
"property": jsii.String("property"),
"type": jsii.String("type"),
"userAttribute": jsii.String("userAttribute"),
"value": jsii.String("value"),
},
"id": &componentPropertyProperty{
"bindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"bindings": map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
"collectionBindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"componentName": jsii.String("componentName"),
"concat": []interface{}{
componentPropertyProperty_,
},
"condition": &ComponentConditionPropertyProperty{
"else": componentPropertyProperty_,
"field": jsii.String("field"),
"operand": jsii.String("operand"),
"operandType": jsii.String("operandType"),
"operator": jsii.String("operator"),
"property": jsii.String("property"),
"then": componentPropertyProperty_,
},
"configured": jsii.Boolean(false),
"defaultValue": jsii.String("defaultValue"),
"event": jsii.String("event"),
"importedValue": jsii.String("importedValue"),
"model": jsii.String("model"),
"property": jsii.String("property"),
"type": jsii.String("type"),
"userAttribute": jsii.String("userAttribute"),
"value": jsii.String("value"),
},
"model": jsii.String("model"),
"state": &MutationActionSetStateParameterProperty{
"componentName": jsii.String("componentName"),
"property": jsii.String("property"),
"set": &componentPropertyProperty{
"bindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"bindings": map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
"collectionBindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"componentName": jsii.String("componentName"),
"concat": []interface{}{
componentPropertyProperty_,
},
"condition": &ComponentConditionPropertyProperty{
"else": componentPropertyProperty_,
"field": jsii.String("field"),
"operand": jsii.String("operand"),
"operandType": jsii.String("operandType"),
"operator": jsii.String("operator"),
"property": jsii.String("property"),
"then": componentPropertyProperty_,
},
"configured": jsii.Boolean(false),
"defaultValue": jsii.String("defaultValue"),
"event": jsii.String("event"),
"importedValue": jsii.String("importedValue"),
"model": jsii.String("model"),
"property": jsii.String("property"),
"type": jsii.String("type"),
"userAttribute": jsii.String("userAttribute"),
"value": jsii.String("value"),
},
},
"target": &componentPropertyProperty{
"bindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"bindings": map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
"collectionBindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"componentName": jsii.String("componentName"),
"concat": []interface{}{
componentPropertyProperty_,
},
"condition": &ComponentConditionPropertyProperty{
"else": componentPropertyProperty_,
"field": jsii.String("field"),
"operand": jsii.String("operand"),
"operandType": jsii.String("operandType"),
"operator": jsii.String("operator"),
"property": jsii.String("property"),
"then": componentPropertyProperty_,
},
"configured": jsii.Boolean(false),
"defaultValue": jsii.String("defaultValue"),
"event": jsii.String("event"),
"importedValue": jsii.String("importedValue"),
"model": jsii.String("model"),
"property": jsii.String("property"),
"type": jsii.String("type"),
"userAttribute": jsii.String("userAttribute"),
"value": jsii.String("value"),
},
"type": &componentPropertyProperty{
"bindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"bindings": map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
"collectionBindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"componentName": jsii.String("componentName"),
"concat": []interface{}{
componentPropertyProperty_,
},
"condition": &ComponentConditionPropertyProperty{
"else": componentPropertyProperty_,
"field": jsii.String("field"),
"operand": jsii.String("operand"),
"operandType": jsii.String("operandType"),
"operator": jsii.String("operator"),
"property": jsii.String("property"),
"then": componentPropertyProperty_,
},
"configured": jsii.Boolean(false),
"defaultValue": jsii.String("defaultValue"),
"event": jsii.String("event"),
"importedValue": jsii.String("importedValue"),
"model": jsii.String("model"),
"property": jsii.String("property"),
"type": jsii.String("type"),
"userAttribute": jsii.String("userAttribute"),
"value": jsii.String("value"),
},
"url": &componentPropertyProperty{
"bindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"bindings": map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
"collectionBindingProperties": &ComponentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"componentName": jsii.String("componentName"),
"concat": []interface{}{
componentPropertyProperty_,
},
"condition": &ComponentConditionPropertyProperty{
"else": componentPropertyProperty_,
"field": jsii.String("field"),
"operand": jsii.String("operand"),
"operandType": jsii.String("operandType"),
"operator": jsii.String("operator"),
"property": jsii.String("property"),
"then": componentPropertyProperty_,
},
"configured": jsii.Boolean(false),
"defaultValue": jsii.String("defaultValue"),
"event": jsii.String("event"),
"importedValue": jsii.String("importedValue"),
"model": jsii.String("model"),
"property": jsii.String("property"),
"type": jsii.String("type"),
"userAttribute": jsii.String("userAttribute"),
"value": jsii.String("value"),
},
},
},
},
}
type CfnComponent_ComponentConditionPropertyProperty ¶
type CfnComponent_ComponentConditionPropertyProperty struct {
// The value to assign to the property if the condition is not met.
Else interface{} `field:"optional" json:"else" yaml:"else"`
// The name of a field.
//
// Specify this when the property is a data model.
Field *string `field:"optional" json:"field" yaml:"field"`
// The value of the property to evaluate.
Operand *string `field:"optional" json:"operand" yaml:"operand"`
// The type of the property to evaluate.
OperandType *string `field:"optional" json:"operandType" yaml:"operandType"`
// The operator to use to perform the evaluation, such as `eq` to represent equals.
Operator *string `field:"optional" json:"operator" yaml:"operator"`
// The name of the conditional property.
Property *string `field:"optional" json:"property" yaml:"property"`
// The value to assign to the property if the condition is met.
Then interface{} `field:"optional" json:"then" yaml:"then"`
}
The `ComponentConditionProperty` property specifies a conditional expression for setting a component property.
Use `ComponentConditionProperty` to set a property to different values conditionally, based on the value of another property.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
var componentPropertyProperty_ componentPropertyProperty
componentConditionPropertyProperty := &componentConditionPropertyProperty{
else: &componentPropertyProperty{
bindingProperties: &componentPropertyBindingPropertiesProperty{
property: jsii.String("property"),
// the properties below are optional
field: jsii.String("field"),
},
bindings: map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
collectionBindingProperties: &componentPropertyBindingPropertiesProperty{
property: jsii.String("property"),
// the properties below are optional
field: jsii.String("field"),
},
componentName: jsii.String("componentName"),
concat: []interface{}{
componentPropertyProperty_,
},
condition: &componentConditionPropertyProperty{
else: componentPropertyProperty_,
field: jsii.String("field"),
operand: jsii.String("operand"),
operandType: jsii.String("operandType"),
operator: jsii.String("operator"),
property: jsii.String("property"),
then: componentPropertyProperty_,
},
configured: jsii.Boolean(false),
defaultValue: jsii.String("defaultValue"),
event: jsii.String("event"),
importedValue: jsii.String("importedValue"),
model: jsii.String("model"),
property: jsii.String("property"),
type: jsii.String("type"),
userAttribute: jsii.String("userAttribute"),
value: jsii.String("value"),
},
field: jsii.String("field"),
operand: jsii.String("operand"),
operandType: jsii.String("operandType"),
operator: jsii.String("operator"),
property: jsii.String("property"),
then: &componentPropertyProperty{
bindingProperties: &componentPropertyBindingPropertiesProperty{
property: jsii.String("property"),
// the properties below are optional
field: jsii.String("field"),
},
bindings: map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
collectionBindingProperties: &componentPropertyBindingPropertiesProperty{
property: jsii.String("property"),
// the properties below are optional
field: jsii.String("field"),
},
componentName: jsii.String("componentName"),
concat: []interface{}{
componentPropertyProperty_,
},
condition: &componentConditionPropertyProperty{
else: componentPropertyProperty_,
field: jsii.String("field"),
operand: jsii.String("operand"),
operandType: jsii.String("operandType"),
operator: jsii.String("operator"),
property: jsii.String("property"),
then: componentPropertyProperty_,
},
configured: jsii.Boolean(false),
defaultValue: jsii.String("defaultValue"),
event: jsii.String("event"),
importedValue: jsii.String("importedValue"),
model: jsii.String("model"),
property: jsii.String("property"),
type: jsii.String("type"),
userAttribute: jsii.String("userAttribute"),
value: jsii.String("value"),
},
}
type CfnComponent_ComponentDataConfigurationProperty ¶
type CfnComponent_ComponentDataConfigurationProperty struct {
// The name of the data model to use to bind data to a component.
Model *string `field:"required" json:"model" yaml:"model"`
// A list of IDs to use to bind data to a component.
//
// Use this property to bind specifically chosen data, rather than data retrieved from a query.
Identifiers *[]*string `field:"optional" json:"identifiers" yaml:"identifiers"`
// Represents the conditional logic to use when binding data to a component.
//
// Use this property to retrieve only a subset of the data in a collection.
Predicate interface{} `field:"optional" json:"predicate" yaml:"predicate"`
// Describes how to sort the component's properties.
Sort interface{} `field:"optional" json:"sort" yaml:"sort"`
}
The `ComponentDataConfiguration` property specifies the configuration for binding a component's properties to data.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
var predicateProperty_ predicateProperty
componentDataConfigurationProperty := &componentDataConfigurationProperty{
model: jsii.String("model"),
// the properties below are optional
identifiers: []*string{
jsii.String("identifiers"),
},
predicate: &predicateProperty{
and: []interface{}{
predicateProperty_,
},
field: jsii.String("field"),
operand: jsii.String("operand"),
operator: jsii.String("operator"),
or: []interface{}{
predicateProperty_,
},
},
sort: []interface{}{
&sortPropertyProperty{
direction: jsii.String("direction"),
field: jsii.String("field"),
},
},
}
type CfnComponent_ComponentEventProperty ¶
type CfnComponent_ComponentEventProperty struct {
// The action to perform when a specific event is raised.
Action *string `field:"optional" json:"action" yaml:"action"`
// Describes information about the action.
Parameters interface{} `field:"optional" json:"parameters" yaml:"parameters"`
}
The `ComponentEvent` property specifies the configuration of an event.
You can bind an event and a corresponding action to a `Component` or a `ComponentChild` . A button click is an example of an event.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
var componentPropertyProperty_ componentPropertyProperty
componentEventProperty := &componentEventProperty{
action: jsii.String("action"),
parameters: &actionParametersProperty{
anchor: &componentPropertyProperty{
bindingProperties: &componentPropertyBindingPropertiesProperty{
property: jsii.String("property"),
// the properties below are optional
field: jsii.String("field"),
},
bindings: map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
collectionBindingProperties: &componentPropertyBindingPropertiesProperty{
property: jsii.String("property"),
// the properties below are optional
field: jsii.String("field"),
},
componentName: jsii.String("componentName"),
concat: []interface{}{
componentPropertyProperty_,
},
condition: &componentConditionPropertyProperty{
else: componentPropertyProperty_,
field: jsii.String("field"),
operand: jsii.String("operand"),
operandType: jsii.String("operandType"),
operator: jsii.String("operator"),
property: jsii.String("property"),
then: componentPropertyProperty_,
},
configured: jsii.Boolean(false),
defaultValue: jsii.String("defaultValue"),
event: jsii.String("event"),
importedValue: jsii.String("importedValue"),
model: jsii.String("model"),
property: jsii.String("property"),
type: jsii.String("type"),
userAttribute: jsii.String("userAttribute"),
value: jsii.String("value"),
},
fields: map[string]interface{}{
"fieldsKey": &componentPropertyProperty{
"bindingProperties": &componentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"bindings": map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
"collectionBindingProperties": &componentPropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"componentName": jsii.String("componentName"),
"concat": []interface{}{
componentPropertyProperty_,
},
"condition": &componentConditionPropertyProperty{
"else": componentPropertyProperty_,
"field": jsii.String("field"),
"operand": jsii.String("operand"),
"operandType": jsii.String("operandType"),
"operator": jsii.String("operator"),
"property": jsii.String("property"),
"then": componentPropertyProperty_,
},
"configured": jsii.Boolean(false),
"defaultValue": jsii.String("defaultValue"),
"event": jsii.String("event"),
"importedValue": jsii.String("importedValue"),
"model": jsii.String("model"),
"property": jsii.String("property"),
"type": jsii.String("type"),
"userAttribute": jsii.String("userAttribute"),
"value": jsii.String("value"),
},
},
global: &componentPropertyProperty{
bindingProperties: &componentPropertyBindingPropertiesProperty{
property: jsii.String("property"),
// the properties below are optional
field: jsii.String("field"),
},
bindings: map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
collectionBindingProperties: &componentPropertyBindingPropertiesProperty{
property: jsii.String("property"),
// the properties below are optional
field: jsii.String("field"),
},
componentName: jsii.String("componentName"),
concat: []interface{}{
componentPropertyProperty_,
},
condition: &componentConditionPropertyProperty{
else: componentPropertyProperty_,
field: jsii.String("field"),
operand: jsii.String("operand"),
operandType: jsii.String("operandType"),
operator: jsii.String("operator"),
property: jsii.String("property"),
then: componentPropertyProperty_,
},
configured: jsii.Boolean(false),
defaultValue: jsii.String("defaultValue"),
event: jsii.String("event"),
importedValue: jsii.String("importedValue"),
model: jsii.String("model"),
property: jsii.String("property"),
type: jsii.String("type"),
userAttribute: jsii.String("userAttribute"),
value: jsii.String("value"),
},
id: &componentPropertyProperty{
bindingProperties: &componentPropertyBindingPropertiesProperty{
property: jsii.String("property"),
// the properties below are optional
field: jsii.String("field"),
},
bindings: map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
collectionBindingProperties: &componentPropertyBindingPropertiesProperty{
property: jsii.String("property"),
// the properties below are optional
field: jsii.String("field"),
},
componentName: jsii.String("componentName"),
concat: []interface{}{
componentPropertyProperty_,
},
condition: &componentConditionPropertyProperty{
else: componentPropertyProperty_,
field: jsii.String("field"),
operand: jsii.String("operand"),
operandType: jsii.String("operandType"),
operator: jsii.String("operator"),
property: jsii.String("property"),
then: componentPropertyProperty_,
},
configured: jsii.Boolean(false),
defaultValue: jsii.String("defaultValue"),
event: jsii.String("event"),
importedValue: jsii.String("importedValue"),
model: jsii.String("model"),
property: jsii.String("property"),
type: jsii.String("type"),
userAttribute: jsii.String("userAttribute"),
value: jsii.String("value"),
},
model: jsii.String("model"),
state: &mutationActionSetStateParameterProperty{
componentName: jsii.String("componentName"),
property: jsii.String("property"),
set: &componentPropertyProperty{
bindingProperties: &componentPropertyBindingPropertiesProperty{
property: jsii.String("property"),
// the properties below are optional
field: jsii.String("field"),
},
bindings: map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
collectionBindingProperties: &componentPropertyBindingPropertiesProperty{
property: jsii.String("property"),
// the properties below are optional
field: jsii.String("field"),
},
componentName: jsii.String("componentName"),
concat: []interface{}{
componentPropertyProperty_,
},
condition: &componentConditionPropertyProperty{
else: componentPropertyProperty_,
field: jsii.String("field"),
operand: jsii.String("operand"),
operandType: jsii.String("operandType"),
operator: jsii.String("operator"),
property: jsii.String("property"),
then: componentPropertyProperty_,
},
configured: jsii.Boolean(false),
defaultValue: jsii.String("defaultValue"),
event: jsii.String("event"),
importedValue: jsii.String("importedValue"),
model: jsii.String("model"),
property: jsii.String("property"),
type: jsii.String("type"),
userAttribute: jsii.String("userAttribute"),
value: jsii.String("value"),
},
},
target: &componentPropertyProperty{
bindingProperties: &componentPropertyBindingPropertiesProperty{
property: jsii.String("property"),
// the properties below are optional
field: jsii.String("field"),
},
bindings: map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
collectionBindingProperties: &componentPropertyBindingPropertiesProperty{
property: jsii.String("property"),
// the properties below are optional
field: jsii.String("field"),
},
componentName: jsii.String("componentName"),
concat: []interface{}{
componentPropertyProperty_,
},
condition: &componentConditionPropertyProperty{
else: componentPropertyProperty_,
field: jsii.String("field"),
operand: jsii.String("operand"),
operandType: jsii.String("operandType"),
operator: jsii.String("operator"),
property: jsii.String("property"),
then: componentPropertyProperty_,
},
configured: jsii.Boolean(false),
defaultValue: jsii.String("defaultValue"),
event: jsii.String("event"),
importedValue: jsii.String("importedValue"),
model: jsii.String("model"),
property: jsii.String("property"),
type: jsii.String("type"),
userAttribute: jsii.String("userAttribute"),
value: jsii.String("value"),
},
type: &componentPropertyProperty{
bindingProperties: &componentPropertyBindingPropertiesProperty{
property: jsii.String("property"),
// the properties below are optional
field: jsii.String("field"),
},
bindings: map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
collectionBindingProperties: &componentPropertyBindingPropertiesProperty{
property: jsii.String("property"),
// the properties below are optional
field: jsii.String("field"),
},
componentName: jsii.String("componentName"),
concat: []interface{}{
componentPropertyProperty_,
},
condition: &componentConditionPropertyProperty{
else: componentPropertyProperty_,
field: jsii.String("field"),
operand: jsii.String("operand"),
operandType: jsii.String("operandType"),
operator: jsii.String("operator"),
property: jsii.String("property"),
then: componentPropertyProperty_,
},
configured: jsii.Boolean(false),
defaultValue: jsii.String("defaultValue"),
event: jsii.String("event"),
importedValue: jsii.String("importedValue"),
model: jsii.String("model"),
property: jsii.String("property"),
type: jsii.String("type"),
userAttribute: jsii.String("userAttribute"),
value: jsii.String("value"),
},
url: &componentPropertyProperty{
bindingProperties: &componentPropertyBindingPropertiesProperty{
property: jsii.String("property"),
// the properties below are optional
field: jsii.String("field"),
},
bindings: map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
collectionBindingProperties: &componentPropertyBindingPropertiesProperty{
property: jsii.String("property"),
// the properties below are optional
field: jsii.String("field"),
},
componentName: jsii.String("componentName"),
concat: []interface{}{
componentPropertyProperty_,
},
condition: &componentConditionPropertyProperty{
else: componentPropertyProperty_,
field: jsii.String("field"),
operand: jsii.String("operand"),
operandType: jsii.String("operandType"),
operator: jsii.String("operator"),
property: jsii.String("property"),
then: componentPropertyProperty_,
},
configured: jsii.Boolean(false),
defaultValue: jsii.String("defaultValue"),
event: jsii.String("event"),
importedValue: jsii.String("importedValue"),
model: jsii.String("model"),
property: jsii.String("property"),
type: jsii.String("type"),
userAttribute: jsii.String("userAttribute"),
value: jsii.String("value"),
},
},
}
type CfnComponent_ComponentPropertyBindingPropertiesProperty ¶
type CfnComponent_ComponentPropertyBindingPropertiesProperty struct {
// The component property to bind to the data field.
Property *string `field:"required" json:"property" yaml:"property"`
// The data field to bind the property to.
Field *string `field:"optional" json:"field" yaml:"field"`
}
The `ComponentPropertyBindingProperties` property specifies a component property to associate with a binding property.
This enables exposed properties on the top level component to propagate data to the component's property values.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
componentPropertyBindingPropertiesProperty := &componentPropertyBindingPropertiesProperty{
property: jsii.String("property"),
// the properties below are optional
field: jsii.String("field"),
}
type CfnComponent_ComponentPropertyProperty ¶
type CfnComponent_ComponentPropertyProperty struct {
// The information to bind the component property to data at runtime.
BindingProperties interface{} `field:"optional" json:"bindingProperties" yaml:"bindingProperties"`
// The information to bind the component property to form data.
Bindings interface{} `field:"optional" json:"bindings" yaml:"bindings"`
// The information to bind the component property to data at runtime.
//
// Use this for collection components.
CollectionBindingProperties interface{} `field:"optional" json:"collectionBindingProperties" yaml:"collectionBindingProperties"`
// The name of the component that is affected by an event.
ComponentName *string `field:"optional" json:"componentName" yaml:"componentName"`
// A list of component properties to concatenate to create the value to assign to this component property.
Concat interface{} `field:"optional" json:"concat" yaml:"concat"`
// The conditional expression to use to assign a value to the component property.
Condition interface{} `field:"optional" json:"condition" yaml:"condition"`
// Specifies whether the user configured the property in Amplify Studio after importing it.
Configured interface{} `field:"optional" json:"configured" yaml:"configured"`
// The default value to assign to the component property.
DefaultValue *string `field:"optional" json:"defaultValue" yaml:"defaultValue"`
// An event that occurs in your app.
//
// Use this for workflow data binding.
Event *string `field:"optional" json:"event" yaml:"event"`
// The default value assigned to the property when the component is imported into an app.
ImportedValue *string `field:"optional" json:"importedValue" yaml:"importedValue"`
// The data model to use to assign a value to the component property.
Model *string `field:"optional" json:"model" yaml:"model"`
// The name of the component's property that is affected by an event.
Property *string `field:"optional" json:"property" yaml:"property"`
// The component type.
Type *string `field:"optional" json:"type" yaml:"type"`
// An authenticated user attribute to use to assign a value to the component property.
UserAttribute *string `field:"optional" json:"userAttribute" yaml:"userAttribute"`
// The value to assign to the component property.
Value *string `field:"optional" json:"value" yaml:"value"`
}
The `ComponentProperty` property specifies the configuration for all of a component's properties.
Use `ComponentProperty` to specify the values to render or bind by default.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
var componentConditionPropertyProperty_ componentConditionPropertyProperty
var componentPropertyProperty_ componentPropertyProperty
componentPropertyProperty := &componentPropertyProperty{
bindingProperties: &componentPropertyBindingPropertiesProperty{
property: jsii.String("property"),
// the properties below are optional
field: jsii.String("field"),
},
bindings: map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
collectionBindingProperties: &componentPropertyBindingPropertiesProperty{
property: jsii.String("property"),
// the properties below are optional
field: jsii.String("field"),
},
componentName: jsii.String("componentName"),
concat: []interface{}{
&componentPropertyProperty{
bindingProperties: &componentPropertyBindingPropertiesProperty{
property: jsii.String("property"),
// the properties below are optional
field: jsii.String("field"),
},
bindings: map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
collectionBindingProperties: &componentPropertyBindingPropertiesProperty{
property: jsii.String("property"),
// the properties below are optional
field: jsii.String("field"),
},
componentName: jsii.String("componentName"),
concat: []interface{}{
componentPropertyProperty_,
},
condition: &componentConditionPropertyProperty{
else: componentPropertyProperty_,
field: jsii.String("field"),
operand: jsii.String("operand"),
operandType: jsii.String("operandType"),
operator: jsii.String("operator"),
property: jsii.String("property"),
then: componentPropertyProperty_,
},
configured: jsii.Boolean(false),
defaultValue: jsii.String("defaultValue"),
event: jsii.String("event"),
importedValue: jsii.String("importedValue"),
model: jsii.String("model"),
property: jsii.String("property"),
type: jsii.String("type"),
userAttribute: jsii.String("userAttribute"),
value: jsii.String("value"),
},
},
condition: &componentConditionPropertyProperty{
else: &componentPropertyProperty{
bindingProperties: &componentPropertyBindingPropertiesProperty{
property: jsii.String("property"),
// the properties below are optional
field: jsii.String("field"),
},
bindings: map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
collectionBindingProperties: &componentPropertyBindingPropertiesProperty{
property: jsii.String("property"),
// the properties below are optional
field: jsii.String("field"),
},
componentName: jsii.String("componentName"),
concat: []interface{}{
componentPropertyProperty_,
},
condition: componentConditionPropertyProperty_,
configured: jsii.Boolean(false),
defaultValue: jsii.String("defaultValue"),
event: jsii.String("event"),
importedValue: jsii.String("importedValue"),
model: jsii.String("model"),
property: jsii.String("property"),
type: jsii.String("type"),
userAttribute: jsii.String("userAttribute"),
value: jsii.String("value"),
},
field: jsii.String("field"),
operand: jsii.String("operand"),
operandType: jsii.String("operandType"),
operator: jsii.String("operator"),
property: jsii.String("property"),
then: &componentPropertyProperty{
bindingProperties: &componentPropertyBindingPropertiesProperty{
property: jsii.String("property"),
// the properties below are optional
field: jsii.String("field"),
},
bindings: map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
collectionBindingProperties: &componentPropertyBindingPropertiesProperty{
property: jsii.String("property"),
// the properties below are optional
field: jsii.String("field"),
},
componentName: jsii.String("componentName"),
concat: []interface{}{
componentPropertyProperty_,
},
condition: componentConditionPropertyProperty_,
configured: jsii.Boolean(false),
defaultValue: jsii.String("defaultValue"),
event: jsii.String("event"),
importedValue: jsii.String("importedValue"),
model: jsii.String("model"),
property: jsii.String("property"),
type: jsii.String("type"),
userAttribute: jsii.String("userAttribute"),
value: jsii.String("value"),
},
},
configured: jsii.Boolean(false),
defaultValue: jsii.String("defaultValue"),
event: jsii.String("event"),
importedValue: jsii.String("importedValue"),
model: jsii.String("model"),
property: jsii.String("property"),
type: jsii.String("type"),
userAttribute: jsii.String("userAttribute"),
value: jsii.String("value"),
}
type CfnComponent_ComponentVariantProperty ¶
type CfnComponent_ComponentVariantProperty struct {
// The properties of the component variant that can be overriden when customizing an instance of the component.
//
// You can't specify `tags` as a valid property for `overrides` .
Overrides interface{} `field:"optional" json:"overrides" yaml:"overrides"`
// The combination of variants that comprise this variant.
VariantValues interface{} `field:"optional" json:"variantValues" yaml:"variantValues"`
}
The `ComponentVariant` property specifies the style configuration of a unique variation of a main component.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
var overrides interface{}
componentVariantProperty := &componentVariantProperty{
overrides: overrides,
variantValues: map[string]*string{
"variantValuesKey": jsii.String("variantValues"),
},
}
type CfnComponent_FormBindingElementProperty ¶
type CfnComponent_FormBindingElementProperty struct {
// The name of the component to retrieve a value from.
Element *string `field:"required" json:"element" yaml:"element"`
// The property to retrieve a value from.
Property *string `field:"required" json:"property" yaml:"property"`
}
Describes how to bind a component property to form data.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
formBindingElementProperty := &formBindingElementProperty{
element: jsii.String("element"),
property: jsii.String("property"),
}
type CfnComponent_MutationActionSetStateParameterProperty ¶
type CfnComponent_MutationActionSetStateParameterProperty struct {
// The name of the component that is being modified.
ComponentName *string `field:"required" json:"componentName" yaml:"componentName"`
// The name of the component property to apply the state configuration to.
Property *string `field:"required" json:"property" yaml:"property"`
// The state configuration to assign to the property.
Set interface{} `field:"required" json:"set" yaml:"set"`
}
The `MutationActionSetStateParameter` property specifies the state configuration when an action modifies a property of another element within the same component.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
var componentPropertyProperty_ componentPropertyProperty
mutationActionSetStateParameterProperty := &mutationActionSetStateParameterProperty{
componentName: jsii.String("componentName"),
property: jsii.String("property"),
set: &componentPropertyProperty{
bindingProperties: &componentPropertyBindingPropertiesProperty{
property: jsii.String("property"),
// the properties below are optional
field: jsii.String("field"),
},
bindings: map[string]interface{}{
"bindingsKey": &FormBindingElementProperty{
"element": jsii.String("element"),
"property": jsii.String("property"),
},
},
collectionBindingProperties: &componentPropertyBindingPropertiesProperty{
property: jsii.String("property"),
// the properties below are optional
field: jsii.String("field"),
},
componentName: jsii.String("componentName"),
concat: []interface{}{
componentPropertyProperty_,
},
condition: &componentConditionPropertyProperty{
else: componentPropertyProperty_,
field: jsii.String("field"),
operand: jsii.String("operand"),
operandType: jsii.String("operandType"),
operator: jsii.String("operator"),
property: jsii.String("property"),
then: componentPropertyProperty_,
},
configured: jsii.Boolean(false),
defaultValue: jsii.String("defaultValue"),
event: jsii.String("event"),
importedValue: jsii.String("importedValue"),
model: jsii.String("model"),
property: jsii.String("property"),
type: jsii.String("type"),
userAttribute: jsii.String("userAttribute"),
value: jsii.String("value"),
},
}
type CfnComponent_PredicateProperty ¶
type CfnComponent_PredicateProperty struct {
// A list of predicates to combine logically.
And interface{} `field:"optional" json:"and" yaml:"and"`
// The field to query.
Field *string `field:"optional" json:"field" yaml:"field"`
// The value to use when performing the evaluation.
Operand *string `field:"optional" json:"operand" yaml:"operand"`
// The operator to use to perform the evaluation.
Operator *string `field:"optional" json:"operator" yaml:"operator"`
// A list of predicates to combine logically.
Or interface{} `field:"optional" json:"or" yaml:"or"`
}
The `Predicate` property specifies information for generating Amplify DataStore queries.
Use `Predicate` to retrieve a subset of the data in a collection.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
var predicateProperty_ predicateProperty
predicateProperty := &predicateProperty{
and: []interface{}{
&predicateProperty{
and: []interface{}{
predicateProperty_,
},
field: jsii.String("field"),
operand: jsii.String("operand"),
operator: jsii.String("operator"),
or: []interface{}{
predicateProperty_,
},
},
},
field: jsii.String("field"),
operand: jsii.String("operand"),
operator: jsii.String("operator"),
or: []interface{}{
&predicateProperty{
and: []interface{}{
predicateProperty_,
},
field: jsii.String("field"),
operand: jsii.String("operand"),
operator: jsii.String("operator"),
or: []interface{}{
predicateProperty_,
},
},
},
}
type CfnComponent_SortPropertyProperty ¶
type CfnComponent_SortPropertyProperty struct {
// The direction of the sort, either ascending or descending.
Direction *string `field:"required" json:"direction" yaml:"direction"`
// The field to perform the sort on.
Field *string `field:"required" json:"field" yaml:"field"`
}
The `SortProperty` property specifies how to sort the data that you bind to a component.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
sortPropertyProperty := &sortPropertyProperty{
direction: jsii.String("direction"),
field: jsii.String("field"),
}
type CfnForm ¶
type CfnForm interface {
awscdk.CfnResource
awscdk.IInspectable
// The unique ID of the Amplify app associated with the form.
AppId() *string
SetAppId(val *string)
AttrId() *string
// Options for this resource, such as condition, update policy etc.
// Experimental.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
// Experimental.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
// Experimental.
CreationStack() *[]*string
// Stores the call to action configuration for the form.
Cta() interface{}
SetCta(val interface{})
// The type of data source to use to create the form.
DataType() interface{}
SetDataType(val interface{})
// The name of the backend environment that is a part of the Amplify app.
EnvironmentName() *string
SetEnvironmentName(val *string)
// Stores the information about the form's fields.
Fields() interface{}
SetFields(val interface{})
// The operation to perform on the specified form.
FormActionType() *string
SetFormActionType(val *string)
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
// Experimental.
LogicalId() *string
// The name of the form.
Name() *string
SetName(val *string)
// The construct tree node associated with this construct.
// Experimental.
Node() awscdk.ConstructNode
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
// Experimental.
Ref() *string
// The schema version of the form when it was imported.
SchemaVersion() *string
SetSchemaVersion(val *string)
// Stores the visual helper elements for the form that are not associated with any data.
SectionalElements() interface{}
SetSectionalElements(val interface{})
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
// Experimental.
Stack() awscdk.Stack
// Stores the configuration for the form's style.
Style() interface{}
SetStyle(val interface{})
// One or more key-value pairs to use when tagging the form.
Tags() awscdk.TagManager
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
// Experimental.
UpdatedProperites() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
// Experimental.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
// Experimental.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
// Experimental.
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
// Experimental.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
// Experimental.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
// Experimental.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
// Experimental.
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
// Experimental.
GetAtt(attributeName *string) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
// Experimental.
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
OnPrepare()
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
OnSynthesize(session constructs.ISynthesisSession)
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
OnValidate() *[]*string
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
// Experimental.
ShouldSynthesize() *bool
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
Synthesize(session awscdk.ISynthesisSession)
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
// Experimental.
ToString() *string
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
Validate() *[]*string
// Experimental.
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::AmplifyUIBuilder::Form`.
Contains the configuration settings for a `Form` user interface (UI) element for an Amplify app. A form is a component you can add to your project by specifying a data source as the default configuration for the form.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnForm := awscdk.Aws_amplifyuibuilder.NewCfnForm(this, jsii.String("MyCfnForm"), &cfnFormProps{
dataType: &formDataTypeConfigProperty{
dataSourceType: jsii.String("dataSourceType"),
dataTypeName: jsii.String("dataTypeName"),
},
fields: map[string]interface{}{
"fieldsKey": &FieldConfigProperty{
"excluded": jsii.Boolean(false),
"inputType": &FieldInputConfigProperty{
"type": jsii.String("type"),
// the properties below are optional
"defaultChecked": jsii.Boolean(false),
"defaultCountryCode": jsii.String("defaultCountryCode"),
"defaultValue": jsii.String("defaultValue"),
"descriptiveText": jsii.String("descriptiveText"),
"maxValue": jsii.Number(123),
"minValue": jsii.Number(123),
"name": jsii.String("name"),
"placeholder": jsii.String("placeholder"),
"readOnly": jsii.Boolean(false),
"required": jsii.Boolean(false),
"step": jsii.Number(123),
"value": jsii.String("value"),
"valueMappings": &ValueMappingsProperty{
"values": []interface{}{
&ValueMappingProperty{
"value": &FormInputValuePropertyProperty{
"value": jsii.String("value"),
},
// the properties below are optional
"displayValue": &FormInputValuePropertyProperty{
"value": jsii.String("value"),
},
},
},
},
},
"label": jsii.String("label"),
"position": &FieldPositionProperty{
"below": jsii.String("below"),
"fixed": jsii.String("fixed"),
"rightOf": jsii.String("rightOf"),
},
"validations": []interface{}{
&FieldValidationConfigurationProperty{
"type": jsii.String("type"),
// the properties below are optional
"numValues": []interface{}{
jsii.Number(123),
},
"strValues": []*string{
jsii.String("strValues"),
},
"validationMessage": jsii.String("validationMessage"),
},
},
},
},
formActionType: jsii.String("formActionType"),
name: jsii.String("name"),
schemaVersion: jsii.String("schemaVersion"),
sectionalElements: map[string]interface{}{
"sectionalElementsKey": &SectionalElementProperty{
"type": jsii.String("type"),
// the properties below are optional
"level": jsii.Number(123),
"orientation": jsii.String("orientation"),
"position": &FieldPositionProperty{
"below": jsii.String("below"),
"fixed": jsii.String("fixed"),
"rightOf": jsii.String("rightOf"),
},
"text": jsii.String("text"),
},
},
style: &formStyleProperty{
horizontalGap: &formStyleConfigProperty{
tokenReference: jsii.String("tokenReference"),
value: jsii.String("value"),
},
outerPadding: &formStyleConfigProperty{
tokenReference: jsii.String("tokenReference"),
value: jsii.String("value"),
},
verticalGap: &formStyleConfigProperty{
tokenReference: jsii.String("tokenReference"),
value: jsii.String("value"),
},
},
// the properties below are optional
appId: jsii.String("appId"),
cta: &formCTAProperty{
cancel: &formButtonProperty{
children: jsii.String("children"),
excluded: jsii.Boolean(false),
position: &fieldPositionProperty{
below: jsii.String("below"),
fixed: jsii.String("fixed"),
rightOf: jsii.String("rightOf"),
},
},
clear: &formButtonProperty{
children: jsii.String("children"),
excluded: jsii.Boolean(false),
position: &fieldPositionProperty{
below: jsii.String("below"),
fixed: jsii.String("fixed"),
rightOf: jsii.String("rightOf"),
},
},
position: jsii.String("position"),
submit: &formButtonProperty{
children: jsii.String("children"),
excluded: jsii.Boolean(false),
position: &fieldPositionProperty{
below: jsii.String("below"),
fixed: jsii.String("fixed"),
rightOf: jsii.String("rightOf"),
},
},
},
environmentName: jsii.String("environmentName"),
tags: map[string]*string{
"tagsKey": jsii.String("tags"),
},
})
func NewCfnForm ¶
func NewCfnForm(scope awscdk.Construct, id *string, props *CfnFormProps) CfnForm
Create a new `AWS::AmplifyUIBuilder::Form`.
type CfnFormProps ¶
type CfnFormProps struct {
// The type of data source to use to create the form.
DataType interface{} `field:"required" json:"dataType" yaml:"dataType"`
// Stores the information about the form's fields.
Fields interface{} `field:"required" json:"fields" yaml:"fields"`
// The operation to perform on the specified form.
FormActionType *string `field:"required" json:"formActionType" yaml:"formActionType"`
// The name of the form.
Name *string `field:"required" json:"name" yaml:"name"`
// The schema version of the form when it was imported.
SchemaVersion *string `field:"required" json:"schemaVersion" yaml:"schemaVersion"`
// Stores the visual helper elements for the form that are not associated with any data.
SectionalElements interface{} `field:"required" json:"sectionalElements" yaml:"sectionalElements"`
// Stores the configuration for the form's style.
Style interface{} `field:"required" json:"style" yaml:"style"`
// The unique ID of the Amplify app associated with the form.
AppId *string `field:"optional" json:"appId" yaml:"appId"`
// Stores the call to action configuration for the form.
Cta interface{} `field:"optional" json:"cta" yaml:"cta"`
// The name of the backend environment that is a part of the Amplify app.
EnvironmentName *string `field:"optional" json:"environmentName" yaml:"environmentName"`
// One or more key-value pairs to use when tagging the form.
Tags *map[string]*string `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnForm`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnFormProps := &cfnFormProps{
dataType: &formDataTypeConfigProperty{
dataSourceType: jsii.String("dataSourceType"),
dataTypeName: jsii.String("dataTypeName"),
},
fields: map[string]interface{}{
"fieldsKey": &FieldConfigProperty{
"excluded": jsii.Boolean(false),
"inputType": &FieldInputConfigProperty{
"type": jsii.String("type"),
// the properties below are optional
"defaultChecked": jsii.Boolean(false),
"defaultCountryCode": jsii.String("defaultCountryCode"),
"defaultValue": jsii.String("defaultValue"),
"descriptiveText": jsii.String("descriptiveText"),
"maxValue": jsii.Number(123),
"minValue": jsii.Number(123),
"name": jsii.String("name"),
"placeholder": jsii.String("placeholder"),
"readOnly": jsii.Boolean(false),
"required": jsii.Boolean(false),
"step": jsii.Number(123),
"value": jsii.String("value"),
"valueMappings": &ValueMappingsProperty{
"values": []interface{}{
&ValueMappingProperty{
"value": &FormInputValuePropertyProperty{
"value": jsii.String("value"),
},
// the properties below are optional
"displayValue": &FormInputValuePropertyProperty{
"value": jsii.String("value"),
},
},
},
},
},
"label": jsii.String("label"),
"position": &FieldPositionProperty{
"below": jsii.String("below"),
"fixed": jsii.String("fixed"),
"rightOf": jsii.String("rightOf"),
},
"validations": []interface{}{
&FieldValidationConfigurationProperty{
"type": jsii.String("type"),
// the properties below are optional
"numValues": []interface{}{
jsii.Number(123),
},
"strValues": []*string{
jsii.String("strValues"),
},
"validationMessage": jsii.String("validationMessage"),
},
},
},
},
formActionType: jsii.String("formActionType"),
name: jsii.String("name"),
schemaVersion: jsii.String("schemaVersion"),
sectionalElements: map[string]interface{}{
"sectionalElementsKey": &SectionalElementProperty{
"type": jsii.String("type"),
// the properties below are optional
"level": jsii.Number(123),
"orientation": jsii.String("orientation"),
"position": &FieldPositionProperty{
"below": jsii.String("below"),
"fixed": jsii.String("fixed"),
"rightOf": jsii.String("rightOf"),
},
"text": jsii.String("text"),
},
},
style: &formStyleProperty{
horizontalGap: &formStyleConfigProperty{
tokenReference: jsii.String("tokenReference"),
value: jsii.String("value"),
},
outerPadding: &formStyleConfigProperty{
tokenReference: jsii.String("tokenReference"),
value: jsii.String("value"),
},
verticalGap: &formStyleConfigProperty{
tokenReference: jsii.String("tokenReference"),
value: jsii.String("value"),
},
},
// the properties below are optional
appId: jsii.String("appId"),
cta: &formCTAProperty{
cancel: &formButtonProperty{
children: jsii.String("children"),
excluded: jsii.Boolean(false),
position: &fieldPositionProperty{
below: jsii.String("below"),
fixed: jsii.String("fixed"),
rightOf: jsii.String("rightOf"),
},
},
clear: &formButtonProperty{
children: jsii.String("children"),
excluded: jsii.Boolean(false),
position: &fieldPositionProperty{
below: jsii.String("below"),
fixed: jsii.String("fixed"),
rightOf: jsii.String("rightOf"),
},
},
position: jsii.String("position"),
submit: &formButtonProperty{
children: jsii.String("children"),
excluded: jsii.Boolean(false),
position: &fieldPositionProperty{
below: jsii.String("below"),
fixed: jsii.String("fixed"),
rightOf: jsii.String("rightOf"),
},
},
},
environmentName: jsii.String("environmentName"),
tags: map[string]*string{
"tagsKey": jsii.String("tags"),
},
}
type CfnForm_FieldConfigProperty ¶
type CfnForm_FieldConfigProperty struct {
// Specifies whether to hide a field.
Excluded interface{} `field:"optional" json:"excluded" yaml:"excluded"`
// Describes the configuration for the default input value to display for a field.
InputType interface{} `field:"optional" json:"inputType" yaml:"inputType"`
// The label for the field.
Label *string `field:"optional" json:"label" yaml:"label"`
// Specifies the field position.
Position interface{} `field:"optional" json:"position" yaml:"position"`
// The validations to perform on the value in the field.
Validations interface{} `field:"optional" json:"validations" yaml:"validations"`
}
Describes the configuration information for a field in a table.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
fieldConfigProperty := &fieldConfigProperty{
excluded: jsii.Boolean(false),
inputType: &fieldInputConfigProperty{
type: jsii.String("type"),
// the properties below are optional
defaultChecked: jsii.Boolean(false),
defaultCountryCode: jsii.String("defaultCountryCode"),
defaultValue: jsii.String("defaultValue"),
descriptiveText: jsii.String("descriptiveText"),
maxValue: jsii.Number(123),
minValue: jsii.Number(123),
name: jsii.String("name"),
placeholder: jsii.String("placeholder"),
readOnly: jsii.Boolean(false),
required: jsii.Boolean(false),
step: jsii.Number(123),
value: jsii.String("value"),
valueMappings: &valueMappingsProperty{
values: []interface{}{
&valueMappingProperty{
value: &formInputValuePropertyProperty{
value: jsii.String("value"),
},
// the properties below are optional
displayValue: &formInputValuePropertyProperty{
value: jsii.String("value"),
},
},
},
},
},
label: jsii.String("label"),
position: &fieldPositionProperty{
below: jsii.String("below"),
fixed: jsii.String("fixed"),
rightOf: jsii.String("rightOf"),
},
validations: []interface{}{
&fieldValidationConfigurationProperty{
type: jsii.String("type"),
// the properties below are optional
numValues: []interface{}{
jsii.Number(123),
},
strValues: []*string{
jsii.String("strValues"),
},
validationMessage: jsii.String("validationMessage"),
},
},
}
type CfnForm_FieldInputConfigProperty ¶
type CfnForm_FieldInputConfigProperty struct {
// The input type for the field.
Type *string `field:"required" json:"type" yaml:"type"`
// Specifies whether a field has a default value.
DefaultChecked interface{} `field:"optional" json:"defaultChecked" yaml:"defaultChecked"`
// The default country code for a phone number.
DefaultCountryCode *string `field:"optional" json:"defaultCountryCode" yaml:"defaultCountryCode"`
// The default value for the field.
DefaultValue *string `field:"optional" json:"defaultValue" yaml:"defaultValue"`
// The text to display to describe the field.
DescriptiveText *string `field:"optional" json:"descriptiveText" yaml:"descriptiveText"`
// The maximum value to display for the field.
MaxValue *float64 `field:"optional" json:"maxValue" yaml:"maxValue"`
// The minimum value to display for the field.
MinValue *float64 `field:"optional" json:"minValue" yaml:"minValue"`
// The name of the field.
Name *string `field:"optional" json:"name" yaml:"name"`
// The text to display as a placeholder for the field.
Placeholder *string `field:"optional" json:"placeholder" yaml:"placeholder"`
// Specifies a read only field.
ReadOnly interface{} `field:"optional" json:"readOnly" yaml:"readOnly"`
// Specifies a field that requires input.
Required interface{} `field:"optional" json:"required" yaml:"required"`
// The stepping increment for a numeric value in a field.
Step *float64 `field:"optional" json:"step" yaml:"step"`
// The value for the field.
Value *string `field:"optional" json:"value" yaml:"value"`
// The information to use to customize the input fields with data at runtime.
ValueMappings interface{} `field:"optional" json:"valueMappings" yaml:"valueMappings"`
}
Describes the configuration for the default input values to display for a field.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
fieldInputConfigProperty := &fieldInputConfigProperty{
type: jsii.String("type"),
// the properties below are optional
defaultChecked: jsii.Boolean(false),
defaultCountryCode: jsii.String("defaultCountryCode"),
defaultValue: jsii.String("defaultValue"),
descriptiveText: jsii.String("descriptiveText"),
maxValue: jsii.Number(123),
minValue: jsii.Number(123),
name: jsii.String("name"),
placeholder: jsii.String("placeholder"),
readOnly: jsii.Boolean(false),
required: jsii.Boolean(false),
step: jsii.Number(123),
value: jsii.String("value"),
valueMappings: &valueMappingsProperty{
values: []interface{}{
&valueMappingProperty{
value: &formInputValuePropertyProperty{
value: jsii.String("value"),
},
// the properties below are optional
displayValue: &formInputValuePropertyProperty{
value: jsii.String("value"),
},
},
},
},
}
type CfnForm_FieldPositionProperty ¶
type CfnForm_FieldPositionProperty struct {
// The field position is below the field specified by the string.
Below *string `field:"optional" json:"below" yaml:"below"`
// The field position is fixed and doesn't change in relation to other fields.
Fixed *string `field:"optional" json:"fixed" yaml:"fixed"`
// The field position is to the right of the field specified by the string.
RightOf *string `field:"optional" json:"rightOf" yaml:"rightOf"`
}
Describes the field position.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
fieldPositionProperty := &fieldPositionProperty{
below: jsii.String("below"),
fixed: jsii.String("fixed"),
rightOf: jsii.String("rightOf"),
}
type CfnForm_FieldValidationConfigurationProperty ¶
type CfnForm_FieldValidationConfigurationProperty struct {
// The validation to perform on an object type.
//
// “.
Type *string `field:"required" json:"type" yaml:"type"`
// The validation to perform on a number value.
NumValues interface{} `field:"optional" json:"numValues" yaml:"numValues"`
// The validation to perform on a string value.
StrValues *[]*string `field:"optional" json:"strValues" yaml:"strValues"`
// The validation message to display.
ValidationMessage *string `field:"optional" json:"validationMessage" yaml:"validationMessage"`
}
Describes the validation configuration for a field.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
fieldValidationConfigurationProperty := &fieldValidationConfigurationProperty{
type: jsii.String("type"),
// the properties below are optional
numValues: []interface{}{
jsii.Number(123),
},
strValues: []*string{
jsii.String("strValues"),
},
validationMessage: jsii.String("validationMessage"),
}
type CfnForm_FormButtonProperty ¶
type CfnForm_FormButtonProperty struct {
// Describes the button's properties.
Children *string `field:"optional" json:"children" yaml:"children"`
// Specifies whether the button is visible on the form.
Excluded interface{} `field:"optional" json:"excluded" yaml:"excluded"`
// The position of the button.
Position interface{} `field:"optional" json:"position" yaml:"position"`
}
Describes the configuration for a button UI element that is a part of a form.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
formButtonProperty := &formButtonProperty{
children: jsii.String("children"),
excluded: jsii.Boolean(false),
position: &fieldPositionProperty{
below: jsii.String("below"),
fixed: jsii.String("fixed"),
rightOf: jsii.String("rightOf"),
},
}
type CfnForm_FormCTAProperty ¶
type CfnForm_FormCTAProperty struct {
// Displays a cancel button.
Cancel interface{} `field:"optional" json:"cancel" yaml:"cancel"`
// Displays a clear button.
Clear interface{} `field:"optional" json:"clear" yaml:"clear"`
// The position of the button.
Position *string `field:"optional" json:"position" yaml:"position"`
// Displays a submit button.
Submit interface{} `field:"optional" json:"submit" yaml:"submit"`
}
Describes the call to action button configuration for the form.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
formCTAProperty := &formCTAProperty{
cancel: &formButtonProperty{
children: jsii.String("children"),
excluded: jsii.Boolean(false),
position: &fieldPositionProperty{
below: jsii.String("below"),
fixed: jsii.String("fixed"),
rightOf: jsii.String("rightOf"),
},
},
clear: &formButtonProperty{
children: jsii.String("children"),
excluded: jsii.Boolean(false),
position: &fieldPositionProperty{
below: jsii.String("below"),
fixed: jsii.String("fixed"),
rightOf: jsii.String("rightOf"),
},
},
position: jsii.String("position"),
submit: &formButtonProperty{
children: jsii.String("children"),
excluded: jsii.Boolean(false),
position: &fieldPositionProperty{
below: jsii.String("below"),
fixed: jsii.String("fixed"),
rightOf: jsii.String("rightOf"),
},
},
}
type CfnForm_FormDataTypeConfigProperty ¶
type CfnForm_FormDataTypeConfigProperty struct {
// The data source type, either an Amplify DataStore model or a custom data type.
DataSourceType *string `field:"required" json:"dataSourceType" yaml:"dataSourceType"`
// The unique name of the data type you are using as the data source for the form.
DataTypeName *string `field:"required" json:"dataTypeName" yaml:"dataTypeName"`
}
Describes the data type configuration for the data source associated with a form.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
formDataTypeConfigProperty := &formDataTypeConfigProperty{
dataSourceType: jsii.String("dataSourceType"),
dataTypeName: jsii.String("dataTypeName"),
}
type CfnForm_FormInputValuePropertyProperty ¶
type CfnForm_FormInputValuePropertyProperty struct {
// The value to assign to the input field.
Value *string `field:"optional" json:"value" yaml:"value"`
}
Describes the configuration for an input field on a form.
Use `FormInputValueProperty` to specify the values to render or bind by default.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
formInputValuePropertyProperty := &formInputValuePropertyProperty{
value: jsii.String("value"),
}
type CfnForm_FormStyleConfigProperty ¶
type CfnForm_FormStyleConfigProperty struct {
// A reference to a design token to use to bind the form's style properties to an existing theme.
TokenReference *string `field:"optional" json:"tokenReference" yaml:"tokenReference"`
// The value of the style setting.
Value *string `field:"optional" json:"value" yaml:"value"`
}
Describes the configuration settings for the form's style properties.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
formStyleConfigProperty := &formStyleConfigProperty{
tokenReference: jsii.String("tokenReference"),
value: jsii.String("value"),
}
type CfnForm_FormStyleProperty ¶
type CfnForm_FormStyleProperty struct {
// The spacing for the horizontal gap.
HorizontalGap interface{} `field:"optional" json:"horizontalGap" yaml:"horizontalGap"`
// The size of the outer padding for the form.
OuterPadding interface{} `field:"optional" json:"outerPadding" yaml:"outerPadding"`
// The spacing for the vertical gap.
VerticalGap interface{} `field:"optional" json:"verticalGap" yaml:"verticalGap"`
}
Describes the configuration for the form's style.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
formStyleProperty := &formStyleProperty{
horizontalGap: &formStyleConfigProperty{
tokenReference: jsii.String("tokenReference"),
value: jsii.String("value"),
},
outerPadding: &formStyleConfigProperty{
tokenReference: jsii.String("tokenReference"),
value: jsii.String("value"),
},
verticalGap: &formStyleConfigProperty{
tokenReference: jsii.String("tokenReference"),
value: jsii.String("value"),
},
}
type CfnForm_SectionalElementProperty ¶
type CfnForm_SectionalElementProperty struct {
// The type of sectional element.
//
// Valid values are `Heading` , `Text` , and `Divider` .
Type *string `field:"required" json:"type" yaml:"type"`
// Specifies the size of the font for a `Heading` sectional element.
//
// Valid values are `1 | 2 | 3 | 4 | 5 | 6` .
Level *float64 `field:"optional" json:"level" yaml:"level"`
// Specifies the orientation for a `Divider` sectional element.
//
// Valid values are `horizontal` or `vertical` .
Orientation *string `field:"optional" json:"orientation" yaml:"orientation"`
// Specifies the position of the text in a field for a `Text` sectional element.
Position interface{} `field:"optional" json:"position" yaml:"position"`
// The text for a `Text` sectional element.
Text *string `field:"optional" json:"text" yaml:"text"`
}
Stores the configuration information for a visual helper element for a form.
A sectional element can be a header, a text block, or a divider. These elements are static and not associated with any data.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
sectionalElementProperty := §ionalElementProperty{
type: jsii.String("type"),
// the properties below are optional
level: jsii.Number(123),
orientation: jsii.String("orientation"),
position: &fieldPositionProperty{
below: jsii.String("below"),
fixed: jsii.String("fixed"),
rightOf: jsii.String("rightOf"),
},
text: jsii.String("text"),
}
type CfnForm_ValueMappingProperty ¶
type CfnForm_ValueMappingProperty struct {
// The complex object.
Value interface{} `field:"required" json:"value" yaml:"value"`
// The value to display for the complex object.
DisplayValue interface{} `field:"optional" json:"displayValue" yaml:"displayValue"`
}
Associates a complex object with a display value.
Use `ValueMapping` to store how to represent complex objects when they are displayed.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
valueMappingProperty := &valueMappingProperty{
value: &formInputValuePropertyProperty{
value: jsii.String("value"),
},
// the properties below are optional
displayValue: &formInputValuePropertyProperty{
value: jsii.String("value"),
},
}
type CfnForm_ValueMappingsProperty ¶
type CfnForm_ValueMappingsProperty struct {
// The value and display value pairs.
Values interface{} `field:"required" json:"values" yaml:"values"`
}
Represents the data binding configuration for a value map.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
valueMappingsProperty := &valueMappingsProperty{
values: []interface{}{
&valueMappingProperty{
value: &formInputValuePropertyProperty{
value: jsii.String("value"),
},
// the properties below are optional
displayValue: &formInputValuePropertyProperty{
value: jsii.String("value"),
},
},
},
}
type CfnTheme ¶
type CfnTheme interface {
awscdk.CfnResource
awscdk.IInspectable
// The unique ID for the Amplify app associated with the theme.
AttrAppId() *string
// The time that the theme was created.
AttrCreatedAt() *string
// The name of the backend environment that is a part of the Amplify app.
AttrEnvironmentName() *string
// The ID for the theme.
AttrId() *string
// The time that the theme was modified.
AttrModifiedAt() *string
// Options for this resource, such as condition, update policy etc.
// Experimental.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
// Experimental.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
// Experimental.
CreationStack() *[]*string
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
// Experimental.
LogicalId() *string
// The name of the theme.
Name() *string
SetName(val *string)
// The construct tree node associated with this construct.
// Experimental.
Node() awscdk.ConstructNode
// Describes the properties that can be overriden to customize a theme.
Overrides() interface{}
SetOverrides(val interface{})
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
// Experimental.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
// Experimental.
Stack() awscdk.Stack
// One or more key-value pairs to use when tagging the theme.
Tags() awscdk.TagManager
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
// Experimental.
UpdatedProperites() *map[string]interface{}
// A list of key-value pairs that defines the properties of the theme.
Values() interface{}
SetValues(val interface{})
// Syntactic sugar for `addOverride(path, undefined)`.
// Experimental.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
// Experimental.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
// Experimental.
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
// Experimental.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
// Experimental.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
// Experimental.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
// Experimental.
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
// Experimental.
GetAtt(attributeName *string) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
// Experimental.
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
OnPrepare()
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
OnSynthesize(session constructs.ISynthesisSession)
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
OnValidate() *[]*string
// Overrides the auto-generated logical ID with a specific ID.
// Experimental.
OverrideLogicalId(newLogicalId *string)
// Perform final modifications before synthesis.
//
// This method can be implemented by derived constructs in order to perform
// final changes before synthesis. prepare() will be called after child
// constructs have been prepared.
//
// This is an advanced framework feature. Only use this if you
// understand the implications.
// Experimental.
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
// Experimental.
ShouldSynthesize() *bool
// Allows this construct to emit artifacts into the cloud assembly during synthesis.
//
// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
// as they participate in synthesizing the cloud assembly.
// Experimental.
Synthesize(session awscdk.ISynthesisSession)
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
// Experimental.
ToString() *string
// Validate the current construct.
//
// This method can be implemented by derived constructs in order to perform
// validation logic. It is called on all constructs before synthesis.
//
// Returns: An array of validation error messages, or an empty array if the construct is valid.
// Experimental.
Validate() *[]*string
// Experimental.
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::AmplifyUIBuilder::Theme`.
The AWS::AmplifyUIBuilder::Theme resource specifies a theme within an Amplify app. A theme is a collection of style settings that apply globally to the components associated with the app.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
var themeValuesProperty_ themeValuesProperty
cfnTheme := awscdk.Aws_amplifyuibuilder.NewCfnTheme(this, jsii.String("MyCfnTheme"), &cfnThemeProps{
name: jsii.String("name"),
values: []interface{}{
&themeValuesProperty{
key: jsii.String("key"),
value: &themeValueProperty{
children: []interface{}{
themeValuesProperty_,
},
value: jsii.String("value"),
},
},
},
// the properties below are optional
overrides: []interface{}{
&themeValuesProperty{
key: jsii.String("key"),
value: &themeValueProperty{
children: []interface{}{
themeValuesProperty_,
},
value: jsii.String("value"),
},
},
},
tags: map[string]*string{
"tagsKey": jsii.String("tags"),
},
})
func NewCfnTheme ¶
func NewCfnTheme(scope awscdk.Construct, id *string, props *CfnThemeProps) CfnTheme
Create a new `AWS::AmplifyUIBuilder::Theme`.
type CfnThemeProps ¶
type CfnThemeProps struct {
// The name of the theme.
Name *string `field:"required" json:"name" yaml:"name"`
// A list of key-value pairs that defines the properties of the theme.
Values interface{} `field:"required" json:"values" yaml:"values"`
// Describes the properties that can be overriden to customize a theme.
Overrides interface{} `field:"optional" json:"overrides" yaml:"overrides"`
// One or more key-value pairs to use when tagging the theme.
Tags *map[string]*string `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnTheme`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
var themeValuesProperty_ themeValuesProperty
cfnThemeProps := &cfnThemeProps{
name: jsii.String("name"),
values: []interface{}{
&themeValuesProperty{
key: jsii.String("key"),
value: &themeValueProperty{
children: []interface{}{
themeValuesProperty_,
},
value: jsii.String("value"),
},
},
},
// the properties below are optional
overrides: []interface{}{
&themeValuesProperty{
key: jsii.String("key"),
value: &themeValueProperty{
children: []interface{}{
themeValuesProperty_,
},
value: jsii.String("value"),
},
},
},
tags: map[string]*string{
"tagsKey": jsii.String("tags"),
},
}
type CfnTheme_ThemeValueProperty ¶
type CfnTheme_ThemeValueProperty struct {
// A list of key-value pairs that define the theme's properties.
Children interface{} `field:"optional" json:"children" yaml:"children"`
// The value of a theme property.
Value *string `field:"optional" json:"value" yaml:"value"`
}
The `ThemeValue` property specifies the configuration of a theme's properties.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
var themeValuesProperty_ themeValuesProperty
themeValueProperty := &themeValueProperty{
children: []interface{}{
&themeValuesProperty{
key: jsii.String("key"),
value: &themeValueProperty{
children: []interface{}{
themeValuesProperty_,
},
value: jsii.String("value"),
},
},
},
value: jsii.String("value"),
}
type CfnTheme_ThemeValuesProperty ¶
type CfnTheme_ThemeValuesProperty struct {
// The name of the property.
Key *string `field:"optional" json:"key" yaml:"key"`
// The value of the property.
Value interface{} `field:"optional" json:"value" yaml:"value"`
}
The `ThemeValues` property specifies key-value pair that defines a property of a theme.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
var themeValueProperty_ themeValueProperty
themeValuesProperty := &themeValuesProperty{
key: jsii.String("key"),
value: &themeValueProperty{
children: []interface{}{
&themeValuesProperty{
key: jsii.String("key"),
value: themeValueProperty_,
},
},
value: jsii.String("value"),
},
}
Source Files
¶
- awsamplifyuibuilder.go
- awsamplifyuibuilder_CfnComponent.go
- awsamplifyuibuilder_CfnComponentProps.go
- awsamplifyuibuilder_CfnComponent_ActionParametersProperty.go
- awsamplifyuibuilder_CfnComponent_ComponentBindingPropertiesValuePropertiesProperty.go
- awsamplifyuibuilder_CfnComponent_ComponentBindingPropertiesValueProperty.go
- awsamplifyuibuilder_CfnComponent_ComponentChildProperty.go
- awsamplifyuibuilder_CfnComponent_ComponentConditionPropertyProperty.go
- awsamplifyuibuilder_CfnComponent_ComponentDataConfigurationProperty.go
- awsamplifyuibuilder_CfnComponent_ComponentEventProperty.go
- awsamplifyuibuilder_CfnComponent_ComponentPropertyBindingPropertiesProperty.go
- awsamplifyuibuilder_CfnComponent_ComponentPropertyProperty.go
- awsamplifyuibuilder_CfnComponent_ComponentVariantProperty.go
- awsamplifyuibuilder_CfnComponent_FormBindingElementProperty.go
- awsamplifyuibuilder_CfnComponent_MutationActionSetStateParameterProperty.go
- awsamplifyuibuilder_CfnComponent_PredicateProperty.go
- awsamplifyuibuilder_CfnComponent_SortPropertyProperty.go
- awsamplifyuibuilder_CfnComponent__runtime_type_checks.go
- awsamplifyuibuilder_CfnForm.go
- awsamplifyuibuilder_CfnFormProps.go
- awsamplifyuibuilder_CfnForm_FieldConfigProperty.go
- awsamplifyuibuilder_CfnForm_FieldInputConfigProperty.go
- awsamplifyuibuilder_CfnForm_FieldPositionProperty.go
- awsamplifyuibuilder_CfnForm_FieldValidationConfigurationProperty.go
- awsamplifyuibuilder_CfnForm_FormButtonProperty.go
- awsamplifyuibuilder_CfnForm_FormCTAProperty.go
- awsamplifyuibuilder_CfnForm_FormDataTypeConfigProperty.go
- awsamplifyuibuilder_CfnForm_FormInputValuePropertyProperty.go
- awsamplifyuibuilder_CfnForm_FormStyleConfigProperty.go
- awsamplifyuibuilder_CfnForm_FormStyleProperty.go
- awsamplifyuibuilder_CfnForm_SectionalElementProperty.go
- awsamplifyuibuilder_CfnForm_ValueMappingProperty.go
- awsamplifyuibuilder_CfnForm_ValueMappingsProperty.go
- awsamplifyuibuilder_CfnForm__runtime_type_checks.go
- awsamplifyuibuilder_CfnTheme.go
- awsamplifyuibuilder_CfnThemeProps.go
- awsamplifyuibuilder_CfnTheme_ThemeValueProperty.go
- awsamplifyuibuilder_CfnTheme_ThemeValuesProperty.go
- awsamplifyuibuilder_CfnTheme__runtime_type_checks.go
Directories
Click to show internal directories.
Click to hide internal directories.