software.amazon.awscdk.pipelines

Class SimpleSynthAction

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.pipelines.SimpleSynthAction

All Implemented Interfaces:

IAction, IGrantable, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.26.0 (build 7d76e02)",
           date="2021-03-25T11:30:29.085Z")
 @Stability(value=Experimental)
public class SimpleSynthAction
extends software.amazon.jsii.JsiiObject
implements IAction, IGrantable

(experimental) A standard synth with a generated buildspec.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SimpleSynthAction.Builder (experimental) A fluent builder for SimpleSynthAction.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.codepipeline.IAction

IAction.Jsii$Default, IAction.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.iam.IGrantable

IGrantable.Jsii$Default, IGrantable.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SimpleSynthAction(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	SimpleSynthAction(software.amazon.jsii.JsiiObjectRef objRef)
	SimpleSynthAction(SimpleSynthActionProps props)

Method Summary

Modifier and Type	Method and Description
ActionConfig	bind(Construct scope, IStage stage, ActionBindOptions options) (experimental) Exists to implement IAction.
ActionProperties	getActionProperties() (experimental) Exists to implement IAction.
IPrincipal	getGrantPrincipal() (experimental) The CodeBuild Project's principal.
IProject	getProject() (experimental) Project generated to run the synth command.
Rule	onStateChange(String name) (experimental) Exists to implement IAction.
Rule	onStateChange(String name, IRuleTarget target) (experimental) Exists to implement IAction.
Rule	onStateChange(String name, IRuleTarget target, RuleProps options) (experimental) Exists to implement IAction.
static SimpleSynthAction	standardNpmSynth(StandardNpmSynthOptions options) (experimental) Create a standard NPM synth action.
static SimpleSynthAction	standardYarnSynth(StandardYarnSynthOptions options) (experimental) Create a standard Yarn synth action.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

SimpleSynthAction

protected SimpleSynthAction(software.amazon.jsii.JsiiObjectRef objRef)

SimpleSynthAction

protected SimpleSynthAction(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

SimpleSynthAction

@Stability(value=Experimental)
public SimpleSynthAction(@NotNull
                                                        SimpleSynthActionProps props)

Parameters:

props - This parameter is required.

Method Detail

standardNpmSynth

@Stability(value=Experimental)
 @NotNull
public static SimpleSynthAction standardNpmSynth(@NotNull
                                                                                          StandardNpmSynthOptions options)

(experimental) Create a standard NPM synth action.

Uses npm ci to install dependencies and npx cdk synth to synthesize.

If you need a build step, add buildCommand: 'npm run build'.

Parameters:

options - This parameter is required.

standardYarnSynth

@Stability(value=Experimental)
 @NotNull
public static SimpleSynthAction standardYarnSynth(@NotNull
                                                                                           StandardYarnSynthOptions options)

(experimental) Create a standard Yarn synth action.

Uses yarn install --frozen-lockfile to install dependencies and npx cdk synth to synthesize.

If you need a build step, add buildCommand: 'yarn build'.

Parameters:

options - This parameter is required.

bind

@Stability(value=Experimental)
 @NotNull
public ActionConfig bind(@NotNull
                                                                  Construct scope,
                                                                  @NotNull
                                                                  IStage stage,
                                                                  @NotNull
                                                                  ActionBindOptions options)

(experimental) Exists to implement IAction.

Specified by:

bind in interface IAction

Parameters:

scope - This parameter is required.

stage - This parameter is required.

options - This parameter is required.

onStateChange

@Stability(value=Experimental)
 @NotNull
public Rule onStateChange(@NotNull
                                                                   String name,
                                                                   @Nullable
                                                                   IRuleTarget target,
                                                                   @Nullable
                                                                   RuleProps options)

(experimental) Exists to implement IAction.

Specified by:

onStateChange in interface IAction

Parameters:

name - This parameter is required.

target -

options -

onStateChange

@Stability(value=Experimental)
 @NotNull
public Rule onStateChange(@NotNull
                                                                   String name,
                                                                   @Nullable
                                                                   IRuleTarget target)

(experimental) Exists to implement IAction.

Specified by:

onStateChange in interface IAction

Parameters:

name - This parameter is required.

target -

onStateChange

@Stability(value=Experimental)
 @NotNull
public Rule onStateChange(@NotNull
                                                                   String name)

(experimental) Exists to implement IAction.

Specified by:

onStateChange in interface IAction

Parameters:

name - This parameter is required.

getActionProperties

@Stability(value=Experimental)
 @NotNull
public ActionProperties getActionProperties()

(experimental) Exists to implement IAction.

Specified by:

getActionProperties in interface IAction

getGrantPrincipal

@Stability(value=Experimental)
 @NotNull
public IPrincipal getGrantPrincipal()

(experimental) The CodeBuild Project's principal.

Specified by:

getGrantPrincipal in interface IGrantable

getProject

@Stability(value=Experimental)
 @NotNull
public IProject getProject()

(experimental) Project generated to run the synth command.