Class CfnComponent.ActionParametersProperty

Represents the event action configuration for an element of a Component or ComponentChild .

Inheritance

System.Object

CfnComponent.ActionParametersProperty

Implements

CfnComponent.IActionParametersProperty

Namespace: Amazon.CDK.AWS.AmplifyUIBuilder

Assembly: Amazon.CDK.AWS.AmplifyUIBuilder.dll

Syntax (csharp)

public class ActionParametersProperty : Object, CfnComponent.IActionParametersProperty

Syntax (vb)

Public Class ActionParametersProperty
    Inherits Object
    Implements CfnComponent.IActionParametersProperty

Remarks

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.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-actionparameters.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.AmplifyUIBuilder;

ComponentPropertyProperty componentPropertyProperty_;

var actionParametersProperty = new ActionParametersProperty {
    Anchor = new ComponentPropertyProperty {
        BindingProperties = new ComponentPropertyBindingPropertiesProperty {
            Property = "property",

            // the properties below are optional
            Field = "field"
        },
        Bindings = new Dictionary<string, object> {
            { "bindingsKey", new FormBindingElementProperty {
                Element = "element",
                Property = "property"
            } }
        },
        CollectionBindingProperties = new ComponentPropertyBindingPropertiesProperty {
            Property = "property",

            // the properties below are optional
            Field = "field"
        },
        ComponentName = "componentName",
        Concat = new [] { componentPropertyProperty_ },
        Condition = new ComponentConditionPropertyProperty {
            Else = componentPropertyProperty_,
            Field = "field",
            Operand = "operand",
            OperandType = "operandType",
            Operator = "operator",
            Property = "property",
            Then = componentPropertyProperty_
        },
        Configured = false,
        DefaultValue = "defaultValue",
        Event = "event",
        ImportedValue = "importedValue",
        Model = "model",
        Property = "property",
        Type = "type",
        UserAttribute = "userAttribute",
        Value = "value"
    },
    Fields = new Dictionary<string, object> {
        { "fieldsKey", new ComponentPropertyProperty {
            BindingProperties = new ComponentPropertyBindingPropertiesProperty {
                Property = "property",

                // the properties below are optional
                Field = "field"
            },
            Bindings = new Dictionary<string, object> {
                { "bindingsKey", new FormBindingElementProperty {
                    Element = "element",
                    Property = "property"
                } }
            },
            CollectionBindingProperties = new ComponentPropertyBindingPropertiesProperty {
                Property = "property",

                // the properties below are optional
                Field = "field"
            },
            ComponentName = "componentName",
            Concat = new [] { componentPropertyProperty_ },
            Condition = new ComponentConditionPropertyProperty {
                Else = componentPropertyProperty_,
                Field = "field",
                Operand = "operand",
                OperandType = "operandType",
                Operator = "operator",
                Property = "property",
                Then = componentPropertyProperty_
            },
            Configured = false,
            DefaultValue = "defaultValue",
            Event = "event",
            ImportedValue = "importedValue",
            Model = "model",
            Property = "property",
            Type = "type",
            UserAttribute = "userAttribute",
            Value = "value"
        } }
    },
    Global = new ComponentPropertyProperty {
        BindingProperties = new ComponentPropertyBindingPropertiesProperty {
            Property = "property",

            // the properties below are optional
            Field = "field"
        },
        Bindings = new Dictionary<string, object> {
            { "bindingsKey", new FormBindingElementProperty {
                Element = "element",
                Property = "property"
            } }
        },
        CollectionBindingProperties = new ComponentPropertyBindingPropertiesProperty {
            Property = "property",

            // the properties below are optional
            Field = "field"
        },
        ComponentName = "componentName",
        Concat = new [] { componentPropertyProperty_ },
        Condition = new ComponentConditionPropertyProperty {
            Else = componentPropertyProperty_,
            Field = "field",
            Operand = "operand",
            OperandType = "operandType",
            Operator = "operator",
            Property = "property",
            Then = componentPropertyProperty_
        },
        Configured = false,
        DefaultValue = "defaultValue",
        Event = "event",
        ImportedValue = "importedValue",
        Model = "model",
        Property = "property",
        Type = "type",
        UserAttribute = "userAttribute",
        Value = "value"
    },
    Id = new ComponentPropertyProperty {
        BindingProperties = new ComponentPropertyBindingPropertiesProperty {
            Property = "property",

            // the properties below are optional
            Field = "field"
        },
        Bindings = new Dictionary<string, object> {
            { "bindingsKey", new FormBindingElementProperty {
                Element = "element",
                Property = "property"
            } }
        },
        CollectionBindingProperties = new ComponentPropertyBindingPropertiesProperty {
            Property = "property",

            // the properties below are optional
            Field = "field"
        },
        ComponentName = "componentName",
        Concat = new [] { componentPropertyProperty_ },
        Condition = new ComponentConditionPropertyProperty {
            Else = componentPropertyProperty_,
            Field = "field",
            Operand = "operand",
            OperandType = "operandType",
            Operator = "operator",
            Property = "property",
            Then = componentPropertyProperty_
        },
        Configured = false,
        DefaultValue = "defaultValue",
        Event = "event",
        ImportedValue = "importedValue",
        Model = "model",
        Property = "property",
        Type = "type",
        UserAttribute = "userAttribute",
        Value = "value"
    },
    Model = "model",
    State = new MutationActionSetStateParameterProperty {
        ComponentName = "componentName",
        Property = "property",
        Set = new ComponentPropertyProperty {
            BindingProperties = new ComponentPropertyBindingPropertiesProperty {
                Property = "property",

                // the properties below are optional
                Field = "field"
            },
            Bindings = new Dictionary<string, object> {
                { "bindingsKey", new FormBindingElementProperty {
                    Element = "element",
                    Property = "property"
                } }
            },
            CollectionBindingProperties = new ComponentPropertyBindingPropertiesProperty {
                Property = "property",

                // the properties below are optional
                Field = "field"
            },
            ComponentName = "componentName",
            Concat = new [] { componentPropertyProperty_ },
            Condition = new ComponentConditionPropertyProperty {
                Else = componentPropertyProperty_,
                Field = "field",
                Operand = "operand",
                OperandType = "operandType",
                Operator = "operator",
                Property = "property",
                Then = componentPropertyProperty_
            },
            Configured = false,
            DefaultValue = "defaultValue",
            Event = "event",
            ImportedValue = "importedValue",
            Model = "model",
            Property = "property",
            Type = "type",
            UserAttribute = "userAttribute",
            Value = "value"
        }
    },
    Target = new ComponentPropertyProperty {
        BindingProperties = new ComponentPropertyBindingPropertiesProperty {
            Property = "property",

            // the properties below are optional
            Field = "field"
        },
        Bindings = new Dictionary<string, object> {
            { "bindingsKey", new FormBindingElementProperty {
                Element = "element",
                Property = "property"
            } }
        },
        CollectionBindingProperties = new ComponentPropertyBindingPropertiesProperty {
            Property = "property",

            // the properties below are optional
            Field = "field"
        },
        ComponentName = "componentName",
        Concat = new [] { componentPropertyProperty_ },
        Condition = new ComponentConditionPropertyProperty {
            Else = componentPropertyProperty_,
            Field = "field",
            Operand = "operand",
            OperandType = "operandType",
            Operator = "operator",
            Property = "property",
            Then = componentPropertyProperty_
        },
        Configured = false,
        DefaultValue = "defaultValue",
        Event = "event",
        ImportedValue = "importedValue",
        Model = "model",
        Property = "property",
        Type = "type",
        UserAttribute = "userAttribute",
        Value = "value"
    },
    Type = new ComponentPropertyProperty {
        BindingProperties = new ComponentPropertyBindingPropertiesProperty {
            Property = "property",

            // the properties below are optional
            Field = "field"
        },
        Bindings = new Dictionary<string, object> {
            { "bindingsKey", new FormBindingElementProperty {
                Element = "element",
                Property = "property"
            } }
        },
        CollectionBindingProperties = new ComponentPropertyBindingPropertiesProperty {
            Property = "property",

            // the properties below are optional
            Field = "field"
        },
        ComponentName = "componentName",
        Concat = new [] { componentPropertyProperty_ },
        Condition = new ComponentConditionPropertyProperty {
            Else = componentPropertyProperty_,
            Field = "field",
            Operand = "operand",
            OperandType = "operandType",
            Operator = "operator",
            Property = "property",
            Then = componentPropertyProperty_
        },
        Configured = false,
        DefaultValue = "defaultValue",
        Event = "event",
        ImportedValue = "importedValue",
        Model = "model",
        Property = "property",
        Type = "type",
        UserAttribute = "userAttribute",
        Value = "value"
    },
    Url = new ComponentPropertyProperty {
        BindingProperties = new ComponentPropertyBindingPropertiesProperty {
            Property = "property",

            // the properties below are optional
            Field = "field"
        },
        Bindings = new Dictionary<string, object> {
            { "bindingsKey", new FormBindingElementProperty {
                Element = "element",
                Property = "property"
            } }
        },
        CollectionBindingProperties = new ComponentPropertyBindingPropertiesProperty {
            Property = "property",

            // the properties below are optional
            Field = "field"
        },
        ComponentName = "componentName",
        Concat = new [] { componentPropertyProperty_ },
        Condition = new ComponentConditionPropertyProperty {
            Else = componentPropertyProperty_,
            Field = "field",
            Operand = "operand",
            OperandType = "operandType",
            Operator = "operator",
            Property = "property",
            Then = componentPropertyProperty_
        },
        Configured = false,
        DefaultValue = "defaultValue",
        Event = "event",
        ImportedValue = "importedValue",
        Model = "model",
        Property = "property",
        Type = "type",
        UserAttribute = "userAttribute",
        Value = "value"
    }
};

