software.amazon.awscdk.pipelines

Interface ProduceActionOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ProduceActionOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:42.942Z")
 @Stability(value=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.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;
 PolicyStatement policyStatement;
 SecurityGroup securityGroup;
 Subnet subnet;
 SubnetFilter subnetFilter;
 Object value;
 Vpc vpc;
 ProduceActionOptions produceActionOptions = ProduceActionOptions.builder()
         .actionName("actionName")
         .artifacts(artifactMap)
         .pipeline(codePipeline)
         .runOrder(123)
         .scope(construct)
         // 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)
                 .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();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static ProduceActionOptions.Builder	builder()
String	getActionName() Name the action should get.
ArtifactMap	getArtifacts() Helper object to translate FileSets to CodePipeline Artifacts.
default Boolean	getBeforeSelfMutation() Whether or not this action is inserted before self mutation.
default CodeBuildOptions	getCodeBuildDefaults() If this action factory creates a CodeBuild step, default options to inherit.
default Artifact	getFallbackArtifact() An input artifact that CodeBuild projects that don't actually need an input artifact can use.
CodePipeline	getPipeline() The pipeline the action is being generated for.
Number	getRunOrder() RunOrder the action should get.
software.constructs.Construct	getScope() Scope in which to create constructs.
default String	getVariablesNamespace() If this step is producing outputs, the variables namespace assigned to it.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getActionName

@Stability(value=Stable)
 @NotNull
String getActionName()

Name the action should get.

getArtifacts

@Stability(value=Stable)
 @NotNull
ArtifactMap getArtifacts()

Helper object to translate FileSets to CodePipeline Artifacts.

getPipeline

@Stability(value=Stable)
 @NotNull
CodePipeline getPipeline()

The pipeline the action is being generated for.

getRunOrder

@Stability(value=Stable)
 @NotNull
Number getRunOrder()

RunOrder the action should get.

getScope

@Stability(value=Stable)
 @NotNull
software.constructs.Construct getScope()

Scope in which to create constructs.

getBeforeSelfMutation

@Stability(value=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(value=Stable)
 @Nullable
default CodeBuildOptions getCodeBuildDefaults()

If this action factory creates a CodeBuild step, default options to inherit.

Default: - No CodeBuild project defaults

getFallbackArtifact

@Stability(value=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(value=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(value=Stable)
static ProduceActionOptions.Builder builder()

Returns:

a ProduceActionOptions.Builder of ProduceActionOptions