software.amazon.awscdk.services.billingconductor

Class CfnCustomLineItem

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

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.923Z")
 @Stability(value=Stable)
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 fixed charge that can be applied to a single billing group for the current or previous billing period. The one-time fixed charge is either a fee or discount.

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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnCustomLineItem(software.constructs.Construct scope, 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
String	getAttrArn() The Amazon Resource Name (ARN) that references the billing group where the custom line item applies to.
Number	getAttrAssociationSize() The number of resources that are associated to the custom line item.
Number	getAttrCreationTime() The time created.
String	getAttrCurrencyCode() The custom line item's charge value currency.
Number	getAttrLastModifiedTime() The most recent time the custom line item was modified.
String	getAttrProductCode() The product code associated with the custom line item.
String	getBillingGroupArn() The Amazon Resource Name (ARN) that references the billing group where the custom line item applies to.
Object	getBillingPeriodRange() A time range for which the custom line item is effective.
protected Map<String,Object>	getCfnProperties()
Object	getCustomLineItemChargeDetails() The charge details of a custom line item.
String	getDescription() The custom line item's description.
String	getName() The custom line item's name.
TagManager	getTags() `AWS::BillingConductor::CustomLineItem.Tags`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setBillingGroupArn(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(String value) The custom line item's description.
void	setName(String value) The custom line item's name.

Methods inherited from class software.amazon.awscdk.CfnResource

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

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final 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

@Stability(value=Stable)
public CfnCustomLineItem(@NotNull
                                                  software.constructs.Construct scope,
                                                  @NotNull
                                                  String id,
                                                  @NotNull
                                                  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

@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getAttrArn()

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

getAttrAssociationSize

@Stability(value=Stable)
 @NotNull
public Number getAttrAssociationSize()

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

getAttrCreationTime

@Stability(value=Stable)
 @NotNull
public Number getAttrCreationTime()

The time created.

getAttrCurrencyCode

@Stability(value=Stable)
 @NotNull
public String getAttrCurrencyCode()

The custom line item's charge value currency.

Only one of the valid values can be used.

getAttrLastModifiedTime

@Stability(value=Stable)
 @NotNull
public Number getAttrLastModifiedTime()

The most recent time the custom line item was modified.

getAttrProductCode

@Stability(value=Stable)
 @NotNull
public String getAttrProductCode()

The product code associated with the custom line item.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

`AWS::BillingConductor::CustomLineItem.Tags`.

getBillingGroupArn

@Stability(value=Stable)
 @NotNull
public String getBillingGroupArn()

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

setBillingGroupArn

@Stability(value=Stable)
public void setBillingGroupArn(@NotNull
                                                        String value)

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

getName

@Stability(value=Stable)
 @NotNull
public String getName()

The custom line item's name.

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

The custom line item's name.

getBillingPeriodRange

@Stability(value=Stable)
 @Nullable
public Object getBillingPeriodRange()

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

setBillingPeriodRange

@Stability(value=Stable)
public void setBillingPeriodRange(@Nullable
                                                           CfnCustomLineItem.BillingPeriodRangeProperty value)

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

setBillingPeriodRange

@Stability(value=Stable)
public void setBillingPeriodRange(@Nullable
                                                           IResolvable value)

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

getCustomLineItemChargeDetails

@Stability(value=Stable)
 @Nullable
public Object getCustomLineItemChargeDetails()

The charge details of a custom line item.

It should contain only one of Flat or Percentage .

setCustomLineItemChargeDetails

@Stability(value=Stable)
public void setCustomLineItemChargeDetails(@Nullable
                                                                    CfnCustomLineItem.CustomLineItemChargeDetailsProperty value)

The charge details of a custom line item.

It should contain only one of Flat or Percentage .

setCustomLineItemChargeDetails

@Stability(value=Stable)
public void setCustomLineItemChargeDetails(@Nullable
                                                                    IResolvable value)

The charge details of a custom line item.

It should contain only one of Flat or Percentage .

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

The custom line item's description.

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

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

The custom line item's description.

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