Package software.amazon.awscdk.services.billingconductor

Interface CfnCustomLineItemProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCustomLineItemProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:03.523Z")
@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
         .accountId("accountId")
         .billingPeriodRange(BillingPeriodRangeProperty.builder()
                 .exclusiveEndBillingPeriod("exclusiveEndBillingPeriod")
                 .inclusiveStartBillingPeriod("inclusiveStartBillingPeriod")
                 .build())
         .customLineItemChargeDetails(CustomLineItemChargeDetailsProperty.builder()
                 .type("type")
                 // the properties below are optional
                 .flat(CustomLineItemFlatChargeDetailsProperty.builder()
                         .chargeValue(123)
                         .build())
                 .lineItemFilters(List.of(LineItemFilterProperty.builder()
                         .attribute("attribute")
                         .matchOption("matchOption")
                         .values(List.of("values"))
                         .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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-billingconductor-customlineitem.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnCustomLineItemProps.Builder	A builder for CfnCustomLineItemProps
static final class	CfnCustomLineItemProps.Jsii$Proxy	An implementation for CfnCustomLineItemProps

Method Summary

Modifier and Type	Method	Description
static CfnCustomLineItemProps.Builder	builder()
default String	getAccountId()	The AWS account in which this custom line item will be applied to.
String	getBillingGroupArn()	The Amazon Resource Name (ARN) that references the billing group where the custom line item applies to.
default Object	getBillingPeriodRange()	A time range for which the custom line item is effective.
default Object	getCustomLineItemChargeDetails()	The charge details of a custom line item.
default String	getDescription()	The custom line item's description.
String	getName()	The custom line item's name.
default List<CfnTag>	getTags()	A map that contains tag keys and tag values that are attached to a custom line item.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-billingconductor-customlineitem.html#cfn-billingconductor-customlineitem-billinggrouparn

getName

@Stability(Stable)
@NotNull
String getName()

The custom line item's name.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-billingconductor-customlineitem.html#cfn-billingconductor-customlineitem-name

getAccountId

@Stability(Stable)
@Nullable
default String getAccountId()

The AWS account in which this custom line item will be applied to.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-billingconductor-customlineitem.html#cfn-billingconductor-customlineitem-accountid

getBillingPeriodRange

@Stability(Stable)
@Nullable
default Object getBillingPeriodRange()

A time range for which the custom line item is effective.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-billingconductor-customlineitem.html#cfn-billingconductor-customlineitem-billingperiodrange

getCustomLineItemChargeDetails

@Stability(Stable)
@Nullable
default Object getCustomLineItemChargeDetails()

The charge details of a custom line item.

It should contain only one of Flat or Percentage .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-billingconductor-customlineitem.html#cfn-billingconductor-customlineitem-customlineitemchargedetails

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-billingconductor-customlineitem.html#cfn-billingconductor-customlineitem-description

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-billingconductor-customlineitem.html#cfn-billingconductor-customlineitem-tags

builder

@Stability(Stable)
static CfnCustomLineItemProps.Builder builder()

Returns:

a CfnCustomLineItemProps.Builder of CfnCustomLineItemProps