software.amazon.awscdk.pipelines

Interface SimpleSynthOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

SimpleSynthActionProps, StandardNpmSynthOptions, StandardYarnSynthOptions

All Known Implementing Classes:

SimpleSynthActionProps.Jsii$Proxy, SimpleSynthOptions.Jsii$Proxy, StandardNpmSynthOptions.Jsii$Proxy, StandardYarnSynthOptions.Jsii$Proxy

Deprecated.

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

@Generated(value="jsii-pacmak/1.70.0 (build 03c2f6f)",
           date="2022-11-01T13:16:58.614Z")
 @Stability(value=Deprecated)
 @Deprecated
public interface SimpleSynthOptions
extends software.amazon.jsii.JsiiSerializable

(deprecated) Configuration options for a SimpleSynth.

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;
 BuildSpec buildSpec;
 PolicyStatement policyStatement;
 Subnet subnet;
 SubnetFilter subnetFilter;
 Object value;
 Vpc vpc;
 SimpleSynthOptions simpleSynthOptions = SimpleSynthOptions.builder()
         .cloudAssemblyArtifact(artifact)
         .sourceArtifact(artifact)
         // the properties below are optional
         .actionName("actionName")
         .additionalArtifacts(List.of(AdditionalArtifact.builder()
                 .artifact(artifact)
                 .directory("directory")
                 .build()))
         .buildSpec(buildSpec)
         .copyEnvironmentVariables(List.of("copyEnvironmentVariables"))
         .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()))
         .projectName("projectName")
         .rolePolicyStatements(List.of(policyStatement))
         .subdirectory("subdirectory")
         .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())
         .vpc(vpc)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SimpleSynthOptions.Builder Deprecated.
static class	SimpleSynthOptions.Jsii$Proxy Deprecated.

Method Summary

Modifier and Type	Method and Description
static SimpleSynthOptions.Builder	builder() Deprecated.
default String	getActionName() Deprecated.
default List<AdditionalArtifact>	getAdditionalArtifacts() Deprecated.
default BuildSpec	getBuildSpec() Deprecated.
Artifact	getCloudAssemblyArtifact() Deprecated.
default List<String>	getCopyEnvironmentVariables() Deprecated.
default BuildEnvironment	getEnvironment() Deprecated.
default Map<String,BuildEnvironmentVariable>	getEnvironmentVariables() Deprecated.
default String	getProjectName() Deprecated.
default List<PolicyStatement>	getRolePolicyStatements() Deprecated.
Artifact	getSourceArtifact() Deprecated.
default String	getSubdirectory() Deprecated.
default SubnetSelection	getSubnetSelection() Deprecated.
default IVpc	getVpc() Deprecated.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getCloudAssemblyArtifact

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
Artifact getCloudAssemblyArtifact()

Deprecated.

(deprecated) The artifact where the CloudAssembly should be emitted.

getSourceArtifact

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
Artifact getSourceArtifact()

Deprecated.

(deprecated) The source artifact of the CodePipeline.

getActionName

@Stability(value=Deprecated)
 @Deprecated
 @Nullable
default String getActionName()

Deprecated.

(deprecated) Name of the build action.

Default: 'Synth'

getAdditionalArtifacts

@Stability(value=Deprecated)
 @Deprecated
 @Nullable
default List<AdditionalArtifact> getAdditionalArtifacts()

Deprecated.

(deprecated) Produce additional output artifacts after the build based on the given directories.

Can be used to produce additional artifacts during the build step, separate from the cloud assembly, which can be used further on in the pipeline.

Directories are evaluated with respect to subdirectory.

Default: - No additional artifacts generated

getBuildSpec

@Stability(value=Deprecated)
 @Deprecated
 @Nullable
default BuildSpec getBuildSpec()

Deprecated.

(deprecated) custom BuildSpec that is merged with the generated one.

Default: - none

getCopyEnvironmentVariables

@Stability(value=Deprecated)
 @Deprecated
 @Nullable
default List<String> getCopyEnvironmentVariables()

Deprecated.

(deprecated) Environment variables to copy over from parent env.

These are environment variables that are being used by the build.

Default: - No environment variables copied

getEnvironment

@Stability(value=Deprecated)
 @Deprecated
 @Nullable
default BuildEnvironment getEnvironment()

Deprecated.

(deprecated) Build environment to use for CodeBuild job.

Default: BuildEnvironment.LinuxBuildImage.STANDARD_5_0

getEnvironmentVariables

@Stability(value=Deprecated)
 @Deprecated
 @Nullable
default Map<String,BuildEnvironmentVariable> getEnvironmentVariables()

Deprecated.

(deprecated) Environment variables to send into build.

NOTE: You may run into the 1000-character limit for the Action configuration if you have a large number of variables or if their names or values are very long. If you do, pass them to the underlying CodeBuild project directly in environment instead. However, you will not be able to use CodePipeline Variables in this case.

Default: - No additional environment variables

getProjectName

@Stability(value=Deprecated)
 @Deprecated
 @Nullable
default String getProjectName()

Deprecated.

(deprecated) Name of the CodeBuild project.

Default: - Automatically generated

getRolePolicyStatements

@Stability(value=Deprecated)
 @Deprecated
 @Nullable
default List<PolicyStatement> getRolePolicyStatements()

Deprecated.

(deprecated) Policy statements to add to role used during the synth.

Can be used to add acces to a CodeArtifact repository etc.

Default: - No policy statements added to CodeBuild Project Role

getSubdirectory

@Stability(value=Deprecated)
 @Deprecated
 @Nullable
default String getSubdirectory()

Deprecated.

(deprecated) Directory inside the source where package.json and cdk.json are located.

Default: - Repository root

getSubnetSelection

@Stability(value=Deprecated)
 @Deprecated
 @Nullable
default SubnetSelection getSubnetSelection()

Deprecated.

(deprecated) Which subnets to use.

Only used if 'vpc' is supplied.

Default: - All private subnets.

getVpc

@Stability(value=Deprecated)
 @Deprecated
 @Nullable
default IVpc getVpc()

Deprecated.

(deprecated) The VPC where to execute the SimpleSynth.

Default: - No VPC

builder

@Stability(value=Deprecated)
 @Deprecated
static SimpleSynthOptions.Builder builder()

Deprecated.

Returns:

a SimpleSynthOptions.Builder of SimpleSynthOptions