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
,ITaggable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.106.0 (build e852934)",
date="2025-02-06T22:15:50.535Z")
@Stability(Stable)
public class CfnCustomLineItem
extends CfnResource
implements IInspectable, ITaggable
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 .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:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic interface
The billing period range in which the custom line item request will be applied.static final class
A fluent builder forCfnCustomLineItem
.static interface
The charge details of a custom line item.static interface
The charge details of a custom line item.static interface
A representation of the charge details associated with a percentage custom line item.static interface
A representation of the line item filter for your 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.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable
ITaggable.Jsii$Default, ITaggable.Jsii$Proxy
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
CfnCustomLineItem
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnCustomLineItem
(software.amazon.jsii.JsiiObjectRef objRef) CfnCustomLineItem
(software.constructs.Construct scope, String id, CfnCustomLineItemProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe AWS account in which this custom line item will be applied to.The Amazon Resource Name (ARN) that references the billing group where the custom line item applies to.The number of resources that are associated to the custom line item.The time created.The custom line item's charge value currency.The most recent time the custom line item was modified.The product code associated with the custom line item.The Amazon Resource Name (ARN) that references the billing group where the custom line item applies to.A time range for which the custom line item is effective.The charge details of a custom line item.The custom line item's description.getName()
The custom line item's name.getTags()
Tag Manager which manages the tags for this resource.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.renderProperties
(Map<String, Object> props) void
setAccountId
(String value) The AWS account in which this custom line item will be applied to.void
setBillingGroupArn
(String value) The Amazon Resource Name (ARN) that references the billing group where the custom line item applies to.void
setBillingPeriodRange
(IResolvable value) A time range for which the custom line item is effective.void
A time range for which the custom line item is effective.void
The charge details of a custom line item.void
The charge details of a custom line item.void
setDescription
(String value) The custom line item's description.void
The custom line item's name.void
setTagsRaw
(List<CfnTag> value) A map that contains tag keys and tag values that are attached to a custom line item.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, 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 Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnCustomLineItem
protected CfnCustomLineItem(software.amazon.jsii.JsiiObjectRef objRef) -
CfnCustomLineItem
protected CfnCustomLineItem(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnCustomLineItem
@Stability(Stable) public CfnCustomLineItem(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnCustomLineItemProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- 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 classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrArn
The Amazon Resource Name (ARN) that references the billing group where the custom line item applies to. -
getAttrAssociationSize
The number of resources that are associated to the custom line item. -
getAttrCreationTime
The time created. -
getAttrCurrencyCode
The custom line item's charge value currency.Only one of the valid values can be used.
-
getAttrLastModifiedTime
The most recent time the custom line item was modified. -
getAttrProductCode
The product code associated with the custom line item. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
Tag Manager which manages the tags for this resource. -
getBillingGroupArn
The Amazon Resource Name (ARN) that references the billing group where the custom line item applies to. -
setBillingGroupArn
The Amazon Resource Name (ARN) that references the billing group where the custom line item applies to. -
getName
The custom line item's name. -
setName
The custom line item's name. -
getAccountId
The AWS account in which this custom line item will be applied to. -
setAccountId
The AWS account in which this custom line item will be applied to. -
getBillingPeriodRange
A time range for which the custom line item is effective. -
setBillingPeriodRange
A time range for which the custom line item is effective. -
setBillingPeriodRange
@Stability(Stable) public void setBillingPeriodRange(@Nullable CfnCustomLineItem.BillingPeriodRangeProperty value) A time range for which the custom line item is effective. -
getCustomLineItemChargeDetails
The charge details of a custom line item. -
setCustomLineItemChargeDetails
The charge details of a custom line item. -
setCustomLineItemChargeDetails
@Stability(Stable) public void setCustomLineItemChargeDetails(@Nullable CfnCustomLineItem.CustomLineItemChargeDetailsProperty value) The charge details of a custom line item. -
getDescription
The custom line item's description. -
setDescription
The custom line item's description. -
getTagsRaw
A map that contains tag keys and tag values that are attached to a custom line item. -
setTagsRaw
A map that contains tag keys and tag values that are attached to a custom line item.
-