Package software.amazon.awscdk.pipelines

Interface ShellScriptActionProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
ShellScriptActionProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:49.871Z") @Stability(Deprecated) @Deprecated public interface ShellScriptActionProps extends software.amazon.jsii.JsiiSerializable
Deprecated.
This class is part of the old API. Use the API based on the CodePipeline class instead
(deprecated) Properties for ShellScriptAction.

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;
 ShellScriptActionProps shellScriptActionProps = ShellScriptActionProps.builder()
         .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();

  • Method Details

    • getActionName

      @Stability(Deprecated) @Deprecated @NotNull String getActionName()
      Deprecated.
      (deprecated) Name of the validation action in the pipeline.

    • getCommands

      @Stability(Deprecated) @Deprecated @NotNull List<String> getCommands()
      Deprecated.
      (deprecated) Commands to run.

    • getAdditionalArtifacts

      @Stability(Deprecated) @Deprecated @Nullable default List<Artifact> getAdditionalArtifacts()
      Deprecated.
      (deprecated) Additional artifacts to use as input for the CodeBuild project.

      You can use these files to load more complex test sets into the shellscript build environment.

      The files artifact given here will be unpacked into the current working directory, the other ones will be unpacked into directories which are available through the environment variables $CODEBUILD_SRC_DIR_.

      The CodeBuild job must have at least one input artifact, so you must provide either at least one additional artifact here or one stack output using useOutput.

      Default: - No additional artifacts

    • getBashOptions

      @Stability(Deprecated) @Deprecated @Nullable default String getBashOptions()
      Deprecated.
      (deprecated) Bash options to set at the start of the script.

      Default: '-eu' (errexit and nounset)

    • getEnvironment

      @Stability(Deprecated) @Deprecated @Nullable default BuildEnvironment getEnvironment()
      Deprecated.
      (deprecated) The CodeBuild environment where scripts are executed.

      Default: LinuxBuildImage.STANDARD_5_0

    • getEnvironmentVariables

      @Stability(Deprecated) @Deprecated @Nullable default Map<String,BuildEnvironmentVariable> getEnvironmentVariables()
      Deprecated.
      (deprecated) Environment variables to send into build.

      Default: - No additional environment variables

    • getRolePolicyStatements

      @Stability(Deprecated) @Deprecated @Nullable default List<PolicyStatement> getRolePolicyStatements()
      Deprecated.
      (deprecated) Additional policy statements to add to the execution role.

      Default: - No policy statements

    • getRunOrder

      @Stability(Deprecated) @Deprecated @Nullable default Number getRunOrder()
      Deprecated.
      (deprecated) RunOrder for this action.

      Use this to sequence the shell script after the deployments.

      The default value is 100 so you don't have to supply the value if you just want to run this after the application stacks have been deployed, and you don't have more than 100 stacks.

      Default: 100

    • getSecurityGroups

      @Stability(Deprecated) @Deprecated @Nullable default List<ISecurityGroup> getSecurityGroups()
      Deprecated.
      (deprecated) Which security group to associate with the script's project network interfaces.

      If no security group is identified, one will be created automatically.

      Only used if 'vpc' is supplied.

      Default: - Security group will be automatically created.

    • getSubnetSelection

      @Stability(Deprecated) @Deprecated @Nullable default SubnetSelection getSubnetSelection()
      Deprecated.
      (deprecated) Which subnets to use.

      Only used if 'vpc' is supplied.

      Default: - All private subnets.

    • getUseOutputs

      @Stability(Deprecated) @Deprecated @Nullable default Map<String,StackOutput> getUseOutputs()
      Deprecated.
      (deprecated) Stack outputs to make available as environment variables.

      Default: - No outputs used

    • getVpc

      @Stability(Deprecated) @Deprecated @Nullable default IVpc getVpc()
      Deprecated.
      (deprecated) The VPC where to execute the specified script.

      Default: - No VPC

    • builder

      @Stability(Deprecated) @Deprecated static ShellScriptActionProps.Builder builder()
      Deprecated.
      Returns:
      a ShellScriptActionProps.Builder of ShellScriptActionProps