software.amazon.awscdk.services.billingconductor

Class CfnPricingRule

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

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.928Z")
 @Stability(value=Stable)
public class CfnPricingRule
extends CfnResource
implements IInspectable

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

Creates a pricing rule can be associated to 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")
         .modifierPercentage(123)
         .name("name")
         .scope("scope")
         .type("type")
         // the properties below are optional
         .description("description")
         .service("service")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnPricingRule.Builder A fluent builder for CfnPricingRule.

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
	CfnPricingRule(software.constructs.Construct scope, 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
String	getAttrArn() The Amazon Resource Name (ARN) used to uniquely identify a pricing rule.
Number	getAttrAssociatedPricingPlanCount() The pricing plans count that this pricing rule is associated with.
Number	getAttrCreationTime() The time the pricing rule was created.
Number	getAttrLastModifiedTime() The most recent time the pricing rule was modified.
protected Map<String,Object>	getCfnProperties()
String	getDescription() The pricing rule description.
Number	getModifierPercentage() A percentage modifier applied on the public pricing rates.
String	getName() The name of a pricing rule.
String	getScope() The scope of pricing rule that indicates if it is globally applicable, or if it is service-specific.
String	getService() If the `Scope` attribute is `SERVICE` , this attribute indicates which service the `PricingRule` is applicable for.
TagManager	getTags() `AWS::BillingConductor::PricingRule.Tags`.
String	getType() The type of pricing rule.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value) The pricing rule description.
void	setModifierPercentage(Number value) A percentage modifier applied on the public pricing rates.
void	setName(String value) The name of a pricing rule.
void	setScope(String value) The scope of pricing rule that indicates if it is globally applicable, or if it is service-specific.
void	setService(String value) If the `Scope` attribute is `SERVICE` , this attribute indicates which service the `PricingRule` is applicable for.
void	setType(String value) The type of pricing rule.

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

CfnPricingRule

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

CfnPricingRule

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

CfnPricingRule

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

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

getAttrAssociatedPricingPlanCount

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

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

getAttrCreationTime

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

The time the pricing rule was created.

getAttrLastModifiedTime

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

The most recent time the pricing rule was modified.

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::PricingRule.Tags`.

getModifierPercentage

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

A percentage modifier applied on the public pricing rates.

setModifierPercentage

@Stability(value=Stable)
public void setModifierPercentage(@NotNull
                                                           Number value)

A percentage modifier applied on the public pricing rates.

getName

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

The name of a pricing rule.

setName

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

The name of a pricing rule.

getScope

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

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

setScope

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

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

getType

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

The type of pricing rule.

setType

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

The type of pricing rule.

getDescription

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

The pricing rule description.

setDescription

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

The pricing rule description.

getService

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

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

setService

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

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