Documentation
¶
Index ¶
- func CfnComponent_CFN_RESOURCE_TYPE_NAME() *string
- func CfnComponent_IsCfnElement(x interface{}) *bool
- func CfnComponent_IsCfnResource(x interface{}) *bool
- func CfnComponent_IsConstruct(x interface{}) *bool
- func CfnForm_CFN_RESOURCE_TYPE_NAME() *string
- func CfnForm_IsCfnElement(x interface{}) *bool
- func CfnForm_IsCfnResource(x interface{}) *bool
- func CfnForm_IsConstruct(x interface{}) *bool
- func CfnTheme_CFN_RESOURCE_TYPE_NAME() *string
- func CfnTheme_IsCfnElement(x interface{}) *bool
- func CfnTheme_IsCfnResource(x interface{}) *bool
- func CfnTheme_IsConstruct(x interface{}) *bool
- func NewCfnComponent_Override(c CfnComponent, scope constructs.Construct, id *string, ...)
- func NewCfnForm_Override(c CfnForm, scope constructs.Construct, id *string, props *CfnFormProps)
- func NewCfnTheme_Override(c CfnTheme, scope constructs.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_FileUploaderFieldConfigProperty
- type CfnForm_FormButtonProperty
- type CfnForm_FormCTAProperty
- type CfnForm_FormDataTypeConfigProperty
- type CfnForm_FormInputBindingPropertiesValuePropertiesProperty
- type CfnForm_FormInputBindingPropertiesValueProperty
- type CfnForm_FormInputValuePropertyBindingPropertiesProperty
- 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.
func CfnComponent_IsCfnResource ¶
func CfnComponent_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnComponent_IsConstruct ¶
func CfnComponent_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnForm_CFN_RESOURCE_TYPE_NAME ¶ added in v2.55.0
func CfnForm_CFN_RESOURCE_TYPE_NAME() *string
func CfnForm_IsCfnElement ¶ added in v2.55.0
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.
func CfnForm_IsCfnResource ¶ added in v2.55.0
func CfnForm_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnForm_IsConstruct ¶ added in v2.55.0
func CfnForm_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
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.
func CfnTheme_IsCfnResource ¶
func CfnTheme_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnTheme_IsConstruct ¶
func CfnTheme_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func NewCfnComponent_Override ¶
func NewCfnComponent_Override(c CfnComponent, scope constructs.Construct, id *string, props *CfnComponentProps)
Create a new `AWS::AmplifyUIBuilder::Component`.
func NewCfnForm_Override ¶ added in v2.55.0
func NewCfnForm_Override(c CfnForm, scope constructs.Construct, id *string, props *CfnFormProps)
Create a new `AWS::AmplifyUIBuilder::Form`.
func NewCfnTheme_Override ¶
func NewCfnTheme_Override(c CfnTheme, scope constructs.Construct, id *string, props *CfnThemeProps)
Create a new `AWS::AmplifyUIBuilder::Theme`.
Types ¶
type CfnComponent ¶
type CfnComponent interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawsamplifyuibuilder.IComponentRef
awscdk.ITaggable
// The unique ID of the Amplify app associated with the component.
AppId() *string
SetAppId(val *string)
// The time that the component was created.
AttrCreatedAt() *string
// The unique ID of the component.
AttrId() *string
// The time that the component was modified.
AttrModifiedAt() *string
// The information to connect a component's properties to data at runtime.
BindingProperties() interface{}
SetBindingProperties(val interface{})
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// A list of the component's `ComponentChild` instances.
Children() interface{}
SetChildren(val interface{})
// The data binding configuration for the component's properties.
CollectionProperties() interface{}
SetCollectionProperties(val interface{})
// A reference to a Component resource.
ComponentRef() *interfacesawsamplifyuibuilder.ComponentReference
// The type of the 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.
CreationStack() *[]*string
Env() *interfaces.ResourceEnvironment
// The name of the backend environment that is a part of the Amplify app.
EnvironmentName() *string
SetEnvironmentName(val *string)
// Describes the events that can be raised on the component.
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.
LogicalId() *string
// The name of the component.
Name() *string
SetName(val *string)
// The tree node.
Node() constructs.Node
// Describes the component's properties that can be overriden in a customized instance of the component.
Overrides() interface{}
SetOverrides(val interface{})
// Describes the component's 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 })`.
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).
Stack() awscdk.Stack
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
// One or more key-value pairs to use when tagging the component.
TagsRaw() *map[string]*string
SetTagsRaw(val *map[string]*string)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// A list of the component's variants.
Variants() interface{}
SetVariants(val interface{})
// Syntactic sugar for `addOverride(path, undefined)`.
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.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
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.
//
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.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
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`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
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.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) 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.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// 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.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
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:
func NewCfnComponent ¶
func NewCfnComponent(scope constructs.Construct, id *string, props *CfnComponentProps) CfnComponent
Create a new `AWS::AmplifyUIBuilder::Component`.
type CfnComponentProps ¶
type CfnComponentProps struct {
// The unique ID of the Amplify app associated with the component.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-component.html#cfn-amplifyuibuilder-component-appid
//
AppId *string `field:"optional" json:"appId" yaml:"appId"`
// The information to connect a component's properties to data at runtime.
//
// You can't specify `tags` as a valid property for `bindingProperties` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-component.html#cfn-amplifyuibuilder-component-bindingproperties
//
BindingProperties interface{} `field:"optional" json:"bindingProperties" yaml:"bindingProperties"`
// A list of the component's `ComponentChild` instances.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-component.html#cfn-amplifyuibuilder-component-children
//
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` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-component.html#cfn-amplifyuibuilder-component-collectionproperties
//
CollectionProperties interface{} `field:"optional" json:"collectionProperties" yaml:"collectionProperties"`
// The type of the component.
//
// This can be an Amplify custom UI component or another custom component.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-component.html#cfn-amplifyuibuilder-component-componenttype
//
ComponentType *string `field:"optional" json:"componentType" yaml:"componentType"`
// The name of the backend environment that is a part of the Amplify app.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-component.html#cfn-amplifyuibuilder-component-environmentname
//
EnvironmentName *string `field:"optional" json:"environmentName" yaml:"environmentName"`
// 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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-component.html#cfn-amplifyuibuilder-component-events
//
Events interface{} `field:"optional" json:"events" yaml:"events"`
// The name of the component.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-component.html#cfn-amplifyuibuilder-component-name
//
Name *string `field:"optional" 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` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-component.html#cfn-amplifyuibuilder-component-overrides
//
Overrides interface{} `field:"optional" json:"overrides" yaml:"overrides"`
// Describes the component's properties.
//
// You can't specify `tags` as a valid property for `properties` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-component.html#cfn-amplifyuibuilder-component-properties
//
Properties interface{} `field:"optional" json:"properties" yaml:"properties"`
// The schema version of the component when it was imported.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-component.html#cfn-amplifyuibuilder-component-schemaversion
//
SchemaVersion *string `field:"optional" json:"schemaVersion" yaml:"schemaVersion"`
// The unique ID of the component in its original source system, such as Figma.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-component.html#cfn-amplifyuibuilder-component-sourceid
//
SourceId *string `field:"optional" json:"sourceId" yaml:"sourceId"`
// One or more key-value pairs to use when tagging the component.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-component.html#cfn-amplifyuibuilder-component-tags
//
Tags *map[string]*string `field:"optional" json:"tags" yaml:"tags"`
// A list of the component's variants.
//
// A variant is a unique style configuration of a main component.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-component.html#cfn-amplifyuibuilder-component-variants
//
Variants interface{} `field:"optional" json:"variants" yaml:"variants"`
}
Properties for defining a `CfnComponent`.
Example:
type CfnComponent_ActionParametersProperty ¶ added in v2.15.0
type CfnComponent_ActionParametersProperty struct {
// The HTML anchor link to the location to open.
//
// Specify this value for a navigation action.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-actionparameters.html#cfn-amplifyuibuilder-component-actionparameters-anchor
//
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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-actionparameters.html#cfn-amplifyuibuilder-component-actionparameters-fields
//
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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-actionparameters.html#cfn-amplifyuibuilder-component-actionparameters-global
//
Global interface{} `field:"optional" json:"global" yaml:"global"`
// The unique ID of the component that the `ActionParameters` apply to.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-actionparameters.html#cfn-amplifyuibuilder-component-actionparameters-id
//
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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-actionparameters.html#cfn-amplifyuibuilder-component-actionparameters-model
//
Model *string `field:"optional" json:"model" yaml:"model"`
// A key-value pair that specifies the state property name and its initial value.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-actionparameters.html#cfn-amplifyuibuilder-component-actionparameters-state
//
State interface{} `field:"optional" json:"state" yaml:"state"`
// The element within the same component to modify when the action occurs.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-actionparameters.html#cfn-amplifyuibuilder-component-actionparameters-target
//
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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-actionparameters.html#cfn-amplifyuibuilder-component-actionparameters-type
//
Type interface{} `field:"optional" json:"type" yaml:"type"`
// The URL to the location to open.
//
// Specify this value for a navigation action.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-actionparameters.html#cfn-amplifyuibuilder-component-actionparameters-url
//
Url interface{} `field:"optional" json:"url" yaml:"url"`
}
Represents 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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentbindingpropertiesvalueproperties.html#cfn-amplifyuibuilder-component-componentbindingpropertiesvalueproperties-bucket
//
Bucket *string `field:"optional" json:"bucket" yaml:"bucket"`
// The default value to assign to the property.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentbindingpropertiesvalueproperties.html#cfn-amplifyuibuilder-component-componentbindingpropertiesvalueproperties-defaultvalue
//
DefaultValue *string `field:"optional" json:"defaultValue" yaml:"defaultValue"`
// The field to bind the data to.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentbindingpropertiesvalueproperties.html#cfn-amplifyuibuilder-component-componentbindingpropertiesvalueproperties-field
//
Field *string `field:"optional" json:"field" yaml:"field"`
// The storage key for an Amazon S3 bucket.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentbindingpropertiesvalueproperties.html#cfn-amplifyuibuilder-component-componentbindingpropertiesvalueproperties-key
//
Key *string `field:"optional" json:"key" yaml:"key"`
// An Amplify DataStore model.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentbindingpropertiesvalueproperties.html#cfn-amplifyuibuilder-component-componentbindingpropertiesvalueproperties-model
//
Model *string `field:"optional" json:"model" yaml:"model"`
// A list of predicates for binding a component's properties to data.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentbindingpropertiesvalueproperties.html#cfn-amplifyuibuilder-component-componentbindingpropertiesvalueproperties-predicates
//
Predicates interface{} `field:"optional" json:"predicates" yaml:"predicates"`
// The name of a component slot.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentbindingpropertiesvalueproperties.html#cfn-amplifyuibuilder-component-componentbindingpropertiesvalueproperties-slotname
//
SlotName *string `field:"optional" json:"slotName" yaml:"slotName"`
// An authenticated user attribute.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentbindingpropertiesvalueproperties.html#cfn-amplifyuibuilder-component-componentbindingpropertiesvalueproperties-userattribute
//
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"),
OperandType: jsii.String("operandType"),
Operator: jsii.String("operator"),
Or: []interface{}{
predicateProperty_,
},
},
},
SlotName: jsii.String("slotName"),
UserAttribute: jsii.String("userAttribute"),
}
type CfnComponent_ComponentBindingPropertiesValueProperty ¶
type CfnComponent_ComponentBindingPropertiesValueProperty struct {
// Describes the properties to customize with data at runtime.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentbindingpropertiesvalue.html#cfn-amplifyuibuilder-component-componentbindingpropertiesvalue-bindingproperties
//
BindingProperties interface{} `field:"optional" json:"bindingProperties" yaml:"bindingProperties"`
// The default value of the property.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentbindingpropertiesvalue.html#cfn-amplifyuibuilder-component-componentbindingpropertiesvalue-defaultvalue
//
DefaultValue *string `field:"optional" json:"defaultValue" yaml:"defaultValue"`
// The property type.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentbindingpropertiesvalue.html#cfn-amplifyuibuilder-component-componentbindingpropertiesvalue-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"),
OperandType: jsii.String("operandType"),
Operator: jsii.String("operator"),
Or: []interface{}{
predicateProperty_,
},
},
},
SlotName: jsii.String("slotName"),
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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentchild.html#cfn-amplifyuibuilder-component-componentchild-componenttype
//
ComponentType *string `field:"required" json:"componentType" yaml:"componentType"`
// The name of the child component.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentchild.html#cfn-amplifyuibuilder-component-componentchild-name
//
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` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentchild.html#cfn-amplifyuibuilder-component-componentchild-properties
//
Properties interface{} `field:"required" json:"properties" yaml:"properties"`
// The list of `ComponentChild` instances for this component.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentchild.html#cfn-amplifyuibuilder-component-componentchild-children
//
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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentchild.html#cfn-amplifyuibuilder-component-componentchild-events
//
Events interface{} `field:"optional" json:"events" yaml:"events"`
// The unique ID of the child component in its original source system, such as Figma.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentchild.html#cfn-amplifyuibuilder-component-componentchild-sourceid
//
SourceId *string `field:"optional" json:"sourceId" yaml:"sourceId"`
}
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_,
},
Events: map[string]interface{}{
"eventsKey": &ComponentEventProperty{
"action": jsii.String("action"),
"bindingEvent": jsii.String("bindingEvent"),
"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"),
},
},
},
},
SourceId: jsii.String("sourceId"),
}
type CfnComponent_ComponentConditionPropertyProperty ¶
type CfnComponent_ComponentConditionPropertyProperty struct {
// The value to assign to the property if the condition is not met.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentconditionproperty.html#cfn-amplifyuibuilder-component-componentconditionproperty-else
//
Else interface{} `field:"optional" json:"else" yaml:"else"`
// The name of a field.
//
// Specify this when the property is a data model.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentconditionproperty.html#cfn-amplifyuibuilder-component-componentconditionproperty-field
//
Field *string `field:"optional" json:"field" yaml:"field"`
// The value of the property to evaluate.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentconditionproperty.html#cfn-amplifyuibuilder-component-componentconditionproperty-operand
//
Operand *string `field:"optional" json:"operand" yaml:"operand"`
// The type of the property to evaluate.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentconditionproperty.html#cfn-amplifyuibuilder-component-componentconditionproperty-operandtype
//
OperandType *string `field:"optional" json:"operandType" yaml:"operandType"`
// The operator to use to perform the evaluation, such as `eq` to represent equals.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentconditionproperty.html#cfn-amplifyuibuilder-component-componentconditionproperty-operator
//
Operator *string `field:"optional" json:"operator" yaml:"operator"`
// The name of the conditional property.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentconditionproperty.html#cfn-amplifyuibuilder-component-componentconditionproperty-property
//
Property *string `field:"optional" json:"property" yaml:"property"`
// The value to assign to the property if the condition is met.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentconditionproperty.html#cfn-amplifyuibuilder-component-componentconditionproperty-then
//
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 componentConditionPropertyProperty_ ComponentConditionPropertyProperty
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_,
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"),
},
}
type CfnComponent_ComponentDataConfigurationProperty ¶
type CfnComponent_ComponentDataConfigurationProperty struct {
// The name of the data model to use to bind data to a component.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentdataconfiguration.html#cfn-amplifyuibuilder-component-componentdataconfiguration-model
//
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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentdataconfiguration.html#cfn-amplifyuibuilder-component-componentdataconfiguration-identifiers
//
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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentdataconfiguration.html#cfn-amplifyuibuilder-component-componentdataconfiguration-predicate
//
Predicate interface{} `field:"optional" json:"predicate" yaml:"predicate"`
// Describes how to sort the component's properties.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentdataconfiguration.html#cfn-amplifyuibuilder-component-componentdataconfiguration-sort
//
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"),
OperandType: jsii.String("operandType"),
Operator: jsii.String("operator"),
Or: []interface{}{
predicateProperty_,
},
},
Sort: []interface{}{
&SortPropertyProperty{
Direction: jsii.String("direction"),
Field: jsii.String("field"),
},
},
}
type CfnComponent_ComponentEventProperty ¶ added in v2.15.0
type CfnComponent_ComponentEventProperty struct {
// The action to perform when a specific event is raised.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentevent.html#cfn-amplifyuibuilder-component-componentevent-action
//
Action *string `field:"optional" json:"action" yaml:"action"`
// Binds an event to an action on a component.
//
// When you specify a `bindingEvent` , the event is called when the action is performed.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentevent.html#cfn-amplifyuibuilder-component-componentevent-bindingevent
//
BindingEvent *string `field:"optional" json:"bindingEvent" yaml:"bindingEvent"`
// Describes information about the action.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentevent.html#cfn-amplifyuibuilder-component-componentevent-parameters
//
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"),
BindingEvent: jsii.String("bindingEvent"),
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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentpropertybindingproperties.html#cfn-amplifyuibuilder-component-componentpropertybindingproperties-property
//
Property *string `field:"required" json:"property" yaml:"property"`
// The data field to bind the property to.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentpropertybindingproperties.html#cfn-amplifyuibuilder-component-componentpropertybindingproperties-field
//
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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html#cfn-amplifyuibuilder-component-componentproperty-bindingproperties
//
BindingProperties interface{} `field:"optional" json:"bindingProperties" yaml:"bindingProperties"`
// The information to bind the component property to form data.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html#cfn-amplifyuibuilder-component-componentproperty-bindings
//
Bindings interface{} `field:"optional" json:"bindings" yaml:"bindings"`
// The information to bind the component property to data at runtime.
//
// Use this for collection components.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html#cfn-amplifyuibuilder-component-componentproperty-collectionbindingproperties
//
CollectionBindingProperties interface{} `field:"optional" json:"collectionBindingProperties" yaml:"collectionBindingProperties"`
// The name of the component that is affected by an event.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html#cfn-amplifyuibuilder-component-componentproperty-componentname
//
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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html#cfn-amplifyuibuilder-component-componentproperty-concat
//
Concat interface{} `field:"optional" json:"concat" yaml:"concat"`
// The conditional expression to use to assign a value to the component property.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html#cfn-amplifyuibuilder-component-componentproperty-condition
//
Condition interface{} `field:"optional" json:"condition" yaml:"condition"`
// Specifies whether the user configured the property in Amplify Studio after importing it.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html#cfn-amplifyuibuilder-component-componentproperty-configured
//
Configured interface{} `field:"optional" json:"configured" yaml:"configured"`
// The default value to assign to the component property.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html#cfn-amplifyuibuilder-component-componentproperty-defaultvalue
//
DefaultValue *string `field:"optional" json:"defaultValue" yaml:"defaultValue"`
// An event that occurs in your app.
//
// Use this for workflow data binding.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html#cfn-amplifyuibuilder-component-componentproperty-event
//
Event *string `field:"optional" json:"event" yaml:"event"`
// The default value assigned to the property when the component is imported into an app.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html#cfn-amplifyuibuilder-component-componentproperty-importedvalue
//
ImportedValue *string `field:"optional" json:"importedValue" yaml:"importedValue"`
// The data model to use to assign a value to the component property.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html#cfn-amplifyuibuilder-component-componentproperty-model
//
Model *string `field:"optional" json:"model" yaml:"model"`
// The name of the component's property that is affected by an event.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html#cfn-amplifyuibuilder-component-componentproperty-property
//
Property *string `field:"optional" json:"property" yaml:"property"`
// The component type.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html#cfn-amplifyuibuilder-component-componentproperty-type
//
Type *string `field:"optional" json:"type" yaml:"type"`
// An authenticated user attribute to use to assign a value to the component property.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html#cfn-amplifyuibuilder-component-componentproperty-userattribute
//
UserAttribute *string `field:"optional" json:"userAttribute" yaml:"userAttribute"`
// The value to assign to the component property.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentproperty.html#cfn-amplifyuibuilder-component-componentproperty-value
//
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 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_,
},
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_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` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentvariant.html#cfn-amplifyuibuilder-component-componentvariant-overrides
//
Overrides interface{} `field:"optional" json:"overrides" yaml:"overrides"`
// The combination of variants that comprise this variant.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-componentvariant.html#cfn-amplifyuibuilder-component-componentvariant-variantvalues
//
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 ¶ added in v2.55.0
type CfnComponent_FormBindingElementProperty struct {
// The name of the component to retrieve a value from.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-formbindingelement.html#cfn-amplifyuibuilder-component-formbindingelement-element
//
Element *string `field:"required" json:"element" yaml:"element"`
// The property to retrieve a value from.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-formbindingelement.html#cfn-amplifyuibuilder-component-formbindingelement-property
//
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 ¶ added in v2.15.0
type CfnComponent_MutationActionSetStateParameterProperty struct {
// The name of the component that is being modified.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-mutationactionsetstateparameter.html#cfn-amplifyuibuilder-component-mutationactionsetstateparameter-componentname
//
ComponentName *string `field:"required" json:"componentName" yaml:"componentName"`
// The name of the component property to apply the state configuration to.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-mutationactionsetstateparameter.html#cfn-amplifyuibuilder-component-mutationactionsetstateparameter-property
//
Property *string `field:"required" json:"property" yaml:"property"`
// The state configuration to assign to the property.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-mutationactionsetstateparameter.html#cfn-amplifyuibuilder-component-mutationactionsetstateparameter-set
//
Set interface{} `field:"required" json:"set" yaml:"set"`
}
Represents 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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-predicate.html#cfn-amplifyuibuilder-component-predicate-and
//
And interface{} `field:"optional" json:"and" yaml:"and"`
// The field to query.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-predicate.html#cfn-amplifyuibuilder-component-predicate-field
//
Field *string `field:"optional" json:"field" yaml:"field"`
// The value to use when performing the evaluation.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-predicate.html#cfn-amplifyuibuilder-component-predicate-operand
//
Operand *string `field:"optional" json:"operand" yaml:"operand"`
// The type of value to use when performing the evaluation.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-predicate.html#cfn-amplifyuibuilder-component-predicate-operandtype
//
OperandType *string `field:"optional" json:"operandType" yaml:"operandType"`
// The operator to use to perform the evaluation.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-predicate.html#cfn-amplifyuibuilder-component-predicate-operator
//
Operator *string `field:"optional" json:"operator" yaml:"operator"`
// A list of predicates to combine logically.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-predicate.html#cfn-amplifyuibuilder-component-predicate-or
//
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_,
},
Field: jsii.String("field"),
Operand: jsii.String("operand"),
OperandType: jsii.String("operandType"),
Operator: jsii.String("operator"),
Or: []interface{}{
predicateProperty_,
},
}
type CfnComponent_SortPropertyProperty ¶
type CfnComponent_SortPropertyProperty struct {
// The direction of the sort, either ascending or descending.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-sortproperty.html#cfn-amplifyuibuilder-component-sortproperty-direction
//
Direction *string `field:"required" json:"direction" yaml:"direction"`
// The field to perform the sort on.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-sortproperty.html#cfn-amplifyuibuilder-component-sortproperty-field
//
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 ¶ added in v2.55.0
type CfnForm interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawsamplifyuibuilder.IFormRef
awscdk.ITaggable
// The unique ID of the Amplify app associated with the form.
AppId() *string
SetAppId(val *string)
// The ID for the form.
AttrId() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
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.
CreationStack() *[]*string
// The `FormCTA` object that 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{})
Env() *interfaces.ResourceEnvironment
// The name of the backend environment that is a part of the Amplify app.
EnvironmentName() *string
SetEnvironmentName(val *string)
// The configuration information for the form's fields.
Fields() interface{}
SetFields(val interface{})
// Specifies whether to perform a create or update action on the form.
FormActionType() *string
SetFormActionType(val *string)
// A reference to a Form resource.
FormRef() *interfacesawsamplifyuibuilder.FormReference
// Specifies an icon or decoration to display on the form.
LabelDecorator() *string
SetLabelDecorator(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.
LogicalId() *string
// The name of the form.
Name() *string
SetName(val *string)
// The tree node.
Node() constructs.Node
// 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 })`.
Ref() *string
// The schema version of the form.
SchemaVersion() *string
SetSchemaVersion(val *string)
// The configuration information for the visual helper elements for the form.
SectionalElements() interface{}
SetSectionalElements(val interface{})
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// The configuration for the form's style.
Style() interface{}
SetStyle(val interface{})
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
// One or more key-value pairs to use when tagging the form data.
TagsRaw() *map[string]*string
SetTagsRaw(val *map[string]*string)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
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.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
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.
//
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.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
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`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
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.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) 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.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// 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.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
The AWS::AmplifyUIBuilder::Form resource specifies all of the information that is required to create 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"
var formInputValuePropertyProperty_ FormInputValuePropertyProperty
cfnForm := awscdk.Aws_amplifyuibuilder.NewCfnForm(this, jsii.String("MyCfnForm"), &CfnFormProps{
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"),
},
},
},
DataType: &FormDataTypeConfigProperty{
DataSourceType: jsii.String("dataSourceType"),
DataTypeName: jsii.String("dataTypeName"),
},
EnvironmentName: jsii.String("environmentName"),
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"),
"fileUploaderConfig": &FileUploaderFieldConfigProperty{
"acceptedFileTypes": []*string{
jsii.String("acceptedFileTypes"),
},
"accessLevel": jsii.String("accessLevel"),
// the properties below are optional
"isResumable": jsii.Boolean(false),
"maxFileCount": jsii.Number(123),
"maxSize": jsii.Number(123),
"showThumbnails": jsii.Boolean(false),
},
"isArray": jsii.Boolean(false),
"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{
"bindingProperties": &FormInputValuePropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"concat": []interface{}{
formInputValuePropertyProperty_,
},
"value": jsii.String("value"),
},
// the properties below are optional
"displayValue": &FormInputValuePropertyProperty{
"bindingProperties": &FormInputValuePropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"concat": []interface{}{
formInputValuePropertyProperty_,
},
"value": jsii.String("value"),
},
},
},
// the properties below are optional
"bindingProperties": map[string]interface{}{
"bindingPropertiesKey": &FormInputBindingPropertiesValueProperty{
"bindingProperties": &FormInputBindingPropertiesValuePropertiesProperty{
"model": jsii.String("model"),
},
"type": jsii.String("type"),
},
},
},
},
"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"),
LabelDecorator: jsii.String("labelDecorator"),
Name: jsii.String("name"),
SchemaVersion: jsii.String("schemaVersion"),
SectionalElements: map[string]interface{}{
"sectionalElementsKey": &SectionalElementProperty{
"type": jsii.String("type"),
// the properties below are optional
"excluded": jsii.Boolean(false),
"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"),
},
},
Tags: map[string]*string{
"tagsKey": jsii.String("tags"),
},
})
func NewCfnForm ¶ added in v2.55.0
func NewCfnForm(scope constructs.Construct, id *string, props *CfnFormProps) CfnForm
Create a new `AWS::AmplifyUIBuilder::Form`.
type CfnFormProps ¶ added in v2.55.0
type CfnFormProps struct {
// The unique ID of the Amplify app associated with the form.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html#cfn-amplifyuibuilder-form-appid
//
AppId *string `field:"optional" json:"appId" yaml:"appId"`
// The `FormCTA` object that stores the call to action configuration for the form.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html#cfn-amplifyuibuilder-form-cta
//
Cta interface{} `field:"optional" json:"cta" yaml:"cta"`
// The type of data source to use to create the form.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html#cfn-amplifyuibuilder-form-datatype
//
DataType interface{} `field:"optional" json:"dataType" yaml:"dataType"`
// The name of the backend environment that is a part of the Amplify app.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html#cfn-amplifyuibuilder-form-environmentname
//
EnvironmentName *string `field:"optional" json:"environmentName" yaml:"environmentName"`
// The configuration information for the form's fields.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html#cfn-amplifyuibuilder-form-fields
//
Fields interface{} `field:"optional" json:"fields" yaml:"fields"`
// Specifies whether to perform a create or update action on the form.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html#cfn-amplifyuibuilder-form-formactiontype
//
FormActionType *string `field:"optional" json:"formActionType" yaml:"formActionType"`
// Specifies an icon or decoration to display on the form.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html#cfn-amplifyuibuilder-form-labeldecorator
//
LabelDecorator *string `field:"optional" json:"labelDecorator" yaml:"labelDecorator"`
// The name of the form.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html#cfn-amplifyuibuilder-form-name
//
Name *string `field:"optional" json:"name" yaml:"name"`
// The schema version of the form.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html#cfn-amplifyuibuilder-form-schemaversion
//
SchemaVersion *string `field:"optional" json:"schemaVersion" yaml:"schemaVersion"`
// The configuration information for the visual helper elements for the form.
//
// These elements are not associated with any data.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html#cfn-amplifyuibuilder-form-sectionalelements
//
SectionalElements interface{} `field:"optional" json:"sectionalElements" yaml:"sectionalElements"`
// The configuration for the form's style.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html#cfn-amplifyuibuilder-form-style
//
Style interface{} `field:"optional" json:"style" yaml:"style"`
// One or more key-value pairs to use when tagging the form data.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-form.html#cfn-amplifyuibuilder-form-tags
//
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"
var formInputValuePropertyProperty_ FormInputValuePropertyProperty
cfnFormProps := &CfnFormProps{
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"),
},
},
},
DataType: &FormDataTypeConfigProperty{
DataSourceType: jsii.String("dataSourceType"),
DataTypeName: jsii.String("dataTypeName"),
},
EnvironmentName: jsii.String("environmentName"),
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"),
"fileUploaderConfig": &FileUploaderFieldConfigProperty{
"acceptedFileTypes": []*string{
jsii.String("acceptedFileTypes"),
},
"accessLevel": jsii.String("accessLevel"),
// the properties below are optional
"isResumable": jsii.Boolean(false),
"maxFileCount": jsii.Number(123),
"maxSize": jsii.Number(123),
"showThumbnails": jsii.Boolean(false),
},
"isArray": jsii.Boolean(false),
"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{
"bindingProperties": &FormInputValuePropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"concat": []interface{}{
formInputValuePropertyProperty_,
},
"value": jsii.String("value"),
},
// the properties below are optional
"displayValue": &FormInputValuePropertyProperty{
"bindingProperties": &FormInputValuePropertyBindingPropertiesProperty{
"property": jsii.String("property"),
// the properties below are optional
"field": jsii.String("field"),
},
"concat": []interface{}{
formInputValuePropertyProperty_,
},
"value": jsii.String("value"),
},
},
},
// the properties below are optional
"bindingProperties": map[string]interface{}{
"bindingPropertiesKey": &FormInputBindingPropertiesValueProperty{
"bindingProperties": &FormInputBindingPropertiesValuePropertiesProperty{
"model": jsii.String("model"),
},
"type": jsii.String("type"),
},
},
},
},
"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"),
LabelDecorator: jsii.String("labelDecorator"),
Name: jsii.String("name"),
SchemaVersion: jsii.String("schemaVersion"),
SectionalElements: map[string]interface{}{
"sectionalElementsKey": &SectionalElementProperty{
"type": jsii.String("type"),
// the properties below are optional
"excluded": jsii.Boolean(false),
"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"),
},
},
Tags: map[string]*string{
"tagsKey": jsii.String("tags"),
},
}
type CfnForm_FieldConfigProperty ¶ added in v2.55.0
type CfnForm_FieldConfigProperty struct {
// Specifies whether to hide a field.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldconfig.html#cfn-amplifyuibuilder-form-fieldconfig-excluded
//
Excluded interface{} `field:"optional" json:"excluded" yaml:"excluded"`
// Describes the configuration for the default input value to display for a field.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldconfig.html#cfn-amplifyuibuilder-form-fieldconfig-inputtype
//
InputType interface{} `field:"optional" json:"inputType" yaml:"inputType"`
// The label for the field.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldconfig.html#cfn-amplifyuibuilder-form-fieldconfig-label
//
Label *string `field:"optional" json:"label" yaml:"label"`
// Specifies the field position.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldconfig.html#cfn-amplifyuibuilder-form-fieldconfig-position
//
Position interface{} `field:"optional" json:"position" yaml:"position"`
// The validations to perform on the value in the field.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldconfig.html#cfn-amplifyuibuilder-form-fieldconfig-validations
//
Validations interface{} `field:"optional" json:"validations" yaml:"validations"`
}
The `FieldConfig` property specifies 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"
var formInputValuePropertyProperty_ FormInputValuePropertyProperty
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"),
FileUploaderConfig: &FileUploaderFieldConfigProperty{
AcceptedFileTypes: []*string{
jsii.String("acceptedFileTypes"),
},
AccessLevel: jsii.String("accessLevel"),
// the properties below are optional
IsResumable: jsii.Boolean(false),
MaxFileCount: jsii.Number(123),
MaxSize: jsii.Number(123),
ShowThumbnails: jsii.Boolean(false),
},
IsArray: jsii.Boolean(false),
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{
BindingProperties: &FormInputValuePropertyBindingPropertiesProperty{
Property: jsii.String("property"),
// the properties below are optional
Field: jsii.String("field"),
},
Concat: []interface{}{
formInputValuePropertyProperty_,
},
Value: jsii.String("value"),
},
// the properties below are optional
DisplayValue: &FormInputValuePropertyProperty{
BindingProperties: &FormInputValuePropertyBindingPropertiesProperty{
Property: jsii.String("property"),
// the properties below are optional
Field: jsii.String("field"),
},
Concat: []interface{}{
formInputValuePropertyProperty_,
},
Value: jsii.String("value"),
},
},
},
// the properties below are optional
BindingProperties: map[string]interface{}{
"bindingPropertiesKey": &FormInputBindingPropertiesValueProperty{
"bindingProperties": &FormInputBindingPropertiesValuePropertiesProperty{
"model": jsii.String("model"),
},
"type": jsii.String("type"),
},
},
},
},
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 ¶ added in v2.55.0
type CfnForm_FieldInputConfigProperty struct {
// The input type for the field.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldinputconfig.html#cfn-amplifyuibuilder-form-fieldinputconfig-type
//
Type *string `field:"required" json:"type" yaml:"type"`
// Specifies whether a field has a default value.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldinputconfig.html#cfn-amplifyuibuilder-form-fieldinputconfig-defaultchecked
//
DefaultChecked interface{} `field:"optional" json:"defaultChecked" yaml:"defaultChecked"`
// The default country code for a phone number.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldinputconfig.html#cfn-amplifyuibuilder-form-fieldinputconfig-defaultcountrycode
//
DefaultCountryCode *string `field:"optional" json:"defaultCountryCode" yaml:"defaultCountryCode"`
// The default value for the field.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldinputconfig.html#cfn-amplifyuibuilder-form-fieldinputconfig-defaultvalue
//
DefaultValue *string `field:"optional" json:"defaultValue" yaml:"defaultValue"`
// The text to display to describe the field.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldinputconfig.html#cfn-amplifyuibuilder-form-fieldinputconfig-descriptivetext
//
DescriptiveText *string `field:"optional" json:"descriptiveText" yaml:"descriptiveText"`
// The configuration for the file uploader field.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldinputconfig.html#cfn-amplifyuibuilder-form-fieldinputconfig-fileuploaderconfig
//
FileUploaderConfig interface{} `field:"optional" json:"fileUploaderConfig" yaml:"fileUploaderConfig"`
// Specifies whether to render the field as an array.
//
// This property is ignored if the `dataSourceType` for the form is a Data Store.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldinputconfig.html#cfn-amplifyuibuilder-form-fieldinputconfig-isarray
//
IsArray interface{} `field:"optional" json:"isArray" yaml:"isArray"`
// The maximum value to display for the field.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldinputconfig.html#cfn-amplifyuibuilder-form-fieldinputconfig-maxvalue
//
MaxValue *float64 `field:"optional" json:"maxValue" yaml:"maxValue"`
// The minimum value to display for the field.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldinputconfig.html#cfn-amplifyuibuilder-form-fieldinputconfig-minvalue
//
MinValue *float64 `field:"optional" json:"minValue" yaml:"minValue"`
// The name of the field.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldinputconfig.html#cfn-amplifyuibuilder-form-fieldinputconfig-name
//
Name *string `field:"optional" json:"name" yaml:"name"`
// The text to display as a placeholder for the field.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldinputconfig.html#cfn-amplifyuibuilder-form-fieldinputconfig-placeholder
//
Placeholder *string `field:"optional" json:"placeholder" yaml:"placeholder"`
// Specifies a read only field.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldinputconfig.html#cfn-amplifyuibuilder-form-fieldinputconfig-readonly
//
ReadOnly interface{} `field:"optional" json:"readOnly" yaml:"readOnly"`
// Specifies a field that requires input.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldinputconfig.html#cfn-amplifyuibuilder-form-fieldinputconfig-required
//
Required interface{} `field:"optional" json:"required" yaml:"required"`
// The stepping increment for a numeric value in a field.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldinputconfig.html#cfn-amplifyuibuilder-form-fieldinputconfig-step
//
Step *float64 `field:"optional" json:"step" yaml:"step"`
// The value for the field.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldinputconfig.html#cfn-amplifyuibuilder-form-fieldinputconfig-value
//
Value *string `field:"optional" json:"value" yaml:"value"`
// The information to use to customize the input fields with data at runtime.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldinputconfig.html#cfn-amplifyuibuilder-form-fieldinputconfig-valuemappings
//
ValueMappings interface{} `field:"optional" json:"valueMappings" yaml:"valueMappings"`
}
The `FieldInputConfig` property specifies 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"
var formInputValuePropertyProperty_ FormInputValuePropertyProperty
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"),
FileUploaderConfig: &FileUploaderFieldConfigProperty{
AcceptedFileTypes: []*string{
jsii.String("acceptedFileTypes"),
},
AccessLevel: jsii.String("accessLevel"),
// the properties below are optional
IsResumable: jsii.Boolean(false),
MaxFileCount: jsii.Number(123),
MaxSize: jsii.Number(123),
ShowThumbnails: jsii.Boolean(false),
},
IsArray: jsii.Boolean(false),
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{
BindingProperties: &FormInputValuePropertyBindingPropertiesProperty{
Property: jsii.String("property"),
// the properties below are optional
Field: jsii.String("field"),
},
Concat: []interface{}{
formInputValuePropertyProperty_,
},
Value: jsii.String("value"),
},
// the properties below are optional
DisplayValue: &FormInputValuePropertyProperty{
BindingProperties: &FormInputValuePropertyBindingPropertiesProperty{
Property: jsii.String("property"),
// the properties below are optional
Field: jsii.String("field"),
},
Concat: []interface{}{
formInputValuePropertyProperty_,
},
Value: jsii.String("value"),
},
},
},
// the properties below are optional
BindingProperties: map[string]interface{}{
"bindingPropertiesKey": &FormInputBindingPropertiesValueProperty{
"bindingProperties": &FormInputBindingPropertiesValuePropertiesProperty{
"model": jsii.String("model"),
},
"type": jsii.String("type"),
},
},
},
}
type CfnForm_FieldPositionProperty ¶ added in v2.55.0
type CfnForm_FieldPositionProperty struct {
// The field position is below the field specified by the string.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldposition.html#cfn-amplifyuibuilder-form-fieldposition-below
//
Below *string `field:"optional" json:"below" yaml:"below"`
// The field position is fixed and doesn't change in relation to other fields.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldposition.html#cfn-amplifyuibuilder-form-fieldposition-fixed
//
Fixed *string `field:"optional" json:"fixed" yaml:"fixed"`
// The field position is to the right of the field specified by the string.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldposition.html#cfn-amplifyuibuilder-form-fieldposition-rightof
//
RightOf *string `field:"optional" json:"rightOf" yaml:"rightOf"`
}
The `FieldPosition` property specifies 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 ¶ added in v2.55.0
type CfnForm_FieldValidationConfigurationProperty struct {
// The validation to perform on an object type.
//
// “.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldvalidationconfiguration.html#cfn-amplifyuibuilder-form-fieldvalidationconfiguration-type
//
Type *string `field:"required" json:"type" yaml:"type"`
// The validation to perform on a number value.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldvalidationconfiguration.html#cfn-amplifyuibuilder-form-fieldvalidationconfiguration-numvalues
//
NumValues interface{} `field:"optional" json:"numValues" yaml:"numValues"`
// The validation to perform on a string value.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldvalidationconfiguration.html#cfn-amplifyuibuilder-form-fieldvalidationconfiguration-strvalues
//
StrValues *[]*string `field:"optional" json:"strValues" yaml:"strValues"`
// The validation message to display.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fieldvalidationconfiguration.html#cfn-amplifyuibuilder-form-fieldvalidationconfiguration-validationmessage
//
ValidationMessage *string `field:"optional" json:"validationMessage" yaml:"validationMessage"`
}
The `FieldValidationConfiguration` property specifies 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_FileUploaderFieldConfigProperty ¶ added in v2.79.0
type CfnForm_FileUploaderFieldConfigProperty struct {
// The file types that are allowed to be uploaded by the file uploader.
//
// Provide this information in an array of strings specifying the valid file extensions.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fileuploaderfieldconfig.html#cfn-amplifyuibuilder-form-fileuploaderfieldconfig-acceptedfiletypes
//
AcceptedFileTypes *[]*string `field:"required" json:"acceptedFileTypes" yaml:"acceptedFileTypes"`
// The access level to assign to the uploaded files in the Amazon S3 bucket where they are stored.
//
// The valid values for this property are `private` , `protected` , or `public` . For detailed information about the permissions associated with each access level, see [File access levels](https://docs.aws.amazon.com/https://docs.amplify.aws/lib/storage/configureaccess/q/platform/js/) in the *Amplify documentation* .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fileuploaderfieldconfig.html#cfn-amplifyuibuilder-form-fileuploaderfieldconfig-accesslevel
//
AccessLevel *string `field:"required" json:"accessLevel" yaml:"accessLevel"`
// Allows the file upload operation to be paused and resumed. The default value is `false` .
//
// When `isResumable` is set to `true` , the file uploader uses a multipart upload to break the files into chunks before upload. The progress of the upload isn't continuous, because the file uploader uploads a chunk at a time.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fileuploaderfieldconfig.html#cfn-amplifyuibuilder-form-fileuploaderfieldconfig-isresumable
//
IsResumable interface{} `field:"optional" json:"isResumable" yaml:"isResumable"`
// Specifies the maximum number of files that can be selected to upload.
//
// The default value is an unlimited number of files.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fileuploaderfieldconfig.html#cfn-amplifyuibuilder-form-fileuploaderfieldconfig-maxfilecount
//
MaxFileCount *float64 `field:"optional" json:"maxFileCount" yaml:"maxFileCount"`
// The maximum file size in bytes that the file uploader will accept.
//
// The default value is an unlimited file size.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fileuploaderfieldconfig.html#cfn-amplifyuibuilder-form-fileuploaderfieldconfig-maxsize
//
MaxSize *float64 `field:"optional" json:"maxSize" yaml:"maxSize"`
// Specifies whether to display or hide the image preview after selecting a file for upload.
//
// The default value is `true` to display the image preview.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-fileuploaderfieldconfig.html#cfn-amplifyuibuilder-form-fileuploaderfieldconfig-showthumbnails
//
ShowThumbnails interface{} `field:"optional" json:"showThumbnails" yaml:"showThumbnails"`
}
Describes the configuration for the file uploader 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"
fileUploaderFieldConfigProperty := &FileUploaderFieldConfigProperty{
AcceptedFileTypes: []*string{
jsii.String("acceptedFileTypes"),
},
AccessLevel: jsii.String("accessLevel"),
// the properties below are optional
IsResumable: jsii.Boolean(false),
MaxFileCount: jsii.Number(123),
MaxSize: jsii.Number(123),
ShowThumbnails: jsii.Boolean(false),
}
type CfnForm_FormButtonProperty ¶ added in v2.55.0
type CfnForm_FormButtonProperty struct {
// Describes the button's properties.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formbutton.html#cfn-amplifyuibuilder-form-formbutton-children
//
Children *string `field:"optional" json:"children" yaml:"children"`
// Specifies whether the button is visible on the form.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formbutton.html#cfn-amplifyuibuilder-form-formbutton-excluded
//
Excluded interface{} `field:"optional" json:"excluded" yaml:"excluded"`
// The position of the button.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formbutton.html#cfn-amplifyuibuilder-form-formbutton-position
//
Position interface{} `field:"optional" json:"position" yaml:"position"`
}
The `FormButton` property specifies 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 ¶ added in v2.55.0
type CfnForm_FormCTAProperty struct {
// Displays a cancel button.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formcta.html#cfn-amplifyuibuilder-form-formcta-cancel
//
Cancel interface{} `field:"optional" json:"cancel" yaml:"cancel"`
// Displays a clear button.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formcta.html#cfn-amplifyuibuilder-form-formcta-clear
//
Clear interface{} `field:"optional" json:"clear" yaml:"clear"`
// The position of the button.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formcta.html#cfn-amplifyuibuilder-form-formcta-position
//
Position *string `field:"optional" json:"position" yaml:"position"`
// Displays a submit button.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formcta.html#cfn-amplifyuibuilder-form-formcta-submit
//
Submit interface{} `field:"optional" json:"submit" yaml:"submit"`
}
The `FormCTA` property specifies 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 ¶ added in v2.55.0
type CfnForm_FormDataTypeConfigProperty struct {
// The data source type, either an Amplify DataStore model or a custom data type.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formdatatypeconfig.html#cfn-amplifyuibuilder-form-formdatatypeconfig-datasourcetype
//
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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formdatatypeconfig.html#cfn-amplifyuibuilder-form-formdatatypeconfig-datatypename
//
DataTypeName *string `field:"required" json:"dataTypeName" yaml:"dataTypeName"`
}
The `FormDataTypeConfig` property specifies 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_FormInputBindingPropertiesValuePropertiesProperty ¶ added in v2.127.0
type CfnForm_FormInputBindingPropertiesValuePropertiesProperty struct {
// An Amplify DataStore model.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-forminputbindingpropertiesvalueproperties.html#cfn-amplifyuibuilder-form-forminputbindingpropertiesvalueproperties-model
//
Model *string `field:"optional" json:"model" yaml:"model"`
}
Represents 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 Amplify DataStore model.
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"
formInputBindingPropertiesValuePropertiesProperty := &FormInputBindingPropertiesValuePropertiesProperty{
Model: jsii.String("model"),
}
type CfnForm_FormInputBindingPropertiesValueProperty ¶ added in v2.127.0
type CfnForm_FormInputBindingPropertiesValueProperty struct {
// Describes the properties to customize with data at runtime.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-forminputbindingpropertiesvalue.html#cfn-amplifyuibuilder-form-forminputbindingpropertiesvalue-bindingproperties
//
BindingProperties interface{} `field:"optional" json:"bindingProperties" yaml:"bindingProperties"`
// The property type.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-forminputbindingpropertiesvalue.html#cfn-amplifyuibuilder-form-forminputbindingpropertiesvalue-type
//
Type *string `field:"optional" json:"type" yaml:"type"`
}
Represents the data binding configuration for a form's input fields at runtime.You can use `FormInputBindingPropertiesValue` to add exposed properties to a form to allow different values to be entered when a form 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"
formInputBindingPropertiesValueProperty := &FormInputBindingPropertiesValueProperty{
BindingProperties: &FormInputBindingPropertiesValuePropertiesProperty{
Model: jsii.String("model"),
},
Type: jsii.String("type"),
}
type CfnForm_FormInputValuePropertyBindingPropertiesProperty ¶ added in v2.127.0
type CfnForm_FormInputValuePropertyBindingPropertiesProperty struct {
// The form property to bind to the data field.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-forminputvaluepropertybindingproperties.html#cfn-amplifyuibuilder-form-forminputvaluepropertybindingproperties-property
//
Property *string `field:"required" json:"property" yaml:"property"`
// The data field to bind the property to.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-forminputvaluepropertybindingproperties.html#cfn-amplifyuibuilder-form-forminputvaluepropertybindingproperties-field
//
Field *string `field:"optional" json:"field" yaml:"field"`
}
Associates a form property to a binding property.
This enables exposed properties on the top level form to propagate data to the form'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"
formInputValuePropertyBindingPropertiesProperty := &FormInputValuePropertyBindingPropertiesProperty{
Property: jsii.String("property"),
// the properties below are optional
Field: jsii.String("field"),
}
type CfnForm_FormInputValuePropertyProperty ¶ added in v2.55.0
type CfnForm_FormInputValuePropertyProperty struct {
// The information to bind fields to data at runtime.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-forminputvalueproperty.html#cfn-amplifyuibuilder-form-forminputvalueproperty-bindingproperties
//
BindingProperties interface{} `field:"optional" json:"bindingProperties" yaml:"bindingProperties"`
// A list of form properties to concatenate to create the value to assign to this field property.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-forminputvalueproperty.html#cfn-amplifyuibuilder-form-forminputvalueproperty-concat
//
Concat interface{} `field:"optional" json:"concat" yaml:"concat"`
// The value to assign to the input field.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-forminputvalueproperty.html#cfn-amplifyuibuilder-form-forminputvalueproperty-value
//
Value *string `field:"optional" json:"value" yaml:"value"`
}
The `FormInputValueProperty` property specifies 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"
var formInputValuePropertyProperty_ FormInputValuePropertyProperty
formInputValuePropertyProperty := &FormInputValuePropertyProperty{
BindingProperties: &FormInputValuePropertyBindingPropertiesProperty{
Property: jsii.String("property"),
// the properties below are optional
Field: jsii.String("field"),
},
Concat: []interface{}{
formInputValuePropertyProperty_,
},
Value: jsii.String("value"),
}
type CfnForm_FormStyleConfigProperty ¶ added in v2.55.0
type CfnForm_FormStyleConfigProperty struct {
// A reference to a design token to use to bind the form's style properties to an existing theme.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formstyleconfig.html#cfn-amplifyuibuilder-form-formstyleconfig-tokenreference
//
TokenReference *string `field:"optional" json:"tokenReference" yaml:"tokenReference"`
// The value of the style setting.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formstyleconfig.html#cfn-amplifyuibuilder-form-formstyleconfig-value
//
Value *string `field:"optional" json:"value" yaml:"value"`
}
The `FormStyleConfig` property specifies 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 ¶ added in v2.55.0
type CfnForm_FormStyleProperty struct {
// The spacing for the horizontal gap.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formstyle.html#cfn-amplifyuibuilder-form-formstyle-horizontalgap
//
HorizontalGap interface{} `field:"optional" json:"horizontalGap" yaml:"horizontalGap"`
// The size of the outer padding for the form.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formstyle.html#cfn-amplifyuibuilder-form-formstyle-outerpadding
//
OuterPadding interface{} `field:"optional" json:"outerPadding" yaml:"outerPadding"`
// The spacing for the vertical gap.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-formstyle.html#cfn-amplifyuibuilder-form-formstyle-verticalgap
//
VerticalGap interface{} `field:"optional" json:"verticalGap" yaml:"verticalGap"`
}
The `FormStyle` property specifies 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 ¶ added in v2.55.0
type CfnForm_SectionalElementProperty struct {
// The type of sectional element.
//
// Valid values are `Heading` , `Text` , and `Divider` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-sectionalelement.html#cfn-amplifyuibuilder-form-sectionalelement-type
//
Type *string `field:"required" json:"type" yaml:"type"`
// Excludes a sectional element that was generated by default for a specified data model.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-sectionalelement.html#cfn-amplifyuibuilder-form-sectionalelement-excluded
//
Excluded interface{} `field:"optional" json:"excluded" yaml:"excluded"`
// Specifies the size of the font for a `Heading` sectional element.
//
// Valid values are `1 | 2 | 3 | 4 | 5 | 6` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-sectionalelement.html#cfn-amplifyuibuilder-form-sectionalelement-level
//
Level *float64 `field:"optional" json:"level" yaml:"level"`
// Specifies the orientation for a `Divider` sectional element.
//
// Valid values are `horizontal` or `vertical` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-sectionalelement.html#cfn-amplifyuibuilder-form-sectionalelement-orientation
//
Orientation *string `field:"optional" json:"orientation" yaml:"orientation"`
// Specifies the position of the text in a field for a `Text` sectional element.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-sectionalelement.html#cfn-amplifyuibuilder-form-sectionalelement-position
//
Position interface{} `field:"optional" json:"position" yaml:"position"`
// The text for a `Text` sectional element.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-sectionalelement.html#cfn-amplifyuibuilder-form-sectionalelement-text
//
Text *string `field:"optional" json:"text" yaml:"text"`
}
The `SectionalElement` property specifies 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 := &SectionalElementProperty{
Type: jsii.String("type"),
// the properties below are optional
Excluded: jsii.Boolean(false),
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 ¶ added in v2.55.0
type CfnForm_ValueMappingProperty struct {
// The complex object.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-valuemapping.html#cfn-amplifyuibuilder-form-valuemapping-value
//
Value interface{} `field:"required" json:"value" yaml:"value"`
// The value to display for the complex object.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-valuemapping.html#cfn-amplifyuibuilder-form-valuemapping-displayvalue
//
DisplayValue interface{} `field:"optional" json:"displayValue" yaml:"displayValue"`
}
The `ValueMapping` property specifies the association between a complex object and 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"
var formInputValuePropertyProperty_ FormInputValuePropertyProperty
valueMappingProperty := &ValueMappingProperty{
Value: &FormInputValuePropertyProperty{
BindingProperties: &FormInputValuePropertyBindingPropertiesProperty{
Property: jsii.String("property"),
// the properties below are optional
Field: jsii.String("field"),
},
Concat: []interface{}{
formInputValuePropertyProperty_,
},
Value: jsii.String("value"),
},
// the properties below are optional
DisplayValue: &FormInputValuePropertyProperty{
BindingProperties: &FormInputValuePropertyBindingPropertiesProperty{
Property: jsii.String("property"),
// the properties below are optional
Field: jsii.String("field"),
},
Concat: []interface{}{
formInputValuePropertyProperty_,
},
Value: jsii.String("value"),
},
}
type CfnForm_ValueMappingsProperty ¶ added in v2.55.0
type CfnForm_ValueMappingsProperty struct {
// The value and display value pairs.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-valuemappings.html#cfn-amplifyuibuilder-form-valuemappings-values
//
Values interface{} `field:"required" json:"values" yaml:"values"`
// The information to bind fields to data at runtime.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-form-valuemappings.html#cfn-amplifyuibuilder-form-valuemappings-bindingproperties
//
BindingProperties interface{} `field:"optional" json:"bindingProperties" yaml:"bindingProperties"`
}
The `ValueMappings` property specifies 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"
var formInputValuePropertyProperty_ FormInputValuePropertyProperty
valueMappingsProperty := &ValueMappingsProperty{
Values: []interface{}{
&ValueMappingProperty{
Value: &FormInputValuePropertyProperty{
BindingProperties: &FormInputValuePropertyBindingPropertiesProperty{
Property: jsii.String("property"),
// the properties below are optional
Field: jsii.String("field"),
},
Concat: []interface{}{
formInputValuePropertyProperty_,
},
Value: jsii.String("value"),
},
// the properties below are optional
DisplayValue: &FormInputValuePropertyProperty{
BindingProperties: &FormInputValuePropertyBindingPropertiesProperty{
Property: jsii.String("property"),
// the properties below are optional
Field: jsii.String("field"),
},
Concat: []interface{}{
formInputValuePropertyProperty_,
},
Value: jsii.String("value"),
},
},
},
// the properties below are optional
BindingProperties: map[string]interface{}{
"bindingPropertiesKey": &FormInputBindingPropertiesValueProperty{
"bindingProperties": &FormInputBindingPropertiesValuePropertiesProperty{
"model": jsii.String("model"),
},
"type": jsii.String("type"),
},
},
}
type CfnTheme ¶
type CfnTheme interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawsamplifyuibuilder.IThemeRef
awscdk.ITaggable
// The unique ID for the Amplify app associated with the theme.
AppId() *string
SetAppId(val *string)
// The time that the theme was created.
AttrCreatedAt() *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.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
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.
CreationStack() *[]*string
Env() *interfaces.ResourceEnvironment
// The name of the backend environment that is a part of the Amplify app.
EnvironmentName() *string
SetEnvironmentName(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.
LogicalId() *string
// The name of the theme.
Name() *string
SetName(val *string)
// The tree node.
Node() constructs.Node
// 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 })`.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
// One or more key-value pairs to use when tagging the theme.
TagsRaw() *map[string]*string
SetTagsRaw(val *map[string]*string)
// A reference to a Theme resource.
ThemeRef() *interfacesawsamplifyuibuilder.ThemeReference
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *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)`.
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.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
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.
//
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.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
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`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
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.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) 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.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// 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.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
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{
AppId: jsii.String("appId"),
EnvironmentName: jsii.String("environmentName"),
Name: jsii.String("name"),
Overrides: []interface{}{
&ThemeValuesProperty{
Key: jsii.String("key"),
Value: &ThemeValueProperty{
Children: []interface{}{
themeValuesProperty_,
},
Value: jsii.String("value"),
},
},
},
Tags: map[string]*string{
"tagsKey": jsii.String("tags"),
},
Values: []interface{}{
&ThemeValuesProperty{
Key: jsii.String("key"),
Value: &ThemeValueProperty{
Children: []interface{}{
themeValuesProperty_,
},
Value: jsii.String("value"),
},
},
},
})
func NewCfnTheme ¶
func NewCfnTheme(scope constructs.Construct, id *string, props *CfnThemeProps) CfnTheme
Create a new `AWS::AmplifyUIBuilder::Theme`.
type CfnThemeProps ¶
type CfnThemeProps struct {
// The unique ID for the Amplify app associated with the theme.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-theme.html#cfn-amplifyuibuilder-theme-appid
//
AppId *string `field:"optional" json:"appId" yaml:"appId"`
// The name of the backend environment that is a part of the Amplify app.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-theme.html#cfn-amplifyuibuilder-theme-environmentname
//
EnvironmentName *string `field:"optional" json:"environmentName" yaml:"environmentName"`
// The name of the theme.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-theme.html#cfn-amplifyuibuilder-theme-name
//
Name *string `field:"optional" json:"name" yaml:"name"`
// Describes the properties that can be overriden to customize a theme.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-theme.html#cfn-amplifyuibuilder-theme-overrides
//
Overrides interface{} `field:"optional" json:"overrides" yaml:"overrides"`
// One or more key-value pairs to use when tagging the theme.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-theme.html#cfn-amplifyuibuilder-theme-tags
//
Tags *map[string]*string `field:"optional" json:"tags" yaml:"tags"`
// A list of key-value pairs that defines the properties of the theme.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplifyuibuilder-theme.html#cfn-amplifyuibuilder-theme-values
//
Values interface{} `field:"optional" json:"values" yaml:"values"`
}
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{
AppId: jsii.String("appId"),
EnvironmentName: jsii.String("environmentName"),
Name: jsii.String("name"),
Overrides: []interface{}{
&ThemeValuesProperty{
Key: jsii.String("key"),
Value: &ThemeValueProperty{
Children: []interface{}{
themeValuesProperty_,
},
Value: jsii.String("value"),
},
},
},
Tags: map[string]*string{
"tagsKey": jsii.String("tags"),
},
Values: []interface{}{
&ThemeValuesProperty{
Key: jsii.String("key"),
Value: &ThemeValueProperty{
Children: []interface{}{
themeValuesProperty_,
},
Value: jsii.String("value"),
},
},
},
}
type CfnTheme_ThemeValueProperty ¶
type CfnTheme_ThemeValueProperty struct {
// A list of key-value pairs that define the theme's properties.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-theme-themevalue.html#cfn-amplifyuibuilder-theme-themevalue-children
//
Children interface{} `field:"optional" json:"children" yaml:"children"`
// The value of a theme property.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-theme-themevalue.html#cfn-amplifyuibuilder-theme-themevalue-value
//
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 themeValueProperty_ ThemeValueProperty
themeValueProperty := &ThemeValueProperty{
Children: []interface{}{
&ThemeValuesProperty{
Key: jsii.String("key"),
Value: themeValueProperty_,
},
},
Value: jsii.String("value"),
}
type CfnTheme_ThemeValuesProperty ¶
type CfnTheme_ThemeValuesProperty struct {
// The name of the property.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-theme-themevalues.html#cfn-amplifyuibuilder-theme-themevalues-key
//
Key *string `field:"optional" json:"key" yaml:"key"`
// The value of the property.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-theme-themevalues.html#cfn-amplifyuibuilder-theme-themevalues-value
//
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 themeValuesProperty_ ThemeValuesProperty
themeValuesProperty := &ThemeValuesProperty{
Key: jsii.String("key"),
Value: &ThemeValueProperty{
Children: []interface{}{
themeValuesProperty_,
},
Value: jsii.String("value"),
},
}
Source Files
¶
- CfnComponent.go
- CfnComponentProps.go
- CfnComponent_ActionParametersProperty.go
- CfnComponent_ComponentBindingPropertiesValuePropertiesProperty.go
- CfnComponent_ComponentBindingPropertiesValueProperty.go
- CfnComponent_ComponentChildProperty.go
- CfnComponent_ComponentConditionPropertyProperty.go
- CfnComponent_ComponentDataConfigurationProperty.go
- CfnComponent_ComponentEventProperty.go
- CfnComponent_ComponentPropertyBindingPropertiesProperty.go
- CfnComponent_ComponentPropertyProperty.go
- CfnComponent_ComponentVariantProperty.go
- CfnComponent_FormBindingElementProperty.go
- CfnComponent_MutationActionSetStateParameterProperty.go
- CfnComponent_PredicateProperty.go
- CfnComponent_SortPropertyProperty.go
- CfnComponent__checks.go
- CfnForm.go
- CfnFormProps.go
- CfnForm_FieldConfigProperty.go
- CfnForm_FieldInputConfigProperty.go
- CfnForm_FieldPositionProperty.go
- CfnForm_FieldValidationConfigurationProperty.go
- CfnForm_FileUploaderFieldConfigProperty.go
- CfnForm_FormButtonProperty.go
- CfnForm_FormCTAProperty.go
- CfnForm_FormDataTypeConfigProperty.go
- CfnForm_FormInputBindingPropertiesValuePropertiesProperty.go
- CfnForm_FormInputBindingPropertiesValueProperty.go
- CfnForm_FormInputValuePropertyBindingPropertiesProperty.go
- CfnForm_FormInputValuePropertyProperty.go
- CfnForm_FormStyleConfigProperty.go
- CfnForm_FormStyleProperty.go
- CfnForm_SectionalElementProperty.go
- CfnForm_ValueMappingProperty.go
- CfnForm_ValueMappingsProperty.go
- CfnForm__checks.go
- CfnTheme.go
- CfnThemeProps.go
- CfnTheme_ThemeValueProperty.go
- CfnTheme_ThemeValuesProperty.go
- CfnTheme__checks.go
- main.go