Package software.amazon.awscdk.services.bcmpricingcalculator

Class CfnWorkloadEstimate

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.bcmpricingcalculator.CfnWorkloadEstimate
All Implemented Interfaces:
IInspectable, IWorkloadEstimateRef, IEnvironmentAware, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.140.0 (build 79fd58c)", date="2026-09-30T11:04:45.879Z") @Stability(Stable) public class CfnWorkloadEstimate extends CfnResource implements IInspectable, IWorkloadEstimateRef, ITaggableV2
Resource Type definition for AWS::BcmPricingCalculator::WorkloadEstimate.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.bcmpricingcalculator.*;
 CfnWorkloadEstimate cfnWorkloadEstimate = CfnWorkloadEstimate.Builder.create(this, "MyCfnWorkloadEstimate")
         .name("name")
         // the properties below are optional
         .expiresAt("expiresAt")
         .rateType("rateType")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnWorkloadEstimate

      protected CfnWorkloadEstimate(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnWorkloadEstimate

      protected CfnWorkloadEstimate(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnWorkloadEstimate

      @Stability(Stable) public CfnWorkloadEstimate(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnWorkloadEstimateProps props)
      Create a new AWS::BcmPricingCalculator::WorkloadEstimate.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForWorkloadEstimate

      @Stability(Stable) @NotNull public static String arnForWorkloadEstimate(@NotNull IWorkloadEstimateRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnWorkloadEstimate

      @Stability(Stable) @NotNull public static Boolean isCfnWorkloadEstimate(@NotNull Object x)
      Checks whether the given object is a CfnWorkloadEstimate.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the workload estimate.

    • getAttrCostCurrency

      @Stability(Stable) @NotNull public String getAttrCostCurrency()

    • getAttrCreatedAt

      @Stability(Stable) @NotNull public String getAttrCreatedAt()
      The timestamp when the workload estimate was created.

    • getAttrFailureMessage

      @Stability(Stable) @NotNull public String getAttrFailureMessage()
      An error message if the workload estimate failed.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The unique identifier of the workload estimate.

    • getAttrRateTimestamp

      @Stability(Stable) @NotNull public String getAttrRateTimestamp()
      The timestamp of the pricing rates used for the estimate.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()

    • getAttrTotalCost

      @Stability(Stable) @NotNull public IResolvable getAttrTotalCost()
      The total estimated cost for the workload.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getCfnPropertyNames

      @Stability(Stable) @NotNull protected Map<String,String> getCfnPropertyNames()
      Overrides:
      getCfnPropertyNames in class CfnResource

    • getWorkloadEstimateRef

      @Stability(Stable) @NotNull public WorkloadEstimateReference getWorkloadEstimateRef()
      A reference to a WorkloadEstimate resource.
      Specified by:
      getWorkloadEstimateRef in interface IWorkloadEstimateRef

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the workload estimate.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the workload estimate.

    • getExpiresAt

      @Stability(Stable) @Nullable public String getExpiresAt()
      The timestamp when the workload estimate will expire.

    • setExpiresAt

      @Stability(Stable) public void setExpiresAt(@Nullable String value)
      The timestamp when the workload estimate will expire.

    • getRateType

      @Stability(Stable) @Nullable public String getRateType()

    • setRateType

      @Stability(Stable) public void setRateType(@Nullable String value)

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      An array of key-value pairs to apply to this resource.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      An array of key-value pairs to apply to this resource.