Show / Hide Table of Contents

Class ActionProps

Properties for the Action construct.

Inheritance
object
ActionProps
Implements
IActionProps
Inherited Members
object.GetType()
object.MemberwiseClone()
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
Namespace: Amazon.CDK.AWS.AppConfig
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class ActionProps : IActionProps
Syntax (vb)
Public Class ActionProps Implements IActionProps
Remarks

ExampleMetadata: infused

Examples
Function fn;


            new Extension(this, "MyExtension", new ExtensionProps {
                Actions = new [] {
                    new Action(new ActionProps {
                        ActionPoints = new [] { ActionPoint.ON_DEPLOYMENT_START },
                        EventDestination = new LambdaDestination(fn)
                    }) }
            });

Synopsis

Constructors

ActionProps()

Properties for the Action construct.

Properties

ActionPoints

The action points that will trigger the extension action.

Description

The description for the action.

EventDestination

The event destination for the action.

ExecutionRole

The execution role for the action.

InvokeWithoutExecutionRole

The flag that specifies whether or not to create the execution role.

Name

The name for the action.

Constructors

ActionProps()

Properties for the Action construct.

public ActionProps()
Remarks

ExampleMetadata: infused

Examples
Function fn;


            new Extension(this, "MyExtension", new ExtensionProps {
                Actions = new [] {
                    new Action(new ActionProps {
                        ActionPoints = new [] { ActionPoint.ON_DEPLOYMENT_START },
                        EventDestination = new LambdaDestination(fn)
                    }) }
            });

Properties

ActionPoints

The action points that will trigger the extension action.

public ActionPoint[] ActionPoints { get; set; }
Property Value

ActionPoint[]

Remarks

ExampleMetadata: infused

Description

The description for the action.

public string? Description { get; set; }
Property Value

string

Remarks

Default: - No description.

EventDestination

The event destination for the action.

public IEventDestination EventDestination { get; set; }
Property Value

IEventDestination

Remarks

ExampleMetadata: infused

ExecutionRole

The execution role for the action.

public IRole? ExecutionRole { get; set; }
Property Value

IRole

Remarks

Default: - A role is generated.

InvokeWithoutExecutionRole

The flag that specifies whether or not to create the execution role.

public bool? InvokeWithoutExecutionRole { get; set; }
Property Value

bool?

Remarks

If set to true, then the role will not be auto-generated under the assumption there is already the corresponding resource-based policy attached to the event destination. If false, the execution role will be generated if not provided.

Default: false

Name

The name for the action.

public string? Name { get; set; }
Property Value

string

Remarks

Default: - A name is generated.

Implements

IActionProps
Back to top Generated by DocFX