Package software.amazon.awscdk.services.codepipeline.actions

Interface ServiceCatalogDeployActionBeta1Props

All Superinterfaces:

CommonActionProps, CommonAwsActionProps, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ServiceCatalogDeployActionBeta1Props.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:48.496Z")
@Stability(Stable)
public interface ServiceCatalogDeployActionBeta1Props
extends software.amazon.jsii.JsiiSerializable, CommonAwsActionProps

Construction properties of the ServiceCatalog deploy CodePipeline Action.

Example:

 Artifact cdkBuildOutput = new Artifact();
 ServiceCatalogDeployActionBeta1 serviceCatalogDeployAction = ServiceCatalogDeployActionBeta1.Builder.create()
         .actionName("ServiceCatalogDeploy")
         .templatePath(cdkBuildOutput.atPath("Sample.template.json"))
         .productVersionName("Version - " + Date.getNow().getToString())
         .productVersionDescription("This is a version from the pipeline with a new description.")
         .productId("prod-XXXXXXXX")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ServiceCatalogDeployActionBeta1Props.Builder	builder()
String	getProductId()	The identifier of the product in the Service Catalog.
default String	getProductVersionDescription()	The optional description of this version of the Service Catalog product.
String	getProductVersionName()	The name of the version of the Service Catalog product to be deployed.
ArtifactPath	getTemplatePath()	The path to the cloudformation artifact.

Methods inherited from interface software.amazon.awscdk.services.codepipeline.CommonActionProps

getActionName, getRunOrder, getVariablesNamespace

Methods inherited from interface software.amazon.awscdk.services.codepipeline.CommonAwsActionProps

getRole

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getProductId

@Stability(Stable)
@NotNull
String getProductId()

The identifier of the product in the Service Catalog.

This product must already exist.

getProductVersionName

@Stability(Stable)
@NotNull
String getProductVersionName()

The name of the version of the Service Catalog product to be deployed.

getTemplatePath

@Stability(Stable)
@NotNull
ArtifactPath getTemplatePath()

The path to the cloudformation artifact.

getProductVersionDescription

@Stability(Stable)
@Nullable
default String getProductVersionDescription()

The optional description of this version of the Service Catalog product.

Default: ''

builder

@Stability(Stable)
static ServiceCatalogDeployActionBeta1Props.Builder builder()

Returns:

a ServiceCatalogDeployActionBeta1Props.Builder of ServiceCatalogDeployActionBeta1Props