Package software.amazon.awscdk.services.billingconductor

Class CfnPricingRule

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.billingconductor.CfnPricingRule
All Implemented Interfaces:
IInspectable, IPricingRuleRef, IEnvironmentAware, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-11-13T16:10:00.103Z") @Stability(Stable) public class CfnPricingRule extends CfnResource implements IInspectable, IPricingRuleRef, ITaggable
Creates a pricing rule which can be associated with a pricing plan, or a set of pricing plans.

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.billingconductor.*;
 CfnPricingRule cfnPricingRule = CfnPricingRule.Builder.create(this, "MyCfnPricingRule")
         .name("name")
         .scope("scope")
         .type("type")
         // the properties below are optional
         .billingEntity("billingEntity")
         .description("description")
         .modifierPercentage(123)
         .operation("operation")
         .service("service")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .tiering(TieringProperty.builder()
                 .freeTier(FreeTierProperty.builder()
                         .activated(false)
                         .build())
                 .build())
         .usageType("usageType")
         .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

    • CfnPricingRule

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

    • CfnPricingRule

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

    • CfnPricingRule

      @Stability(Stable) public CfnPricingRule(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnPricingRuleProps props)
      Create a new AWS::BillingConductor::PricingRule.

      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

    • 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) used to uniquely identify a pricing rule.

    • getAttrAssociatedPricingPlanCount

      @Stability(Stable) @NotNull public Number getAttrAssociatedPricingPlanCount()
      The pricing plans count that this pricing rule is associated with.

    • getAttrCreationTime

      @Stability(Stable) @NotNull public Number getAttrCreationTime()
      The time the pricing rule was created.

    • getAttrLastModifiedTime

      @Stability(Stable) @NotNull public Number getAttrLastModifiedTime()
      The most recent time the pricing rule was modified.

    • getCfnProperties

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

    • getPricingRuleRef

      @Stability(Stable) @NotNull public PricingRuleReference getPricingRuleRef()
      A reference to a PricingRule resource.
      Specified by:
      getPricingRuleRef in interface IPricingRuleRef

    • getTags

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

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of a pricing rule.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of a pricing rule.

    • getScope

      @Stability(Stable) @NotNull public String getScope()
      The scope of pricing rule that indicates if it's globally applicable or service-specific.

    • setScope

      @Stability(Stable) public void setScope(@NotNull String value)
      The scope of pricing rule that indicates if it's globally applicable or service-specific.

    • getType

      @Stability(Stable) @NotNull public String getType()
      The type of pricing rule.

    • setType

      @Stability(Stable) public void setType(@NotNull String value)
      The type of pricing rule.

    • getBillingEntity

      @Stability(Stable) @Nullable public String getBillingEntity()
      The seller of services provided by AWS , their affiliates, or third-party providers selling services via AWS Marketplace .

    • setBillingEntity

      @Stability(Stable) public void setBillingEntity(@Nullable String value)
      The seller of services provided by AWS , their affiliates, or third-party providers selling services via AWS Marketplace .

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The pricing rule description.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The pricing rule description.

    • getModifierPercentage

      @Stability(Stable) @Nullable public Number getModifierPercentage()
      A percentage modifier applied on the public pricing rates.

    • setModifierPercentage

      @Stability(Stable) public void setModifierPercentage(@Nullable Number value)
      A percentage modifier applied on the public pricing rates.

    • getOperation

      @Stability(Stable) @Nullable public String getOperation()
      Operation is the specific AWS action covered by this line item.

    • setOperation

      @Stability(Stable) public void setOperation(@Nullable String value)
      Operation is the specific AWS action covered by this line item.

    • getService

      @Stability(Stable) @Nullable public String getService()
      If the Scope attribute is SERVICE , this attribute indicates which service the PricingRule is applicable for.

    • setService

      @Stability(Stable) public void setService(@Nullable String value)
      If the Scope attribute is SERVICE , this attribute indicates which service the PricingRule is applicable for.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      A map that contains tag keys and tag values that are attached to a pricing rule.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      A map that contains tag keys and tag values that are attached to a pricing rule.

    • getTiering

      @Stability(Stable) @Nullable public Object getTiering()
      The set of tiering configurations for the pricing rule.

      Returns union: either IResolvable or CfnPricingRule.TieringProperty

    • setTiering

      @Stability(Stable) public void setTiering(@Nullable IResolvable value)
      The set of tiering configurations for the pricing rule.

    • setTiering

      @Stability(Stable) public void setTiering(@Nullable CfnPricingRule.TieringProperty value)
      The set of tiering configurations for the pricing rule.

    • getUsageType

      @Stability(Stable) @Nullable public String getUsageType()
      Usage Type is the unit that each service uses to measure the usage of a specific type of resource.

    • setUsageType

      @Stability(Stable) public void setUsageType(@Nullable String value)
      Usage Type is the unit that each service uses to measure the usage of a specific type of resource.