Show / Hide Table of Contents

Interface IBindableDeploymentConfig

A DeploymentConfig that can specialize itself based on the target group it will be used for.

Inherited Members
IDeploymentConfigRef.DeploymentConfigRef
IEnvironmentAware.Env
Namespace: Amazon.CDK.AWS.CodeDeploy
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IBindableDeploymentConfig : IDeploymentConfigRef, IConstruct, IDependable, IEnvironmentAware
Syntax (vb)
Public Interface IBindableDeploymentConfig Inherits IDeploymentConfigRef, IConstruct, IDependable, IEnvironmentAware
Remarks

For example, this is used for AWS-managed deployment configs: these are already present in every region, but we need a region-specific ARN to reference them. Since we might use them in conjunction with cross-region DeploymentGroups, we need to specialize the account and region to the DeploymentGroup before using.

A DeploymentGroup must call bindEnvironment() first if it detects this type, before reading the DeploymentConfig ARN.

Synopsis

Methods

BindEnvironment(IDeploymentGroupRef)

Bind the predefined deployment config to the environment of the given resource.

Methods

BindEnvironment(IDeploymentGroupRef)

Bind the predefined deployment config to the environment of the given resource.

IDeploymentConfigRef BindEnvironment(IDeploymentGroupRef deploymentGroup)
Parameters
deploymentGroup IDeploymentGroupRef
Returns

IDeploymentConfigRef

Remarks

For example, this is used for AWS-managed deployment configs: these are already present in every region, but we need a region-specific ARN to reference them. Since we might use them in conjunction with cross-region DeploymentGroups, we need to specialize the account and region to the DeploymentGroup before using.

A DeploymentGroup must call bindEnvironment() first if it detects this type, before reading the DeploymentConfig ARN.

Back to top Generated by DocFX