Synopsis

Constructors

ActionParametersProperty()

Properties

Anchor	The HTML anchor link to the location to open.
Fields	A dictionary of key-value pairs mapping Amplify Studio properties to fields in a data model.
Global	Specifies whether the user should be signed out globally.
Id	The unique ID of the component that the ActionParameters apply to.
Model	The name of the data model.
State	A key-value pair that specifies the state property name and its initial value.
Target	The element within the same component to modify when the action occurs.
Type	The type of navigation action.
Url	The URL to the location to open.

Constructors

ActionParametersProperty()

public ActionParametersProperty()

Properties

Anchor

The HTML anchor link to the location to open.

public object Anchor { get; set; }

Property Value

System.Object

Remarks

Specify this value for a navigation action.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-actionparameters.html#cfn-amplifyuibuilder-component-actionparameters-anchor

Fields

A dictionary of key-value pairs mapping Amplify Studio properties to fields in a data model.

public object Fields { get; set; }

Property Value

System.Object

Remarks

Use when the action performs an operation on an Amplify DataStore model.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-actionparameters.html#cfn-amplifyuibuilder-component-actionparameters-fields

Global

Specifies whether the user should be signed out globally.

public object Global { get; set; }

Property Value

System.Object

Remarks

Specify this value for an auth sign out action.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-actionparameters.html#cfn-amplifyuibuilder-component-actionparameters-global

Id

The unique ID of the component that the ActionParameters apply to.

public object Id { get; set; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-actionparameters.html#cfn-amplifyuibuilder-component-actionparameters-id

Model

The name of the data model.

public string Model { get; set; }

Property Value

System.String

Remarks

Use when the action performs an operation on an Amplify DataStore model.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-actionparameters.html#cfn-amplifyuibuilder-component-actionparameters-model

State

A key-value pair that specifies the state property name and its initial value.

public object State { get; set; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-actionparameters.html#cfn-amplifyuibuilder-component-actionparameters-state

Target

The element within the same component to modify when the action occurs.

public object Target { get; set; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-actionparameters.html#cfn-amplifyuibuilder-component-actionparameters-target

Type

The type of navigation action.

public object Type { get; set; }

Property Value

System.Object

Remarks

Valid values are url and anchor . This value is required for a navigation action.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-actionparameters.html#cfn-amplifyuibuilder-component-actionparameters-type

Url

The URL to the location to open.

public object Url { get; set; }

Property Value

System.Object

Remarks

Specify this value for a navigation action.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amplifyuibuilder-component-actionparameters.html#cfn-amplifyuibuilder-component-actionparameters-url

Implements

CfnComponent.IActionParametersProperty