Package software.amazon.awscdk.pipelines

Interface CdkPipelineProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CdkPipelineProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:49.755Z") @Stability(Deprecated) @Deprecated public interface CdkPipelineProps 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 a CdkPipeline.

Example: 

 Artifact sourceArtifact = new Artifact();
 Artifact cloudAssemblyArtifact = new Artifact();
 CdkPipeline pipeline = CdkPipeline.Builder.create(this, "MyPipeline")
         .cloudAssemblyArtifact(cloudAssemblyArtifact)
         .synthAction(SimpleSynthAction.standardNpmSynth(StandardNpmSynthOptions.builder()
                 .sourceArtifact(sourceArtifact)
                 .cloudAssemblyArtifact(cloudAssemblyArtifact)
                 .environment(BuildEnvironment.builder()
                         .privileged(true)
                         .build())
                 .build()))
         .build();

  • Method Details

    • getCloudAssemblyArtifact

      @Stability(Deprecated) @Deprecated @NotNull Artifact getCloudAssemblyArtifact()
      Deprecated.
      (deprecated) The artifact you have defined to be the artifact to hold the cloudAssemblyArtifact for the synth action.

    • getAssetBuildSpec

      @Stability(Deprecated) @Deprecated @Nullable default BuildSpec getAssetBuildSpec()
      Deprecated.
      (deprecated) Custom BuildSpec that is merged with generated one (for asset publishing actions).

      Default: - none

    • getAssetPreInstallCommands

      @Stability(Deprecated) @Deprecated @Nullable default List<String> getAssetPreInstallCommands()
      Deprecated.
      (deprecated) Additional commands to run before installing cdk-assets during the asset publishing step Use this to setup proxies or npm mirrors.

      Default: -

    • getCdkCliVersion

      @Stability(Deprecated) @Deprecated @Nullable default String getCdkCliVersion()
      Deprecated.
      (deprecated) CDK CLI version to use in pipeline.

      Some Actions in the pipeline will download and run a version of the CDK CLI. Specify the version here.

      Default: - Latest version

    • getCodePipeline

      @Stability(Deprecated) @Deprecated @Nullable default Pipeline getCodePipeline()
      Deprecated.
      (deprecated) Existing CodePipeline to add deployment stages to.

      Use this if you want more control over the CodePipeline that gets created. You can choose to not pass this value, in which case a new CodePipeline is created with default settings.

      If you pass an existing CodePipeline, it should have been created with restartExecutionOnUpdate: true.

      [disable-awslint:ref-via-interface]

      Default: - A new CodePipeline is automatically generated

    • getCrossAccountKeys

      @Stability(Deprecated) @Deprecated @Nullable default Boolean getCrossAccountKeys()
      Deprecated.
      (deprecated) Create KMS keys for cross-account deployments.

      This controls whether the pipeline is enabled for cross-account deployments.

      Can only be set if codePipeline is not set.

      By default cross-account deployments are enabled, but this feature requires that KMS Customer Master Keys are created which have a cost of $1/month.

      If you do not need cross-account deployments, you can set this to false to not create those keys and save on that cost (the artifact bucket will be encrypted with an AWS-managed key). However, cross-account deployments will no longer be possible.

      Default: true

    • getDockerCredentials

      @Stability(Deprecated) @Deprecated @Nullable default List<DockerCredential> getDockerCredentials()
      Deprecated.
      (deprecated) A list of credentials used to authenticate to Docker registries.

      Specify any credentials necessary within the pipeline to build, synth, update, or publish assets.

      Default: []

    • getEnableKeyRotation

      @Stability(Deprecated) @Deprecated @Nullable default Boolean getEnableKeyRotation()
      Deprecated.
      (deprecated) Enables KMS key rotation for cross-account keys.

      Cannot be set if crossAccountKeys was set to false.

      Key rotation costs $1/month when enabled.

      Default: - false (key rotation is disabled)

    • getPipelineName

      @Stability(Deprecated) @Deprecated @Nullable default String getPipelineName()
      Deprecated.
      (deprecated) Name of the pipeline.

      Can only be set if codePipeline is not set.

      Default: - A name is automatically generated

    • getSelfMutating

      @Stability(Deprecated) @Deprecated @Nullable default Boolean getSelfMutating()
      Deprecated.
      (deprecated) Whether the pipeline will update itself.

      This needs to be set to true to allow the pipeline to reconfigure itself when assets or stages are being added to it, and true is the recommended setting.

      You can temporarily set this to false while you are iterating on the pipeline itself and prefer to deploy changes using cdk deploy.

      Default: true

    • getSelfMutationBuildSpec

      @Stability(Deprecated) @Deprecated @Nullable default BuildSpec getSelfMutationBuildSpec()
      Deprecated.
      (deprecated) Custom BuildSpec that is merged with generated one (for self-mutation stage).

      Default: - none

    • getSinglePublisherPerType

      @Stability(Deprecated) @Deprecated @Nullable default Boolean getSinglePublisherPerType()
      Deprecated.
      (deprecated) Whether this pipeline creates one asset upload action per asset type or one asset upload per asset.

      Default: false

    • getSourceAction

      @Stability(Deprecated) @Deprecated @Nullable default IAction getSourceAction()
      Deprecated.
      (deprecated) The CodePipeline action used to retrieve the CDK app's source.

      Default: - Required unless `codePipeline` is given

    • getSubnetSelection

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

      Only used if 'vpc' is supplied.

      Default: - All private subnets.

    • getSupportDockerAssets

      @Stability(Deprecated) @Deprecated @Nullable default Boolean getSupportDockerAssets()
      Deprecated.
      (deprecated) Whether the pipeline needs to build Docker images in the UpdatePipeline stage.

      If the UpdatePipeline stage tries to build a Docker image and this flag is not set to true, the build step will run in non-privileged mode and consequently will fail with a message like:

      Cannot connect to the Docker daemon at unix:///var/run/docker.sock. Is the docker daemon running?

      This flag has an effect only if selfMutating is also true.

      Default: - false

    • getSynthAction

      @Stability(Deprecated) @Deprecated @Nullable default IAction getSynthAction()
      Deprecated.
      (deprecated) The CodePipeline action build and synthesis step of the CDK app.

      Default: - Required unless `codePipeline` or `sourceAction` is given

    • getVpc

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

      Default: - No VPC

    • builder

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