@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
date="2022-05-13T01:13:40.856Z")
public interface ProduceActionOptions
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.core.*; import software.amazon.awscdk.pipelines.*; import software.constructs.*; Artifact artifact; ArtifactMap artifactMap; Bucket bucket; IBuildImage buildImage; BuildSpec buildSpec; 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()) .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") .subnetName("subnetName") .subnets(List.of(subnet)) .subnetType(SubnetType.ISOLATED) .build()) .timeout(Duration.minutes(30)) .vpc(vpc) .build()) .fallbackArtifact(artifact) .variablesNamespace("variablesNamespace") .build();
Modifier and Type | Interface and Description |
---|---|
static class |
ProduceActionOptions.Builder
A builder for
ProduceActionOptions |
static class |
ProduceActionOptions.Jsii$Proxy
An implementation for
ProduceActionOptions |
Modifier and Type | Method and Description |
---|---|
static ProduceActionOptions.Builder |
builder() |
java.lang.String |
getActionName()
Name the action should get.
|
ArtifactMap |
getArtifacts()
Helper object to translate FileSets to CodePipeline Artifacts.
|
default java.lang.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.
|
java.lang.Number |
getRunOrder()
RunOrder the action should get.
|
software.constructs.Construct |
getScope()
Scope in which to create constructs.
|
default java.lang.String |
getVariablesNamespace()
If this step is producing outputs, the variables namespace assigned to it.
|
java.lang.String getActionName()
ArtifactMap getArtifacts()
CodePipeline getPipeline()
java.lang.Number getRunOrder()
software.constructs.Construct getScope()
default java.lang.Boolean getBeforeSelfMutation()
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
default CodeBuildOptions getCodeBuildDefaults()
Default: - No CodeBuild project defaults
default Artifact getFallbackArtifact()
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
default java.lang.String getVariablesNamespace()
Pass this on to the Action you are creating.
Default: - Step doesn't produce any outputs
static ProduceActionOptions.Builder builder()
ProduceActionOptions.Builder
of ProduceActionOptions