Interface CfnCustomLineItemProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnCustomLineItemProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:55.830Z") @Stability(Stable) public interface CfnCustomLineItemProps extends software.amazon.jsii.JsiiSerializable
Properties for defining a CfnCustomLineItem.

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.*;
 CfnCustomLineItemProps cfnCustomLineItemProps = CfnCustomLineItemProps.builder()
         .billingGroupArn("billingGroupArn")
         .name("name")
         // the properties below are optional
         .billingPeriodRange(BillingPeriodRangeProperty.builder()
                 .exclusiveEndBillingPeriod("exclusiveEndBillingPeriod")
                 .inclusiveStartBillingPeriod("inclusiveStartBillingPeriod")
                 .build())
         .customLineItemChargeDetails(CustomLineItemChargeDetailsProperty.builder()
                 .type("type")
                 // the properties below are optional
                 .flat(CustomLineItemFlatChargeDetailsProperty.builder()
                         .chargeValue(123)
                         .build())
                 .percentage(CustomLineItemPercentageChargeDetailsProperty.builder()
                         .percentageValue(123)
                         // the properties below are optional
                         .childAssociatedResources(List.of("childAssociatedResources"))
                         .build())
                 .build())
         .description("description")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 
  • Method Details

    • getBillingGroupArn

      @Stability(Stable) @NotNull String getBillingGroupArn()
      The Amazon Resource Name (ARN) that references the billing group where the custom line item applies to.
    • getName

      @Stability(Stable) @NotNull String getName()
      The custom line item's name.
    • getBillingPeriodRange

      @Stability(Stable) @Nullable default Object getBillingPeriodRange()
      A time range for which the custom line item is effective.
    • getCustomLineItemChargeDetails

      @Stability(Stable) @Nullable default Object getCustomLineItemChargeDetails()
      The charge details of a custom line item.

      It should contain only one of Flat or Percentage .

    • getDescription

      @Stability(Stable) @Nullable default String getDescription()
      The custom line item's description.

      This is shown on the Bills page in association with the charge value.

    • getTags

      @Stability(Stable) @Nullable default List<CfnTag> getTags()
      A map that contains tag keys and tag values that are attached to a custom line item.
    • builder

      @Stability(Stable) static CfnCustomLineItemProps.Builder builder()
      Returns:
      a CfnCustomLineItemProps.Builder of CfnCustomLineItemProps