Package software.amazon.awscdk.services.appconfig

Interface CfnExtension.ActionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnExtension.ActionProperty.Jsii$Proxy

Enclosing class:

CfnExtension

@Stability(Stable)
public static interface CfnExtension.ActionProperty
extends software.amazon.jsii.JsiiSerializable

An action defines the tasks that the extension performs during the AWS AppConfig workflow.

Each action includes an action point such as ON_CREATE_HOSTED_CONFIGURATION , PRE_DEPLOYMENT , or ON_DEPLOYMENT . Each action also includes a name, a URI to an AWS Lambda function, and an Amazon Resource Name (ARN) for an AWS Identity and Access Management assume role. You specify the name, URI, and ARN for each action point defined in the extension. You can specify the following actions for an extension:

• PRE_CREATE_HOSTED_CONFIGURATION_VERSION
• PRE_START_DEPLOYMENT
• ON_DEPLOYMENT_START
• ON_DEPLOYMENT_STEP
• ON_DEPLOYMENT_BAKING
• ON_DEPLOYMENT_COMPLETE
• ON_DEPLOYMENT_ROLLED_BACK

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.appconfig.*;
 ActionProperty actionProperty = ActionProperty.builder()
         .name("name")
         .uri("uri")
         // the properties below are optional
         .description("description")
         .roleArn("roleArn")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-extension-action.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnExtension.ActionProperty.Builder	builder()
default String	getDescription()	Information about the action.
String	getName()	The action name.
default String	getRoleArn()	An Amazon Resource Name (ARN) for an AWS Identity and Access Management assume role.
String	getUri()	The extension URI associated to the action point in the extension definition.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

The action name.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-extension-action.html#cfn-appconfig-extension-action-name

getUri

@Stability(Stable)
@NotNull
String getUri()

The extension URI associated to the action point in the extension definition.

The URI can be an Amazon Resource Name (ARN) for one of the following: an AWS Lambda function, an Amazon Simple Queue Service queue, an Amazon Simple Notification Service topic, or the Amazon EventBridge default event bus.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-extension-action.html#cfn-appconfig-extension-action-uri

getDescription

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

Information about the action.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-extension-action.html#cfn-appconfig-extension-action-description

getRoleArn

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

An Amazon Resource Name (ARN) for an AWS Identity and Access Management assume role.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-extension-action.html#cfn-appconfig-extension-action-rolearn

builder

@Stability(Stable)
static CfnExtension.ActionProperty.Builder builder()

Returns:

a CfnExtension.ActionProperty.Builder of CfnExtension.ActionProperty