software.amazon.awscdk.services.codepipeline.actions

Class ServiceCatalogDeployActionBeta1.Builder

java.lang.Object

software.amazon.awscdk.services.codepipeline.actions.ServiceCatalogDeployActionBeta1.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ServiceCatalogDeployActionBeta1>

Enclosing class:

ServiceCatalogDeployActionBeta1

@Stability(value=Stable)
public static final class ServiceCatalogDeployActionBeta1.Builder
extends Object
implements software.amazon.jsii.Builder<ServiceCatalogDeployActionBeta1>

A fluent builder for ServiceCatalogDeployActionBeta1.

Method Summary

Modifier and Type	Method and Description
ServiceCatalogDeployActionBeta1.Builder	actionName(String actionName) The physical, human-readable name of the Action.
ServiceCatalogDeployActionBeta1	build()
static ServiceCatalogDeployActionBeta1.Builder	create()
ServiceCatalogDeployActionBeta1.Builder	productId(String productId) The identifier of the product in the Service Catalog.
ServiceCatalogDeployActionBeta1.Builder	productVersionDescription(String productVersionDescription) The optional description of this version of the Service Catalog product.
ServiceCatalogDeployActionBeta1.Builder	productVersionName(String productVersionName) The name of the version of the Service Catalog product to be deployed.
ServiceCatalogDeployActionBeta1.Builder	role(IRole role) The Role in which context's this Action will be executing in.
ServiceCatalogDeployActionBeta1.Builder	runOrder(Number runOrder) The runOrder property for this Action.
ServiceCatalogDeployActionBeta1.Builder	templatePath(ArtifactPath templatePath) The path to the cloudformation artifact.
ServiceCatalogDeployActionBeta1.Builder	variablesNamespace(String variablesNamespace) The name of the namespace to use for variables emitted by this action.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Stable)
public static ServiceCatalogDeployActionBeta1.Builder create()

Returns:

a new instance of ServiceCatalogDeployActionBeta1.Builder.

actionName

@Stability(value=Stable)
public ServiceCatalogDeployActionBeta1.Builder actionName(String actionName)

The physical, human-readable name of the Action.

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

Parameters:

actionName - The physical, human-readable name of the Action. This parameter is required.

Returns:

this

runOrder

@Stability(value=Stable)
public ServiceCatalogDeployActionBeta1.Builder runOrder(Number runOrder)

The runOrder property for this Action.

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

Default: 1

Parameters:

runOrder - The runOrder property for this Action. This parameter is required.

Returns:

this

See Also:

https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html

variablesNamespace

@Stability(value=Stable)
public ServiceCatalogDeployActionBeta1.Builder variablesNamespace(String variablesNamespace)

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

Parameters:

variablesNamespace - The name of the namespace to use for variables emitted by this action. This parameter is required.

Returns:

this

role

@Stability(value=Stable)
public ServiceCatalogDeployActionBeta1.Builder role(IRole role)

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 {@link IAction.bind} method in the {@link ActionBindOptions.role} property.

Default: a new Role will be generated

Parameters:

role - The Role in which context's this Action will be executing in. This parameter is required.

Returns:

this

productId

@Stability(value=Stable)
public ServiceCatalogDeployActionBeta1.Builder productId(String productId)

The identifier of the product in the Service Catalog.

This product must already exist.

Parameters:

productId - The identifier of the product in the Service Catalog. This parameter is required.

Returns:

this

productVersionName

@Stability(value=Stable)
public ServiceCatalogDeployActionBeta1.Builder productVersionName(String productVersionName)

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

Parameters:

productVersionName - The name of the version of the Service Catalog product to be deployed. This parameter is required.

Returns:

this

templatePath

@Stability(value=Stable)
public ServiceCatalogDeployActionBeta1.Builder templatePath(ArtifactPath templatePath)

The path to the cloudformation artifact.

Parameters:

templatePath - The path to the cloudformation artifact. This parameter is required.

Returns:

this

productVersionDescription

@Stability(value=Stable)
public ServiceCatalogDeployActionBeta1.Builder productVersionDescription(String productVersionDescription)

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

Default: ''

Parameters:

productVersionDescription - The optional description of this version of the Service Catalog product. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public ServiceCatalogDeployActionBeta1 build()

Specified by:

build in interface software.amazon.jsii.Builder<ServiceCatalogDeployActionBeta1>