awsamplifyuibuilder

package
v2.6.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 12, 2022 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

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(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnComponent_IsConstruct 

func CfnComponent_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

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(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnTheme_IsConstruct 

func CfnTheme_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func NewCfnComponent_Override 

func NewCfnComponent_Override(c CfnComponent, scope constructs.Construct, id *string, props *CfnComponentProps)

Create a new `AWS::AmplifyUIBuilder::Component`.

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
	AttrAppId() *string
	AttrCreatedAt() *string
	AttrEnvironmentName() *string
	AttrId() *string
	AttrModifiedAt() *string
	BindingProperties() interface{}
	SetBindingProperties(val interface{})
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	Children() interface{}
	SetChildren(val interface{})
	CollectionProperties() interface{}
	SetCollectionProperties(val interface{})
	ComponentType() *string
	SetComponentType(val *string)
	CreationStack() *[]*string
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() constructs.Node
	Overrides() interface{}
	SetOverrides(val interface{})
	Properties() interface{}
	SetProperties(val interface{})
	Ref() *string
	SourceId() *string
	SetSourceId(val *string)
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	Variants() interface{}
	SetVariants(val interface{})
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::AmplifyUIBuilder::Component`.

The AWS::AmplifyUIBuilder::Component resource specifies a component within an Amplify app. A component is a user interface (UI) element that you can customize. Use `ComponentChild` to configure an instance of a `Component` . A `ComponentChild` instance inherits the configuration of the main `Component` .

TODO: 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 information to connect a component's properties to data at runtime.
	BindingProperties interface{} `json:"bindingProperties"`
	// A list of the component's `ComponentChild` instances.
	Children interface{} `json:"children"`
	// The data binding configuration for the component's properties.
	//
	// Use this for a collection component.
	CollectionProperties interface{} `json:"collectionProperties"`
	// The type of the component.
	//
	// This can be an Amplify custom UI component or another custom component.
	ComponentType *string `json:"componentType"`
	// The name of the component.
	Name *string `json:"name"`
	// Describes the component's properties that can be overriden in a customized instance of the component.
	Overrides interface{} `json:"overrides"`
	// Describes the component's properties.
	Properties interface{} `json:"properties"`
	// The unique ID of the component in its original source system, such as Figma.
	SourceId *string `json:"sourceId"`
	// One or more key-value pairs to use when tagging the component.
	Tags *map[string]*string `json:"tags"`
	// A list of the component's variants.
	//
	// A variant is a unique style configuration of a main component.
	Variants interface{} `json:"variants"`
}

Properties for defining a `CfnComponent`.

TODO: EXAMPLE

type CfnComponent_ComponentBindingPropertiesValuePropertiesProperty 

type CfnComponent_ComponentBindingPropertiesValuePropertiesProperty struct {
	// An Amazon S3 bucket.
	Bucket *string `json:"bucket"`
	// The default value to assign to the property.
	DefaultValue *string `json:"defaultValue"`
	// The field to bind the data to.
	Field *string `json:"field"`
	// The storage key for an Amazon S3 bucket.
	Key *string `json:"key"`
	// An Amplify DataStore model.
	Model *string `json:"model"`
	// A list of predicates for binding a component's properties to data.
	Predicates interface{} `json:"predicates"`
	// An authenticated user attribute.
	UserAttribute *string `json:"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.

TODO: EXAMPLE

type CfnComponent_ComponentBindingPropertiesValueProperty 

type CfnComponent_ComponentBindingPropertiesValueProperty struct {
	// Describes the properties to customize with data at runtime.
	BindingProperties interface{} `json:"bindingProperties"`
	// The default value of the property.
	DefaultValue *string `json:"defaultValue"`
	// The property type.
	Type *string `json:"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.

TODO: EXAMPLE

type CfnComponent_ComponentChildProperty 

type CfnComponent_ComponentChildProperty struct {
	// The type of the child component.
	ComponentType *string `json:"componentType"`
	// The name of the child component.
	Name *string `json:"name"`
	// Describes the properties of the child component.
	Properties interface{} `json:"properties"`
	// The list of `ComponentChild` instances for this component.
	Children interface{} `json:"children"`
}

The `ComponentChild` property specifies a nested UI configuration within a parent `Component` .

TODO: EXAMPLE

type CfnComponent_ComponentConditionPropertyProperty 

type CfnComponent_ComponentConditionPropertyProperty struct {
	// The value to assign to the property if the condition is not met.
	Else interface{} `json:"else"`
	// The name of a field.
	//
	// Specify this when the property is a data model.
	Field *string `json:"field"`
	// The value of the property to evaluate.
	Operand *string `json:"operand"`
	// The operator to use to perform the evaluation, such as `eq` to represent equals.
	Operator *string `json:"operator"`
	// The name of the conditional property.
	Property *string `json:"property"`
	// The value to assign to the property if the condition is met.
	Then interface{} `json:"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.

TODO: EXAMPLE

type CfnComponent_ComponentDataConfigurationProperty 

type CfnComponent_ComponentDataConfigurationProperty struct {
	// The name of the data model to use to bind data to a component.
	Model *string `json:"model"`
	// A list of IDs to use to bind data to a component.
	//
	// Use this property to bind specifically chosen data, rather than data retrieved from a query.
	Identifiers *[]*string `json:"identifiers"`
	// Represents the conditional logic to use when binding data to a component.
	//
	// Use this property to retrieve only a subset of the data in a collection.
	Predicate interface{} `json:"predicate"`
	// Describes how to sort the component's properties.
	Sort interface{} `json:"sort"`
}

The `ComponentDataConfiguration` property specifies the configuration for binding a component's properties to data.

TODO: EXAMPLE

type CfnComponent_ComponentOverridesProperty 

type CfnComponent_ComponentOverridesProperty struct {
}

The `ComponentOverrides` property specifies the component's properties that can be overriden in a customized instance of the component.

TODO: EXAMPLE

type CfnComponent_ComponentOverridesValueProperty 

type CfnComponent_ComponentOverridesValueProperty struct {
}

The `ComponentOverridesValue` property specifies the value of the component's properties that can be overriden in a customized instance of the component.

TODO: EXAMPLE

type CfnComponent_ComponentPropertiesProperty 

type CfnComponent_ComponentPropertiesProperty struct {
}

The `ComponentProperties` property specifies the component's properties.

TODO: EXAMPLE

type CfnComponent_ComponentPropertyBindingPropertiesProperty 

type CfnComponent_ComponentPropertyBindingPropertiesProperty struct {
	// The component property to bind to the data field.
	Property *string `json:"property"`
	// The data field to bind the property to.
	Field *string `json:"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.

TODO: EXAMPLE

type CfnComponent_ComponentPropertyProperty 

type CfnComponent_ComponentPropertyProperty struct {
	// The information to bind the component property to data at runtime.
	BindingProperties interface{} `json:"bindingProperties"`
	// The information to bind the component property to form data.
	Bindings interface{} `json:"bindings"`
	// The information to bind the component property to data at runtime.
	//
	// Use this for collection components.
	CollectionBindingProperties interface{} `json:"collectionBindingProperties"`
	// A list of component properties to concatenate to create the value to assign to this component property.
	Concat interface{} `json:"concat"`
	// The conditional expression to use to assign a value to the component property.
	Condition interface{} `json:"condition"`
	// Specifies whether the user configured the property in Amplify Studio after importing it.
	Configured interface{} `json:"configured"`
	// The default value to assign to the component property.
	DefaultValue *string `json:"defaultValue"`
	// An event that occurs in your app.
	//
	// Use this for workflow data binding.
	Event *string `json:"event"`
	// The default value assigned to the property when the component is imported into an app.
	ImportedValue *string `json:"importedValue"`
	// The data model to use to assign a value to the component property.
	Model *string `json:"model"`
	// The component type.
	Type *string `json:"type"`
	// An authenticated user attribute to use to assign a value to the component property.
	UserAttribute *string `json:"userAttribute"`
	// The value to assign to the component property.
	Value *string `json:"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.

TODO: EXAMPLE

type CfnComponent_ComponentVariantProperty 

type CfnComponent_ComponentVariantProperty struct {
	// The properties of the component variant that can be overriden when customizing an instance of the component.
	Overrides interface{} `json:"overrides"`
	// The combination of variants that comprise this variant.
	VariantValues interface{} `json:"variantValues"`
}

The `ComponentVariant` property specifies the style configuration of a unique variation of a main component.

TODO: EXAMPLE

type CfnComponent_ComponentVariantValuesProperty 

type CfnComponent_ComponentVariantValuesProperty struct {
}

The `ComponentVariantValues` property specifies the combination of variants that comprise a `ComponentVariant` .

TODO: EXAMPLE

type CfnComponent_FormBindingsProperty 

type CfnComponent_FormBindingsProperty struct {
}

The `FormBindings` property specifies how to bind a component's properties to form data.

TODO: EXAMPLE

type CfnComponent_PredicateProperty 

type CfnComponent_PredicateProperty struct {
	// A list of predicates to combine logically.
	And interface{} `json:"and"`
	// The field to query.
	Field *string `json:"field"`
	// The value to use when performing the evaluation.
	Operand *string `json:"operand"`
	// The operator to use to perform the evaluation.
	Operator *string `json:"operator"`
	// A list of predicates to combine logically.
	Or interface{} `json:"or"`
}

The `Predicate` property specifies information for generating Amplify DataStore queries.

Use `Predicate` to retrieve a subset of the data in a collection.

TODO: EXAMPLE

type CfnComponent_SortPropertyProperty 

type CfnComponent_SortPropertyProperty struct {
	// The direction of the sort, either ascending or descending.
	Direction *string `json:"direction"`
	// The field to perform the sort on.
	Field *string `json:"field"`
}

The `SortProperty` property specifies how to sort the data that you bind to a component.

TODO: EXAMPLE

type CfnTheme 

type CfnTheme interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrAppId() *string
	AttrCreatedAt() *string
	AttrEnvironmentName() *string
	AttrId() *string
	AttrModifiedAt() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() constructs.Node
	Overrides() interface{}
	SetOverrides(val interface{})
	Ref() *string
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	Values() interface{}
	SetValues(val interface{})
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::AmplifyUIBuilder::Theme`.

The AWS::AmplifyUIBuilder::Theme resource specifies a theme within an Amplify app. A theme is a collection of style settings that apply globally to the components associated with the app.

TODO: EXAMPLE

func NewCfnTheme 

func NewCfnTheme(scope constructs.Construct, id *string, props *CfnThemeProps) CfnTheme

Create a new `AWS::AmplifyUIBuilder::Theme`.

type CfnThemeProps 

type CfnThemeProps struct {
	// The name of the theme.
	Name *string `json:"name"`
	// A list of key-value pairs that defines the properties of the theme.
	Values interface{} `json:"values"`
	// Describes the properties that can be overriden to customize a theme.
	Overrides interface{} `json:"overrides"`
	// One or more key-value pairs to use when tagging the theme.
	Tags *map[string]*string `json:"tags"`
}

Properties for defining a `CfnTheme`.

TODO: EXAMPLE

type CfnTheme_ThemeValueProperty 

type CfnTheme_ThemeValueProperty struct {
	// A list of key-value pairs that define the theme's properties.
	Children interface{} `json:"children"`
	// The value of a theme property.
	Value *string `json:"value"`
}

The `ThemeValue` property specifies the configuration of a theme's properties.

TODO: EXAMPLE

type CfnTheme_ThemeValuesProperty 

type CfnTheme_ThemeValuesProperty struct {
	// The name of the property.
	Key *string `json:"key"`
	// The value of the property.
	Value interface{} `json:"value"`
}

The `ThemeValues` property specifies key-value pair that defines a property of a theme.

TODO: EXAMPLE

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.