Package software.amazon.awscdk.pipelines

Class CdkPipelineProps.Builder

java.lang.Object
software.amazon.awscdk.pipelines.CdkPipelineProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CdkPipelineProps>
Enclosing interface:
CdkPipelineProps
@Stability(Deprecated) @Deprecated public static final class CdkPipelineProps.Builder extends Object implements software.amazon.jsii.Builder<CdkPipelineProps>
Deprecated.
A builder for CdkPipelineProps

  • Constructor Details

    • Builder

      public Builder()
      Deprecated.

  • Method Details

    • cloudAssemblyArtifact

      @Stability(Deprecated) @Deprecated public CdkPipelineProps.Builder cloudAssemblyArtifact(Artifact cloudAssemblyArtifact)
      Deprecated.
      Sets the value of CdkPipelineProps.getCloudAssemblyArtifact()
      Parameters:
      cloudAssemblyArtifact - The artifact you have defined to be the artifact to hold the cloudAssemblyArtifact for the synth action. This parameter is required.
      Returns:
      this

    • assetBuildSpec

      @Stability(Deprecated) @Deprecated public CdkPipelineProps.Builder assetBuildSpec(BuildSpec assetBuildSpec)
      Deprecated.
      Sets the value of CdkPipelineProps.getAssetBuildSpec()
      Parameters:
      assetBuildSpec - Custom BuildSpec that is merged with generated one (for asset publishing actions).
      Returns:
      this

    • assetPreInstallCommands

      @Stability(Deprecated) @Deprecated public CdkPipelineProps.Builder assetPreInstallCommands(List<String> assetPreInstallCommands)
      Deprecated.
      Sets the value of CdkPipelineProps.getAssetPreInstallCommands()
      Parameters:
      assetPreInstallCommands - Additional commands to run before installing cdk-assets during the asset publishing step Use this to setup proxies or npm mirrors.
      Returns:
      this

    • cdkCliVersion

      @Stability(Deprecated) @Deprecated public CdkPipelineProps.Builder cdkCliVersion(String cdkCliVersion)
      Deprecated.
      Sets the value of CdkPipelineProps.getCdkCliVersion()
      Parameters:
      cdkCliVersion - 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.
      Returns:
      this

    • codePipeline

      @Stability(Deprecated) @Deprecated public CdkPipelineProps.Builder codePipeline(Pipeline codePipeline)
      Deprecated.
      Sets the value of CdkPipelineProps.getCodePipeline()
      Parameters:
      codePipeline - 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]

      Returns:
      this

    • crossAccountKeys

      @Stability(Deprecated) @Deprecated public CdkPipelineProps.Builder crossAccountKeys(Boolean crossAccountKeys)
      Deprecated.
      Sets the value of CdkPipelineProps.getCrossAccountKeys()
      Parameters:
      crossAccountKeys - 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.

      Returns:
      this

    • dockerCredentials

      @Stability(Deprecated) @Deprecated public CdkPipelineProps.Builder dockerCredentials(List<? extends DockerCredential> dockerCredentials)
      Deprecated.
      Sets the value of CdkPipelineProps.getDockerCredentials()
      Parameters:
      dockerCredentials - A list of credentials used to authenticate to Docker registries. Specify any credentials necessary within the pipeline to build, synth, update, or publish assets.
      Returns:
      this

    • enableKeyRotation

      @Stability(Deprecated) @Deprecated public CdkPipelineProps.Builder enableKeyRotation(Boolean enableKeyRotation)
      Deprecated.
      Sets the value of CdkPipelineProps.getEnableKeyRotation()
      Parameters:
      enableKeyRotation - Enables KMS key rotation for cross-account keys. Cannot be set if crossAccountKeys was set to false.

      Key rotation costs $1/month when enabled.

      Returns:
      this

    • pipelineName

      @Stability(Deprecated) @Deprecated public CdkPipelineProps.Builder pipelineName(String pipelineName)
      Deprecated.
      Sets the value of CdkPipelineProps.getPipelineName()
      Parameters:
      pipelineName - Name of the pipeline. Can only be set if codePipeline is not set.
      Returns:
      this

    • selfMutating

      @Stability(Deprecated) @Deprecated public CdkPipelineProps.Builder selfMutating(Boolean selfMutating)
      Deprecated.
      Sets the value of CdkPipelineProps.getSelfMutating()
      Parameters:
      selfMutating - 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.

      Returns:
      this

    • selfMutationBuildSpec

      @Stability(Deprecated) @Deprecated public CdkPipelineProps.Builder selfMutationBuildSpec(BuildSpec selfMutationBuildSpec)
      Deprecated.
      Sets the value of CdkPipelineProps.getSelfMutationBuildSpec()
      Parameters:
      selfMutationBuildSpec - Custom BuildSpec that is merged with generated one (for self-mutation stage).
      Returns:
      this

    • singlePublisherPerType

      @Stability(Deprecated) @Deprecated public CdkPipelineProps.Builder singlePublisherPerType(Boolean singlePublisherPerType)
      Deprecated.
      Sets the value of CdkPipelineProps.getSinglePublisherPerType()
      Parameters:
      singlePublisherPerType - Whether this pipeline creates one asset upload action per asset type or one asset upload per asset.
      Returns:
      this

    • sourceAction

      @Stability(Deprecated) @Deprecated public CdkPipelineProps.Builder sourceAction(IAction sourceAction)
      Deprecated.
      Sets the value of CdkPipelineProps.getSourceAction()
      Parameters:
      sourceAction - The CodePipeline action used to retrieve the CDK app's source.
      Returns:
      this

    • subnetSelection

      @Stability(Deprecated) @Deprecated public CdkPipelineProps.Builder subnetSelection(SubnetSelection subnetSelection)
      Deprecated.
      Sets the value of CdkPipelineProps.getSubnetSelection()
      Parameters:
      subnetSelection - Which subnets to use. Only used if 'vpc' is supplied.
      Returns:
      this

    • supportDockerAssets

      @Stability(Deprecated) @Deprecated public CdkPipelineProps.Builder supportDockerAssets(Boolean supportDockerAssets)
      Deprecated.
      Sets the value of CdkPipelineProps.getSupportDockerAssets()
      Parameters:
      supportDockerAssets - 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.

      Returns:
      this

    • synthAction

      @Stability(Deprecated) @Deprecated public CdkPipelineProps.Builder synthAction(IAction synthAction)
      Deprecated.
      Sets the value of CdkPipelineProps.getSynthAction()
      Parameters:
      synthAction - The CodePipeline action build and synthesis step of the CDK app.
      Returns:
      this

    • vpc

      @Stability(Deprecated) @Deprecated public CdkPipelineProps.Builder vpc(IVpc vpc)
      Deprecated.
      Sets the value of CdkPipelineProps.getVpc()
      Parameters:
      vpc - The VPC where to execute the CdkPipeline actions.
      Returns:
      this

    • build

      @Stability(Deprecated) @Deprecated public CdkPipelineProps build()
      Deprecated.
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CdkPipelineProps>
      Returns:
      a new instance of CdkPipelineProps
      Throws:
      NullPointerException - if any required attribute was not provided