Class ServiceCatalogDeployActionBeta1Props
Construction properties of the ServiceCatalogDeployActionBeta1 ServiceCatalog deploy CodePipeline Action
.
Inheritance
Namespace: Amazon.CDK.AWS.CodePipeline.Actions
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class ServiceCatalogDeployActionBeta1Props : Object, IServiceCatalogDeployActionBeta1Props, ICommonAwsActionProps, ICommonActionProps
Syntax (vb)
Public Class ServiceCatalogDeployActionBeta1Props
Inherits Object
Implements IServiceCatalogDeployActionBeta1Props, ICommonAwsActionProps, ICommonActionProps
Remarks
ExampleMetadata: infused
Examples
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"
});
Synopsis
Constructors
ServiceCatalogDeployActionBeta1Props() |
Properties
ActionName | The physical, human-readable name of the Action. |
ProductId | The identifier of the product in the Service Catalog. |
ProductVersionDescription | The optional description of this version of the Service Catalog product. |
ProductVersionName | The name of the version of the Service Catalog product to be deployed. |
Role | The Role in which context's this Action will be executing in. |
RunOrder | The runOrder property for this Action. |
TemplatePath | The path to the cloudformation artifact. |
VariablesNamespace | The name of the namespace to use for variables emitted by this action. |
Constructors
ServiceCatalogDeployActionBeta1Props()
public ServiceCatalogDeployActionBeta1Props()
Properties
ActionName
The physical, human-readable name of the Action.
public string ActionName { get; set; }
Property Value
System.String
Remarks
Note that Action names must be unique within a single Stage.
ProductId
The identifier of the product in the Service Catalog.
public string ProductId { get; set; }
Property Value
System.String
Remarks
This product must already exist.
ProductVersionDescription
The optional description of this version of the Service Catalog product.
public string ProductVersionDescription { get; set; }
Property Value
System.String
Remarks
Default: ''
ProductVersionName
The name of the version of the Service Catalog product to be deployed.
public string ProductVersionName { get; set; }
Property Value
System.String
Role
The Role in which context's this Action will be executing in.
public IRole Role { get; set; }
Property Value
Remarks
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.
Default: a new Role will be generated
RunOrder
The runOrder property for this Action.
public Nullable<double> RunOrder { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
RunOrder determines the relative order in which multiple Actions in the same Stage execute.
Default: 1
See: https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html
TemplatePath
The path to the cloudformation artifact.
public ArtifactPath_ TemplatePath { get; set; }
Property Value
VariablesNamespace
The name of the namespace to use for variables emitted by this action.
public string VariablesNamespace { get; set; }
Property Value
System.String
Remarks
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