CfnCustomLineItem
- class aws_cdk.aws_billingconductor.CfnCustomLineItem(scope, id, *, billing_group_arn, name, account_id=None, billing_period_range=None, computation_rule=None, custom_line_item_charge_details=None, description=None, presentation_details=None, tags=None)
Bases:
CfnResourceCreates 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.
- See:
- CloudformationResource:
AWS::BillingConductor::CustomLineItem
- ExampleMetadata:
fixture=_generated
Example:
from aws_cdk import CfnTag # The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_billingconductor as billingconductor cfn_custom_line_item = billingconductor.CfnCustomLineItem(self, "MyCfnCustomLineItem", billing_group_arn="billingGroupArn", name="name", # the properties below are optional account_id="accountId", billing_period_range=billingconductor.CfnCustomLineItem.BillingPeriodRangeProperty( exclusive_end_billing_period="exclusiveEndBillingPeriod", inclusive_start_billing_period="inclusiveStartBillingPeriod" ), computation_rule="computationRule", custom_line_item_charge_details=billingconductor.CfnCustomLineItem.CustomLineItemChargeDetailsProperty( type="type", # the properties below are optional flat=billingconductor.CfnCustomLineItem.CustomLineItemFlatChargeDetailsProperty( charge_value=123 ), line_item_filters=[billingconductor.CfnCustomLineItem.LineItemFilterProperty( attribute="attribute", match_option="matchOption", # the properties below are optional attribute_values=["attributeValues"], values=["values"] )], percentage=billingconductor.CfnCustomLineItem.CustomLineItemPercentageChargeDetailsProperty( percentage_value=123, # the properties below are optional child_associated_resources=["childAssociatedResources"] ) ), description="description", presentation_details=billingconductor.CfnCustomLineItem.PresentationDetailsProperty( service="service" ), tags=[CfnTag( key="key", value="value" )] )
Create a new
AWS::BillingConductor::CustomLineItem.- Parameters:
scope (
Construct) – Scope in which this resource is defined.id (
str) – Construct identifier for this resource (unique in its scope).billing_group_arn (
str) – The Amazon Resource Name (ARN) that references the billing group where the custom line item applies to.name (
str) – The custom line item’s name.account_id (
Optional[str]) – The AWS account in which this custom line item will be applied to.billing_period_range (
Union[IResolvable,BillingPeriodRangeProperty,Dict[str,Any],None]) – A time range for which the custom line item is effective.computation_rule (
Optional[str]) – The computation rule that determines how the custom line item charges are computed and reflected in the bill.custom_line_item_charge_details (
Union[IResolvable,CustomLineItemChargeDetailsProperty,Dict[str,Any],None]) – The charge details of a custom line item. It should contain only one ofFlatorPercentage.description (
Optional[str]) – The custom line item’s description. This is shown on the Bills page in association with the charge value.presentation_details (
Union[IResolvable,PresentationDetailsProperty,Dict[str,Any],None]) – Configuration details specifying how the custom line item charges are presented, including which service the charges are shown under.tags (
Optional[Sequence[Union[CfnTag,Dict[str,Any]]]]) – A map that contains tag keys and tag values that are attached to a custom line item.
Methods
- add_deletion_override(path)
Syntactic sugar for
addOverride(path, undefined).- Parameters:
path (
str) – The path of the value to delete.- Return type:
None
- add_dependency(target)
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
- Parameters:
target (
CfnResource)- Return type:
None
- add_depends_on(target)
(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
- Parameters:
target (
CfnResource)- Deprecated:
use addDependency
- Stability:
deprecated
- Return type:
None
- add_metadata(key, value)
Add a value to the CloudFormation Resource Metadata.
- Parameters:
key (
str)value (
Any)
- See:
- Return type:
None
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- add_override(path, value)
Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverrideor prefixpathwith “Properties.” (i.e.Properties.TopicName).If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal
.in the property name, prefix with a\. In most programming languages you will need to write this as"\\."because the\itself will need to be escaped.For example:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
valueargument toaddOverridewill not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.- Parameters:
path (
str) –The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (
Any) –The value. Could be primitive or complex.
- Return type:
None
- add_property_deletion_override(property_path)
Adds an override that deletes the value of a property from the resource definition.
- Parameters:
property_path (
str) – The path to the property.- Return type:
None
- add_property_override(property_path, value)
Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value).- Parameters:
property_path (
str) – The path of the property.value (
Any) – The value.
- Return type:
None
- apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)
Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (
RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:- Parameters:
policy (
Optional[RemovalPolicy])apply_to_update_replace_policy (
Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.
- See:
- Return type:
None
- get_att(attribute_name, type_hint=None)
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g.
resource.arn), but this can be used for future compatibility in case there is no generated attribute.- Parameters:
attribute_name (
str) – The name of the attribute.type_hint (
Optional[ResolutionTypeHint])
- Return type:
- get_metadata(key)
Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters:
key (
str)- See:
- Return type:
Any
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- inspect(inspector)
Examines the CloudFormation resource and discloses attributes.
- Parameters:
inspector (
TreeInspector) – tree inspector to collect and process attributes.- Return type:
None
- obtain_dependencies()
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
- Return type:
List[Union[Stack,CfnResource]]
- obtain_resource_dependencies()
Get a shallow copy of dependencies between this resource and other resources in the same stack.
- Return type:
List[CfnResource]
- override_logical_id(new_logical_id)
Overrides the auto-generated logical ID with a specific ID.
- Parameters:
new_logical_id (
str) – The new logical ID to use for this stack element.- Return type:
None
- remove_dependency(target)
Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
- Parameters:
target (
CfnResource)- Return type:
None
- replace_dependency(target, new_target)
Replaces one dependency with another.
- Parameters:
target (
CfnResource) – The dependency to replace.new_target (
CfnResource) – The new dependency to add.
- Return type:
None
- to_string()
Returns a string representation of this construct.
- Return type:
str- Returns:
a string representation of this resource
Attributes
- CFN_RESOURCE_TYPE_NAME = 'AWS::BillingConductor::CustomLineItem'
- account_id
The AWS account in which this custom line item will be applied to.
- attr_arn
The Amazon Resource Name (ARN) that references the billing group where the custom line item applies to.
- CloudformationAttribute:
Arn
- attr_association_size
The number of resources that are associated to the custom line item.
- CloudformationAttribute:
AssociationSize
- attr_creation_time
The time created.
- CloudformationAttribute:
CreationTime
- attr_currency_code
The custom line item’s charge value currency.
Only one of the valid values can be used.
- CloudformationAttribute:
CurrencyCode
- attr_last_modified_time
The most recent time the custom line item was modified.
- CloudformationAttribute:
LastModifiedTime
- attr_product_code
The product code associated with the custom line item.
- CloudformationAttribute:
ProductCode
- billing_group_arn
The Amazon Resource Name (ARN) that references the billing group where the custom line item applies to.
- billing_period_range
A time range for which the custom line item is effective.
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- computation_rule
The computation rule that determines how the custom line item charges are computed and reflected in the bill.
- creation_stack
return:
the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
- custom_line_item_charge_details
The charge details of a custom line item.
- custom_line_item_ref
A reference to a CustomLineItem resource.
- description
The custom line item’s description.
- env
- logical_id
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use
overrideLogicalId(newLogicalId).- Returns:
the logical ID as a stringified token. This value will only get resolved during synthesis.
- name
The custom line item’s name.
- node
The tree node.
- presentation_details
Configuration details specifying how the custom line item charges are presented, including which service the charges are shown under.
- ref
Return a string that will be resolved to a CloudFormation
{ Ref }for this element.If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through
Lazy.any({ produce: resource.ref }).
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- tags
Tag Manager which manages the tags for this resource.
- tags_raw
A map that contains tag keys and tag values that are attached to a custom line item.
Static Methods
- classmethod arn_for_custom_line_item(resource)
- Parameters:
resource (
ICustomLineItemRef)- Return type:
str
- classmethod is_cfn_custom_line_item(x)
Checks whether the given object is a CfnCustomLineItem.
- Parameters:
x (
Any)- Return type:
bool
- classmethod is_cfn_element(x)
Returns
trueif a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceofto allow stack elements from different versions of this library to be included in the same stack.- Parameters:
x (
Any)- Return type:
bool- Returns:
The construct as a stack element or undefined if it is not a stack element.
- classmethod is_cfn_resource(x)
Check whether the given object is a CfnResource.
- Parameters:
x (
Any)- Return type:
bool
- classmethod is_construct(x)
Checks if
xis a construct.Use this method instead of
instanceofto properly detectConstructinstances, even when the construct library is symlinked.Explanation: in JavaScript, multiple copies of the
constructslibrary on disk are seen as independent, completely different libraries. As a consequence, the classConstructin each copy of theconstructslibrary is seen as a different class, and an instance of one class will not test asinstanceofthe other class.npm installwill not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of theconstructslibrary can be accidentally installed, andinstanceofwill behave unpredictably. It is safest to avoid usinginstanceof, and using this type-testing method instead.- Parameters:
x (
Any) – Any object.- Return type:
bool- Returns:
true if
xis an object created from a class which extendsConstruct.
BillingPeriodRangeProperty
- class CfnCustomLineItem.BillingPeriodRangeProperty(*, exclusive_end_billing_period=None, inclusive_start_billing_period=None)
Bases:
objectThe billing period range in which the custom line item request will be applied.
- Parameters:
exclusive_end_billing_period (
Optional[str]) – The exclusive end billing period that defines a billing period range where a custom line is applied.inclusive_start_billing_period (
Optional[str]) – The inclusive start billing period that defines a billing period range where a custom line is applied.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_billingconductor as billingconductor billing_period_range_property = billingconductor.CfnCustomLineItem.BillingPeriodRangeProperty( exclusive_end_billing_period="exclusiveEndBillingPeriod", inclusive_start_billing_period="inclusiveStartBillingPeriod" )
Attributes
- exclusive_end_billing_period
The exclusive end billing period that defines a billing period range where a custom line is applied.
- inclusive_start_billing_period
The inclusive start billing period that defines a billing period range where a custom line is applied.
CustomLineItemChargeDetailsProperty
- class CfnCustomLineItem.CustomLineItemChargeDetailsProperty(*, type, flat=None, line_item_filters=None, percentage=None)
Bases:
objectThe charge details of a custom line item.
It should contain only one of
FlatorPercentage.- Parameters:
type (
str) – The type of the custom line item that indicates whether the charge is a fee or credit.flat (
Union[IResolvable,CustomLineItemFlatChargeDetailsProperty,Dict[str,Any],None]) – ACustomLineItemFlatChargeDetailsthat describes the charge details of a flat custom line item.line_item_filters (
Union[IResolvable,Sequence[Union[IResolvable,LineItemFilterProperty,Dict[str,Any]]],None]) – A representation of the line item filter.percentage (
Union[IResolvable,CustomLineItemPercentageChargeDetailsProperty,Dict[str,Any],None]) – ACustomLineItemPercentageChargeDetailsthat describes the charge details of a percentage custom line item.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_billingconductor as billingconductor custom_line_item_charge_details_property = billingconductor.CfnCustomLineItem.CustomLineItemChargeDetailsProperty( type="type", # the properties below are optional flat=billingconductor.CfnCustomLineItem.CustomLineItemFlatChargeDetailsProperty( charge_value=123 ), line_item_filters=[billingconductor.CfnCustomLineItem.LineItemFilterProperty( attribute="attribute", match_option="matchOption", # the properties below are optional attribute_values=["attributeValues"], values=["values"] )], percentage=billingconductor.CfnCustomLineItem.CustomLineItemPercentageChargeDetailsProperty( percentage_value=123, # the properties below are optional child_associated_resources=["childAssociatedResources"] ) )
Attributes
- flat
A
CustomLineItemFlatChargeDetailsthat describes the charge details of a flat custom line item.
- line_item_filters
A representation of the line item filter.
- percentage
A
CustomLineItemPercentageChargeDetailsthat describes the charge details of a percentage custom line item.
- type
The type of the custom line item that indicates whether the charge is a fee or credit.
CustomLineItemFlatChargeDetailsProperty
- class CfnCustomLineItem.CustomLineItemFlatChargeDetailsProperty(*, charge_value)
Bases:
objectThe charge details of a custom line item.
It should contain only one of
FlatorPercentage.- Parameters:
charge_value (
Union[int,float]) – The custom line item’s fixed charge value in USD.- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_billingconductor as billingconductor custom_line_item_flat_charge_details_property = billingconductor.CfnCustomLineItem.CustomLineItemFlatChargeDetailsProperty( charge_value=123 )
Attributes
- charge_value
The custom line item’s fixed charge value in USD.
CustomLineItemPercentageChargeDetailsProperty
- class CfnCustomLineItem.CustomLineItemPercentageChargeDetailsProperty(*, percentage_value, child_associated_resources=None)
Bases:
objectA representation of the charge details associated with a percentage custom line item.
- Parameters:
percentage_value (
Union[int,float]) – The custom line item’s percentage value. This will be multiplied against the combined value of its associated resources to determine its charge value.child_associated_resources (
Optional[Sequence[str]]) – A list of resource ARNs to associate to the percentage custom line item.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_billingconductor as billingconductor custom_line_item_percentage_charge_details_property = billingconductor.CfnCustomLineItem.CustomLineItemPercentageChargeDetailsProperty( percentage_value=123, # the properties below are optional child_associated_resources=["childAssociatedResources"] )
Attributes
- child_associated_resources
A list of resource ARNs to associate to the percentage custom line item.
- percentage_value
The custom line item’s percentage value.
This will be multiplied against the combined value of its associated resources to determine its charge value.
LineItemFilterProperty
- class CfnCustomLineItem.LineItemFilterProperty(*, attribute, match_option, attribute_values=None, values=None)
Bases:
objectA representation of the line item filter for your custom line item.
You can use line item filters to include or exclude specific resource values from the billing group’s total cost. For example, if you create a custom line item and you want to filter out a value, such as Savings Plans discounts, you can update
LineItemFilterto exclude it.- Parameters:
attribute (
str) – The attribute of the line item filter. This specifies what attribute that you can filter on.match_option (
str) – The match criteria of the line item filter. This parameter specifies whether not to include the resource value from the billing group total cost.attribute_values (
Optional[Sequence[str]]) – The values of the line item filter. This specifies the values to filter on.values (
Optional[Sequence[str]]) – The values of the line item filter. This specifies the values to filter on. Currently, you can only exclude Savings Plans discounts.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_billingconductor as billingconductor line_item_filter_property = billingconductor.CfnCustomLineItem.LineItemFilterProperty( attribute="attribute", match_option="matchOption", # the properties below are optional attribute_values=["attributeValues"], values=["values"] )
Attributes
- attribute
The attribute of the line item filter.
This specifies what attribute that you can filter on.
- attribute_values
The values of the line item filter.
This specifies the values to filter on.
- match_option
The match criteria of the line item filter.
This parameter specifies whether not to include the resource value from the billing group total cost.
- values
The values of the line item filter.
This specifies the values to filter on. Currently, you can only exclude Savings Plans discounts.
PresentationDetailsProperty
- class CfnCustomLineItem.PresentationDetailsProperty(*, service)
Bases:
objectAn object that defines how custom line item charges are presented in the bill, containing specifications for service presentation.
- Parameters:
service (
str) – The service under which the custom line item charges will be presented. Must be a string between 1 and 128 characters matching the pattern^[a-zA-Z0-9]+$.- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_billingconductor as billingconductor presentation_details_property = billingconductor.CfnCustomLineItem.PresentationDetailsProperty( service="service" )
Attributes
- service
The service under which the custom line item charges will be presented.
Must be a string between 1 and 128 characters matching the pattern
^[a-zA-Z0-9]+$.