Class StackDeploymentProps
Properties for a StackDeployment
.
Inheritance
Implements
Namespace: Amazon.CDK.Pipelines
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class StackDeploymentProps : Object, IStackDeploymentProps
Syntax (vb)
Public Class StackDeploymentProps
Inherits Object
Implements IStackDeploymentProps
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.Pipelines;
var stackDeploymentProps = new StackDeploymentProps {
AbsoluteTemplatePath = "absoluteTemplatePath",
ConstructPath = "constructPath",
StackArtifactId = "stackArtifactId",
StackName = "stackName",
// the properties below are optional
Account = "account",
Assets = new [] { new StackAsset {
AssetId = "assetId",
AssetManifestPath = "assetManifestPath",
AssetSelector = "assetSelector",
AssetType = AssetType.FILE,
IsTemplate = false,
// the properties below are optional
AssetPublishingRoleArn = "assetPublishingRoleArn"
} },
AssumeRoleArn = "assumeRoleArn",
ExecutionRoleArn = "executionRoleArn",
Region = "region",
Tags = new Dictionary<string, string> {
{ "tagsKey", "tags" }
},
TemplateS3Uri = "templateS3Uri"
};
Synopsis
Constructors
StackDeploymentProps() |
Properties
AbsoluteTemplatePath | Template path on disk to cloud assembly (cdk.out). |
Account | Account where the stack should be deployed. |
Assets | Assets referenced by this stack. |
AssumeRoleArn | Role to assume before deploying this stack. |
ConstructPath | Construct path for this stack. |
ExecutionRoleArn | Execution role to pass to CloudFormation. |
Region | Region where the stack should be deployed. |
StackArtifactId | Artifact ID for this stack. |
StackName | Name for this stack. |
Tags | Tags to apply to the stack. |
TemplateS3Uri | The S3 URL which points to the template asset location in the publishing bucket. |
Constructors
StackDeploymentProps()
public StackDeploymentProps()
Properties
AbsoluteTemplatePath
Template path on disk to cloud assembly (cdk.out).
public string AbsoluteTemplatePath { get; set; }
Property Value
System.String
Account
Account where the stack should be deployed.
public string Account { get; set; }
Property Value
System.String
Remarks
Default: - Pipeline account
Assets
Assets referenced by this stack.
public IStackAsset[] Assets { get; set; }
Property Value
Remarks
Default: - No assets
AssumeRoleArn
Role to assume before deploying this stack.
public string AssumeRoleArn { get; set; }
Property Value
System.String
Remarks
Default: - Don't assume any role
ConstructPath
Construct path for this stack.
public string ConstructPath { get; set; }
Property Value
System.String
ExecutionRoleArn
Execution role to pass to CloudFormation.
public string ExecutionRoleArn { get; set; }
Property Value
System.String
Remarks
Default: - No execution role
Region
Region where the stack should be deployed.
public string Region { get; set; }
Property Value
System.String
Remarks
Default: - Pipeline region
StackArtifactId
Artifact ID for this stack.
public string StackArtifactId { get; set; }
Property Value
System.String
StackName
Name for this stack.
public string StackName { get; set; }
Property Value
System.String
Tags
Tags to apply to the stack.
public IDictionary<string, string> Tags { get; set; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.String>
Remarks
Default: - No tags
TemplateS3Uri
The S3 URL which points to the template asset location in the publishing bucket.
public string TemplateS3Uri { get; set; }
Property Value
System.String
Remarks
Default: - Stack template is not published