class ProductStack (construct)
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Servicecatalog.ProductStack |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsservicecatalog#ProductStack |
![]() | software.amazon.awscdk.services.servicecatalog.ProductStack |
![]() | aws_cdk.aws_servicecatalog.ProductStack |
![]() | aws-cdk-lib » aws_servicecatalog » ProductStack |
Implements
IConstruct
, IDependable
, ITaggable
A Service Catalog product stack, which is similar in form to a Cloudformation nested stack.
You can add the resources to this stack that you want to define for your service catalog product.
This stack will not be treated as an independent deployment artifact (won't be listed in "cdk list" or deployable through "cdk deploy"), but rather only synthesized as a template and uploaded as an asset to S3.
Example
class S3BucketProduct extends servicecatalog.ProductStack {
constructor(scope: Construct, id: string) {
super(scope, id);
new s3.Bucket(this, 'BucketProductV2');
}
}
const productStackHistory = new servicecatalog.ProductStackHistory(this, 'ProductStackHistory', {
productStack: new S3BucketProduct(this, 'S3BucketProduct'),
currentVersionName: 'v2',
currentVersionLocked: true
});
const product = new servicecatalog.CloudFormationProduct(this, 'MyFirstProduct', {
productName: "My Product",
owner: "Product Owner",
productVersions: [
productStackHistory.currentVersion(),
productStackHistory.versionFromSnapshot('v1')
],
});
Initializer
new ProductStack(scope: Construct, id: string, props?: ProductStackProps)
Parameters
- scope
Construct
- id
string
- props
Product
Stack Props
Construct Props
Name | Type | Description |
---|---|---|
asset | IBucket | A Bucket can be passed to store assets, enabling ProductStack Asset support. |
memory | number | The amount of memory (in MiB) to allocate to the AWS Lambda function which replicates the files from the CDK bucket to the destination bucket. |
server | Server | A ServerSideEncryption can be enabled to encrypt assets that are put into assetBucket. |
server | string | For AWS_KMS ServerSideEncryption a KMS KeyId must be provided which will be used to encrypt assets. |
assetBucket?
Type:
IBucket
(optional, default: No Bucket provided and Assets will not be supported.)
A Bucket can be passed to store assets, enabling ProductStack Asset support.
memoryLimit?
Type:
number
(optional, default: 128)
The amount of memory (in MiB) to allocate to the AWS Lambda function which replicates the files from the CDK bucket to the destination bucket.
If you are deploying large files, you will need to increase this number accordingly.
serverSideEncryption?
Type:
Server
(optional, default: No encryption is used)
A ServerSideEncryption can be enabled to encrypt assets that are put into assetBucket.
serverSideEncryptionAwsKmsKeyId?
Type:
string
(optional, default: No KMS KeyId and SSE_KMS encryption cannot be used)
For AWS_KMS ServerSideEncryption a KMS KeyId must be provided which will be used to encrypt assets.
Properties
Name | Type | Description |
---|---|---|
account | string | The AWS account into which this stack will be deployed. |
artifact | string | The ID of the cloud assembly artifact for this stack. |
availability | string[] | Returns the list of AZs that are available in the AWS environment (account/region) associated with this stack. |
bundling | boolean | Indicates whether the stack requires bundling or not. |
dependencies | Stack [] | Return the stacks this stack depends on. |
environment | string | The environment coordinates in which this stack is deployed. |
nested | boolean | Indicates if this is a nested stack, in which case parentStack will include a reference to it's parent. |
node | Node | The tree node. |
notification | string[] | Returns the list of notification Amazon Resource Names (ARNs) for the current stack. |
partition | string | The partition in which this stack is defined. |
region | string | The AWS region into which this stack will be deployed (e.g. us-west-2 ). |
stack | string | The ID of the stack. |
stack | string | The concrete CloudFormation physical stack name. |
synthesizer | IStack | Synthesis method for this stack. |
tags | Tag | Tags to be applied to the stack. |
template | string | The name of the CloudFormation template file emitted to the output directory during synthesis. |
template | ITemplate | Options for CloudFormation template (like version, transform, description). |
termination | boolean | Whether termination protection is enabled for this stack. |
url | string | The Amazon domain suffix for the region in which this stack is defined. |
nested | Stack | If this is a nested stack, returns it's parent stack. |
nested | Cfn | If this is a nested stack, this represents its AWS::CloudFormation::Stack resource. |
account
Type:
string
The AWS account into which this stack will be deployed.
This value is resolved according to the following rules:
- The value provided to
env.account
when the stack is defined. This can either be a concrete account (e.g.585695031111
) or theAws.ACCOUNT_ID
token. Aws.ACCOUNT_ID
, which represents the CloudFormation intrinsic reference{ "Ref": "AWS::AccountId" }
encoded as a string token.
Preferably, you should use the return value as an opaque string and not
attempt to parse it to implement your logic. If you do, you must first
check that it is a concrete value an not an unresolved token. If this
value is an unresolved token (Token.isUnresolved(stack.account)
returns
true
), this implies that the user wishes that this stack will synthesize
into a account-agnostic template. In this case, your code should either
fail (throw an error, emit a synth error using Annotations.of(construct).addError()
) or
implement some other region-agnostic behavior.
artifactId
Type:
string
The ID of the cloud assembly artifact for this stack.
availabilityZones
Type:
string[]
Returns the list of AZs that are available in the AWS environment (account/region) associated with this stack.
If the stack is environment-agnostic (either account and/or region are
tokens), this property will return an array with 2 tokens that will resolve
at deploy-time to the first two availability zones returned from CloudFormation's
Fn::GetAZs
intrinsic function.
If they are not available in the context, returns a set of dummy values and
reports them as missing, and let the CLI resolve them by calling EC2
DescribeAvailabilityZones
on the target environment.
To specify a different strategy for selecting availability zones override this method.
bundlingRequired
Type:
boolean
Indicates whether the stack requires bundling or not.
dependencies
Type:
Stack
[]
Return the stacks this stack depends on.
environment
Type:
string
The environment coordinates in which this stack is deployed.
In the form
aws://account/region
. Use stack.account
and stack.region
to obtain
the specific values, no need to parse.
You can use this value to determine if two stacks are targeting the same environment.
If either stack.account
or stack.region
are not concrete values (e.g.
Aws.ACCOUNT_ID
or Aws.REGION
) the special strings unknown-account
and/or
unknown-region
will be used respectively to indicate this stack is
region/account-agnostic.
nested
Type:
boolean
Indicates if this is a nested stack, in which case parentStack
will include a reference to it's parent.
node
Type:
Node
The tree node.
notificationArns
Type:
string[]
Returns the list of notification Amazon Resource Names (ARNs) for the current stack.
partition
Type:
string
The partition in which this stack is defined.
region
Type:
string
The AWS region into which this stack will be deployed (e.g. us-west-2
).
This value is resolved according to the following rules:
- The value provided to
env.region
when the stack is defined. This can either be a concrete region (e.g.us-west-2
) or theAws.REGION
token. Aws.REGION
, which is represents the CloudFormation intrinsic reference{ "Ref": "AWS::Region" }
encoded as a string token.
Preferably, you should use the return value as an opaque string and not
attempt to parse it to implement your logic. If you do, you must first
check that it is a concrete value an not an unresolved token. If this
value is an unresolved token (Token.isUnresolved(stack.region)
returns
true
), this implies that the user wishes that this stack will synthesize
into a region-agnostic template. In this case, your code should either
fail (throw an error, emit a synth error using Annotations.of(construct).addError()
) or
implement some other region-agnostic behavior.
stackId
Type:
string
The ID of the stack. Example
// After resolving, looks like
'arn:aws:cloudformation:us-west-2:123456789012:stack/teststack/51af3dc0-da77-11e4-872e-1234567db123'
stackName
Type:
string
The concrete CloudFormation physical stack name.
This is either the name defined explicitly in the stackName
prop or
allocated based on the stack's location in the construct tree. Stacks that
are directly defined under the app use their construct id
as their stack
name. Stacks that are defined deeper within the tree will use a hashed naming
scheme based on the construct path to ensure uniqueness.
If you wish to obtain the deploy-time AWS::StackName intrinsic,
you can use Aws.STACK_NAME
directly.
synthesizer
Type:
IStack
Synthesis method for this stack.
tags
Type:
Tag
Tags to be applied to the stack.
templateFile
Type:
string
The name of the CloudFormation template file emitted to the output directory during synthesis.
Example value: MyStack.template.json
templateOptions
Type:
ITemplate
Options for CloudFormation template (like version, transform, description).
terminationProtection
Type:
boolean
Whether termination protection is enabled for this stack.
urlSuffix
Type:
string
The Amazon domain suffix for the region in which this stack is defined.
nestedStackParent?
Type:
Stack
(optional)
If this is a nested stack, returns it's parent stack.
nestedStackResource?
Type:
Cfn
(optional)
If this is a nested stack, this represents its AWS::CloudFormation::Stack
resource.
undefined
for top-level (non-nested) stacks.
Methods
Name | Description |
---|---|
add | Add a dependency between this stack and another stack. |
add | Adds an arbitary key-value pair, with information you want to record about the stack. |
add | Add a Transform to this stack. A Transform is a macro that AWS CloudFormation uses to process your template. |
export | Create a CloudFormation Export for a string list value. |
export | Create a CloudFormation Export for a string value. |
format | Creates an ARN from components. |
get | Allocates a stack-unique CloudFormation-compatible logical identity for a specific resource. |
regional | Look up a fact value for the given fact for the region of this stack. |
rename | Rename a generated logical identities. |
report | Indicate that a context key was expected. |
resolve(obj) | Resolve a tokenized value in the context of the current stack. |
split | Splits the provided ARN into its components. |
to | Convert an object, potentially containing tokens, to a JSON string. |
to | Returns a string representation of this construct. |
to | Convert an object, potentially containing tokens, to a YAML string. |
Dependency(target, reason?)
addpublic addDependency(target: Stack, reason?: string): void
Parameters
- target
Stack
- reason
string
Add a dependency between this stack and another stack.
This can be used to define dependencies between any two stacks within an app, and also supports nested stacks.
Metadata(key, value)
addpublic addMetadata(key: string, value: any): void
Parameters
- key
string
- value
any
Adds an arbitary key-value pair, with information you want to record about the stack.
These get translated to the Metadata section of the generated template.
See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Transform(transform)
addpublic addTransform(transform: string): void
Parameters
- transform
string
— The transform to add.
Add a Transform to this stack. A Transform is a macro that AWS CloudFormation uses to process your template.
Duplicate values are removed when stack is synthesized.
See also: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-section-structure.html Example
declare const stack: Stack;
stack.addTransform('AWS::Serverless-2016-10-31')
StringListValue(exportedValue, options?)
exportpublic exportStringListValue(exportedValue: any, options?: ExportValueOptions): string[]
Parameters
- exportedValue
any
- options
Export
Value Options
Returns
string[]
Create a CloudFormation Export for a string list value.
Returns a string list representing the corresponding Fn.importValue()
expression for this Export. The export expression is automatically wrapped with an
Fn::Join
and the import value with an Fn::Split
, since CloudFormation can only
export strings. You can control the name for the export by passing the name
option.
If you don't supply a value for name
, the value you're exporting must be
a Resource attribute (for example: bucket.bucketName
) and it will be
given the same name as the automatic cross-stack reference that would be created
if you used the attribute in another Stack.
One of the uses for this method is to remove the relationship between two Stacks established by automatic cross-stack references. It will temporarily ensure that the CloudFormation Export still exists while you remove the reference from the consuming stack. After that, you can remove the resource and the manual export.
See exportValue
for an example of this process.
Value(exportedValue, options?)
exportpublic exportValue(exportedValue: any, options?: ExportValueOptions): string
Parameters
- exportedValue
any
- options
Export
Value Options
Returns
string
Create a CloudFormation Export for a string value.
Returns a string representing the corresponding Fn.importValue()
expression for this Export. You can control the name for the export by
passing the name
option.
If you don't supply a value for name
, the value you're exporting must be
a Resource attribute (for example: bucket.bucketName
) and it will be
given the same name as the automatic cross-stack reference that would be created
if you used the attribute in another Stack.
One of the uses for this method is to remove the relationship between two Stacks established by automatic cross-stack references. It will temporarily ensure that the CloudFormation Export still exists while you remove the reference from the consuming stack. After that, you can remove the resource and the manual export.
Here is how the process works. Let's say there are two stacks,
producerStack
and consumerStack
, and producerStack
has a bucket
called bucket
, which is referenced by consumerStack
(perhaps because
an AWS Lambda Function writes into it, or something like that).
It is not safe to remove producerStack.bucket
because as the bucket is being
deleted, consumerStack
might still be using it.
Instead, the process takes two deployments:
Deployment 1: break the relationship:
- Make sure
consumerStack
no longer referencesbucket.bucketName
(maybe the consumer stack now uses its own bucket, or it writes to an AWS DynamoDB table, or maybe you just remove the Lambda Function altogether). - In the
ProducerStack
class, callthis.exportValue(this.bucket.bucketName)
. This will make sure the CloudFormation Export continues to exist while the relationship between the two stacks is being broken. - Deploy (this will effectively only change the
consumerStack
, but it's safe to deploy both).
Deployment 2: remove the bucket resource:
- You are now free to remove the
bucket
resource fromproducerStack
. - Don't forget to remove the
exportValue()
call as well. - Deploy again (this time only the
producerStack
will be changed -- the bucket will be deleted).
Arn(components)
formatpublic formatArn(components: ArnComponents): string
Parameters
- components
Arn
Components
Returns
string
Creates an ARN from components.
If partition
, region
or account
are not specified, the stack's
partition, region and account will be used.
If any component is the empty string, an empty string will be inserted into the generated ARN at the location that component corresponds to.
The ARN will be formatted as follows:
arn:{partition}:{service}:{region}:{account}:{resource}{sep}{resource-name}
The required ARN pieces that are omitted will be taken from the stack that the 'scope' is attached to. If all ARN pieces are supplied, the supplied scope can be 'undefined'.
LogicalId(element)
getpublic getLogicalId(element: CfnElement): string
Parameters
- element
Cfn
— The CloudFormation element for which a logical identity is needed.Element
Returns
string
Allocates a stack-unique CloudFormation-compatible logical identity for a specific resource.
This method is called when a CfnElement
is created and used to render the
initial logical identity of resources. Logical ID renames are applied at
this stage.
This method uses the protected method allocateLogicalId
to render the
logical ID for an element. To modify the naming scheme, extend the Stack
class and override this method.
Fact(factName, defaultValue?)
regionalpublic regionalFact(factName: string, defaultValue?: string): string
Parameters
- factName
string
- defaultValue
string
Returns
string
Look up a fact value for the given fact for the region of this stack.
Will return a definite value only if the region of the current stack is resolved. If not, a lookup map will be added to the stack and the lookup will be done at CDK deployment time.
What regions will be included in the lookup map is controlled by the
@aws-cdk/core:target-partitions
context value: it must be set to a list
of partitions, and only regions from the given partitions will be included.
If no such context key is set, all regions will be included.
This function is intended to be used by construct library authors. Application builders can rely on the abstractions offered by construct libraries and do not have to worry about regional facts.
If defaultValue
is not given, it is an error if the fact is unknown for
the given region.
LogicalId(oldId, newId)
renamepublic renameLogicalId(oldId: string, newId: string): void
Parameters
- oldId
string
- newId
string
Rename a generated logical identities.
To modify the naming scheme strategy, extend the Stack
class and
override the allocateLogicalId
method.
MissingContextKey(report)
reportpublic reportMissingContextKey(report: MissingContext): void
Parameters
- report
Missing
— The set of parameters needed to obtain the context.Context
Indicate that a context key was expected.
Contains instructions which will be emitted into the cloud assembly on how the key should be supplied.
resolve(obj)
public resolve(obj: any): any
Parameters
- obj
any
Returns
any
Resolve a tokenized value in the context of the current stack.
Arn(arn, arnFormat)
splitpublic splitArn(arn: string, arnFormat: ArnFormat): ArnComponents
Parameters
- arn
string
— the ARN to split into its components. - arnFormat
Arn
— the expected format of 'arn' - depends on what format the service 'arn' represents uses.Format
Returns
Splits the provided ARN into its components.
Works both if 'arn' is a string like 'arn:aws:s3:::bucket', and a Token representing a dynamic CloudFormation expression (in which case the returned components will also be dynamic CloudFormation expressions, encoded as Tokens).
JsonString(obj, space?)
topublic toJsonString(obj: any, space?: number): string
Parameters
- obj
any
- space
number
Returns
string
Convert an object, potentially containing tokens, to a JSON string.
String()
topublic toString(): string
Returns
string
Returns a string representation of this construct.
YamlString(obj)
topublic toYamlString(obj: any): string
Parameters
- obj
any
Returns
string
Convert an object, potentially containing tokens, to a YAML string.