Package software.amazon.awscdk.services.appconfig

Interface ActionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ActionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-09-11T18:01:10.845Z")
@Stability(Stable)
public interface ActionProps
extends software.amazon.jsii.JsiiSerializable

Properties for the Action construct.

Example:

 Function fn;
 Extension.Builder.create(this, "MyExtension")
         .actions(List.of(
             Action.Builder.create()
                     .actionPoints(List.of(ActionPoint.ON_DEPLOYMENT_START))
                     .eventDestination(new LambdaDestination(fn))
                     .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	ActionProps.Builder	A builder for ActionProps
static final class	ActionProps.Jsii$Proxy	An implementation for ActionProps

Method Summary

Modifier and Type	Method	Description
static ActionProps.Builder	builder()
List<ActionPoint>	getActionPoints()	The action points that will trigger the extension action.
default String	getDescription()	The description for the action.
IEventDestination	getEventDestination()	The event destination for the action.
default IRole	getExecutionRole()	The execution role for the action.
default Boolean	getInvokeWithoutExecutionRole()	The flag that specifies whether or not to create the execution role.
default String	getName()	The name for the action.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getActionPoints

@Stability(Stable)
@NotNull
List<ActionPoint> getActionPoints()

The action points that will trigger the extension action.

getEventDestination

@Stability(Stable)
@NotNull
IEventDestination getEventDestination()

The event destination for the action.

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description for the action.

Default: - No description.

getExecutionRole

@Stability(Stable)
@Nullable
default IRole getExecutionRole()

The execution role for the action.

Default: - A role is generated.

getInvokeWithoutExecutionRole

@Stability(Stable)
@Nullable
default Boolean getInvokeWithoutExecutionRole()

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

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

getName

@Stability(Stable)
@Nullable
default String getName()

The name for the action.

Default: - A name is generated.

builder

@Stability(Stable)
static ActionProps.Builder builder()

Returns:

a ActionProps.Builder of ActionProps