class ContainerRecipeBase 🔹

Language	Type name
.NET	Amazon.CDK.AWS.ImageBuilder.Alpha.ContainerRecipeBase
Go	github.com/aws/aws-cdk-go/awsimagebuilderalpha/v2#ContainerRecipeBase
Java	software.amazon.awscdk.services.imagebuilder.alpha.ContainerRecipeBase
Python	aws_cdk.aws_imagebuilder_alpha.ContainerRecipeBase
TypeScript (source)	@aws-cdk/aws-imagebuilder-alpha » ContainerRecipeBase

Implements IConstruct, IDependable, IResource, IEnvironmentAware, IContainerRecipe, IRecipeBase

Extends Resource

Implemented by ContainerRecipe

A new or imported Container Recipe.

Initializer

new ContainerRecipeBase(scope: Construct, id: string, props?: ResourceProps)

Parameters

• scope Construct
• id string
• props ResourceProps

Properties

Name	Type	Description
containerRecipeArn🔹	string	The ARN of the container recipe.
containerRecipeName🔹	string	The name of the container recipe.
containerRecipeVersion🔹	string	The version of the container recipe.
env🔹	ResourceEnvironment	The environment this resource belongs to.
node🔹	Node	The tree node.
stack🔹	Stack	The stack in which this resource is defined.

---

containerRecipeArn🔹

Type: string

The ARN of the container recipe.

---

containerRecipeName🔹

Type: string

The name of the container recipe.

---

containerRecipeVersion🔹

Type: string

The version of the container recipe.

---

env🔹

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

---

node🔹

Type: Node

The tree node.

---

stack🔹

Type: Stack

The stack in which this resource is defined.

Methods

Name	Description
applyCrossStackReferenceStrength(strength)🔹	Override the cross-stack reference strength for this resource.
applyRemovalPolicy(policy)🔹	Apply the given removal policy to this resource.
grant(grantee, ...actions)🔹	Grant custom actions to the given grantee for the container recipe [disable-awslint:no-grants].
grantRead(grantee)🔹	Grant read permissions to the given grantee for the container recipe [disable-awslint:no-grants].
toString()🔹	Returns a string representation of this construct.
with(...mixins)🔹	Applies one or more mixins to this construct.

---

applyCrossStackReferenceStrength(strength)🔹

public applyCrossStackReferenceStrength(strength: ReferenceStrength): void

Parameters

• strength ReferenceStrength — - The reference strength to use for this resource.

Override the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

---

applyRemovalPolicy(policy)🔹

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

---

grant(grantee, ...actions)🔹

public grant(grantee: IGrantable, ...actions: string[]): Grant

Parameters

• grantee IGrantable — The principal.
• actions string — The list of actions.

Returns

• Grant

Grant custom actions to the given grantee for the container recipe [disable-awslint:no-grants].

---

grantRead(grantee)🔹

public grantRead(grantee: IGrantable): Grant

Parameters

• grantee IGrantable — The principal.

Returns

• Grant

Grant read permissions to the given grantee for the container recipe [disable-awslint:no-grants].

---

toString()🔹

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

with(...mixins)🔹

public with(...mixins: IMixin[]): IConstruct

Parameters

• mixins IMixin

Returns

• IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.