CfnCustomLineItemPropsMixin

class aws_cdk.mixins_preview.aws_billingconductor.mixins.CfnCustomLineItemPropsMixin(props, *, strategy=None)

Bases: Mixin

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-billingconductor-customlineitem.html
CloudformationResource:: AWS::BillingConductor::CustomLineItem
Mixin:: true
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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_billingconductor import mixins as billingconductor_mixins

cfn_custom_line_item_props_mixin = billingconductor_mixins.CfnCustomLineItemPropsMixin(billingconductor_mixins.CfnCustomLineItemMixinProps(
    account_id="accountId",
    billing_group_arn="billingGroupArn",
    billing_period_range=billingconductor_mixins.CfnCustomLineItemPropsMixin.BillingPeriodRangeProperty(
        exclusive_end_billing_period="exclusiveEndBillingPeriod",
        inclusive_start_billing_period="inclusiveStartBillingPeriod"
    ),
    computation_rule="computationRule",
    custom_line_item_charge_details=billingconductor_mixins.CfnCustomLineItemPropsMixin.CustomLineItemChargeDetailsProperty(
        flat=billingconductor_mixins.CfnCustomLineItemPropsMixin.CustomLineItemFlatChargeDetailsProperty(
            charge_value=123
        ),
        line_item_filters=[billingconductor_mixins.CfnCustomLineItemPropsMixin.LineItemFilterProperty(
            attribute="attribute",
            match_option="matchOption",
            values=["values"]
        )],
        percentage=billingconductor_mixins.CfnCustomLineItemPropsMixin.CustomLineItemPercentageChargeDetailsProperty(
            child_associated_resources=["childAssociatedResources"],
            percentage_value=123
        ),
        type="type"
    ),
    description="description",
    name="name",
    presentation_details=billingconductor_mixins.CfnCustomLineItemPropsMixin.PresentationDetailsProperty(
        service="service"
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::BillingConductor::CustomLineItem.

Parameters:

props (Union[CfnCustomLineItemMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['accountId', 'billingGroupArn', 'billingPeriodRange', 'computationRule', 'customLineItemChargeDetails', 'description', 'name', 'presentationDetails', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

BillingPeriodRangeProperty

class CfnCustomLineItemPropsMixin.BillingPeriodRangeProperty(*, exclusive_end_billing_period=None, inclusive_start_billing_period=None)

Bases: object

The 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:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-billingconductor-customlineitem-billingperiodrange.html

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.mixins_preview.aws_billingconductor import mixins as billingconductor_mixins

billing_period_range_property = billingconductor_mixins.CfnCustomLineItemPropsMixin.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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-billingconductor-customlineitem-billingperiodrange.html#cfn-billingconductor-customlineitem-billingperiodrange-exclusiveendbillingperiod

inclusive_start_billing_period

The inclusive start billing period that defines a billing period range where a custom line is applied.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-billingconductor-customlineitem-billingperiodrange.html#cfn-billingconductor-customlineitem-billingperiodrange-inclusivestartbillingperiod

CustomLineItemChargeDetailsProperty

class CfnCustomLineItemPropsMixin.CustomLineItemChargeDetailsProperty(*, flat=None, line_item_filters=None, percentage=None, type=None)

Bases: object

The charge details of a custom line item.

It should contain only one of Flat or Percentage .

Parameters:

flat (Union[IResolvable, CustomLineItemFlatChargeDetailsProperty, Dict[str, Any], None]) – A CustomLineItemFlatChargeDetails that 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]) – A CustomLineItemPercentageChargeDetails that describes the charge details of a percentage custom line item.
type (Optional[str]) – The type of the custom line item that indicates whether the charge is a fee or credit.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-billingconductor-customlineitem-customlineitemchargedetails.html

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.mixins_preview.aws_billingconductor import mixins as billingconductor_mixins

custom_line_item_charge_details_property = billingconductor_mixins.CfnCustomLineItemPropsMixin.CustomLineItemChargeDetailsProperty(
    flat=billingconductor_mixins.CfnCustomLineItemPropsMixin.CustomLineItemFlatChargeDetailsProperty(
        charge_value=123
    ),
    line_item_filters=[billingconductor_mixins.CfnCustomLineItemPropsMixin.LineItemFilterProperty(
        attribute="attribute",
        match_option="matchOption",
        values=["values"]
    )],
    percentage=billingconductor_mixins.CfnCustomLineItemPropsMixin.CustomLineItemPercentageChargeDetailsProperty(
        child_associated_resources=["childAssociatedResources"],
        percentage_value=123
    ),
    type="type"
)

Attributes

flat

A CustomLineItemFlatChargeDetails that describes the charge details of a flat custom line item.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-billingconductor-customlineitem-customlineitemchargedetails.html#cfn-billingconductor-customlineitem-customlineitemchargedetails-flat

line_item_filters

A representation of the line item filter.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-billingconductor-customlineitem-customlineitemchargedetails.html#cfn-billingconductor-customlineitem-customlineitemchargedetails-lineitemfilters

percentage

A CustomLineItemPercentageChargeDetails that describes the charge details of a percentage custom line item.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-billingconductor-customlineitem-customlineitemchargedetails.html#cfn-billingconductor-customlineitem-customlineitemchargedetails-percentage

type

The type of the custom line item that indicates whether the charge is a fee or credit.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-billingconductor-customlineitem-customlineitemchargedetails.html#cfn-billingconductor-customlineitem-customlineitemchargedetails-type

CustomLineItemFlatChargeDetailsProperty

class CfnCustomLineItemPropsMixin.CustomLineItemFlatChargeDetailsProperty(*, charge_value=None)

Bases: object

The charge details of a custom line item.

It should contain only one of Flat or Percentage .

Parameters:: charge_value (Union[int, float, None]) – The custom line item’s fixed charge value in USD.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-billingconductor-customlineitem-customlineitemflatchargedetails.html
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.mixins_preview.aws_billingconductor import mixins as billingconductor_mixins

custom_line_item_flat_charge_details_property = billingconductor_mixins.CfnCustomLineItemPropsMixin.CustomLineItemFlatChargeDetailsProperty(
    charge_value=123
)

Attributes

charge_value

The custom line item’s fixed charge value in USD.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-billingconductor-customlineitem-customlineitemflatchargedetails.html#cfn-billingconductor-customlineitem-customlineitemflatchargedetails-chargevalue

CustomLineItemPercentageChargeDetailsProperty

class CfnCustomLineItemPropsMixin.CustomLineItemPercentageChargeDetailsProperty(*, child_associated_resources=None, percentage_value=None)

Bases: object

A representation of the charge details associated with a percentage custom line item.

Parameters:

child_associated_resources (Optional[Sequence[str]]) – A list of resource ARNs to associate to the percentage custom line item.
percentage_value (Union[int, float, None]) – The custom line item’s percentage value. This will be multiplied against the combined value of its associated resources to determine its charge value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-billingconductor-customlineitem-customlineitempercentagechargedetails.html

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.mixins_preview.aws_billingconductor import mixins as billingconductor_mixins

custom_line_item_percentage_charge_details_property = billingconductor_mixins.CfnCustomLineItemPropsMixin.CustomLineItemPercentageChargeDetailsProperty(
    child_associated_resources=["childAssociatedResources"],
    percentage_value=123
)

Attributes

child_associated_resources

A list of resource ARNs to associate to the percentage custom line item.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-billingconductor-customlineitem-customlineitempercentagechargedetails.html#cfn-billingconductor-customlineitem-customlineitempercentagechargedetails-childassociatedresources

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-billingconductor-customlineitem-customlineitempercentagechargedetails.html#cfn-billingconductor-customlineitem-customlineitempercentagechargedetails-percentagevalue

LineItemFilterProperty

class CfnCustomLineItemPropsMixin.LineItemFilterProperty(*, attribute=None, match_option=None, values=None)

Bases: object

A 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 LineItemFilter to exclude it.

Parameters:

attribute (Optional[str]) – The attribute of the line item filter. This specifies what attribute that you can filter on.
match_option (Optional[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.
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:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-billingconductor-customlineitem-lineitemfilter.html

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.mixins_preview.aws_billingconductor import mixins as billingconductor_mixins

line_item_filter_property = billingconductor_mixins.CfnCustomLineItemPropsMixin.LineItemFilterProperty(
    attribute="attribute",
    match_option="matchOption",
    values=["values"]
)

Attributes

attribute

The attribute of the line item filter.

This specifies what attribute that you can filter on.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-billingconductor-customlineitem-lineitemfilter.html#cfn-billingconductor-customlineitem-lineitemfilter-attribute

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-billingconductor-customlineitem-lineitemfilter.html#cfn-billingconductor-customlineitem-lineitemfilter-matchoption

values

The values of the line item filter.

This specifies the values to filter on. Currently, you can only exclude Savings Plans discounts.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-billingconductor-customlineitem-lineitemfilter.html#cfn-billingconductor-customlineitem-lineitemfilter-values

PresentationDetailsProperty

class CfnCustomLineItemPropsMixin.PresentationDetailsProperty(*, service=None)

Bases: object

Parameters:: service (Optional[str])
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-billingconductor-customlineitem-presentationdetails.html
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.mixins_preview.aws_billingconductor import mixins as billingconductor_mixins

presentation_details_property = billingconductor_mixins.CfnCustomLineItemPropsMixin.PresentationDetailsProperty(
    service="service"
)

Attributes

service

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-billingconductor-customlineitem-presentationdetails.html#cfn-billingconductor-customlineitem-presentationdetails-service

Type:: see