ConsumableResource L2 construct Added in v2.273.0
A Batch Consumable Resource.
Consumable resources are finite resources that are consumed by jobs, such as third-party software licenses or API rate limits.
Example
const taggedResource = new batch.ConsumableResource(this, 'TaggedResource', {
totalQuantity: 100,
tags: {
Team: 'batch',
},
});
tagged_resource = batch.ConsumableResource(self, "TaggedResource",
total_quantity=100,
tags={
"Team": "batch"
}
)
ConsumableResource taggedResource = ConsumableResource.Builder.create(this, "TaggedResource")
.totalQuantity(100)
.tags(Map.of(
"Team", "batch"))
.build();
// Install: dotnet add package Amazon.CDK.Lib
var taggedResource = new ConsumableResource(this, "TaggedResource", new ConsumableResourceProps {
TotalQuantity = 100,
Tags = new Dictionary<string, string> {
{ "Team", "batch" }
}
});
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
taggedResource := batch.NewConsumableResource(this, jsii.String("TaggedResource"), &ConsumableResourceProps{
TotalQuantity: jsii.Number(100),
Tags: map[string]*string{
"Team": jsii.String("batch"),
},
})
Initializer
new ConsumableResource(scope: Construct, id: string, props: ConsumableResourceProps)
ConsumableResource(scope: Construct, id: str, props: ConsumableResourceProps)
new ConsumableResource(Construct scope, String id, ConsumableResourceProps props)
new ConsumableResource(Construct scope, string id, ConsumableResourceProps props)
NewConsumableResource(Scope Construct, Id *string, Props ConsumableResourceProps)
Construct Props
consumableResourceNamestringconsumable_resource_namestrconsumableResourceNameStringConsumableResourceNamestringConsumableResourceName*string= CloudFormation-generated name#The name must be unique within the account and Region. Changing it replaces the resource.
resourceTypeConsumableResourceTyperesource_typeConsumableResourceTyperesourceTypeConsumableResourceTypeResourceTypeConsumableResourceTypeResourceTypeConsumableResourceType= ConsumableResourceType.REPLENISH…#Changing this property replaces the resource. Because the name must be unique within the account and Region, changing the type of a resource that has a consumableResourceName fails the deployment unless the name is changed as well.
default
Default: ConsumableResourceType.REPLENISHABLE
tags{ [key: string]: string }tagstyping.Mapping[str, str]tagsMap<String, String>TagsIDictionary<string, string>Tags*map[string]*string= no tags#totalQuantitynumbertotal_quantityint | floattotalQuantityNumberTotalQuantitydoubleTotalQuantity*float64required#Must be a non-negative integer.
Properties
consumableResourceArnstringconsumable_resource_arnstrconsumableResourceArnStringConsumableResourceArnstringConsumableResourceArn*stringrequired#consumableResourceNamestringconsumable_resource_namestrconsumableResourceNameStringConsumableResourceNamestringConsumableResourceName*stringrequired#consumableResourceRefConsumableResourceReferenceconsumable_resource_refConsumableResourceReferenceconsumableResourceRefConsumableResourceReferenceConsumableResourceRefConsumableResourceReferenceConsumableResourceRefConsumableResourceReferencerequired#envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#notes
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.
grantsConsumableResourceGrantsgrantsConsumableResourceGrantsgrantsConsumableResourceGrantsGrantsConsumableResourceGrantsGrantsConsumableResourceGrantsrequired#PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringrequiredstatic#Methods
applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#notes · 1 parameter
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.
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#notes
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).
fromConsumableResourceArn(scope: Construct, id: string, consumableResourceArn: string): IConsumableResource@staticmethod def from_consumable_resource_arn(scope: Construct, id: str, consumable_resource_arn: str) -> IConsumableResourcepublic static IConsumableResource fromConsumableResourceArn(Construct scope, String id, String consumableResourceArn)public static IConsumableResource FromConsumableResourceArn(Construct scope, string id, string consumableResourceArn)func FromConsumableResourceArn(Scope Construct, Id *string, ConsumableResourceArn *string) IConsumableResourcestatic#isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#notes · 1 parameter · returns
Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.
Parameters
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#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.