Package software.amazon.awscdk.services.billingconductor

Class CfnPricingRule

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.billingconductor.CfnPricingRule
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:55.832Z") @Stability(Stable) public class CfnPricingRule extends CfnResource implements IInspectable
A CloudFormation AWS::BillingConductor::PricingRule.

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();

  • 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 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 -
      • scoped id of the resource.
      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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      A map that contains tag keys and tag values that are attached to a pricing rule.

    • 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.

      This describes the specific usage of the line item.

      If the Scope attribute is set to SKU , this attribute indicates which operation the PricingRule is modifying. For example, a value of RunInstances:0202 indicates the operation of running an Amazon EC2 instance.

    • setOperation

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

      This describes the specific usage of the line item.

      If the Scope attribute is set to SKU , this attribute indicates which operation the PricingRule is modifying. For example, a value of RunInstances:0202 indicates the operation of running an Amazon EC2 instance.

    • 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.

    • getTiering

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

    • 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.