software.amazon.awscdk.services.billingconductor

Class CfnPricingRule

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

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-28T21:34:14.625Z")
public class CfnPricingRule
extends CfnResource
implements IInspectable

A CloudFormation `AWS::BillingConductor::PricingRule`.

Creates a pricing rule which can be associated with a pricing plan, or a set of pricing plans.

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.*;
 CfnPricingRule cfnPricingRule = CfnPricingRule.Builder.create(this, "MyCfnPricingRule")
         .name("name")
         .scope("scope")
         .type("type")
         // the properties below are optional
         .billingEntity("billingEntity")
         .description("description")
         .modifierPercentage(123)
         .operation("operation")
         .service("service")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .tiering(TieringProperty.builder()
                 .freeTier(FreeTierProperty.builder()
                         .activated(false)
                         .build())
                 .build())
         .usageType("usageType")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnPricingRule.Builder A fluent builder for CfnPricingRule.
static interface	CfnPricingRule.FreeTierProperty Example:
static interface	CfnPricingRule.TieringProperty Example:

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
	CfnPricingRule(Construct scope, java.lang.String id, CfnPricingRuleProps props) Create a new `AWS::BillingConductor::PricingRule`.
protected	CfnPricingRule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnPricingRule(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrArn() The Amazon Resource Name (ARN) used to uniquely identify a pricing rule.
java.lang.Number	getAttrAssociatedPricingPlanCount() The pricing plans count that this pricing rule is associated with.
java.lang.Number	getAttrCreationTime() The time the pricing rule was created.
java.lang.Number	getAttrLastModifiedTime() The most recent time the pricing rule was modified.
java.lang.String	getBillingEntity() The seller of services provided by AWS , their affiliates, or third-party providers selling services via AWS Marketplace .
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getDescription() The pricing rule description.
java.lang.Number	getModifierPercentage() A percentage modifier applied on the public pricing rates.
java.lang.String	getName() The name of a pricing rule.
java.lang.String	getOperation() `AWS::BillingConductor::PricingRule.Operation`.
java.lang.String	getScope() The scope of pricing rule that indicates if it is globally applicable, or if it is service-specific.
java.lang.String	getService() If the `Scope` attribute is `SERVICE` , this attribute indicates which service the `PricingRule` is applicable for.
TagManager	getTags() A map that contains tag keys and tag values that are attached to a pricing rule.
java.lang.Object	getTiering() The set of tiering configurations for the pricing rule.
java.lang.String	getType() The type of pricing rule.
java.lang.String	getUsageType() Usage Type is the unit that each service uses to measure the usage of a specific type of resource.
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	setBillingEntity(java.lang.String value) The seller of services provided by AWS , their affiliates, or third-party providers selling services via AWS Marketplace .
void	setDescription(java.lang.String value) The pricing rule description.
void	setModifierPercentage(java.lang.Number value) A percentage modifier applied on the public pricing rates.
void	setName(java.lang.String value) The name of a pricing rule.
void	setOperation(java.lang.String value) `AWS::BillingConductor::PricingRule.Operation`.
void	setScope(java.lang.String value) The scope of pricing rule that indicates if it is globally applicable, or if it is service-specific.
void	setService(java.lang.String value) If the `Scope` attribute is `SERVICE` , this attribute indicates which service the `PricingRule` is applicable for.
void	setTiering(CfnPricingRule.TieringProperty value) The set of tiering configurations for the pricing rule.
void	setTiering(IResolvable value) The set of tiering configurations for the pricing rule.
void	setType(java.lang.String value) The type of pricing rule.
void	setUsageType(java.lang.String value) Usage Type is the unit that each service uses to measure the usage of a specific type of resource.

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

CfnPricingRule

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

CfnPricingRule

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

CfnPricingRule

public CfnPricingRule(Construct scope,
                      java.lang.String id,
                      CfnPricingRuleProps props)

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

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) used to uniquely identify a pricing rule.

getAttrAssociatedPricingPlanCount

public java.lang.Number getAttrAssociatedPricingPlanCount()

The pricing plans count that this pricing rule is associated with.

getAttrCreationTime

public java.lang.Number getAttrCreationTime()

The time the pricing rule was created.

getAttrLastModifiedTime

public java.lang.Number getAttrLastModifiedTime()

The most recent time the pricing rule was modified.

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 pricing rule.

getName

public java.lang.String getName()

The name of a pricing rule.

setName

public void setName(java.lang.String value)

The name of a pricing rule.

getScope

public java.lang.String getScope()

The scope of pricing rule that indicates if it is globally applicable, or if it is service-specific.

setScope

public void setScope(java.lang.String value)

The scope of pricing rule that indicates if it is globally applicable, or if it is service-specific.

getType

public java.lang.String getType()

The type of pricing rule.

setType

public void setType(java.lang.String value)

The type of pricing rule.

getBillingEntity

public java.lang.String getBillingEntity()

The seller of services provided by AWS , their affiliates, or third-party providers selling services via AWS Marketplace .

setBillingEntity

public void setBillingEntity(java.lang.String value)

The seller of services provided by AWS , their affiliates, or third-party providers selling services via AWS Marketplace .

getDescription

public java.lang.String getDescription()

The pricing rule description.

setDescription

public void setDescription(java.lang.String value)

The pricing rule description.

getModifierPercentage

public java.lang.Number getModifierPercentage()

A percentage modifier applied on the public pricing rates.

setModifierPercentage

public void setModifierPercentage(java.lang.Number value)

A percentage modifier applied on the public pricing rates.

getOperation

public java.lang.String getOperation()

`AWS::BillingConductor::PricingRule.Operation`.

setOperation

public void setOperation(java.lang.String value)

`AWS::BillingConductor::PricingRule.Operation`.

getService

public java.lang.String getService()

If the `Scope` attribute is `SERVICE` , this attribute indicates which service the `PricingRule` is applicable for.

setService

public void setService(java.lang.String value)

If the `Scope` attribute is `SERVICE` , this attribute indicates which service the `PricingRule` is applicable for.

getTiering

public java.lang.Object getTiering()

The set of tiering configurations for the pricing rule.

setTiering

public void setTiering(IResolvable value)

The set of tiering configurations for the pricing rule.

setTiering

public void setTiering(CfnPricingRule.TieringProperty value)

The set of tiering configurations for the pricing rule.

getUsageType

public java.lang.String getUsageType()

Usage Type is the unit that each service uses to measure the usage of a specific type of resource.

setUsageType

public void setUsageType(java.lang.String value)

Usage Type is the unit that each service uses to measure the usage of a specific type of resource.