${e}
`:""}var ct=["button","checkbox","file","hidden","image","radio","range","reset","submit"];function ut(){let t=document.activeElement;return t?t.isContentEditable||t.tagName==="TEXTAREA"||t.tagName==="SEARCH"?!0:t.tagName==="INPUT"&&!ct.includes(t.type):!1}var D="mousedown",Me="mousemove",$="mouseup",ne={x:0,y:0},Qe=!1,ce=!1,dt=!1,F=!1,Oe=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(Oe?"is-mobile":"not-mobile");Oe&&"ontouchstart"in document.documentElement&&(dt=!0,D="touchstart",Me="touchmove",$="touchend");document.addEventListener(D,t=>{ce=!0,F=!1;let e=D=="touchstart"?t.targetTouches[0]:t;ne.y=e.pageY||0,ne.x=e.pageX||0});document.addEventListener(Me,t=>{if(ce&&!F){let e=D=="touchstart"?t.targetTouches[0]:t,n=ne.x-(e.pageX||0),r=ne.y-(e.pageY||0);F=Math.sqrt(n*n+r*r)>10}});document.addEventListener($,()=>{ce=!1});document.addEventListener("click",t=>{Qe&&(t.preventDefault(),t.stopImmediatePropagation(),Qe=!1)});var re=class extends I{active;className;constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener($,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(D,n=>this.onDocumentPointerDown(n)),document.addEventListener($,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){F||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!F&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var ue=new Map,de=class{open;accordions=[];key;constructor(e,n){this.key=e,this.open=n}add(e){this.accordions.push(e),e.open=this.open,e.addEventListener("toggle",()=>{this.toggle(e.open)})}toggle(e){for(let n of this.accordions)n.open=e;S.setItem(this.key,e.toString())}},ie=class extends I{constructor(e){super(e);let n=this.el.querySelector("summary"),r=n.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)});let i=`tsd-accordion-${n.dataset.key??n.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`,s;if(ue.has(i))s=ue.get(i);else{let o=S.getItem(i),a=o?o==="true":this.el.open;s=new de(i,a),ue.set(i,s)}s.add(this.el)}};function He(t){let e=S.getItem("tsd-theme")||"os";t.value=e,Ae(e),t.addEventListener("change",()=>{S.setItem("tsd-theme",t.value),Ae(t.value)})}function Ae(t){document.documentElement.dataset.theme=t}var se;function Ne(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",Re),Re())}async function Re(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let e=await R(window.navigationData);se=document.documentElement.dataset.base,se.endsWith("/")||(se+="/"),t.innerHTML="";for(let n of e)Be(n,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function Be(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-accordion`:"tsd-accordion";let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.dataset.key=i.join("$"),o.innerHTML='',De(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let c=a.appendChild(document.createElement("ul"));c.className="tsd-nested-navigation";for(let l of t.children)Be(l,c,i)}else De(t,r,t.class)}function De(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));if(r.href=se+t.path,n&&(r.className=n),location.pathname===r.pathname&&!r.href.includes("#")&&(r.classList.add("current"),r.ariaCurrent="page"),t.kind){let i=window.translations[`kind_${t.kind}`].replaceAll('"',""");r.innerHTML=``}r.appendChild(Fe(t.text,document.createElement("span")))}else{let r=e.appendChild(document.createElement("span")),i=window.translations.folder.replaceAll('"',""");r.innerHTML=``,r.appendChild(Fe(t.text,document.createElement("span")))}}function Fe(t,e){let n=t.split(/(?<=[^A-Z])(?=[A-Z])|(?<=[A-Z])(?=[A-Z][a-z])|(?<=[_-])(?=[^_-])/);for(let r=0;rClass EmbeddedLinuxCodeBuildProjectStack
Hierarchy
- Stack
- EmbeddedLinuxCodeBuildProjectStack
Index
Constructors
Properties
Accessors
Methods
is
Constructors
constructor
- new EmbeddedLinuxCodeBuildProjectStack(
    scope: Construct,
    id: string,
    props: EmbeddedLinuxCodeBuildProjectProps,
): EmbeddedLinuxCodeBuildProjectStackParameters
- scope: Construct
- id: string
- props: EmbeddedLinuxCodeBuildProjectProps
Returns EmbeddedLinuxCodeBuildProjectStack
Properties
Readonlytags
tags: TagManager
Tags to be applied to the stack.
+Readonlytemplate
templateOptions: ITemplateOptions
Options for CloudFormation template (like version, transform, description).
+Readonlyregion
region: 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.regionwhen 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.
Readonlyaccount
account: 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.accountwhen the stack is defined. This can +either be a concrete account (e.g.585695031111) or the +Aws.ACCOUNT_IDtoken.
+ 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 an 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 account-agnostic behavior.
Readonlyenvironment
environment: 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.
Optional Readonlynested
nestedStackResource?: CfnResource
If this is a nested stack, this represents its AWS::CloudFormation::Stack
+resource. undefined for top-level (non-nested) stacks.
Readonlytemplate
templateFile: string
The name of the CloudFormation template file emitted to the output +directory during synthesis.
+Example value: MyStack.template.json
Readonlyartifact
artifactId: string
The ID of the cloud assembly artifact for this stack.
+Readonlysynthesizer
synthesizer: IStackSynthesizer
Synthesis method for this stack
+Readonly Internal_
_versionReportingEnabled: boolean
Whether version reporting is enabled for this stack
+Controls whether the CDK Metadata resource is injected
+Readonly Internal_
_crossRegionReferences: boolean
Whether cross region references are enabled for this stack
+Optional Readonly Internal_
_notificationArns?: string[]
SNS Notification ARNs to receive stack events.
+Readonlynode
node: Node
The tree node.
+Accessors
termination
- get terminationProtection(): boolean
Whether termination protection is enabled for this stack.
+Returns boolean
- set terminationProtection(value: boolean): void
Parameters
- value: boolean
Returns void
dependencies
- get dependencies(): Stack[]
Return the stacks this stack depends on
+Returns Stack[]
stack
- get stackName(): string
The concrete CloudFormation physical stack name.
+This is either the name defined explicitly in the
+stackNameprop or +allocated based on the stack's location in the construct tree. Stacks that +are directly defined under the app use their constructidas 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_NAMEdirectly.Returns string
partition
- get partition(): string
The partition in which this stack is defined
+Returns string
url
- get urlSuffix(): string
The Amazon domain suffix for the region in which this stack is defined
+Returns string
stack
- get stackId(): string
notification
- get notificationArns(): string[]
Returns the list of notification Amazon Resource Names (ARNs) for the current stack.
+Returns string[]
nested
- get nested(): boolean
Indicates if this is a nested stack, in which case
+parentStackwill include a reference to it's parent.Returns boolean
availability
- get availabilityZones(): 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::GetAZsintrinsic 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 +
+DescribeAvailabilityZoneson the target environment.To specify a different strategy for selecting availability zones override this method.
+Returns string[]
nested
- get nestedStackParent(): undefined | Stack
If this is a nested stack, returns it's parent stack.
+Returns undefined | Stack
bundling
- get bundlingRequired(): boolean
Indicates whether the stack requires bundling or not
+Returns boolean
Methods
Staticis
Return whether the given object is a Stack.
+We do attribute detection since we can't reliably use 'instanceof'.
+Parameters
- this: void
- x: any
Returns x is Stack
Staticof
Looks up the first stack scope in which
+constructis defined. Fails if there is no stack up the tree.Parameters
- construct: IConstruct
The construct to start the search from.
+
Returns Stack
- construct: IConstruct
resolve
Resolve a tokenized value in the context of the current stack.
+Parameters
- obj: any
Returns any
to
Convert an object, potentially containing tokens, to a JSON string
+Parameters
- this: void
- obj: any
Optionalspace: number
Returns string
to
Convert an object, potentially containing tokens, to a YAML string
+Parameters
- obj: any
Returns string
report
Indicate that a context key was expected
+Contains instructions which will be emitted into the cloud assembly on how +the key should be supplied.
+Parameters
- report: MissingContext
The set of parameters needed to obtain the context
+
Returns void
- report: MissingContext
rename
Rename a generated logical identities
+To modify the naming scheme strategy, extend the
+Stackclass and +override theallocateLogicalIdmethod.Parameters
- oldId: string
- newId: string
Returns void
get
Allocates a stack-unique CloudFormation-compatible logical identity for a +specific resource.
+This method is called when a
+CfnElementis 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
+allocateLogicalIdto render the +logical ID for an element. To modify the naming scheme, extend theStack+class and override this method.Parameters
- element: CfnElement
The CloudFormation element for which a logical identity is +needed.
+
Returns string
- element: CfnElement
add
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.
+Parameters
- target: Stack
Optionalreason: string
Returns void
format
Creates an ARN from components.
+If
+partition,regionoraccountare 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'.
+Parameters
- components: ArnComponents
Returns string
split
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).
+Parameters
- arn: string
the ARN to split into its components
+ - arnFormat: ArnFormat
the expected format of 'arn' - depends on what format the service 'arn' represents uses
+
Returns ArnComponents
- arn: string
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.
+Parameters
- transform: string
The transform to add
+
Returns void
- transform: string
add
Adds an arbitrary key-value pair, with information you want to record about the stack. +These get translated to the Metadata section of the generated template.
+Parameters
- key: string
- value: any
Returns void
_
InternalCalled implicitly by the
+addDependencyhelper function in order to +realize a dependency between two top-level stacks at the assembly level.Use
+stack.addDependencyto define the dependency between any two stacks, +and take into account nested stack relationships.Parameters
- target: Stack
Optionalreason: StackDependencyReason
Returns void
_
InternalCalled implicitly by the
+obtainDependencieshelper function in order to +collect resource dependencies across two top-level stacks at the assembly level.Use
+stack.obtainDependenciesto see the dependencies between any two stacks.Parameters
- reasonFilter: StackDependencyReason
Returns Element[]
_
- _removeAssemblyDependency(
    target: Stack,
    reasonFilter?: StackDependencyReason,
): voidInternalCalled implicitly by the
+removeDependencyhelper function in order to +remove a dependency between two top-level stacks at the assembly level.Use
+stack.addDependencyto define the dependency between any two stacks, +and take into account nested stack relationships.Parameters
- target: Stack
OptionalreasonFilter: StackDependencyReason
Returns void
_
- _synthesizeTemplate(
    session: ISynthesisSession,
    lookupRoleArn?: string,
    lookupRoleExternalId?: string,
    lookupRoleAdditionalOptions?: { [key: string]: any },
): voidInternalSynthesizes the cloudformation template into a cloud assembly.
+Parameters
- session: ISynthesisSession
OptionallookupRoleArn: stringOptionallookupRoleExternalId: stringOptionallookupRoleAdditionalOptions: { [key: string]: any }
Returns void
regional
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-partitionscontext 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
+defaultValueis not given, it is an error if the fact is unknown for +the given region.Parameters
- factName: string
OptionaldefaultValue: string
Returns string
export
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 thenameoption.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, +
+producerStackandconsumerStack, andproducerStackhas a bucket +calledbucket, which is referenced byconsumerStack(perhaps because +an AWS Lambda Function writes into it, or something like that).It is not safe to remove
+producerStack.bucketbecause as the bucket is being +deleted,consumerStackmight still be using it.Instead, the process takes two deployments:
+Deployment 1: break the relationship:
+-
+
- Make sure
consumerStackno 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
ProducerStackclass, 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
bucketresource fromproducerStack.
+ - Don't forget to remove the
exportValue()call as well.
+ - Deploy again (this time only the
producerStackwill be changed -- the bucket will be deleted).
+
Parameters
- exportedValue: any
Optionaloptions: ExportValueOptions
Returns string
- Make sure
export
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::Joinand the import value with anFn::Split, since CloudFormation can only +export strings. You can control the name for the export by passing thenameoption.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
+exportValuefor an example of this process.Parameters
- exportedValue: any
Optionaloptions: ExportValueOptions
Returns string[]
Protectedallocate
Returns the naming scheme used to allocate logical IDs. By default, uses +the
+HashedAddressingSchemebut this method can be overridden to customize +this behavior.In order to make sure logical IDs are unique and stable, we hash the resource +construct tree path (i.e. toplevel/secondlevel/.../myresource) and add it as +a suffix to the path components joined without a separator (CloudFormation +IDs only allow alphanumeric characters).
+The result will be:
+<path.join('')><md5(path.join('/')> +"human" "hash"
+If the "human" part of the ID exceeds 240 characters, we simply trim it so +the total ID doesn't exceed CloudFormation's 255 character limit.
+We only take 8 characters from the md5 hash (0.000005 chance of collision).
+Special cases:
+-
+
- If the path only contains a single component (i.e. it's a top-level +resource), we won't add the hash to it. The hash is not needed for +disambiguation and also, it allows for a more straightforward migration an +existing CloudFormation template to a CDK stack without logical ID changes +(or renames). +
- For aesthetic reasons, if the last components of the path are the same
+(i.e.
L1/L2/Pipeline/Pipeline), they will be de-duplicated to make the +resulting human portion of the ID more pleasing:L1L2Pipeline<HASH>+instead ofL1L2PipelinePipeline<HASH>
+ - If a component is named "Default" it will be omitted from the path. This +allows refactoring higher level abstractions around constructs without affecting +the IDs of already deployed resources. +
- If a component is named "Resource" it will be omitted from the user-visible +path, but included in the hash. This reduces visual noise in the human readable +part of the identifier. +
Parameters
- cfnElement: CfnElement
The element for which the logical ID is allocated.
+
Returns string
Protected_
InternalValidate stack name
+CloudFormation stack names can include dashes in addition to the regular identifier +character classes, and we don't allow one of the magic markers.
+Parameters
- name: string
Returns void
Protected_
InternalReturns the CloudFormation template for this stack by traversing +the tree and invoking _toCloudFormation() on all Entity objects.
+Returns any
add
Configure a stack tag
+At deploy time, CloudFormation will automatically apply all stack tags to all resources in the stack.
+Parameters
- tagName: string
- tagValue: string
Returns void
remove
Remove a stack tag
+At deploy time, CloudFormation will automatically apply all stack tags to all resources in the stack.
+Parameters
- tagName: string
Returns void
Staticis
Checks if
+xis a construct.Use this method instead of
+instanceofto properly detectConstruct+instances, even when the construct library is symlinked.Explanation: in JavaScript, multiple copies of the
+constructslibrary on +disk are seen as independent, completely different libraries. As a +consequence, the classConstructin each copy of theconstructslibrary +is seen as a different class, and an instance of one class will not test as +instanceofthe other class.npm installwill not create installations +like this, but users may manually symlink construct libraries together or +use a monorepo tool: in those cases, multiple copies of theconstructs+library can be accidentally installed, andinstanceofwill behave +unpredictably. It is safest to avoid usinginstanceof, and using +this type-testing method instead.Parameters
- x: any
Any object
+
Returns x is Construct
true if
+xis an object created from a class which extendsConstruct.- x: any
to
Returns a string representation of this construct.
+Returns string
Class EmbeddedLinuxCodePipelineBaseImageStack
The pipeline for building the CodeBuild Image used in other pipelines. This +will produce an image for an OS based on verified Yocto hosts.
+For configuration options see BuildBaseImageCodePipelineProps.
+Hierarchy
- Stack
- EmbeddedLinuxCodePipelineBaseImageStack
Index
Constructors
Properties
Accessors
Methods
is
Constructors
constructor
- new EmbeddedLinuxCodePipelineBaseImageStack(
    scope: Construct,
    id: string,
    props: EmbeddedLinuxCodePipelineBaseImageProps,
): EmbeddedLinuxCodePipelineBaseImageStackParameters
- scope: Construct
- id: string
- props: EmbeddedLinuxCodePipelineBaseImageProps
Returns EmbeddedLinuxCodePipelineBaseImageStack
Properties
Readonlytags
tags: TagManager
Tags to be applied to the stack.
+Readonlytemplate
templateOptions: ITemplateOptions
Options for CloudFormation template (like version, transform, description).
+Readonlyregion
region: 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.regionwhen 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.
Readonlyaccount
account: 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.accountwhen the stack is defined. This can +either be a concrete account (e.g.585695031111) or the +Aws.ACCOUNT_IDtoken.
+ 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 an 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 account-agnostic behavior.
Readonlyenvironment
environment: 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.
Optional Readonlynested
nestedStackResource?: CfnResource
If this is a nested stack, this represents its AWS::CloudFormation::Stack
+resource. undefined for top-level (non-nested) stacks.
Readonlytemplate
templateFile: string
The name of the CloudFormation template file emitted to the output +directory during synthesis.
+Example value: MyStack.template.json
Readonlyartifact
artifactId: string
The ID of the cloud assembly artifact for this stack.
+Readonlysynthesizer
synthesizer: IStackSynthesizer
Synthesis method for this stack
+Readonly Internal_
_versionReportingEnabled: boolean
Whether version reporting is enabled for this stack
+Controls whether the CDK Metadata resource is injected
+Readonly Internal_
_crossRegionReferences: boolean
Whether cross region references are enabled for this stack
+Optional Readonly Internal_
_notificationArns?: string[]
SNS Notification ARNs to receive stack events.
+Readonlyecr
ecrRepository: IRepository
The ECR Repository where the image is located.
+Readonlyecr
ecrRepositoryImageTag: string
The ECR Image Tag to find the base imaged.
+Readonlynode
node: Node
The tree node.
+Accessors
termination
- get terminationProtection(): boolean
Whether termination protection is enabled for this stack.
+Returns boolean
- set terminationProtection(value: boolean): void
Parameters
- value: boolean
Returns void
dependencies
- get dependencies(): Stack[]
Return the stacks this stack depends on
+Returns Stack[]
stack
- get stackName(): string
The concrete CloudFormation physical stack name.
+This is either the name defined explicitly in the
+stackNameprop or +allocated based on the stack's location in the construct tree. Stacks that +are directly defined under the app use their constructidas 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_NAMEdirectly.Returns string
partition
- get partition(): string
The partition in which this stack is defined
+Returns string
url
- get urlSuffix(): string
The Amazon domain suffix for the region in which this stack is defined
+Returns string
stack
- get stackId(): string
notification
- get notificationArns(): string[]
Returns the list of notification Amazon Resource Names (ARNs) for the current stack.
+Returns string[]
nested
- get nested(): boolean
Indicates if this is a nested stack, in which case
+parentStackwill include a reference to it's parent.Returns boolean
availability
- get availabilityZones(): 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::GetAZsintrinsic 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 +
+DescribeAvailabilityZoneson the target environment.To specify a different strategy for selecting availability zones override this method.
+Returns string[]
nested
- get nestedStackParent(): undefined | Stack
If this is a nested stack, returns it's parent stack.
+Returns undefined | Stack
bundling
- get bundlingRequired(): boolean
Indicates whether the stack requires bundling or not
+Returns boolean
Methods
Staticis
Return whether the given object is a Stack.
+We do attribute detection since we can't reliably use 'instanceof'.
+Parameters
- this: void
- x: any
Returns x is Stack
Staticof
Looks up the first stack scope in which
+constructis defined. Fails if there is no stack up the tree.Parameters
- construct: IConstruct
The construct to start the search from.
+
Returns Stack
- construct: IConstruct
resolve
Resolve a tokenized value in the context of the current stack.
+Parameters
- obj: any
Returns any
to
Convert an object, potentially containing tokens, to a JSON string
+Parameters
- this: void
- obj: any
Optionalspace: number
Returns string
to
Convert an object, potentially containing tokens, to a YAML string
+Parameters
- obj: any
Returns string
report
Indicate that a context key was expected
+Contains instructions which will be emitted into the cloud assembly on how +the key should be supplied.
+Parameters
- report: MissingContext
The set of parameters needed to obtain the context
+
Returns void
- report: MissingContext
rename
Rename a generated logical identities
+To modify the naming scheme strategy, extend the
+Stackclass and +override theallocateLogicalIdmethod.Parameters
- oldId: string
- newId: string
Returns void
get
Allocates a stack-unique CloudFormation-compatible logical identity for a +specific resource.
+This method is called when a
+CfnElementis 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
+allocateLogicalIdto render the +logical ID for an element. To modify the naming scheme, extend theStack+class and override this method.Parameters
- element: CfnElement
The CloudFormation element for which a logical identity is +needed.
+
Returns string
- element: CfnElement
add
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.
+Parameters
- target: Stack
Optionalreason: string
Returns void
format
Creates an ARN from components.
+If
+partition,regionoraccountare 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'.
+Parameters
- components: ArnComponents
Returns string
split
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).
+Parameters
- arn: string
the ARN to split into its components
+ - arnFormat: ArnFormat
the expected format of 'arn' - depends on what format the service 'arn' represents uses
+
Returns ArnComponents
- arn: string
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.
+Parameters
- transform: string
The transform to add
+
Returns void
- transform: string
add
Adds an arbitrary key-value pair, with information you want to record about the stack. +These get translated to the Metadata section of the generated template.
+Parameters
- key: string
- value: any
Returns void
_
InternalCalled implicitly by the
+addDependencyhelper function in order to +realize a dependency between two top-level stacks at the assembly level.Use
+stack.addDependencyto define the dependency between any two stacks, +and take into account nested stack relationships.Parameters
- target: Stack
Optionalreason: StackDependencyReason
Returns void
_
InternalCalled implicitly by the
+obtainDependencieshelper function in order to +collect resource dependencies across two top-level stacks at the assembly level.Use
+stack.obtainDependenciesto see the dependencies between any two stacks.Parameters
- reasonFilter: StackDependencyReason
Returns Element[]
_
- _removeAssemblyDependency(
    target: Stack,
    reasonFilter?: StackDependencyReason,
): voidInternalCalled implicitly by the
+removeDependencyhelper function in order to +remove a dependency between two top-level stacks at the assembly level.Use
+stack.addDependencyto define the dependency between any two stacks, +and take into account nested stack relationships.Parameters
- target: Stack
OptionalreasonFilter: StackDependencyReason
Returns void
_
- _synthesizeTemplate(
    session: ISynthesisSession,
    lookupRoleArn?: string,
    lookupRoleExternalId?: string,
    lookupRoleAdditionalOptions?: { [key: string]: any },
): voidInternalSynthesizes the cloudformation template into a cloud assembly.
+Parameters
- session: ISynthesisSession
OptionallookupRoleArn: stringOptionallookupRoleExternalId: stringOptionallookupRoleAdditionalOptions: { [key: string]: any }
Returns void
regional
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-partitionscontext 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
+defaultValueis not given, it is an error if the fact is unknown for +the given region.Parameters
- factName: string
OptionaldefaultValue: string
Returns string
export
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 thenameoption.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, +
+producerStackandconsumerStack, andproducerStackhas a bucket +calledbucket, which is referenced byconsumerStack(perhaps because +an AWS Lambda Function writes into it, or something like that).It is not safe to remove
+producerStack.bucketbecause as the bucket is being +deleted,consumerStackmight still be using it.Instead, the process takes two deployments:
+Deployment 1: break the relationship:
+-
+
- Make sure
consumerStackno 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
ProducerStackclass, 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
bucketresource fromproducerStack.
+ - Don't forget to remove the
exportValue()call as well.
+ - Deploy again (this time only the
producerStackwill be changed -- the bucket will be deleted).
+
Parameters
- exportedValue: any
Optionaloptions: ExportValueOptions
Returns string
- Make sure
export
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::Joinand the import value with anFn::Split, since CloudFormation can only +export strings. You can control the name for the export by passing thenameoption.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
+exportValuefor an example of this process.Parameters
- exportedValue: any
Optionaloptions: ExportValueOptions
Returns string[]
Protectedallocate
Returns the naming scheme used to allocate logical IDs. By default, uses +the
+HashedAddressingSchemebut this method can be overridden to customize +this behavior.In order to make sure logical IDs are unique and stable, we hash the resource +construct tree path (i.e. toplevel/secondlevel/.../myresource) and add it as +a suffix to the path components joined without a separator (CloudFormation +IDs only allow alphanumeric characters).
+The result will be:
+<path.join('')><md5(path.join('/')> +"human" "hash"
+If the "human" part of the ID exceeds 240 characters, we simply trim it so +the total ID doesn't exceed CloudFormation's 255 character limit.
+We only take 8 characters from the md5 hash (0.000005 chance of collision).
+Special cases:
+-
+
- If the path only contains a single component (i.e. it's a top-level +resource), we won't add the hash to it. The hash is not needed for +disambiguation and also, it allows for a more straightforward migration an +existing CloudFormation template to a CDK stack without logical ID changes +(or renames). +
- For aesthetic reasons, if the last components of the path are the same
+(i.e.
L1/L2/Pipeline/Pipeline), they will be de-duplicated to make the +resulting human portion of the ID more pleasing:L1L2Pipeline<HASH>+instead ofL1L2PipelinePipeline<HASH>
+ - If a component is named "Default" it will be omitted from the path. This +allows refactoring higher level abstractions around constructs without affecting +the IDs of already deployed resources. +
- If a component is named "Resource" it will be omitted from the user-visible +path, but included in the hash. This reduces visual noise in the human readable +part of the identifier. +
Parameters
- cfnElement: CfnElement
The element for which the logical ID is allocated.
+
Returns string
Protected_
InternalValidate stack name
+CloudFormation stack names can include dashes in addition to the regular identifier +character classes, and we don't allow one of the magic markers.
+Parameters
- name: string
Returns void
Protected_
InternalReturns the CloudFormation template for this stack by traversing +the tree and invoking _toCloudFormation() on all Entity objects.
+Returns any
add
Configure a stack tag
+At deploy time, CloudFormation will automatically apply all stack tags to all resources in the stack.
+Parameters
- tagName: string
- tagValue: string
Returns void
remove
Remove a stack tag
+At deploy time, CloudFormation will automatically apply all stack tags to all resources in the stack.
+Parameters
- tagName: string
Returns void
Staticis
Checks if
+xis a construct.Use this method instead of
+instanceofto properly detectConstruct+instances, even when the construct library is symlinked.Explanation: in JavaScript, multiple copies of the
+constructslibrary on +disk are seen as independent, completely different libraries. As a +consequence, the classConstructin each copy of theconstructslibrary +is seen as a different class, and an instance of one class will not test as +instanceofthe other class.npm installwill not create installations +like this, but users may manually symlink construct libraries together or +use a monorepo tool: in those cases, multiple copies of theconstructs+library can be accidentally installed, andinstanceofwill behave +unpredictably. It is safest to avoid usinginstanceof, and using +this type-testing method instead.Parameters
- x: any
Any object
+
Returns x is Construct
true if
+xis an object created from a class which extendsConstruct.- x: any
to
Returns a string representation of this construct.
+Returns string
Class EmbeddedLinuxCodePipelineStack
The stack for creating a build pipeline.
+See EmbeddedLinuxCodePipelineProps for configration options.
+Hierarchy
- Stack
- EmbeddedLinuxCodePipelineStack
Index
Constructors
Properties
Accessors
Methods
is
Constructors
constructor
- new EmbeddedLinuxCodePipelineStack(
    scope: Construct,
    id: string,
    props: EmbeddedLinuxCodePipelineProps,
): EmbeddedLinuxCodePipelineStackParameters
- scope: Construct
- id: string
- props: EmbeddedLinuxCodePipelineProps
Returns EmbeddedLinuxCodePipelineStack
Properties
Readonlytags
tags: TagManager
Tags to be applied to the stack.
+Readonlytemplate
templateOptions: ITemplateOptions
Options for CloudFormation template (like version, transform, description).
+Readonlyregion
region: 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.regionwhen 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.
Readonlyaccount
account: 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.accountwhen the stack is defined. This can +either be a concrete account (e.g.585695031111) or the +Aws.ACCOUNT_IDtoken.
+ 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 an 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 account-agnostic behavior.
Readonlyenvironment
environment: 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.
Optional Readonlynested
nestedStackResource?: CfnResource
If this is a nested stack, this represents its AWS::CloudFormation::Stack
+resource. undefined for top-level (non-nested) stacks.
Readonlytemplate
templateFile: string
The name of the CloudFormation template file emitted to the output +directory during synthesis.
+Example value: MyStack.template.json
Readonlyartifact
artifactId: string
The ID of the cloud assembly artifact for this stack.
+Readonlysynthesizer
synthesizer: IStackSynthesizer
Synthesis method for this stack
+Readonly Internal_
_versionReportingEnabled: boolean
Whether version reporting is enabled for this stack
+Controls whether the CDK Metadata resource is injected
+Readonly Internal_
_crossRegionReferences: boolean
Whether cross region references are enabled for this stack
+Optional Readonly Internal_
_notificationArns?: string[]
SNS Notification ARNs to receive stack events.
+Readonlynode
node: Node
The tree node.
+Accessors
termination
- get terminationProtection(): boolean
Whether termination protection is enabled for this stack.
+Returns boolean
- set terminationProtection(value: boolean): void
Parameters
- value: boolean
Returns void
dependencies
- get dependencies(): Stack[]
Return the stacks this stack depends on
+Returns Stack[]
stack
- get stackName(): string
The concrete CloudFormation physical stack name.
+This is either the name defined explicitly in the
+stackNameprop or +allocated based on the stack's location in the construct tree. Stacks that +are directly defined under the app use their constructidas 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_NAMEdirectly.Returns string
partition
- get partition(): string
The partition in which this stack is defined
+Returns string
url
- get urlSuffix(): string
The Amazon domain suffix for the region in which this stack is defined
+Returns string
stack
- get stackId(): string
notification
- get notificationArns(): string[]
Returns the list of notification Amazon Resource Names (ARNs) for the current stack.
+Returns string[]
nested
- get nested(): boolean
Indicates if this is a nested stack, in which case
+parentStackwill include a reference to it's parent.Returns boolean
availability
- get availabilityZones(): 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::GetAZsintrinsic 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 +
+DescribeAvailabilityZoneson the target environment.To specify a different strategy for selecting availability zones override this method.
+Returns string[]
nested
- get nestedStackParent(): undefined | Stack
If this is a nested stack, returns it's parent stack.
+Returns undefined | Stack
bundling
- get bundlingRequired(): boolean
Indicates whether the stack requires bundling or not
+Returns boolean
Methods
Staticis
Return whether the given object is a Stack.
+We do attribute detection since we can't reliably use 'instanceof'.
+Parameters
- this: void
- x: any
Returns x is Stack
Staticof
Looks up the first stack scope in which
+constructis defined. Fails if there is no stack up the tree.Parameters
- construct: IConstruct
The construct to start the search from.
+
Returns Stack
- construct: IConstruct
resolve
Resolve a tokenized value in the context of the current stack.
+Parameters
- obj: any
Returns any
to
Convert an object, potentially containing tokens, to a JSON string
+Parameters
- this: void
- obj: any
Optionalspace: number
Returns string
to
Convert an object, potentially containing tokens, to a YAML string
+Parameters
- obj: any
Returns string
report
Indicate that a context key was expected
+Contains instructions which will be emitted into the cloud assembly on how +the key should be supplied.
+Parameters
- report: MissingContext
The set of parameters needed to obtain the context
+
Returns void
- report: MissingContext
rename
Rename a generated logical identities
+To modify the naming scheme strategy, extend the
+Stackclass and +override theallocateLogicalIdmethod.Parameters
- oldId: string
- newId: string
Returns void
get
Allocates a stack-unique CloudFormation-compatible logical identity for a +specific resource.
+This method is called when a
+CfnElementis 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
+allocateLogicalIdto render the +logical ID for an element. To modify the naming scheme, extend theStack+class and override this method.Parameters
- element: CfnElement
The CloudFormation element for which a logical identity is +needed.
+
Returns string
- element: CfnElement
add
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.
+Parameters
- target: Stack
Optionalreason: string
Returns void
format
Creates an ARN from components.
+If
+partition,regionoraccountare 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'.
+Parameters
- components: ArnComponents
Returns string
split
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).
+Parameters
- arn: string
the ARN to split into its components
+ - arnFormat: ArnFormat
the expected format of 'arn' - depends on what format the service 'arn' represents uses
+
Returns ArnComponents
- arn: string
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.
+Parameters
- transform: string
The transform to add
+
Returns void
- transform: string
add
Adds an arbitrary key-value pair, with information you want to record about the stack. +These get translated to the Metadata section of the generated template.
+Parameters
- key: string
- value: any
Returns void
_
InternalCalled implicitly by the
+addDependencyhelper function in order to +realize a dependency between two top-level stacks at the assembly level.Use
+stack.addDependencyto define the dependency between any two stacks, +and take into account nested stack relationships.Parameters
- target: Stack
Optionalreason: StackDependencyReason
Returns void
_
InternalCalled implicitly by the
+obtainDependencieshelper function in order to +collect resource dependencies across two top-level stacks at the assembly level.Use
+stack.obtainDependenciesto see the dependencies between any two stacks.Parameters
- reasonFilter: StackDependencyReason
Returns Element[]
_
- _removeAssemblyDependency(
    target: Stack,
    reasonFilter?: StackDependencyReason,
): voidInternalCalled implicitly by the
+removeDependencyhelper function in order to +remove a dependency between two top-level stacks at the assembly level.Use
+stack.addDependencyto define the dependency between any two stacks, +and take into account nested stack relationships.Parameters
- target: Stack
OptionalreasonFilter: StackDependencyReason
Returns void
_
- _synthesizeTemplate(
    session: ISynthesisSession,
    lookupRoleArn?: string,
    lookupRoleExternalId?: string,
    lookupRoleAdditionalOptions?: { [key: string]: any },
): voidInternalSynthesizes the cloudformation template into a cloud assembly.
+Parameters
- session: ISynthesisSession
OptionallookupRoleArn: stringOptionallookupRoleExternalId: stringOptionallookupRoleAdditionalOptions: { [key: string]: any }
Returns void
regional
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-partitionscontext 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
+defaultValueis not given, it is an error if the fact is unknown for +the given region.Parameters
- factName: string
OptionaldefaultValue: string
Returns string
export
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 thenameoption.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, +
+producerStackandconsumerStack, andproducerStackhas a bucket +calledbucket, which is referenced byconsumerStack(perhaps because +an AWS Lambda Function writes into it, or something like that).It is not safe to remove
+producerStack.bucketbecause as the bucket is being +deleted,consumerStackmight still be using it.Instead, the process takes two deployments:
+Deployment 1: break the relationship:
+-
+
- Make sure
consumerStackno 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
ProducerStackclass, 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
bucketresource fromproducerStack.
+ - Don't forget to remove the
exportValue()call as well.
+ - Deploy again (this time only the
producerStackwill be changed -- the bucket will be deleted).
+
Parameters
- exportedValue: any
Optionaloptions: ExportValueOptions
Returns string
- Make sure
export
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::Joinand the import value with anFn::Split, since CloudFormation can only +export strings. You can control the name for the export by passing thenameoption.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
+exportValuefor an example of this process.Parameters
- exportedValue: any
Optionaloptions: ExportValueOptions
Returns string[]
Protectedallocate
Returns the naming scheme used to allocate logical IDs. By default, uses +the
+HashedAddressingSchemebut this method can be overridden to customize +this behavior.In order to make sure logical IDs are unique and stable, we hash the resource +construct tree path (i.e. toplevel/secondlevel/.../myresource) and add it as +a suffix to the path components joined without a separator (CloudFormation +IDs only allow alphanumeric characters).
+The result will be:
+<path.join('')><md5(path.join('/')> +"human" "hash"
+If the "human" part of the ID exceeds 240 characters, we simply trim it so +the total ID doesn't exceed CloudFormation's 255 character limit.
+We only take 8 characters from the md5 hash (0.000005 chance of collision).
+Special cases:
+-
+
- If the path only contains a single component (i.e. it's a top-level +resource), we won't add the hash to it. The hash is not needed for +disambiguation and also, it allows for a more straightforward migration an +existing CloudFormation template to a CDK stack without logical ID changes +(or renames). +
- For aesthetic reasons, if the last components of the path are the same
+(i.e.
L1/L2/Pipeline/Pipeline), they will be de-duplicated to make the +resulting human portion of the ID more pleasing:L1L2Pipeline<HASH>+instead ofL1L2PipelinePipeline<HASH>
+ - If a component is named "Default" it will be omitted from the path. This +allows refactoring higher level abstractions around constructs without affecting +the IDs of already deployed resources. +
- If a component is named "Resource" it will be omitted from the user-visible +path, but included in the hash. This reduces visual noise in the human readable +part of the identifier. +
Parameters
- cfnElement: CfnElement
The element for which the logical ID is allocated.
+
Returns string
Protected_
InternalValidate stack name
+CloudFormation stack names can include dashes in addition to the regular identifier +character classes, and we don't allow one of the magic markers.
+Parameters
- name: string
Returns void
Protected_
InternalReturns the CloudFormation template for this stack by traversing +the tree and invoking _toCloudFormation() on all Entity objects.
+Returns any
add
Configure a stack tag
+At deploy time, CloudFormation will automatically apply all stack tags to all resources in the stack.
+Parameters
- tagName: string
- tagValue: string
Returns void
remove
Remove a stack tag
+At deploy time, CloudFormation will automatically apply all stack tags to all resources in the stack.
+Parameters
- tagName: string
Returns void
Staticis
Checks if
+xis a construct.Use this method instead of
+instanceofto properly detectConstruct+instances, even when the construct library is symlinked.Explanation: in JavaScript, multiple copies of the
+constructslibrary on +disk are seen as independent, completely different libraries. As a +consequence, the classConstructin each copy of theconstructslibrary +is seen as a different class, and an instance of one class will not test as +instanceofthe other class.npm installwill not create installations +like this, but users may manually symlink construct libraries together or +use a monorepo tool: in those cases, multiple copies of theconstructs+library can be accidentally installed, andinstanceofwill behave +unpredictably. It is safest to avoid usinginstanceof, and using +this type-testing method instead.Parameters
- x: any
Any object
+
Returns x is Construct
true if
+xis an object created from a class which extendsConstruct.- x: any
to
Returns a string representation of this construct.
+Returns string
Class PipelineResourcesStack
Input (Source) data for our PipelineResourcesStack.
+Hierarchy
- Stack
- PipelineResourcesStack
Index
Constructors
Properties
tags
+template
Accessors
Methods
is
Constructors
constructor
- new PipelineResourcesStack(
    scope: Construct,
    id: string,
    props: PipelineResourcesProps,
): PipelineResourcesStackParameters
- scope: Construct
- id: string
- props: PipelineResourcesProps
Returns PipelineResourcesStack
Properties
Readonlytags
tags: TagManager
Tags to be applied to the stack.
+Readonlytemplate
templateOptions: ITemplateOptions
Options for CloudFormation template (like version, transform, description).
+Readonlyregion
region: 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.regionwhen 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.
Readonlyaccount
account: 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.accountwhen the stack is defined. This can +either be a concrete account (e.g.585695031111) or the +Aws.ACCOUNT_IDtoken.
+ 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 an 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 account-agnostic behavior.
Readonlyenvironment
environment: 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.
Optional Readonlynested
nestedStackResource?: CfnResource
If this is a nested stack, this represents its AWS::CloudFormation::Stack
+resource. undefined for top-level (non-nested) stacks.
Readonlytemplate
templateFile: string
The name of the CloudFormation template file emitted to the output +directory during synthesis.
+Example value: MyStack.template.json
Readonlyartifact
artifactId: string
The ID of the cloud assembly artifact for this stack.
+Readonlysynthesizer
synthesizer: IStackSynthesizer
Synthesis method for this stack
+Readonly Internal_
_versionReportingEnabled: boolean
Whether version reporting is enabled for this stack
+Controls whether the CDK Metadata resource is injected
+Readonly Internal_
_crossRegionReferences: boolean
Whether cross region references are enabled for this stack
+Optional Readonly Internal_
_notificationArns?: string[]
SNS Notification ARNs to receive stack events.
+Readonlyvpc
vpc: IVpc
The VPC for the pipeline to reside in.
+Readonlyecr
ecrRepository: IRepository
The respository to put the build host container in.
+Readonlypipeline
pipelineArtifactBucket: Bucket
The artifact bucket
+Readonlypipeline
pipelineSourceBucket: Bucket
The source bucket
+Readonlypipeline
pipelineOutputBucket: Bucket
The output bucket
+Optional Readonlylogging
loggingBucket?: Bucket
The Cloudwatch logging bucket
+Readonlyencryption
encryptionKey: Key
The encryption key use across
+Readonlynode
node: Node
The tree node.
+Accessors
termination
- get terminationProtection(): boolean
Whether termination protection is enabled for this stack.
+Returns boolean
- set terminationProtection(value: boolean): void
Parameters
- value: boolean
Returns void
dependencies
- get dependencies(): Stack[]
Return the stacks this stack depends on
+Returns Stack[]
stack
- get stackName(): string
The concrete CloudFormation physical stack name.
+This is either the name defined explicitly in the
+stackNameprop or +allocated based on the stack's location in the construct tree. Stacks that +are directly defined under the app use their constructidas 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_NAMEdirectly.Returns string
partition
- get partition(): string
The partition in which this stack is defined
+Returns string
url
- get urlSuffix(): string
The Amazon domain suffix for the region in which this stack is defined
+Returns string
stack
- get stackId(): string
notification
- get notificationArns(): string[]
Returns the list of notification Amazon Resource Names (ARNs) for the current stack.
+Returns string[]
nested
- get nested(): boolean
Indicates if this is a nested stack, in which case
+parentStackwill include a reference to it's parent.Returns boolean
availability
- get availabilityZones(): 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::GetAZsintrinsic 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 +
+DescribeAvailabilityZoneson the target environment.To specify a different strategy for selecting availability zones override this method.
+Returns string[]
nested
- get nestedStackParent(): undefined | Stack
If this is a nested stack, returns it's parent stack.
+Returns undefined | Stack
bundling
- get bundlingRequired(): boolean
Indicates whether the stack requires bundling or not
+Returns boolean
Methods
Staticis
Return whether the given object is a Stack.
+We do attribute detection since we can't reliably use 'instanceof'.
+Parameters
- this: void
- x: any
Returns x is Stack
Staticof
Looks up the first stack scope in which
+constructis defined. Fails if there is no stack up the tree.Parameters
- construct: IConstruct
The construct to start the search from.
+
Returns Stack
- construct: IConstruct
resolve
Resolve a tokenized value in the context of the current stack.
+Parameters
- obj: any
Returns any
to
Convert an object, potentially containing tokens, to a JSON string
+Parameters
- this: void
- obj: any
Optionalspace: number
Returns string
to
Convert an object, potentially containing tokens, to a YAML string
+Parameters
- obj: any
Returns string
report
Indicate that a context key was expected
+Contains instructions which will be emitted into the cloud assembly on how +the key should be supplied.
+Parameters
- report: MissingContext
The set of parameters needed to obtain the context
+
Returns void
- report: MissingContext
rename
Rename a generated logical identities
+To modify the naming scheme strategy, extend the
+Stackclass and +override theallocateLogicalIdmethod.Parameters
- oldId: string
- newId: string
Returns void
get
Allocates a stack-unique CloudFormation-compatible logical identity for a +specific resource.
+This method is called when a
+CfnElementis 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
+allocateLogicalIdto render the +logical ID for an element. To modify the naming scheme, extend theStack+class and override this method.Parameters
- element: CfnElement
The CloudFormation element for which a logical identity is +needed.
+
Returns string
- element: CfnElement
add
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.
+Parameters
- target: Stack
Optionalreason: string
Returns void
format
Creates an ARN from components.
+If
+partition,regionoraccountare 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'.
+Parameters
- components: ArnComponents
Returns string
split
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).
+Parameters
- arn: string
the ARN to split into its components
+ - arnFormat: ArnFormat
the expected format of 'arn' - depends on what format the service 'arn' represents uses
+
Returns ArnComponents
- arn: string
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.
+Parameters
- transform: string
The transform to add
+
Returns void
- transform: string
add
Adds an arbitrary key-value pair, with information you want to record about the stack. +These get translated to the Metadata section of the generated template.
+Parameters
- key: string
- value: any
Returns void
_
InternalCalled implicitly by the
+addDependencyhelper function in order to +realize a dependency between two top-level stacks at the assembly level.Use
+stack.addDependencyto define the dependency between any two stacks, +and take into account nested stack relationships.Parameters
- target: Stack
Optionalreason: StackDependencyReason
Returns void
_
InternalCalled implicitly by the
+obtainDependencieshelper function in order to +collect resource dependencies across two top-level stacks at the assembly level.Use
+stack.obtainDependenciesto see the dependencies between any two stacks.Parameters
- reasonFilter: StackDependencyReason
Returns Element[]
_
- _removeAssemblyDependency(
    target: Stack,
    reasonFilter?: StackDependencyReason,
): voidInternalCalled implicitly by the
+removeDependencyhelper function in order to +remove a dependency between two top-level stacks at the assembly level.Use
+stack.addDependencyto define the dependency between any two stacks, +and take into account nested stack relationships.Parameters
- target: Stack
OptionalreasonFilter: StackDependencyReason
Returns void
_
- _synthesizeTemplate(
    session: ISynthesisSession,
    lookupRoleArn?: string,
    lookupRoleExternalId?: string,
    lookupRoleAdditionalOptions?: { [key: string]: any },
): voidInternalSynthesizes the cloudformation template into a cloud assembly.
+Parameters
- session: ISynthesisSession
OptionallookupRoleArn: stringOptionallookupRoleExternalId: stringOptionallookupRoleAdditionalOptions: { [key: string]: any }
Returns void
regional
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-partitionscontext 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
+defaultValueis not given, it is an error if the fact is unknown for +the given region.Parameters
- factName: string
OptionaldefaultValue: string
Returns string
export
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 thenameoption.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, +
+producerStackandconsumerStack, andproducerStackhas a bucket +calledbucket, which is referenced byconsumerStack(perhaps because +an AWS Lambda Function writes into it, or something like that).It is not safe to remove
+producerStack.bucketbecause as the bucket is being +deleted,consumerStackmight still be using it.Instead, the process takes two deployments:
+Deployment 1: break the relationship:
+-
+
- Make sure
consumerStackno 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
ProducerStackclass, 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
bucketresource fromproducerStack.
+ - Don't forget to remove the
exportValue()call as well.
+ - Deploy again (this time only the
producerStackwill be changed -- the bucket will be deleted).
+
Parameters
- exportedValue: any
Optionaloptions: ExportValueOptions
Returns string
- Make sure
export
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::Joinand the import value with anFn::Split, since CloudFormation can only +export strings. You can control the name for the export by passing thenameoption.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
+exportValuefor an example of this process.Parameters
- exportedValue: any
Optionaloptions: ExportValueOptions
Returns string[]
Protectedallocate
Returns the naming scheme used to allocate logical IDs. By default, uses +the
+HashedAddressingSchemebut this method can be overridden to customize +this behavior.In order to make sure logical IDs are unique and stable, we hash the resource +construct tree path (i.e. toplevel/secondlevel/.../myresource) and add it as +a suffix to the path components joined without a separator (CloudFormation +IDs only allow alphanumeric characters).
+The result will be:
+<path.join('')><md5(path.join('/')> +"human" "hash"
+If the "human" part of the ID exceeds 240 characters, we simply trim it so +the total ID doesn't exceed CloudFormation's 255 character limit.
+We only take 8 characters from the md5 hash (0.000005 chance of collision).
+Special cases:
+-
+
- If the path only contains a single component (i.e. it's a top-level +resource), we won't add the hash to it. The hash is not needed for +disambiguation and also, it allows for a more straightforward migration an +existing CloudFormation template to a CDK stack without logical ID changes +(or renames). +
- For aesthetic reasons, if the last components of the path are the same
+(i.e.
L1/L2/Pipeline/Pipeline), they will be de-duplicated to make the +resulting human portion of the ID more pleasing:L1L2Pipeline<HASH>+instead ofL1L2PipelinePipeline<HASH>
+ - If a component is named "Default" it will be omitted from the path. This +allows refactoring higher level abstractions around constructs without affecting +the IDs of already deployed resources. +
- If a component is named "Resource" it will be omitted from the user-visible +path, but included in the hash. This reduces visual noise in the human readable +part of the identifier. +
Parameters
- cfnElement: CfnElement
The element for which the logical ID is allocated.
+
Returns string
Protected_
InternalValidate stack name
+CloudFormation stack names can include dashes in addition to the regular identifier +character classes, and we don't allow one of the magic markers.
+Parameters
- name: string
Returns void
Protected_
InternalReturns the CloudFormation template for this stack by traversing +the tree and invoking _toCloudFormation() on all Entity objects.
+Returns any
add
Configure a stack tag
+At deploy time, CloudFormation will automatically apply all stack tags to all resources in the stack.
+Parameters
- tagName: string
- tagValue: string
Returns void
remove
Remove a stack tag
+At deploy time, CloudFormation will automatically apply all stack tags to all resources in the stack.
+Parameters
- tagName: string
Returns void
Staticis
Checks if
+xis a construct.Use this method instead of
+instanceofto properly detectConstruct+instances, even when the construct library is symlinked.Explanation: in JavaScript, multiple copies of the
+constructslibrary on +disk are seen as independent, completely different libraries. As a +consequence, the classConstructin each copy of theconstructslibrary +is seen as a different class, and an instance of one class will not test as +instanceofthe other class.npm installwill not create installations +like this, but users may manually symlink construct libraries together or +use a monorepo tool: in those cases, multiple copies of theconstructs+library can be accidentally installed, andinstanceofwill behave +unpredictably. It is safest to avoid usinginstanceof, and using +this type-testing method instead.Parameters
- x: any
Any object
+
Returns x is Construct
true if
+xis an object created from a class which extendsConstruct.- x: any
to
Returns a string representation of this construct.
+Returns string
Enumeration ProjectType
The type of project built.
+Enumeration Members
Poky
Poky: "poky"
Build core-image-minimal from poky.
+Q
QEmu: "qemu"
Build the Qemu meta-aws Demonstration Distribution.
+Poky
PokyAmi: "poky-ami"
Build an EC2 AMI
+Kas
Kas: "kas"
Build an kas based image
+Renesas
Renesas: "renesas"
Build an Renesas image
+Nxp
NxpImx: "nxp-imx"
Build an IMX image using NXP layers.
+Code
CodeBuild: "codebuild"
Build no pipeline, just CodeBuild project to connect with GitHub actions.
+Custom
Custom: "custom"
Build an image using a custom buildspec and asstes.
+aws4embeddedlinux-cdk-lib
Hierarchy Summary
aws4embeddedlinux-cdk-lib
aws4embeddedlinux-ci
The aws4embeddedlinux-ci library helps you deploy an AWS cloud infrastructure supporting the Embedded Linux builds for your project using AWS CDK.
Table of Contents
-
+
- Architecture +
- API documentation +
- Project Build with AWS CodePipeline +
- Project Build with AWS CodeBuild as Action Runner +
- Setup +
- Development Setup +
- Known issues +
- Security +
- Contributing +
- License +
Architecture
This is the overall architecture pattern used to deploy the build pipeline:
+
API documentation
The API documentation is generated automatically using Typedoc.
+ +Project Build with AWS CodePipeline
Several pipelines are provided in this library, each one demonstrating a different aspect of how to build a Yocto image with AWS.
+Once deployed, ou can review the pipeline execution from the Developer Tools > Pipeline - CodePipeline > Pipelines page in the AWS Console.
From the pipeline page, you can find the source repository (S3), the CodeBuild Project (with the build logs), and the S3 bucket that the image is uploaded to, at the end.
+Each pipelines will refresh/re-run automatically every week using AWS EventBridge in order to grab the latest updates.
+Poky
The pipeline name will end with poky.
This example will build the core-image-minimal image from Poky using the repo tool to manage layers. CVE checking is also enabled in the buildspec file.
Expected build times:
+-
+
- First build: 32 minutes +
- Rebuild (without any change, just use sstate cache): 8 minutes +
Poky EC2 AMI
The pipeline name will end with poky-ami.
Yocto can be used to create an EC2 AMI. This example builds an AMI based on Poky and meta-aws and exports it to your AMI registry using the VM Import/Export Service.
+Expected build times:
+-
+
- First build: 52 minutes +
- Rebuild (without any change, just use sstate cache): 17 minutes +
Kas
The pipeline name will end with kas.
The Kas example shows how to use a Kas Config to manage layers.
+This tool can help programatically manage layers and config with tighter Yocto integration than Git Submodules or the Repo tool.
+Expected build times:
+-
+
- First build: 36 minutes +
- Rebuild (without any change, just use sstate cache): 11 minutes +
QEmu
The pipeline name will end with qemu.
This example builds a Qemu based image using meta-aws-demos.
+The Qemu image can be run in the CodeBuild environment. Using SLIRP networking, OEQA testing such as ptest can be run in the pipeline.
+Expected build times:
+-
+
- First build: 45 minutes +
- Rebuild (without any change, just use sstate cache): 14 minutes +
NXP / IMX
The pipeline name will end with nxp.
This example will build an image for the i.MX 6ULL EVK board.
+NXP requires users to accept and comply with a EULA in order to build and, for this reason, the buildspec will require modification before the build succeeds.
+See the IMX Yocto Users Guide for more detail.
+Expected build times:
+-
+
- First build: xx minutes +
- Rebuild (without any change, just use sstate cache): xx minutes +
Renesas
This example is based on the Yocto / Renesas R-Car work to build an image for Renesas R-Car-H3 Starter Kit Premier board (unofficial name - H3ULCB) including the proprietary graphics and multimedia drivers from Renesas.
+You will need to download the Multimedia and Graphics library and related Linux drivers from the following link (registration necessary):
+ +Download the following files:
+-
+
- R-Car_Gen3_Series_Evaluation_Software_Package_for_Linux-20220121 +
- R-Car_Gen3_Series_Evaluation_Software_Package_of_Linux_Drivers-20220121 +
Graphic drivers are required for Wayland. Multimedia drivers are optional.
+Steps to build the image:
+-
+
- Create a folder named
proprietaryin the root of the source repo
+ - Copy the downloaded files into the
proprietaryfolder
+ - Uncomment the
#TODOline in thebuild.shfile in the source repo
+ - Deploy the build pipeline +
A build should automatically start. Once it succeeds you will get an image containing the proprietary graphics and multimedia drivers.
+Expected build times:
+-
+
- First build: 30 minutes +
- Rebuild (without any change, just use sstate cache): 9 minutes +
Project Build with AWS CodeBuild as Action Runner
This will create an AWS CodeBuild project ready to build Embedded Linux which can be used to connect to an external source, e.g. GitHub Actions. This is not using any AWS CodePipeline as in the the Pipeline examples section.
+You can use the following example for your GitHub Action.
+We recommend you to clone the created AWS CodeBuild project and then proceed with the GitHub Action configuration. +However, this will result in the use of the same EFS file system across projects.
+Using the AWS CodeBuild project requires a source to be configured manually in the AWS Console at Developer Tools > Build - CodeBuild > Projects.
To configure the AWS CodeBuild source connection to a GitHub repository, you will need to:
+-
+
- Select the AWS CodeBuild project (
aws4el-ci-codebuild-project)
+ - Select the
Project Detailstab
+ - Scroll to the
Sourcesection and click on Edit.
+ - Select
GitHubas a Source provider. Configure the access to your repository
+ - Scroll to the Primary source webhook events section, enable Rebuild every time a code change is pushed to this repository +
- Expand the Webhook event filter groups section and click on Add filter group if no group is present, then select WORKFLOW_JOB_QUEUED as Filter group 1 +
Modify your repository GitHub action by replacing the following line:
+runs-on: ${{ vars.CODEBUILD_RUNNER_NAME }}-${{ github.run_id }}-${{ github.run_attempt }}
+with:
+runs-on: codebuild-<project-name>-${{ github.run_id }}-${{ github.run_attempt }}
+<project-name> should be replaced by your AWS CodeBuild project name (aws4el-ci-codebuild-project).
+There might be more than one occuerence to replace in the file.
Refer to the following example for more details.
+ +Setup
In order to use this library, you must first set up an AWS CDK project, including +installing the CDK tool and bootstrapping the account you wish to deploy to.
+Additionally, you must have NodeJS installed.
+Note
+This library is tested against Node Versions 22. If these version is not available for your system, we recommend using NVM to install a compatible version.
+You can also use the sample project code provided to get started and deploy the stacks.
+ +Setting Up A New Project
In order to create a new project, you will need to initialize a new CDK project.
+More details can be found in the CDK Getting Started Documentation.
+The following commands will create a new CDK project named my-project:
mkdir my-project
cd my-project
cdk init app --language typescript
+Then you will need to install the CDK library including the aws4embeddedlinux-ci library either using npm:
npm install aws4embeddedlinux/aws4embeddedlinux-ci
+of `yarn':
+yarn add aws4embeddedlinux-cdk-lib@aws4embeddedlinux/aws4embeddedlinux-ci
yarn install
+++If you are not familliar with Yarn, please refer to the documentation.
+
Once added, you can start creatin your application using the library.
+For example, you can start by importing classes using:
+import {
EmbeddedLinuxCodePipelineBaseImageStack,
EmbeddedLinuxCodePipelineStack,
EmbeddedLinuxCodeBuildProjectStack,
PipelineResourcesStack,
ProjectType,
} from "aws4embeddedlinux-cdk-lib";
+Then deploy the base resources and base image pipeline stacks:
+const pipelineResourcesStack = new PipelineResourcesStack(app, `demo-resources`, {...});
const baseImageStack = new EmbeddedLinuxCodePipelineBaseImageStack(app, `demo-pipeline-base-image`, {...});
+And ultimately deploy the target pipeline:
+const projectPipeline = new EmbeddedLinuxCodePipelineStack(app, "demo-project", {
projectType: ProjectType.Poky,
ecrRepository: <ecrRepository>,
ecrRepositoryImageTag: <ecrRepositoryImageTag>,
pipelineSourceBucket: <SourceBucket>,
pipelineArtifactBucket: <ArtifactBucket>,
pipelineOutputBucket: <OutputBucket>,
vpc: <vpc>,
encryptionKey: <encryptionKey>,
});
+Refer to the API Documentation and the sample for more details.
+Once you have completed the code of your application, you can deploy the CDK stack using:
+cdk deploy
+After the CDK application is successfully deployed, the 'Base Image' pipeline needs to complete successfully.
+This will create an Ubuntu based container for building the Yocto images.
+Note
+This container is used by the other pipelines. If the other pipelines are run before this container is created and pushed to ECR, they will fail.
+The 'Base Image' pipeline will run weekly by default to keep the container patched and up to date.
+Note
+We recommend you to deploy first the 'Base Image' pipeline and once the pipeline completes successfully, then you can deploy the other pipelines in you application as described in the sample.
+Once your pipelines completes successfully, the Yocto deploy directory generated content will be pushed into a S3 bucket.
+ +Development Setup
The repository is leveraging Yarn 2 and if you are not familliar with Yarn, please refer to the documentation.
+If you are looking to develop new feature, you can use yarn link to develop with a local copy of this repo.
In this library repo, execute the following:
+yarn install
yarn run build
yarn link
+and in your project folder:
+yarn install
yarn link "aws4embeddedlinux-cdk-lib"
yarn run build
+This will link through the system node_modules install.
++Note:
+You should not install / reference the
+aws4embeddedlinux/aws4embeddedlinux-cilibrary in yourpackage.jsonwhen using this approach.
++Note:
+After changing the code for the
+aws4embeddedlinux/aws4embeddedlinux-cilibrary, you will need to runyarn run buildfor changes to be available in your current project.
++Note:
+When using a system node install on Linux, this can require sudo access. +To avoid this, use a node version manager or set a node prefix.
+
Using Git Credentials and Build Time Secrets
AWS Secrets Manager is the preferred method for adding and using secrets in your pipelines.
+The service provides a structured means of access and avoids the pitfalls of putting secrets in environment variables, source repos, etc.
+The following steps detaisl at a high level, how you can enable the use of AWS Secrets Manager in your pipelines:
+-
+
-
+
Create a Secret in Secrets Manager and add your secret value.
+
+ -
+
Grant access permissions to the CodeBuild pipeline project.
+
+ -
+
Create a Policy Statement which allows
+secretsmanager:GetSecretValuefor your secret.
+ -
+
Add this policy statement to the
+buildPolicyAdditionsprops for theEmbeddedLinuxPipelineStack. e.g.
+ +import * as iam from "aws-cdk-lib/aws-iam";
const projectPipeline = new EmbeddedLinuxCodePipelineStack(app, "MyPokyPipeline", {
projectType: ProjectType.Poky,
ecrRepository: <ecrRepository>,
ecrRepositoryImageTag: <ecrRepositoryImageTag>,
pipelineSourceBucket: <SourceBucket>,
pipelineArtifactBucket: <ArtifactBucket>,
pipelineOutputBucket: <OutputBucket>,
vpc: <vpc>,
encryptionKey: <encryptionKey>,
buildPolicyAdditions: [
iam.PolicyStatement.fromJson({
Effect: "Allow",
Action: "secretsmanager:GetSecretValue",
Resource:
"arn:aws:secretsmanager:us-west-2:123456789012:secret:my-secret-??????",
}),
],
}); +
+ -
+
The secret can then be used in the CodeBuild Project by adding it to the BuildSpec.
+
+ +env:
secrets-manager:
SECRET_VALUE: "<Secret ARN>" +
+
See the CodeBuild Documentation for more details.
+CVE Checking With Yocto
CVE checking is enabled in the reference implementations. Details on this can be found in the Yocto documentation.
+ +Known issues
-
+
- The use of this CDK library is currently not supported in Windows environments (you can still use WSL). +
- When using AWS Cloud9, a micro instance type will run out of memory. +
- Deletion of stacks while a CodePipeline is running can lead to unexpected behaviours. +
- The NXP-IMX pipeline will fail unless you adjust the build spec file and address the licence acceptance requirement. +
Security
See SECURITY for more information about reporting issues with this project.
+ +Contributing
See CONTRIBUTING for more information.
+ +License
This library is licensed under the MIT-0 License. See the LICENSE file.
+ +Interface EmbeddedLinuxCodeBuildProjectProps
Properties to allow customizing the build.
+interface EmbeddedLinuxCodeBuildProjectProps {
    description?: string;
    env?: Environment;
    stackName?: string;
    tags?: { [key: string]: string };
    notificationArns?: string[];
    synthesizer?: IStackSynthesizer;
    terminationProtection?: boolean;
    analyticsReporting?: boolean;
    crossRegionReferences?: boolean;
    permissionsBoundary?: PermissionsBoundary;
    suppressTemplateIndentation?: boolean;
    propertyInjectors?: IPropertyInjector[];
    ecrRepository: IRepository;
    ecrRepositoryImageTag: string;
    vpc: IVpc;
    buildPolicyAdditions?: PolicyStatement[];
    encryptionKey: Key;
}
    description?: string;
    env?: Environment;
    stackName?: string;
    tags?: { [key: string]: string };
    notificationArns?: string[];
    synthesizer?: IStackSynthesizer;
    terminationProtection?: boolean;
    analyticsReporting?: boolean;
    crossRegionReferences?: boolean;
    permissionsBoundary?: PermissionsBoundary;
    suppressTemplateIndentation?: boolean;
    propertyInjectors?: IPropertyInjector[];
    ecrRepository: IRepository;
    ecrRepositoryImageTag: string;
    vpc: IVpc;
    buildPolicyAdditions?: PolicyStatement[];
    encryptionKey: Key;
}
Hierarchy
- StackProps
- EmbeddedLinuxCodeBuildProjectProps
Index
Properties
Properties
Optional Readonlydescription
description?: string
A description of the stack.
+Optional Readonlyenv
env?: Environment
The AWS environment (account/region) where this stack will be deployed.
+Set the region/account fields of env to either a concrete value to
+select the indicated environment (recommended for production stacks), or to
+the values of environment variables
+CDK_DEFAULT_REGION/CDK_DEFAULT_ACCOUNT to let the target environment
+depend on the AWS credentials/configuration that the CDK CLI is executed
+under (recommended for development stacks).
If the Stack is instantiated inside a Stage, any undefined
+region/account fields from env will default to the same field on the
+encompassing Stage, if configured there.
If either region or account are not set nor inherited from Stage, the
+Stack will be considered "environment-agnostic"". Environment-agnostic
+stacks can be deployed to any environment but may not be able to take
+advantage of all features of the CDK. For example, they will not be able to
+use environmental context lookups such as ec2.Vpc.fromLookup and will not
+automatically translate Service Principals to the right format based on the
+environment's AWS partition, and other such enhancements.
Example
// Use a concrete account and region to deploy this stack to:
// `.account` and `.region` will simply return these values.
new Stack(app, 'Stack1', {
env: {
account: '123456789012',
region: 'us-east-1'
},
});
// Use the CLI's current credentials to determine the target environment:
// `.account` and `.region` will reflect the account+region the CLI
// is configured to use (based on the user CLI credentials)
new Stack(app, 'Stack2', {
env: {
account: process.env.CDK_DEFAULT_ACCOUNT,
region: process.env.CDK_DEFAULT_REGION
},
});
// Define multiple stacks stage associated with an environment
const myStage = new Stage(app, 'MyStage', {
env: {
account: '123456789012',
region: 'us-east-1'
}
});
// both of these stacks will use the stage's account/region:
// `.account` and `.region` will resolve to the concrete values as above
new MyStack(myStage, 'Stack1');
new YourStack(myStage, 'Stack2');
// Define an environment-agnostic stack:
// `.account` and `.region` will resolve to `{ "Ref": "AWS::AccountId" }` and `{ "Ref": "AWS::Region" }` respectively.
// which will only resolve to actual values by CloudFormation during deployment.
new MyStack(app, 'Stack1');
+Optional Readonlystack
stackName?: string
Name to deploy the stack with
+Optional Readonlytags
tags?: { [key: string]: string }
Tags that will be applied to the Stack
+These tags are applied to the CloudFormation Stack itself. They will not +appear in the CloudFormation template.
+However, at deployment time, CloudFormation will apply these tags to all
+resources in the stack that support tagging. You will not be able to exempt
+resources from tagging (using the excludeResourceTypes property of
+Tags.of(...).add()) for tags applied in this way.
Optional Readonlynotification
notificationArns?: string[]
SNS Topic ARNs that will receive stack events.
+Optional Readonlysynthesizer
synthesizer?: IStackSynthesizer
Synthesis method to use while deploying this stack
+The Stack Synthesizer controls aspects of synthesis and deployment, +like how assets are referenced and what IAM roles to use. For more +information, see the README of the main CDK package.
+If not specified, the defaultStackSynthesizer from App will be used.
+If that is not specified, DefaultStackSynthesizer is used if
+@aws-cdk/core:newStyleStackSynthesis is set to true or the CDK major
+version is v2. In CDK v1 LegacyStackSynthesizer is the default if no
+other synthesizer is specified.
Optional Readonlytermination
terminationProtection?: boolean
Whether to enable termination protection for this stack.
+Optional Readonlyanalytics
analyticsReporting?: boolean
Include runtime versioning information in this Stack
+Optional Readonlycross
crossRegionReferences?: boolean
Enable this flag to allow native cross region stack references.
+Enabling this will create a CloudFormation custom resource +in both the producing stack and consuming stack in order to perform the export/import
+This feature is currently experimental
+Optional Readonlypermissions
permissionsBoundary?: PermissionsBoundary
Options for applying a permissions boundary to all IAM Roles +and Users created within this Stage
+Optional Readonlysuppress
suppressTemplateIndentation?: boolean
Enable this flag to suppress indentation in generated +CloudFormation templates.
+If not specified, the value of the @aws-cdk/core:suppressTemplateIndentation
+context key will be used. If that is not specified, then the
+default value false will be used.
Optional Readonlyproperty
propertyInjectors?: IPropertyInjector[]
A list of IPropertyInjector attached to this Stack.
+Readonlyecr
ecrRepository: IRepository
ECR Repository where the Build Host Image resides.
+Readonlyecr
ecrRepositoryImageTag: string
Tag for the Build Host Image
+Readonlyvpc
vpc: IVpc
VPC where the networking setup resides.
+Optional Readonlybuild
buildPolicyAdditions?: PolicyStatement[]
Additional policy statements to add to the build project.
+Readonlyencryption
encryptionKey: Key
The encryption key use across
+Interface EmbeddedLinuxCodePipelineBaseImageProps
Select options for the BuildImageCodePipelineStack.
+interface EmbeddedLinuxCodePipelineBaseImageProps {
    description?: string;
    env?: Environment;
    stackName?: string;
    tags?: { [key: string]: string };
    notificationArns?: string[];
    synthesizer?: IStackSynthesizer;
    terminationProtection?: boolean;
    analyticsReporting?: boolean;
    crossRegionReferences?: boolean;
    permissionsBoundary?: PermissionsBoundary;
    suppressTemplateIndentation?: boolean;
    propertyInjectors?: IPropertyInjector[];
    pipelineSourceBucket: IBucket;
    pipelineSourcePrefix?: string;
    pipelineArtifactBucket: Bucket;
    ecrRepository: IRepository;
    encryptionKey: Key;
}
    description?: string;
    env?: Environment;
    stackName?: string;
    tags?: { [key: string]: string };
    notificationArns?: string[];
    synthesizer?: IStackSynthesizer;
    terminationProtection?: boolean;
    analyticsReporting?: boolean;
    crossRegionReferences?: boolean;
    permissionsBoundary?: PermissionsBoundary;
    suppressTemplateIndentation?: boolean;
    propertyInjectors?: IPropertyInjector[];
    pipelineSourceBucket: IBucket;
    pipelineSourcePrefix?: string;
    pipelineArtifactBucket: Bucket;
    ecrRepository: IRepository;
    encryptionKey: Key;
}
Hierarchy
- StackProps
- EmbeddedLinuxCodePipelineBaseImageProps
Index
Properties
description?
+env?
+stack
Properties
Optional Readonlydescription
description?: string
A description of the stack.
+Optional Readonlyenv
env?: Environment
The AWS environment (account/region) where this stack will be deployed.
+Set the region/account fields of env to either a concrete value to
+select the indicated environment (recommended for production stacks), or to
+the values of environment variables
+CDK_DEFAULT_REGION/CDK_DEFAULT_ACCOUNT to let the target environment
+depend on the AWS credentials/configuration that the CDK CLI is executed
+under (recommended for development stacks).
If the Stack is instantiated inside a Stage, any undefined
+region/account fields from env will default to the same field on the
+encompassing Stage, if configured there.
If either region or account are not set nor inherited from Stage, the
+Stack will be considered "environment-agnostic"". Environment-agnostic
+stacks can be deployed to any environment but may not be able to take
+advantage of all features of the CDK. For example, they will not be able to
+use environmental context lookups such as ec2.Vpc.fromLookup and will not
+automatically translate Service Principals to the right format based on the
+environment's AWS partition, and other such enhancements.
Example
// Use a concrete account and region to deploy this stack to:
// `.account` and `.region` will simply return these values.
new Stack(app, 'Stack1', {
env: {
account: '123456789012',
region: 'us-east-1'
},
});
// Use the CLI's current credentials to determine the target environment:
// `.account` and `.region` will reflect the account+region the CLI
// is configured to use (based on the user CLI credentials)
new Stack(app, 'Stack2', {
env: {
account: process.env.CDK_DEFAULT_ACCOUNT,
region: process.env.CDK_DEFAULT_REGION
},
});
// Define multiple stacks stage associated with an environment
const myStage = new Stage(app, 'MyStage', {
env: {
account: '123456789012',
region: 'us-east-1'
}
});
// both of these stacks will use the stage's account/region:
// `.account` and `.region` will resolve to the concrete values as above
new MyStack(myStage, 'Stack1');
new YourStack(myStage, 'Stack2');
// Define an environment-agnostic stack:
// `.account` and `.region` will resolve to `{ "Ref": "AWS::AccountId" }` and `{ "Ref": "AWS::Region" }` respectively.
// which will only resolve to actual values by CloudFormation during deployment.
new MyStack(app, 'Stack1');
+Optional Readonlystack
stackName?: string
Name to deploy the stack with
+Optional Readonlytags
tags?: { [key: string]: string }
Tags that will be applied to the Stack
+These tags are applied to the CloudFormation Stack itself. They will not +appear in the CloudFormation template.
+However, at deployment time, CloudFormation will apply these tags to all
+resources in the stack that support tagging. You will not be able to exempt
+resources from tagging (using the excludeResourceTypes property of
+Tags.of(...).add()) for tags applied in this way.
Optional Readonlynotification
notificationArns?: string[]
SNS Topic ARNs that will receive stack events.
+Optional Readonlysynthesizer
synthesizer?: IStackSynthesizer
Synthesis method to use while deploying this stack
+The Stack Synthesizer controls aspects of synthesis and deployment, +like how assets are referenced and what IAM roles to use. For more +information, see the README of the main CDK package.
+If not specified, the defaultStackSynthesizer from App will be used.
+If that is not specified, DefaultStackSynthesizer is used if
+@aws-cdk/core:newStyleStackSynthesis is set to true or the CDK major
+version is v2. In CDK v1 LegacyStackSynthesizer is the default if no
+other synthesizer is specified.
Optional Readonlytermination
terminationProtection?: boolean
Whether to enable termination protection for this stack.
+Optional Readonlyanalytics
analyticsReporting?: boolean
Include runtime versioning information in this Stack
+Optional Readonlycross
crossRegionReferences?: boolean
Enable this flag to allow native cross region stack references.
+Enabling this will create a CloudFormation custom resource +in both the producing stack and consuming stack in order to perform the export/import
+This feature is currently experimental
+Optional Readonlypermissions
permissionsBoundary?: PermissionsBoundary
Options for applying a permissions boundary to all IAM Roles +and Users created within this Stage
+Optional Readonlysuppress
suppressTemplateIndentation?: boolean
Enable this flag to suppress indentation in generated +CloudFormation templates.
+If not specified, the value of the @aws-cdk/core:suppressTemplateIndentation
+context key will be used. If that is not specified, then the
+default value false will be used.
Optional Readonlyproperty
propertyInjectors?: IPropertyInjector[]
A list of IPropertyInjector attached to this Stack.
+Readonlypipeline
pipelineSourceBucket: IBucket
The pipeline source bucket
+Optionalpipeline
pipelineSourcePrefix?: string
The pipeline source prefix
+Readonlypipeline
pipelineArtifactBucket: Bucket
Artifact bucket to use
+Readonlyecr
ecrRepository: IRepository
The ECR Repository to push to.
+Readonlyencryption
encryptionKey: Key
The encryption key use across
+Interface EmbeddedLinuxCodePipelineProps
Properties to allow customizing the build.
+interface EmbeddedLinuxCodePipelineProps {
    description?: string;
    env?: Environment;
    stackName?: string;
    tags?: { [key: string]: string };
    notificationArns?: string[];
    synthesizer?: IStackSynthesizer;
    terminationProtection?: boolean;
    analyticsReporting?: boolean;
    crossRegionReferences?: boolean;
    permissionsBoundary?: PermissionsBoundary;
    suppressTemplateIndentation?: boolean;
    propertyInjectors?: IPropertyInjector[];
    pipelineSourceBucket: IBucket;
    pipelineSourcePrefix?: string;
    pipelineArtifactBucket: Bucket;
    pipelineArtifactPrefix?: string;
    pipelineOutputBucket: Bucket;
    pipelineOutputPrefix?: string;
    ecrRepository: IRepository;
    ecrRepositoryImageTag: string;
    projectType: ProjectType;
    vpc: IVpc;
    buildPolicyAdditions?: PolicyStatement[];
    environmentVariables?: { [key: string]: BuildEnvironmentVariable };
    encryptionKey: Key;
    sourceCustomPath?: string;
}
    description?: string;
    env?: Environment;
    stackName?: string;
    tags?: { [key: string]: string };
    notificationArns?: string[];
    synthesizer?: IStackSynthesizer;
    terminationProtection?: boolean;
    analyticsReporting?: boolean;
    crossRegionReferences?: boolean;
    permissionsBoundary?: PermissionsBoundary;
    suppressTemplateIndentation?: boolean;
    propertyInjectors?: IPropertyInjector[];
    pipelineSourceBucket: IBucket;
    pipelineSourcePrefix?: string;
    pipelineArtifactBucket: Bucket;
    pipelineArtifactPrefix?: string;
    pipelineOutputBucket: Bucket;
    pipelineOutputPrefix?: string;
    ecrRepository: IRepository;
    ecrRepositoryImageTag: string;
    projectType: ProjectType;
    vpc: IVpc;
    buildPolicyAdditions?: PolicyStatement[];
    environmentVariables?: { [key: string]: BuildEnvironmentVariable };
    encryptionKey: Key;
    sourceCustomPath?: string;
}
Hierarchy
- StackProps
- EmbeddedLinuxCodePipelineProps
Index
Properties
description?
+env?
+stack
Properties
Optional Readonlydescription
description?: string
A description of the stack.
+Optional Readonlyenv
env?: Environment
The AWS environment (account/region) where this stack will be deployed.
+Set the region/account fields of env to either a concrete value to
+select the indicated environment (recommended for production stacks), or to
+the values of environment variables
+CDK_DEFAULT_REGION/CDK_DEFAULT_ACCOUNT to let the target environment
+depend on the AWS credentials/configuration that the CDK CLI is executed
+under (recommended for development stacks).
If the Stack is instantiated inside a Stage, any undefined
+region/account fields from env will default to the same field on the
+encompassing Stage, if configured there.
If either region or account are not set nor inherited from Stage, the
+Stack will be considered "environment-agnostic"". Environment-agnostic
+stacks can be deployed to any environment but may not be able to take
+advantage of all features of the CDK. For example, they will not be able to
+use environmental context lookups such as ec2.Vpc.fromLookup and will not
+automatically translate Service Principals to the right format based on the
+environment's AWS partition, and other such enhancements.
Example
// Use a concrete account and region to deploy this stack to:
// `.account` and `.region` will simply return these values.
new Stack(app, 'Stack1', {
env: {
account: '123456789012',
region: 'us-east-1'
},
});
// Use the CLI's current credentials to determine the target environment:
// `.account` and `.region` will reflect the account+region the CLI
// is configured to use (based on the user CLI credentials)
new Stack(app, 'Stack2', {
env: {
account: process.env.CDK_DEFAULT_ACCOUNT,
region: process.env.CDK_DEFAULT_REGION
},
});
// Define multiple stacks stage associated with an environment
const myStage = new Stage(app, 'MyStage', {
env: {
account: '123456789012',
region: 'us-east-1'
}
});
// both of these stacks will use the stage's account/region:
// `.account` and `.region` will resolve to the concrete values as above
new MyStack(myStage, 'Stack1');
new YourStack(myStage, 'Stack2');
// Define an environment-agnostic stack:
// `.account` and `.region` will resolve to `{ "Ref": "AWS::AccountId" }` and `{ "Ref": "AWS::Region" }` respectively.
// which will only resolve to actual values by CloudFormation during deployment.
new MyStack(app, 'Stack1');
+Optional Readonlystack
stackName?: string
Name to deploy the stack with
+Optional Readonlytags
tags?: { [key: string]: string }
Tags that will be applied to the Stack
+These tags are applied to the CloudFormation Stack itself. They will not +appear in the CloudFormation template.
+However, at deployment time, CloudFormation will apply these tags to all
+resources in the stack that support tagging. You will not be able to exempt
+resources from tagging (using the excludeResourceTypes property of
+Tags.of(...).add()) for tags applied in this way.
Optional Readonlynotification
notificationArns?: string[]
SNS Topic ARNs that will receive stack events.
+Optional Readonlysynthesizer
synthesizer?: IStackSynthesizer
Synthesis method to use while deploying this stack
+The Stack Synthesizer controls aspects of synthesis and deployment, +like how assets are referenced and what IAM roles to use. For more +information, see the README of the main CDK package.
+If not specified, the defaultStackSynthesizer from App will be used.
+If that is not specified, DefaultStackSynthesizer is used if
+@aws-cdk/core:newStyleStackSynthesis is set to true or the CDK major
+version is v2. In CDK v1 LegacyStackSynthesizer is the default if no
+other synthesizer is specified.
Optional Readonlytermination
terminationProtection?: boolean
Whether to enable termination protection for this stack.
+Optional Readonlyanalytics
analyticsReporting?: boolean
Include runtime versioning information in this Stack
+Optional Readonlycross
crossRegionReferences?: boolean
Enable this flag to allow native cross region stack references.
+Enabling this will create a CloudFormation custom resource +in both the producing stack and consuming stack in order to perform the export/import
+This feature is currently experimental
+Optional Readonlypermissions
permissionsBoundary?: PermissionsBoundary
Options for applying a permissions boundary to all IAM Roles +and Users created within this Stage
+Optional Readonlysuppress
suppressTemplateIndentation?: boolean
Enable this flag to suppress indentation in generated +CloudFormation templates.
+If not specified, the value of the @aws-cdk/core:suppressTemplateIndentation
+context key will be used. If that is not specified, then the
+default value false will be used.
Optional Readonlyproperty
propertyInjectors?: IPropertyInjector[]
A list of IPropertyInjector attached to this Stack.
+Readonlypipeline
pipelineSourceBucket: IBucket
The pipeline source bucket
+Optionalpipeline
pipelineSourcePrefix?: string
The pipeline source prefix
+Readonlypipeline
pipelineArtifactBucket: Bucket
The pipeline artifact bucket to use
+Optionalpipeline
pipelineArtifactPrefix?: string
The pipeline artifact bucket prefix to use
+Readonlypipeline
pipelineOutputBucket: Bucket
The pipeline output bucket to use
+Optionalpipeline
pipelineOutputPrefix?: string
The pipeline output bucket prefix to use
+Readonlyecr
ecrRepository: IRepository
ECR Repository where the Build Host Image resides.
+Readonlyecr
ecrRepositoryImageTag: string
Tag for the Build Host Image
+Readonlyproject
The type of project being built.
+Readonlyvpc
vpc: IVpc
VPC where the networking setup resides.
+Optional Readonlybuild
buildPolicyAdditions?: PolicyStatement[]
Additional policy statements to add to the build project.
+Optional Readonlyenvironment
environmentVariables?: { [key: string]: BuildEnvironmentVariable }
Additional build environment variables to the build project.
+Readonlyencryption
encryptionKey: Key
The encryption key use across
+Optional Readonlysource
sourceCustomPath?: string
Custom asset to be provided when using ProjectType.Custom
+Interface PipelineResourcesProps
Select options for the PipelineResourcesStack.
+interface PipelineResourcesProps {
    description?: string;
    env?: Environment;
    stackName?: string;
    tags?: { [key: string]: string };
    notificationArns?: string[];
    synthesizer?: IStackSynthesizer;
    terminationProtection?: boolean;
    analyticsReporting?: boolean;
    crossRegionReferences?: boolean;
    permissionsBoundary?: PermissionsBoundary;
    suppressTemplateIndentation?: boolean;
    propertyInjectors?: IPropertyInjector[];
    resource_prefix: string;
    ecrRepositoryName?: string;
    pipelineArtifactBucketName?: string;
    pipelineSourceBucketName?: string;
    pipelineOutputBucketName?: string;
    loggingBucketName?: string;
}
    description?: string;
    env?: Environment;
    stackName?: string;
    tags?: { [key: string]: string };
    notificationArns?: string[];
    synthesizer?: IStackSynthesizer;
    terminationProtection?: boolean;
    analyticsReporting?: boolean;
    crossRegionReferences?: boolean;
    permissionsBoundary?: PermissionsBoundary;
    suppressTemplateIndentation?: boolean;
    propertyInjectors?: IPropertyInjector[];
    resource_prefix: string;
    ecrRepositoryName?: string;
    pipelineArtifactBucketName?: string;
    pipelineSourceBucketName?: string;
    pipelineOutputBucketName?: string;
    loggingBucketName?: string;
}
Hierarchy
- StackProps
- PipelineResourcesProps
Index
Properties
description?
+env?
+stack
Properties
Optional Readonlydescription
description?: string
A description of the stack.
+Optional Readonlyenv
env?: Environment
The AWS environment (account/region) where this stack will be deployed.
+Set the region/account fields of env to either a concrete value to
+select the indicated environment (recommended for production stacks), or to
+the values of environment variables
+CDK_DEFAULT_REGION/CDK_DEFAULT_ACCOUNT to let the target environment
+depend on the AWS credentials/configuration that the CDK CLI is executed
+under (recommended for development stacks).
If the Stack is instantiated inside a Stage, any undefined
+region/account fields from env will default to the same field on the
+encompassing Stage, if configured there.
If either region or account are not set nor inherited from Stage, the
+Stack will be considered "environment-agnostic"". Environment-agnostic
+stacks can be deployed to any environment but may not be able to take
+advantage of all features of the CDK. For example, they will not be able to
+use environmental context lookups such as ec2.Vpc.fromLookup and will not
+automatically translate Service Principals to the right format based on the
+environment's AWS partition, and other such enhancements.
Example
// Use a concrete account and region to deploy this stack to:
// `.account` and `.region` will simply return these values.
new Stack(app, 'Stack1', {
env: {
account: '123456789012',
region: 'us-east-1'
},
});
// Use the CLI's current credentials to determine the target environment:
// `.account` and `.region` will reflect the account+region the CLI
// is configured to use (based on the user CLI credentials)
new Stack(app, 'Stack2', {
env: {
account: process.env.CDK_DEFAULT_ACCOUNT,
region: process.env.CDK_DEFAULT_REGION
},
});
// Define multiple stacks stage associated with an environment
const myStage = new Stage(app, 'MyStage', {
env: {
account: '123456789012',
region: 'us-east-1'
}
});
// both of these stacks will use the stage's account/region:
// `.account` and `.region` will resolve to the concrete values as above
new MyStack(myStage, 'Stack1');
new YourStack(myStage, 'Stack2');
// Define an environment-agnostic stack:
// `.account` and `.region` will resolve to `{ "Ref": "AWS::AccountId" }` and `{ "Ref": "AWS::Region" }` respectively.
// which will only resolve to actual values by CloudFormation during deployment.
new MyStack(app, 'Stack1');
+Optional Readonlystack
stackName?: string
Name to deploy the stack with
+Optional Readonlytags
tags?: { [key: string]: string }
Tags that will be applied to the Stack
+These tags are applied to the CloudFormation Stack itself. They will not +appear in the CloudFormation template.
+However, at deployment time, CloudFormation will apply these tags to all
+resources in the stack that support tagging. You will not be able to exempt
+resources from tagging (using the excludeResourceTypes property of
+Tags.of(...).add()) for tags applied in this way.
Optional Readonlynotification
notificationArns?: string[]
SNS Topic ARNs that will receive stack events.
+Optional Readonlysynthesizer
synthesizer?: IStackSynthesizer
Synthesis method to use while deploying this stack
+The Stack Synthesizer controls aspects of synthesis and deployment, +like how assets are referenced and what IAM roles to use. For more +information, see the README of the main CDK package.
+If not specified, the defaultStackSynthesizer from App will be used.
+If that is not specified, DefaultStackSynthesizer is used if
+@aws-cdk/core:newStyleStackSynthesis is set to true or the CDK major
+version is v2. In CDK v1 LegacyStackSynthesizer is the default if no
+other synthesizer is specified.
Optional Readonlytermination
terminationProtection?: boolean
Whether to enable termination protection for this stack.
+Optional Readonlyanalytics
analyticsReporting?: boolean
Include runtime versioning information in this Stack
+Optional Readonlycross
crossRegionReferences?: boolean
Enable this flag to allow native cross region stack references.
+Enabling this will create a CloudFormation custom resource +in both the producing stack and consuming stack in order to perform the export/import
+This feature is currently experimental
+Optional Readonlypermissions
permissionsBoundary?: PermissionsBoundary
Options for applying a permissions boundary to all IAM Roles +and Users created within this Stage
+Optional Readonlysuppress
suppressTemplateIndentation?: boolean
Enable this flag to suppress indentation in generated +CloudFormation templates.
+If not specified, the value of the @aws-cdk/core:suppressTemplateIndentation
+context key will be used. If that is not specified, then the
+default value false will be used.
Optional Readonlyproperty
propertyInjectors?: IPropertyInjector[]
A list of IPropertyInjector attached to this Stack.
+Readonlyresource_
resource_prefix: string
The resource prefix
+Optional Readonlyecr
ecrRepositoryName?: string
The ecr repository name - if not provided then the name will be '{prefix}-{account}-{region}-repo'
+Optional Readonlypipeline
pipelineArtifactBucketName?: string
The artifact bucket name - if not provided then the name will be '{prefix}-{account}-{region}-artifact'
+Optional Readonlypipeline
pipelineSourceBucketName?: string
The source bucket name - if not provided then the name will be '{prefix}-{account}-{region}-source'
+Optional Readonlypipeline
pipelineOutputBucketName?: string
The output bucket name - if not provided then the name will be '{prefix}-{account}-{region}-output'
+Optional Readonlylogging
loggingBucketName?: string
Cloudwatch logging bucket name - if not provided then the name will be '{prefix}-{account}-{region}-logs'
+
The stack for creating a build pipeline.
+See EmbeddedLinuxCodeBuildProjectProps for configration options.
+