software.amazon.awscdk.services.billingconductor

Class CfnCustomLineItem

java.lang.Object

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

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:35.524Z")
public class CfnCustomLineItem
extends CfnResource
implements IInspectable

A CloudFormation `AWS::BillingConductor::CustomLineItem`.

Creates a custom line item that can be used to create a one-time or recurring, fixed or percentage-based charge that you can apply to a single billing group. You can apply custom line items to the current or previous billing period. You can create either a fee or a discount custom line item.

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.*;
 CfnCustomLineItem cfnCustomLineItem = CfnCustomLineItem.Builder.create(this, "MyCfnCustomLineItem")
         .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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnCustomLineItem.BillingPeriodRangeProperty The billing period range in which the custom line item request will be applied.
static class	CfnCustomLineItem.Builder A fluent builder for CfnCustomLineItem.
static interface	CfnCustomLineItem.CustomLineItemChargeDetailsProperty The charge details of a custom line item.
static interface	CfnCustomLineItem.CustomLineItemFlatChargeDetailsProperty The charge details of a custom line item.
static interface	CfnCustomLineItem.CustomLineItemPercentageChargeDetailsProperty A representation of the charge details associated with a percentage custom line item.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnCustomLineItem(Construct scope, java.lang.String id, CfnCustomLineItemProps props) Create a new `AWS::BillingConductor::CustomLineItem`.
protected	CfnCustomLineItem(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnCustomLineItem(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrArn() The Amazon Resource Name (ARN) that references the billing group where the custom line item applies to.
java.lang.Number	getAttrAssociationSize() The number of resources that are associated to the custom line item.
java.lang.Number	getAttrCreationTime() The time created.
java.lang.String	getAttrCurrencyCode() The custom line item's charge value currency.
java.lang.Number	getAttrLastModifiedTime() The most recent time the custom line item was modified.
java.lang.String	getAttrProductCode() The product code associated with the custom line item.
java.lang.String	getBillingGroupArn() The Amazon Resource Name (ARN) that references the billing group where the custom line item applies to.
java.lang.Object	getBillingPeriodRange() A time range for which the custom line item is effective.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.Object	getCustomLineItemChargeDetails() The charge details of a custom line item.
java.lang.String	getDescription() The custom line item's description.
java.lang.String	getName() The custom line item's name.
TagManager	getTags() A map that contains tag keys and tag values that are attached to a custom line item.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setBillingGroupArn(java.lang.String value) The Amazon Resource Name (ARN) that references the billing group where the custom line item applies to.
void	setBillingPeriodRange(CfnCustomLineItem.BillingPeriodRangeProperty value) A time range for which the custom line item is effective.
void	setBillingPeriodRange(IResolvable value) A time range for which the custom line item is effective.
void	setCustomLineItemChargeDetails(CfnCustomLineItem.CustomLineItemChargeDetailsProperty value) The charge details of a custom line item.
void	setCustomLineItemChargeDetails(IResolvable value) The charge details of a custom line item.
void	setDescription(java.lang.String value) The custom line item's description.
void	setName(java.lang.String value) The custom line item's name.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnCustomLineItem

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

CfnCustomLineItem

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

CfnCustomLineItem

public CfnCustomLineItem(Construct scope,
                         java.lang.String id,
                         CfnCustomLineItemProps props)

Create a new `AWS::BillingConductor::CustomLineItem`.

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 Detail

inspect

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

public java.lang.String getAttrArn()

The Amazon Resource Name (ARN) that references the billing group where the custom line item applies to.

getAttrAssociationSize

public java.lang.Number getAttrAssociationSize()

The number of resources that are associated to the custom line item.

getAttrCreationTime

public java.lang.Number getAttrCreationTime()

The time created.

getAttrCurrencyCode

public java.lang.String getAttrCurrencyCode()

The custom line item's charge value currency.

Only one of the valid values can be used.

getAttrLastModifiedTime

public java.lang.Number getAttrLastModifiedTime()

The most recent time the custom line item was modified.

getAttrProductCode

public java.lang.String getAttrProductCode()

The product code associated with the custom line item.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

A map that contains tag keys and tag values that are attached to a custom line item.

getBillingGroupArn

public java.lang.String getBillingGroupArn()

The Amazon Resource Name (ARN) that references the billing group where the custom line item applies to.

setBillingGroupArn

public void setBillingGroupArn(java.lang.String value)

The Amazon Resource Name (ARN) that references the billing group where the custom line item applies to.

getName

public java.lang.String getName()

The custom line item's name.

setName

public void setName(java.lang.String value)

The custom line item's name.

getBillingPeriodRange

public java.lang.Object getBillingPeriodRange()

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

setBillingPeriodRange

public void setBillingPeriodRange(IResolvable value)

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

setBillingPeriodRange

public void setBillingPeriodRange(CfnCustomLineItem.BillingPeriodRangeProperty value)

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

getCustomLineItemChargeDetails

public java.lang.Object getCustomLineItemChargeDetails()

The charge details of a custom line item.

It should contain only one of Flat or Percentage .

setCustomLineItemChargeDetails

public void setCustomLineItemChargeDetails(IResolvable value)

The charge details of a custom line item.

It should contain only one of Flat or Percentage .

setCustomLineItemChargeDetails

public void setCustomLineItemChargeDetails(CfnCustomLineItem.CustomLineItemChargeDetailsProperty value)

The charge details of a custom line item.

It should contain only one of Flat or Percentage .

getDescription

public java.lang.String getDescription()

The custom line item's description.

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

setDescription

public void setDescription(java.lang.String value)

The custom line item's description.

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