Class: AWSCDK::BillingConductor::CfnPricingRule

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSBillingconductor::IPricingRuleRef
Defined in:
billing_conductor/cfn_pricing_rule.rb

Overview

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

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnPricingRule

Create a new AWS::BillingConductor::PricingRule.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::BillingConductor::CfnPricingRuleProps) —

    Resource properties.



18
19
20
21
22
23
24
 
# File 'billing_conductor/cfn_pricing_rule.rb', line 18

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::BillingConductor::CfnPricingRuleProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYmlsbGluZ2NvbmR1Y3Rvci5DZm5QcmljaW5nUnVsZVByb3BzIn0=")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_pricing_rule(resource) ⇒ String

Parameters:

Returns:

  • (String) 


85
86
87
88
 
# File 'billing_conductor/cfn_pricing_rule.rb', line 85

def self.arn_for_pricing_rule(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19iaWxsaW5nY29uZHVjdG9yLklQcmljaW5nUnVsZVJlZiJ9")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_billingconductor.CfnPricingRule", "arnForPricingRule", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


192
193
194
 
# File 'billing_conductor/cfn_pricing_rule.rb', line 192

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_billingconductor.CfnPricingRule", "CFN_RESOURCE_TYPE_NAME")
end

.is_cfn_pricing_rule(x) ⇒ Boolean

Checks whether the given object is a CfnPricingRule.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


94
95
96
97
 
# File 'billing_conductor/cfn_pricing_rule.rb', line 94

def self.is_cfn_pricing_rule(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_billingconductor.CfnPricingRule", "isCfnPricingRule", [x])
end

.jsii_overridable_methods ⇒ Object 



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'billing_conductor/cfn_pricing_rule.rb', line 26

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_arn => { kind: :property, name: "attrArn", is_optional: false },
    :attr_associated_pricing_plan_count => { kind: :property, name: "attrAssociatedPricingPlanCount", is_optional: false },
    :attr_creation_time => { kind: :property, name: "attrCreationTime", is_optional: false },
    :attr_last_modified_time => { kind: :property, name: "attrLastModifiedTime", is_optional: false },
    :pricing_rule_ref => { kind: :property, name: "pricingRuleRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :scope => { kind: :property, name: "scope", is_optional: false },
    :type => { kind: :property, name: "type", is_optional: false },
    :billing_entity => { kind: :property, name: "billingEntity", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :modifier_percentage => { kind: :property, name: "modifierPercentage", is_optional: true },
    :operation => { kind: :property, name: "operation", is_optional: true },
    :service => { kind: :property, name: "service", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :tiering => { kind: :property, name: "tiering", is_optional: true },
    :usage_type => { kind: :property, name: "usageType", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



408
409
410
411
 
# File 'billing_conductor/cfn_pricing_rule.rb', line 408

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

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:



420
421
422
423
 
# File 'billing_conductor/cfn_pricing_rule.rb', line 420

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



430
431
432
433
 
# File 'billing_conductor/cfn_pricing_rule.rb', line 430

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



441
442
443
444
445
 
# File 'billing_conductor/cfn_pricing_rule.rb', line 441

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "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,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will 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 (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


498
499
500
501
502
 
# File 'billing_conductor/cfn_pricing_rule.rb', line 498

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



508
509
510
511
 
# File 'billing_conductor/cfn_pricing_rule.rb', line 508

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



520
521
522
523
524
 
# File 'billing_conductor/cfn_pricing_rule.rb', line 520

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



533
534
535
536
 
# File 'billing_conductor/cfn_pricing_rule.rb', line 533

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

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:

See Also:



555
556
557
558
559
560
 
# File 'billing_conductor/cfn_pricing_rule.rb', line 555

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_arn ⇒ String

The Amazon Resource Name (ARN) used to uniquely identify a pricing rule.

Returns:

  • (String) 


199
200
201
 
# File 'billing_conductor/cfn_pricing_rule.rb', line 199

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_associated_pricing_plan_count ⇒ Numeric

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

Returns:

  • (Numeric) 


206
207
208
 
# File 'billing_conductor/cfn_pricing_rule.rb', line 206

def attr_associated_pricing_plan_count()
  jsii_get_property("attrAssociatedPricingPlanCount")
end

#attr_creation_time ⇒ Numeric

The time the pricing rule was created.

Returns:

  • (Numeric) 


213
214
215
 
# File 'billing_conductor/cfn_pricing_rule.rb', line 213

def attr_creation_time()
  jsii_get_property("attrCreationTime")
end

#attr_last_modified_time ⇒ Numeric

The most recent time the pricing rule was modified.

Returns:

  • (Numeric) 


220
221
222
 
# File 'billing_conductor/cfn_pricing_rule.rb', line 220

def attr_last_modified_time()
  jsii_get_property("attrLastModifiedTime")
end

#billing_entity ⇒ String?

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

Returns:

  • (String, nil) 


277
278
279
 
# File 'billing_conductor/cfn_pricing_rule.rb', line 277

def billing_entity()
  jsii_get_property("billingEntity")
end

#billing_entity=(value) ⇒ Object 



281
282
283
284
 
# File 'billing_conductor/cfn_pricing_rule.rb', line 281

def billing_entity=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "billingEntity") unless value.nil?
  jsii_set_property("billingEntity", value)
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



145
146
147
 
# File 'billing_conductor/cfn_pricing_rule.rb', line 145

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


150
151
152
 
# File 'billing_conductor/cfn_pricing_rule.rb', line 150

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


564
565
566
567
 
# File 'billing_conductor/cfn_pricing_rule.rb', line 564

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


155
156
157
 
# File 'billing_conductor/cfn_pricing_rule.rb', line 155

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


162
163
164
 
# File 'billing_conductor/cfn_pricing_rule.rb', line 162

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


107
108
109
 
# File 'billing_conductor/cfn_pricing_rule.rb', line 107

def creation_stack()
  jsii_get_property("creationStack")
end

#description ⇒ String?

The pricing rule description.

Returns:

  • (String, nil) 


289
290
291
 
# File 'billing_conductor/cfn_pricing_rule.rb', line 289

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



293
294
295
296
 
# File 'billing_conductor/cfn_pricing_rule.rb', line 293

def description=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless value.nil?
  jsii_set_property("description", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



167
168
169
 
# File 'billing_conductor/cfn_pricing_rule.rb', line 167

def env()
  jsii_get_property("env")
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

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:

Returns:



577
578
579
580
581
 
# File 'billing_conductor/cfn_pricing_rule.rb', line 577

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



588
589
590
591
 
# File 'billing_conductor/cfn_pricing_rule.rb', line 588

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



658
659
660
661
 
# File 'billing_conductor/cfn_pricing_rule.rb', line 658

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#logical_id ⇒ String

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 override_logical_id(new_logical_id).

Returns:

  • (String) 


119
120
121
 
# File 'billing_conductor/cfn_pricing_rule.rb', line 119

def logical_id()
  jsii_get_property("logicalId")
end

#modifier_percentage ⇒ Numeric?

A percentage modifier applied on the public pricing rates.

Returns:

  • (Numeric, nil) 


301
302
303
 
# File 'billing_conductor/cfn_pricing_rule.rb', line 301

def modifier_percentage()
  jsii_get_property("modifierPercentage")
end

#modifier_percentage=(value) ⇒ Object 



305
306
307
308
 
# File 'billing_conductor/cfn_pricing_rule.rb', line 305

def modifier_percentage=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "modifierPercentage") unless value.nil?
  jsii_set_property("modifierPercentage", value)
end

#name ⇒ String

The name of a pricing rule.

Returns:

  • (String) 


241
242
243
 
# File 'billing_conductor/cfn_pricing_rule.rb', line 241

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



245
246
247
248
 
# File 'billing_conductor/cfn_pricing_rule.rb', line 245

def name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  jsii_set_property("name", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


102
103
104
 
# File 'billing_conductor/cfn_pricing_rule.rb', line 102

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



599
600
601
 
# File 'billing_conductor/cfn_pricing_rule.rb', line 599

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



606
607
608
 
# File 'billing_conductor/cfn_pricing_rule.rb', line 606

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#operation ⇒ String?

Operation is the specific AWS action covered by this line item.

Returns:

  • (String, nil) 


313
314
315
 
# File 'billing_conductor/cfn_pricing_rule.rb', line 313

def operation()
  jsii_get_property("operation")
end

#operation=(value) ⇒ Object 



317
318
319
320
 
# File 'billing_conductor/cfn_pricing_rule.rb', line 317

def operation=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "operation") unless value.nil?
  jsii_set_property("operation", value)
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



399
400
401
402
 
# File 'billing_conductor/cfn_pricing_rule.rb', line 399

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#pricing_rule_ref ⇒ AWSCDK::Interfaces::AWSBillingconductor::PricingRuleReference

A reference to a PricingRule resource.

Returns:



227
228
229
 
# File 'billing_conductor/cfn_pricing_rule.rb', line 227

def pricing_rule_ref()
  jsii_get_property("pricingRuleRef")
end

#ref ⇒ String

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 }).

Returns:

  • (String) 


138
139
140
 
# File 'billing_conductor/cfn_pricing_rule.rb', line 138

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

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:



617
618
619
620
 
# File 'billing_conductor/cfn_pricing_rule.rb', line 617

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


624
625
626
627
 
# File 'billing_conductor/cfn_pricing_rule.rb', line 624

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



634
635
636
637
638
 
# File 'billing_conductor/cfn_pricing_rule.rb', line 634

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#scope ⇒ String

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

Returns:

  • (String) 


253
254
255
 
# File 'billing_conductor/cfn_pricing_rule.rb', line 253

def scope()
  jsii_get_property("scope")
end

#scope=(value) ⇒ Object 



257
258
259
260
 
# File 'billing_conductor/cfn_pricing_rule.rb', line 257

def scope=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "scope")
  jsii_set_property("scope", value)
end

#service ⇒ String?

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

Returns:

  • (String, nil) 


325
326
327
 
# File 'billing_conductor/cfn_pricing_rule.rb', line 325

def service()
  jsii_get_property("service")
end

#service=(value) ⇒ Object 



329
330
331
332
 
# File 'billing_conductor/cfn_pricing_rule.rb', line 329

def service=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "service") unless value.nil?
  jsii_set_property("service", value)
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



643
644
645
 
# File 'billing_conductor/cfn_pricing_rule.rb', line 643

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



128
129
130
 
# File 'billing_conductor/cfn_pricing_rule.rb', line 128

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



234
235
236
 
# File 'billing_conductor/cfn_pricing_rule.rb', line 234

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

A map that contains tag keys and tag values that are attached to a pricing rule.

Returns:



337
338
339
 
# File 'billing_conductor/cfn_pricing_rule.rb', line 337

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



341
342
343
344
345
 
# File 'billing_conductor/cfn_pricing_rule.rb', line 341

def tags_raw=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tagsRaw") unless value.nil?
  jsii_set_property("tagsRaw", value)
end

#tiering ⇒ AWSCDK::IResolvable, ...

The set of tiering configurations for the pricing rule.

Returns:



350
351
352
 
# File 'billing_conductor/cfn_pricing_rule.rb', line 350

def tiering()
  jsii_get_property("tiering")
end

#tiering=(value) ⇒ Object 



354
355
356
357
358
 
# File 'billing_conductor/cfn_pricing_rule.rb', line 354

def tiering=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::BillingConductor::CfnPricingRule::TieringProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iaWxsaW5nY29uZHVjdG9yLkNmblByaWNpbmdSdWxlLlRpZXJpbmdQcm9wZXJ0eSJ9XX19")), "tiering") unless value.nil?
  jsii_set_property("tiering", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



375
376
377
 
# File 'billing_conductor/cfn_pricing_rule.rb', line 375

def to_string()
  jsii_call_method("toString", [])
end

#type ⇒ String

The type of pricing rule.

Returns:

  • (String) 


265
266
267
 
# File 'billing_conductor/cfn_pricing_rule.rb', line 265

def type()
  jsii_get_property("type")
end

#type=(value) ⇒ Object 



269
270
271
272
 
# File 'billing_conductor/cfn_pricing_rule.rb', line 269

def type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type")
  jsii_set_property("type", value)
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


175
176
177
 
# File 'billing_conductor/cfn_pricing_rule.rb', line 175

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


185
186
187
 
# File 'billing_conductor/cfn_pricing_rule.rb', line 185

def updated_properties()
  jsii_get_property("updatedProperties")
end

#usage_type ⇒ String?

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

Returns:

  • (String, nil) 


363
364
365
 
# File 'billing_conductor/cfn_pricing_rule.rb', line 363

def usage_type()
  jsii_get_property("usageType")
end

#usage_type=(value) ⇒ Object 



367
368
369
370
 
# File 'billing_conductor/cfn_pricing_rule.rb', line 367

def usage_type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "usageType") unless value.nil?
  jsii_set_property("usageType", value)
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


649
650
651
652
 
# File 'billing_conductor/cfn_pricing_rule.rb', line 649

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


388
389
390
391
392
393
 
# File 'billing_conductor/cfn_pricing_rule.rb', line 388

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end