Skip to content
v2.274.0

ServiceCatalogDeployActionBeta1Props Struct ​

Construction properties of the ServiceCatalogDeployActionBeta1 ServiceCatalog deploy CodePipeline Action.

Example ​

ts
const cdkBuildOutput = new codepipeline.Artifact();
const serviceCatalogDeployAction = new codepipeline_actions.ServiceCatalogDeployActionBeta1({
  actionName: 'ServiceCatalogDeploy',
  templatePath: cdkBuildOutput.atPath("Sample.template.json"),
  productVersionName: "Version - " + Date.now.toString,
  productVersionDescription: "This is a version from the pipeline with a new description.",
  productId: "prod-XXXXXXXX",
});

Properties ​

actionNamestringaction_namestractionNameStringActionNamestringActionName*stringrequired#
The physical, human-readable name of the Action.

Note that Action names must be unique within a single Stage.

productIdstringproduct_idstrproductIdStringProductIdstringProductId*stringrequired#
The identifier of the product in the Service Catalog.

This product must already exist.

productVersionDescriptionoptionalstringproduct_version_descriptionoptionalstrproductVersionDescriptionoptionalStringProductVersionDescriptionoptionalstringProductVersionDescriptionoptional*string= ''#
The optional description of this version of the Service Catalog product.
productVersionNamestringproduct_version_namestrproductVersionNameStringProductVersionNamestringProductVersionName*stringrequired#
The name of the version of the Service Catalog product to be deployed.
roleoptionalIRoleroleoptionalIRoleroleoptionalIRoleRoleoptionalIRoleRoleoptionalIRole#
The Role in which context's this Action will be executing in.

Default: a new Role will be generated

notes

The Pipeline's Role will assume this Role (the required permissions for that will be granted automatically) right before executing this Action. This Action will be passed into your IAction.bind method in the ActionBindOptions.role property.

runOrderoptionalnumberrun_orderoptionalint | floatrunOrderoptionalNumberRunOrderoptionaldoubleRunOrderoptional*float64= 1#
The runOrder property for this Action.

RunOrder determines the relative order in which multiple Actions in the same Stage execute.

templatePathArtifactPathtemplate_pathArtifactPathtemplatePathArtifactPathTemplatePathArtifactPathTemplatePathArtifactPathrequired#
The path to the cloudformation artifact.
variablesNamespaceoptionalstringvariables_namespaceoptionalstrvariablesNamespaceoptionalStringVariablesNamespaceoptionalstringVariablesNamespaceoptional*string#
The name of the namespace to use for variables emitted by this action.

Default: a name will be generated, based on the stage and action names, if any of the action's variables were referenced - otherwise, no namespace will be set