Package software.amazon.awscdk.pipelines

Interface ProduceActionOptions

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
ProduceActionOptions.Jsii$Proxy
@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)", date="2024-05-02T15:58:34.965Z") @Stability(Stable) public interface ProduceActionOptions extends software.amazon.jsii.JsiiSerializable
Options for the CodePipelineActionFactory.produce() method.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 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.logs.*;
 import software.amazon.awscdk.services.s3.*;
 import software.amazon.awscdk.pipelines.*;
 import software.constructs.*;
 Artifact artifact;
 ArtifactMap artifactMap;
 Bucket bucket;
 IBuildImage buildImage;
 BuildSpec buildSpec;
 Cache cache;
 CodePipeline codePipeline;
 Construct construct;
 IFileSystemLocation fileSystemLocation;
 LogGroup logGroup;
 PolicyStatement policyStatement;
 SecurityGroup securityGroup;
 StackOutputsMap stackOutputsMap;
 Subnet subnet;
 SubnetFilter subnetFilter;
 Object value;
 Vpc vpc;
 ProduceActionOptions produceActionOptions = ProduceActionOptions.builder()
         .actionName("actionName")
         .artifacts(artifactMap)
         .pipeline(codePipeline)
         .runOrder(123)
         .scope(construct)
         .stackOutputsMap(stackOutputsMap)
         // the properties below are optional
         .beforeSelfMutation(false)
         .codeBuildDefaults(CodeBuildOptions.builder()
                 .buildEnvironment(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())
                 .cache(cache)
                 .fileSystemLocations(List.of(fileSystemLocation))
                 .logging(LoggingOptions.builder()
                         .cloudWatch(CloudWatchLoggingOptions.builder()
                                 .enabled(false)
                                 .logGroup(logGroup)
                                 .prefix("prefix")
                                 .build())
                         .s3(S3LoggingOptions.builder()
                                 .bucket(bucket)
                                 // the properties below are optional
                                 .enabled(false)
                                 .encrypted(false)
                                 .prefix("prefix")
                                 .build())
                         .build())
                 .partialBuildSpec(buildSpec)
                 .rolePolicy(List.of(policyStatement))
                 .securityGroups(List.of(securityGroup))
                 .subnetSelection(SubnetSelection.builder()
                         .availabilityZones(List.of("availabilityZones"))
                         .onePerAz(false)
                         .subnetFilters(List.of(subnetFilter))
                         .subnetGroupName("subnetGroupName")
                         .subnets(List.of(subnet))
                         .subnetType(SubnetType.PRIVATE_ISOLATED)
                         .build())
                 .timeout(Duration.minutes(30))
                 .vpc(vpc)
                 .build())
         .fallbackArtifact(artifact)
         .variablesNamespace("variablesNamespace")
         .build();

  • Method Details

    • getActionName

      @Stability(Stable) @NotNull String getActionName()
      Name the action should get.

    • getArtifacts

      @Stability(Stable) @NotNull ArtifactMap getArtifacts()
      Helper object to translate FileSets to CodePipeline Artifacts.

    • getPipeline

      @Stability(Stable) @NotNull CodePipeline getPipeline()
      The pipeline the action is being generated for.

    • getRunOrder

      @Stability(Stable) @NotNull Number getRunOrder()
      RunOrder the action should get.

    • getScope

      @Stability(Stable) @NotNull software.constructs.Construct getScope()
      Scope in which to create constructs.

    • getStackOutputsMap

      @Stability(Stable) @NotNull StackOutputsMap getStackOutputsMap()
      Helper object to produce variables exported from stack deployments.

      If your step references outputs from a stack deployment, use this to map the output references to Codepipeline variable names.

      Note - Codepipeline variables can only be referenced in action configurations.

    • getBeforeSelfMutation

      @Stability(Stable) @Nullable default Boolean getBeforeSelfMutation()
      Whether or not this action is inserted before self mutation.

      If it is, the action should take care to reflect some part of its own definition in the pipeline action definition, to trigger a restart after self-mutation (if necessary).

      Default: false

    • getCodeBuildDefaults

      @Stability(Stable) @Nullable default CodeBuildOptions getCodeBuildDefaults()
      If this action factory creates a CodeBuild step, default options to inherit.

      Default: - No CodeBuild project defaults

    • getFallbackArtifact

      @Stability(Stable) @Nullable default Artifact getFallbackArtifact()
      An input artifact that CodeBuild projects that don't actually need an input artifact can use.

      CodeBuild Projects MUST have an input artifact in order to be added to the Pipeline. If the Project doesn't actually care about its input (it can be anything), it can use the Artifact passed here.

      Default: - A fallback artifact does not exist

    • getVariablesNamespace

      @Stability(Stable) @Nullable default String getVariablesNamespace()
      If this step is producing outputs, the variables namespace assigned to it.

      Pass this on to the Action you are creating.

      Default: - Step doesn't produce any outputs

    • builder

      @Stability(Stable) static ProduceActionOptions.Builder builder()
      Returns:
      a ProduceActionOptions.Builder of ProduceActionOptions