Interface IDeployOptions
Options to use with cdk deploy.
Inherited Members
Namespace: Amazon.CDK.CloudAssembly.Schema
Assembly: Amazon.CDK.CloudAssembly.Schema.dll
Syntax (csharp)
public interface IDeployOptions : IDefaultCdkOptions
Syntax (vb)
Public Interface IDeployOptions
Inherits IDefaultCdkOptions
Remarks
ExampleMetadata: infused
Examples
var app = new App();
var stackUnderTest = new Stack(app, "StackUnderTest");
var stack = new Stack(app, "stack");
var testCase = new IntegTest(app, "CustomizedDeploymentWorkflow", new IntegTestProps {
TestCases = new [] { stackUnderTest },
DiffAssets = true,
StackUpdateWorkflow = true,
CdkCommandOptions = new CdkCommands {
Deploy = new DeployCommand {
Args = new DeployOptions {
RequireApproval = RequireApproval.NEVER,
Json = true
}
},
Destroy = new DestroyCommand {
Args = new DestroyOptions {
Force = true
}
}
}
});
Synopsis
Properties
ChangeSetName | Optional name to use for the CloudFormation change set. |
Ci | Whether we are on a CI system. |
Exclusively | Only perform action on the given stack. |
Execute | Whether to execute the ChangeSet Not providing |
Force | Always deploy, even if templates are identical. |
NotificationArns | ARNs of SNS topics that CloudFormation will notify with stack related events. |
OutputsFile | Path to file where stack outputs will be written after a successful deploy as JSON. |
Parameters | Additional parameters for CloudFormation at deploy time. |
RequireApproval | What kind of security changes require approval. |
ReuseAssets | Reuse the assets with the given asset IDs. |
Rollback | Rollback failed deployments. |
ToolkitStackName | Name of the toolkit stack to use/deploy. |
UsePreviousParameters | Use previous values for unspecified parameters. |
Properties
ChangeSetName
Optional name to use for the CloudFormation change set.
virtual string ChangeSetName { get; }
Property Value
System.String
Remarks
If not provided, a name will be generated automatically.
Default: - auto generate a name
Ci
Whether we are on a CI system.
virtual Nullable<bool> Ci { get; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false
Exclusively
Only perform action on the given stack.
virtual Nullable<bool> Exclusively { get; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false
Execute
Whether to execute the ChangeSet Not providing execute
parameter will result in execution of ChangeSet.
virtual Nullable<bool> Execute { get; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: true
Force
Always deploy, even if templates are identical.
virtual Nullable<bool> Force { get; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false
NotificationArns
ARNs of SNS topics that CloudFormation will notify with stack related events.
virtual string[] NotificationArns { get; }
Property Value
System.String[]
Remarks
Default: - no notifications
OutputsFile
Path to file where stack outputs will be written after a successful deploy as JSON.
virtual string OutputsFile { get; }
Property Value
System.String
Remarks
Default: - Outputs are not written to any file
Parameters
Additional parameters for CloudFormation at deploy time.
virtual IDictionary<string, string> Parameters { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.String>
Remarks
Default: {}
RequireApproval
What kind of security changes require approval.
virtual Nullable<RequireApproval> RequireApproval { get; }
Property Value
System.Nullable<RequireApproval>
Remarks
Default: RequireApproval.Never
ReuseAssets
Reuse the assets with the given asset IDs.
virtual string[] ReuseAssets { get; }
Property Value
System.String[]
Remarks
Default: - do not reuse assets
Rollback
Rollback failed deployments.
virtual Nullable<bool> Rollback { get; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: true
ToolkitStackName
Name of the toolkit stack to use/deploy.
virtual string ToolkitStackName { get; }
Property Value
System.String
Remarks
Default: CDKToolkit
UsePreviousParameters
Use previous values for unspecified parameters.
virtual Nullable<bool> UsePreviousParameters { get; }
Property Value
System.Nullable<System.Boolean>
Remarks
If not set, all parameters must be specified for every deployment.
Default: true