interface ServiceCatalogDeployActionBeta1Props
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.CodePipeline.Actions.ServiceCatalogDeployActionBeta1Props |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awscodepipelineactions#ServiceCatalogDeployActionBeta1Props |
![]() | software.amazon.awscdk.services.codepipeline.actions.ServiceCatalogDeployActionBeta1Props |
![]() | aws_cdk.aws_codepipeline_actions.ServiceCatalogDeployActionBeta1Props |
![]() | aws-cdk-lib » aws_codepipeline_actions » ServiceCatalogDeployActionBeta1Props |
Construction properties of the ServiceCatalogDeployActionBeta1 ServiceCatalog deploy CodePipeline Action
.
Example
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
Name | Type | Description |
---|---|---|
action | string | The physical, human-readable name of the Action. |
product | string | The identifier of the product in the Service Catalog. |
product | string | The name of the version of the Service Catalog product to be deployed. |
template | Artifact | The path to the cloudformation artifact. |
product | string | The optional description of this version of the Service Catalog product. |
role? | IRole | The Role in which context's this Action will be executing in. |
run | number | The runOrder property for this Action. |
variables | string | The name of the namespace to use for variables emitted by this action. |
actionName
Type:
string
The physical, human-readable name of the Action.
Note that Action names must be unique within a single Stage.
productId
Type:
string
The identifier of the product in the Service Catalog.
This product must already exist.
productVersionName
Type:
string
The name of the version of the Service Catalog product to be deployed.
templatePath
Type:
Artifact
The path to the cloudformation artifact.
productVersionDescription?
Type:
string
(optional, default: '')
The optional description of this version of the Service Catalog product.
role?
Type:
IRole
(optional, default: a new Role will be generated)
The Role in which context's this Action will be executing in.
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.
runOrder?
Type:
number
(optional, default: 1)
The runOrder property for this Action.
RunOrder determines the relative order in which multiple Actions in the same Stage execute.
variablesNamespace?
Type:
string
(optional, 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)
The name of the namespace to use for variables emitted by this action.