Class ProductStackHistoryProps

Properties for a ProductStackHistory.

Inheritance

object

ProductStackHistoryProps

Implements

IProductStackHistoryProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.Servicecatalog

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class ProductStackHistoryProps : IProductStackHistoryProps

Syntax (vb)

Public Class ProductStackHistoryProps Implements IProductStackHistoryProps

Remarks

ExampleMetadata: infused

Examples

class S3BucketProduct : ProductStack
            {
                public S3BucketProduct(Construct scope, string id) : base(scope, id)
                {

                    new Bucket(this, "BucketProductV2");
                }
            }

            var productStackHistory = new ProductStackHistory(this, "ProductStackHistory", new ProductStackHistoryProps {
                ProductStack = new S3BucketProduct(this, "S3BucketProduct"),
                CurrentVersionName = "v2",
                CurrentVersionLocked = true
            });

            var product = new CloudFormationProduct(this, "MyFirstProduct", new CloudFormationProductProps {
                ProductName = "My Product",
                Owner = "Product Owner",
                ProductVersions = new [] { productStackHistory.CurrentVersion() }
            });

Synopsis

Constructors

ProductStackHistoryProps()

Properties for a ProductStackHistory.

Properties

CurrentVersionLocked	If this is set to true, the ProductStack will not be overwritten if a snapshot is found for the currentVersionName.
CurrentVersionName	The current version name of the ProductStack.
Description	The description of the product version.
Directory	The directory where template snapshots will be stored.
ProductStack	The ProductStack whose history will be retained as a snapshot.
ValidateTemplate	Whether the specified product template will be validated by CloudFormation.

Constructors

ProductStackHistoryProps()

Properties for a ProductStackHistory.

public ProductStackHistoryProps()

Remarks

ExampleMetadata: infused

Examples

class S3BucketProduct : ProductStack
            {
                public S3BucketProduct(Construct scope, string id) : base(scope, id)
                {

                    new Bucket(this, "BucketProductV2");
                }
            }

            var productStackHistory = new ProductStackHistory(this, "ProductStackHistory", new ProductStackHistoryProps {
                ProductStack = new S3BucketProduct(this, "S3BucketProduct"),
                CurrentVersionName = "v2",
                CurrentVersionLocked = true
            });

            var product = new CloudFormationProduct(this, "MyFirstProduct", new CloudFormationProductProps {
                ProductName = "My Product",
                Owner = "Product Owner",
                ProductVersions = new [] { productStackHistory.CurrentVersion() }
            });

Properties

CurrentVersionLocked

If this is set to true, the ProductStack will not be overwritten if a snapshot is found for the currentVersionName.

public bool CurrentVersionLocked { get; set; }

Property Value

bool

Remarks

ExampleMetadata: infused

CurrentVersionName

The current version name of the ProductStack.

public string CurrentVersionName { get; set; }

Property Value

string

Remarks

ExampleMetadata: infused

Description

The description of the product version.

public string? Description { get; set; }

Property Value

string

Remarks

Default: - No description provided

Directory

The directory where template snapshots will be stored.

public string? Directory { get; set; }

Property Value

string

Remarks

Default: 'product-stack-snapshots'

ProductStack

The ProductStack whose history will be retained as a snapshot.

public ProductStack ProductStack { get; set; }

Property Value

ProductStack

Remarks

ExampleMetadata: infused

ValidateTemplate

Whether the specified product template will be validated by CloudFormation.

public bool? ValidateTemplate { get; set; }

Property Value

bool?

Remarks

If turned off, an invalid template configuration can be stored.

Default: true

Implements

IProductStackHistoryProps