Package software.amazon.awscdk.pipelines

Class ShellScriptAction

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.pipelines.ShellScriptAction

All Implemented Interfaces:

IAction, IGrantable, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:49.868Z")
@Stability(Deprecated)
@Deprecated
public class ShellScriptAction
extends software.amazon.jsii.JsiiObject
implements IAction, IGrantable

Deprecated.

This class is part of the old API. Use the API based on the CodePipeline class instead

(deprecated) Validate a revision using shell commands.

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.codebuild.*;
 import software.amazon.awscdk.services.codepipeline.*;
 import software.amazon.awscdk.services.ec2.*;
 import software.amazon.awscdk.services.iam.*;
 import software.amazon.awscdk.services.s3.*;
 import software.amazon.awscdk.pipelines.*;
 Artifact artifact;
 Bucket bucket;
 IBuildImage buildImage;
 PolicyStatement policyStatement;
 SecurityGroup securityGroup;
 StackOutput stackOutput;
 Subnet subnet;
 SubnetFilter subnetFilter;
 Object value;
 Vpc vpc;
 ShellScriptAction shellScriptAction = ShellScriptAction.Builder.create()
         .actionName("actionName")
         .commands(List.of("commands"))
         // the properties below are optional
         .additionalArtifacts(List.of(artifact))
         .bashOptions("bashOptions")
         .environment(BuildEnvironment.builder()
                 .buildImage(buildImage)
                 .certificate(BuildEnvironmentCertificate.builder()
                         .bucket(bucket)
                         .objectKey("objectKey")
                         .build())
                 .computeType(ComputeType.SMALL)
                 .environmentVariables(Map.of(
                         "environmentVariablesKey", BuildEnvironmentVariable.builder()
                                 .value(value)
                                 // the properties below are optional
                                 .type(BuildEnvironmentVariableType.PLAINTEXT)
                                 .build()))
                 .privileged(false)
                 .build())
         .environmentVariables(Map.of(
                 "environmentVariablesKey", BuildEnvironmentVariable.builder()
                         .value(value)
                         // the properties below are optional
                         .type(BuildEnvironmentVariableType.PLAINTEXT)
                         .build()))
         .rolePolicyStatements(List.of(policyStatement))
         .runOrder(123)
         .securityGroups(List.of(securityGroup))
         .subnetSelection(SubnetSelection.builder()
                 .availabilityZones(List.of("availabilityZones"))
                 .onePerAz(false)
                 .subnetFilters(List.of(subnetFilter))
                 .subnetGroupName("subnetGroupName")
                 .subnetName("subnetName")
                 .subnets(List.of(subnet))
                 .subnetType(SubnetType.ISOLATED)
                 .build())
         .useOutputs(Map.of(
                 "useOutputsKey", stackOutput))
         .vpc(vpc)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ShellScriptAction.Builder	Deprecated.

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	Description
	ShellScriptAction(ShellScriptActionProps props)	Deprecated.
protected	ShellScriptAction(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)	Deprecated.
protected	ShellScriptAction(software.amazon.jsii.JsiiObjectRef objRef)	Deprecated.

Method Summary

Modifier and Type	Method	Description
ActionConfig	bind(Construct scope, IStage stage, ActionBindOptions options)	Deprecated.
ActionProperties	getActionProperties()	Deprecated.
IPrincipal	getGrantPrincipal()	Deprecated.
IProject	getProject()	Deprecated.
Rule	onStateChange(String name)	Deprecated.
Rule	onStateChange(String name, IRuleTarget target)	Deprecated.
Rule	onStateChange(String name, IRuleTarget target, RuleProps options)	Deprecated.

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 Details

ShellScriptAction

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

Deprecated.

ShellScriptAction

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

Deprecated.

ShellScriptAction

@Stability(Deprecated)
@Deprecated
public ShellScriptAction(@NotNull
 ShellScriptActionProps props)

Deprecated.

Parameters:

props - This parameter is required.

Method Details

bind

@Stability(Deprecated)
@Deprecated
@NotNull
public ActionConfig bind(@NotNull
 Construct scope,
 @NotNull
 IStage stage,
 @NotNull
 ActionBindOptions options)

Deprecated.

(deprecated) 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(Deprecated)
@Deprecated
@NotNull
public Rule onStateChange(@NotNull
 String name,
 @Nullable
 IRuleTarget target,
 @Nullable
 RuleProps options)

Deprecated.

(deprecated) Exists to implement IAction.

Specified by:

onStateChange in interface IAction

Parameters:

name - This parameter is required.

target -

options -

onStateChange

@Stability(Deprecated)
@Deprecated
@NotNull
public Rule onStateChange(@NotNull
 String name,
 @Nullable
 IRuleTarget target)

Deprecated.

(deprecated) Exists to implement IAction.

Specified by:

onStateChange in interface IAction

Parameters:

name - This parameter is required.

target -

onStateChange

@Stability(Deprecated)
@Deprecated
@NotNull
public Rule onStateChange(@NotNull
 String name)

Deprecated.

(deprecated) Exists to implement IAction.

Specified by:

onStateChange in interface IAction

Parameters:

name - This parameter is required.

getActionProperties

@Stability(Deprecated)
@Deprecated
@NotNull
public ActionProperties getActionProperties()

Deprecated.

(deprecated) Exists to implement IAction.

Specified by:

getActionProperties in interface IAction

getGrantPrincipal

@Stability(Deprecated)
@Deprecated
@NotNull
public IPrincipal getGrantPrincipal()

Deprecated.

(deprecated) The CodeBuild Project's principal.

Specified by:

getGrantPrincipal in interface IGrantable

getProject

@Stability(Deprecated)
@Deprecated
@NotNull
public IProject getProject()

Deprecated.

(deprecated) Project generated to run the shell script in.