AWS CDK Reference

Appearance

v2.274.0

ServiceCatalogDeployActionBeta1 Class ​

CodePipeline action to connect to an existing ServiceCatalog product.

Note: this class is still experimental, and may have breaking changes in the future!

Source
aws-codepipeline-actions/lib/servicecatalog/deploy-action-beta1.ts

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",
});
python
cdk_build_output = codepipeline.Artifact()
service_catalog_deploy_action = codepipeline_actions.ServiceCatalogDeployActionBeta1(
    action_name="ServiceCatalogDeploy",
    template_path=cdk_build_output.at_path("Sample.template.json"),
    product_version_name="Version - " + Date.now.to_string,
    product_version_description="This is a version from the pipeline with a new description.",
    product_id="prod-XXXXXXXX"
)
java
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();
csharp
// Install: dotnet add package Amazon.CDK.Lib
var cdkBuildOutput = new Artifact();
var serviceCatalogDeployAction = new ServiceCatalogDeployActionBeta1(new ServiceCatalogDeployActionBeta1Props {
    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"
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
cdkBuildOutput := codepipeline.NewArtifact()
serviceCatalogDeployAction := codepipeline_actions.NewServiceCatalogDeployActionBeta1(&ServiceCatalogDeployActionBeta1Props{
	ActionName: jsii.String("ServiceCatalogDeploy"),
	TemplatePath: cdkBuildOutput.AtPath(jsii.String("Sample.template.json")),
	ProductVersionName: jsii.String("Version - " + date.now.toString),
	ProductVersionDescription: jsii.String("This is a version from the pipeline with a new description."),
	ProductId: jsii.String("prod-XXXXXXXX"),
})

Initializer ​

ts
new ServiceCatalogDeployActionBeta1(props: ServiceCatalogDeployActionBeta1Props)
python
ServiceCatalogDeployActionBeta1(props: ServiceCatalogDeployActionBeta1Props)
java
new ServiceCatalogDeployActionBeta1(ServiceCatalogDeployActionBeta1Props props)
csharp
new ServiceCatalogDeployActionBeta1(ServiceCatalogDeployActionBeta1Props props)
go
NewServiceCatalogDeployActionBeta1(Props ServiceCatalogDeployActionBeta1Props)

Properties ​

actionPropertiesActionPropertiesaction_propertiesActionPropertiesactionPropertiesActionPropertiesActionPropertiesActionPropertiesActionPropertiesActionPropertiesrequired#
The simple properties of the Action, like its Owner, name, etc.

Note that this accessor will be called before the bind callback.

Methods ​

bind(scope: Construct, stage: IStage, options: ActionBindOptions): ActionConfigdef bind(self, scope: Construct, stage: IStage, options: ActionBindOptions) -> ActionConfigpublic ActionConfig bind(Construct scope, IStage stage, ActionBindOptions options)public ActionConfig Bind(Construct scope, IStage stage, ActionBindOptions options)func Bind(Scope Construct, Stage IStage, Options ActionBindOptions) ActionConfig#
The callback invoked when this Action is added to a Pipeline.
onStateChange(name: string, target?: IRuleTarget, options?: RuleProps): Ruledef on_state_change(self, name: str, target: typing.Optional[IRuleTarget] = None, options: typing.Optional[RuleProps] = None) -> Rulepublic Rule onStateChange(String name, IRuleTarget target, RuleProps options)public Rule OnStateChange(string name, IRuleTarget? target = null, RuleProps? options = null)func OnStateChange(Name *string, Target IRuleTarget, Options RuleProps) Rule#
Creates an Event that will be triggered whenever the state of this Action changes.