Documentation
¶
Index ¶
- func CfnBillingGroup_CFN_RESOURCE_TYPE_NAME() *string
- func CfnBillingGroup_IsCfnElement(x interface{}) *bool
- func CfnBillingGroup_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnBillingGroup_IsConstruct(x interface{}) *bool
- func CfnCustomLineItem_CFN_RESOURCE_TYPE_NAME() *string
- func CfnCustomLineItem_IsCfnElement(x interface{}) *bool
- func CfnCustomLineItem_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnCustomLineItem_IsConstruct(x interface{}) *bool
- func CfnPricingPlan_CFN_RESOURCE_TYPE_NAME() *string
- func CfnPricingPlan_IsCfnElement(x interface{}) *bool
- func CfnPricingPlan_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnPricingPlan_IsConstruct(x interface{}) *bool
- func CfnPricingRule_CFN_RESOURCE_TYPE_NAME() *string
- func CfnPricingRule_IsCfnElement(x interface{}) *bool
- func CfnPricingRule_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnPricingRule_IsConstruct(x interface{}) *bool
- func NewCfnBillingGroup_Override(c CfnBillingGroup, scope constructs.Construct, id *string, ...)
- func NewCfnCustomLineItem_Override(c CfnCustomLineItem, scope constructs.Construct, id *string, ...)
- func NewCfnPricingPlan_Override(c CfnPricingPlan, scope constructs.Construct, id *string, ...)
- func NewCfnPricingRule_Override(c CfnPricingRule, scope constructs.Construct, id *string, ...)
- type CfnBillingGroup
- type CfnBillingGroupProps
- type CfnBillingGroup_AccountGroupingProperty
- type CfnBillingGroup_ComputationPreferenceProperty
- type CfnCustomLineItem
- type CfnCustomLineItemProps
- type CfnCustomLineItem_BillingPeriodRangeProperty
- type CfnCustomLineItem_CustomLineItemChargeDetailsProperty
- type CfnCustomLineItem_CustomLineItemFlatChargeDetailsProperty
- type CfnCustomLineItem_CustomLineItemPercentageChargeDetailsProperty
- type CfnPricingPlan
- type CfnPricingPlanProps
- type CfnPricingRule
- type CfnPricingRuleProps
- type CfnPricingRule_FreeTierProperty
- type CfnPricingRule_TieringProperty
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfnBillingGroup_CFN_RESOURCE_TYPE_NAME ¶
func CfnBillingGroup_CFN_RESOURCE_TYPE_NAME() *string
func CfnBillingGroup_IsCfnElement ¶
func CfnBillingGroup_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnBillingGroup_IsCfnResource ¶
func CfnBillingGroup_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnBillingGroup_IsConstruct ¶
func CfnBillingGroup_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnCustomLineItem_CFN_RESOURCE_TYPE_NAME ¶
func CfnCustomLineItem_CFN_RESOURCE_TYPE_NAME() *string
func CfnCustomLineItem_IsCfnElement ¶
func CfnCustomLineItem_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnCustomLineItem_IsCfnResource ¶
func CfnCustomLineItem_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnCustomLineItem_IsConstruct ¶
func CfnCustomLineItem_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnPricingPlan_CFN_RESOURCE_TYPE_NAME ¶
func CfnPricingPlan_CFN_RESOURCE_TYPE_NAME() *string
func CfnPricingPlan_IsCfnElement ¶
func CfnPricingPlan_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnPricingPlan_IsCfnResource ¶
func CfnPricingPlan_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnPricingPlan_IsConstruct ¶
func CfnPricingPlan_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnPricingRule_CFN_RESOURCE_TYPE_NAME ¶
func CfnPricingRule_CFN_RESOURCE_TYPE_NAME() *string
func CfnPricingRule_IsCfnElement ¶
func CfnPricingRule_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnPricingRule_IsCfnResource ¶
func CfnPricingRule_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnPricingRule_IsConstruct ¶
func CfnPricingRule_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func NewCfnBillingGroup_Override ¶
func NewCfnBillingGroup_Override(c CfnBillingGroup, scope constructs.Construct, id *string, props *CfnBillingGroupProps)
Create a new `AWS::BillingConductor::BillingGroup`.
func NewCfnCustomLineItem_Override ¶
func NewCfnCustomLineItem_Override(c CfnCustomLineItem, scope constructs.Construct, id *string, props *CfnCustomLineItemProps)
Create a new `AWS::BillingConductor::CustomLineItem`.
func NewCfnPricingPlan_Override ¶
func NewCfnPricingPlan_Override(c CfnPricingPlan, scope constructs.Construct, id *string, props *CfnPricingPlanProps)
Create a new `AWS::BillingConductor::PricingPlan`.
func NewCfnPricingRule_Override ¶
func NewCfnPricingRule_Override(c CfnPricingRule, scope constructs.Construct, id *string, props *CfnPricingRuleProps)
Create a new `AWS::BillingConductor::PricingRule`.
Types ¶
type CfnBillingGroup ¶
type CfnBillingGroup interface { awscdk.CfnResource awscdk.IInspectable // The set of accounts that will be under the billing group. // // The set of accounts resemble the linked accounts in a consolidated family. AccountGrouping() interface{} SetAccountGrouping(val interface{}) // The Amazon Resource Name (ARN) of the created billing group. AttrArn() *string // The time the billing group was created. AttrCreationTime() *float64 // The most recent time the billing group was modified. AttrLastModifiedTime() *float64 // The number of accounts in the particular billing group. AttrSize() *float64 // The billing group status. // // Only one of the valid values can be used. AttrStatus() *string // The reason why the billing group is in its current status. AttrStatusReason() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // The preferences and settings that will be used to compute the AWS charges for a billing group. ComputationPreference() interface{} SetComputationPreference(val interface{}) // Returns: 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. CreationStack() *[]*string // The billing group description. Description() *string SetDescription(val *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 `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The billing group's name. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // The account ID that serves as the main account in a billing group. PrimaryAccountId() *string SetPrimaryAccountId(val *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 })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // `AWS::BillingConductor::BillingGroup.Tags`. Tags() awscdk.TagManager // Deprecated. // 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. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // 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. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // 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. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` 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, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` 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. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // 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:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // 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. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // 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. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // 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. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::BillingConductor::BillingGroup`.
Creates a billing group that resembles a consolidated billing family that AWS charges, based off of the predefined pricing plan computation.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnBillingGroup := awscdk.Aws_billingconductor.NewCfnBillingGroup(this, jsii.String("MyCfnBillingGroup"), &cfnBillingGroupProps{ accountGrouping: &accountGroupingProperty{ linkedAccountIds: []*string{ jsii.String("linkedAccountIds"), }, }, computationPreference: &computationPreferenceProperty{ pricingPlanArn: jsii.String("pricingPlanArn"), }, name: jsii.String("name"), primaryAccountId: jsii.String("primaryAccountId"), // the properties below are optional description: jsii.String("description"), tags: []cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, })
func NewCfnBillingGroup ¶
func NewCfnBillingGroup(scope constructs.Construct, id *string, props *CfnBillingGroupProps) CfnBillingGroup
Create a new `AWS::BillingConductor::BillingGroup`.
type CfnBillingGroupProps ¶
type CfnBillingGroupProps struct { // The set of accounts that will be under the billing group. // // The set of accounts resemble the linked accounts in a consolidated family. AccountGrouping interface{} `field:"required" json:"accountGrouping" yaml:"accountGrouping"` // The preferences and settings that will be used to compute the AWS charges for a billing group. ComputationPreference interface{} `field:"required" json:"computationPreference" yaml:"computationPreference"` // The billing group's name. Name *string `field:"required" json:"name" yaml:"name"` // The account ID that serves as the main account in a billing group. PrimaryAccountId *string `field:"required" json:"primaryAccountId" yaml:"primaryAccountId"` // The billing group description. Description *string `field:"optional" json:"description" yaml:"description"` // `AWS::BillingConductor::BillingGroup.Tags`. Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnBillingGroup`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnBillingGroupProps := &cfnBillingGroupProps{ accountGrouping: &accountGroupingProperty{ linkedAccountIds: []*string{ jsii.String("linkedAccountIds"), }, }, computationPreference: &computationPreferenceProperty{ pricingPlanArn: jsii.String("pricingPlanArn"), }, name: jsii.String("name"), primaryAccountId: jsii.String("primaryAccountId"), // the properties below are optional description: jsii.String("description"), tags: []cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, }
type CfnBillingGroup_AccountGroupingProperty ¶
type CfnBillingGroup_AccountGroupingProperty struct { // The account IDs that make up the billing group. // // Account IDs must be a part of the consolidated billing family, and not associated with another billing group. LinkedAccountIds *[]*string `field:"required" json:"linkedAccountIds" yaml:"linkedAccountIds"` }
The set of accounts that will be under the billing group.
The set of accounts resemble the linked accounts in a consolidated family.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" accountGroupingProperty := &accountGroupingProperty{ linkedAccountIds: []*string{ jsii.String("linkedAccountIds"), }, }
type CfnBillingGroup_ComputationPreferenceProperty ¶
type CfnBillingGroup_ComputationPreferenceProperty struct { // The Amazon Resource Name (ARN) of the pricing plan used to compute the AWS charges for a billing group. PricingPlanArn *string `field:"required" json:"pricingPlanArn" yaml:"pricingPlanArn"` }
The preferences and settings that will be used to compute the AWS charges for a billing group.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" computationPreferenceProperty := &computationPreferenceProperty{ pricingPlanArn: jsii.String("pricingPlanArn"), }
type CfnCustomLineItem ¶
type CfnCustomLineItem interface { awscdk.CfnResource awscdk.IInspectable // The Amazon Resource Name (ARN) that references the billing group where the custom line item applies to. AttrArn() *string // The number of resources that are associated to the custom line item. AttrAssociationSize() *float64 // The time created. AttrCreationTime() *float64 // The custom line item's charge value currency. // // Only one of the valid values can be used. AttrCurrencyCode() *string // The most recent time the custom line item was modified. AttrLastModifiedTime() *float64 // The product code associated with the custom line item. AttrProductCode() *string // The Amazon Resource Name (ARN) that references the billing group where the custom line item applies to. BillingGroupArn() *string SetBillingGroupArn(val *string) // A time range for which the custom line item is effective. BillingPeriodRange() interface{} SetBillingPeriodRange(val interface{}) // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: 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. CreationStack() *[]*string // The charge details of a custom line item. // // It should contain only one of `Flat` or `Percentage` . CustomLineItemChargeDetails() interface{} SetCustomLineItemChargeDetails(val interface{}) // The custom line item's description. // // This is shown on the Bills page in association with the charge value. Description() *string SetDescription(val *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 `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The custom line item's name. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // 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 })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // `AWS::BillingConductor::CustomLineItem.Tags`. Tags() awscdk.TagManager // Deprecated. // 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. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // 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. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // 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. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` 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, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` 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. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // 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:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // 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. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // 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. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // 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. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::BillingConductor::CustomLineItem`.
Creates a custom line item that can be used to create a one-time fixed charge that can be applied to a single billing group for the current or previous billing period. The one-time fixed charge is either a fee or discount.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnCustomLineItem := awscdk.Aws_billingconductor.NewCfnCustomLineItem(this, jsii.String("MyCfnCustomLineItem"), &cfnCustomLineItemProps{ billingGroupArn: jsii.String("billingGroupArn"), name: jsii.String("name"), // the properties below are optional billingPeriodRange: &billingPeriodRangeProperty{ exclusiveEndBillingPeriod: jsii.String("exclusiveEndBillingPeriod"), inclusiveStartBillingPeriod: jsii.String("inclusiveStartBillingPeriod"), }, customLineItemChargeDetails: &customLineItemChargeDetailsProperty{ type: jsii.String("type"), // the properties below are optional flat: &customLineItemFlatChargeDetailsProperty{ chargeValue: jsii.Number(123), }, percentage: &customLineItemPercentageChargeDetailsProperty{ percentageValue: jsii.Number(123), // the properties below are optional childAssociatedResources: []*string{ jsii.String("childAssociatedResources"), }, }, }, description: jsii.String("description"), tags: []cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, })
func NewCfnCustomLineItem ¶
func NewCfnCustomLineItem(scope constructs.Construct, id *string, props *CfnCustomLineItemProps) CfnCustomLineItem
Create a new `AWS::BillingConductor::CustomLineItem`.
type CfnCustomLineItemProps ¶
type CfnCustomLineItemProps struct { // The Amazon Resource Name (ARN) that references the billing group where the custom line item applies to. BillingGroupArn *string `field:"required" json:"billingGroupArn" yaml:"billingGroupArn"` // The custom line item's name. Name *string `field:"required" json:"name" yaml:"name"` // A time range for which the custom line item is effective. BillingPeriodRange interface{} `field:"optional" json:"billingPeriodRange" yaml:"billingPeriodRange"` // The charge details of a custom line item. // // It should contain only one of `Flat` or `Percentage` . CustomLineItemChargeDetails interface{} `field:"optional" json:"customLineItemChargeDetails" yaml:"customLineItemChargeDetails"` // The custom line item's description. // // This is shown on the Bills page in association with the charge value. Description *string `field:"optional" json:"description" yaml:"description"` // `AWS::BillingConductor::CustomLineItem.Tags`. Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnCustomLineItem`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnCustomLineItemProps := &cfnCustomLineItemProps{ billingGroupArn: jsii.String("billingGroupArn"), name: jsii.String("name"), // the properties below are optional billingPeriodRange: &billingPeriodRangeProperty{ exclusiveEndBillingPeriod: jsii.String("exclusiveEndBillingPeriod"), inclusiveStartBillingPeriod: jsii.String("inclusiveStartBillingPeriod"), }, customLineItemChargeDetails: &customLineItemChargeDetailsProperty{ type: jsii.String("type"), // the properties below are optional flat: &customLineItemFlatChargeDetailsProperty{ chargeValue: jsii.Number(123), }, percentage: &customLineItemPercentageChargeDetailsProperty{ percentageValue: jsii.Number(123), // the properties below are optional childAssociatedResources: []*string{ jsii.String("childAssociatedResources"), }, }, }, description: jsii.String("description"), tags: []cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, }
type CfnCustomLineItem_BillingPeriodRangeProperty ¶
type CfnCustomLineItem_BillingPeriodRangeProperty struct { // The inclusive end billing period that defines a billing period range where a custom line is applied. ExclusiveEndBillingPeriod *string `field:"optional" json:"exclusiveEndBillingPeriod" yaml:"exclusiveEndBillingPeriod"` // The inclusive start billing period that defines a billing period range where a custom line is applied. InclusiveStartBillingPeriod *string `field:"optional" json:"inclusiveStartBillingPeriod" yaml:"inclusiveStartBillingPeriod"` }
The billing period range in which the custom line item request will be applied.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" billingPeriodRangeProperty := &billingPeriodRangeProperty{ exclusiveEndBillingPeriod: jsii.String("exclusiveEndBillingPeriod"), inclusiveStartBillingPeriod: jsii.String("inclusiveStartBillingPeriod"), }
type CfnCustomLineItem_CustomLineItemChargeDetailsProperty ¶
type CfnCustomLineItem_CustomLineItemChargeDetailsProperty struct { // The type of the custom line item that indicates whether the charge is a fee or credit. Type *string `field:"required" json:"type" yaml:"type"` // A `CustomLineItemFlatChargeDetails` that describes the charge details of a flat custom line item. Flat interface{} `field:"optional" json:"flat" yaml:"flat"` // A `CustomLineItemPercentageChargeDetails` that describes the charge details of a percentage custom line item. Percentage interface{} `field:"optional" json:"percentage" yaml:"percentage"` }
The charge details of a custom line item.
It should contain only one of `Flat` or `Percentage` .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" customLineItemChargeDetailsProperty := &customLineItemChargeDetailsProperty{ type: jsii.String("type"), // the properties below are optional flat: &customLineItemFlatChargeDetailsProperty{ chargeValue: jsii.Number(123), }, percentage: &customLineItemPercentageChargeDetailsProperty{ percentageValue: jsii.Number(123), // the properties below are optional childAssociatedResources: []*string{ jsii.String("childAssociatedResources"), }, }, }
type CfnCustomLineItem_CustomLineItemFlatChargeDetailsProperty ¶
type CfnCustomLineItem_CustomLineItemFlatChargeDetailsProperty struct { // The custom line item's fixed charge value in USD. ChargeValue *float64 `field:"required" json:"chargeValue" yaml:"chargeValue"` }
The charge details of a custom line item.
It should contain only one of `Flat` or `Percentage` .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" customLineItemFlatChargeDetailsProperty := &customLineItemFlatChargeDetailsProperty{ chargeValue: jsii.Number(123), }
type CfnCustomLineItem_CustomLineItemPercentageChargeDetailsProperty ¶
type CfnCustomLineItem_CustomLineItemPercentageChargeDetailsProperty struct { // The custom line item's percentage value. // // This will be multiplied against the combined value of its associated resources to determine its charge value. PercentageValue *float64 `field:"required" json:"percentageValue" yaml:"percentageValue"` // A list of resource ARNs to associate to the percentage custom line item. ChildAssociatedResources *[]*string `field:"optional" json:"childAssociatedResources" yaml:"childAssociatedResources"` }
A representation of the charge details associated with a percentage custom line item.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" customLineItemPercentageChargeDetailsProperty := &customLineItemPercentageChargeDetailsProperty{ percentageValue: jsii.Number(123), // the properties below are optional childAssociatedResources: []*string{ jsii.String("childAssociatedResources"), }, }
type CfnPricingPlan ¶
type CfnPricingPlan interface { awscdk.CfnResource awscdk.IInspectable // The Amazon Resource Name (ARN) of the created pricing plan. AttrArn() *string // The time the pricing plan was created. AttrCreationTime() *float64 // The most recent time the pricing plan was modified. AttrLastModifiedTime() *float64 // The pricing rules count currently associated with this pricing plan list element. AttrSize() *float64 // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: 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. CreationStack() *[]*string // The pricing plan description. Description() *string SetDescription(val *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 `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The name of a pricing plan. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // The `PricingRuleArns` that are associated with the Pricing Plan. PricingRuleArns() *[]*string SetPricingRuleArns(val *[]*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 })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // `AWS::BillingConductor::PricingPlan.Tags`. Tags() awscdk.TagManager // Deprecated. // 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. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // 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. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // 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. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` 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, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` 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. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // 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:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // 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. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // 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. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // 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. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::BillingConductor::PricingPlan`.
Creates a pricing plan that is used for computing AWS charges for billing groups.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnPricingPlan := awscdk.Aws_billingconductor.NewCfnPricingPlan(this, jsii.String("MyCfnPricingPlan"), &cfnPricingPlanProps{ name: jsii.String("name"), // the properties below are optional description: jsii.String("description"), pricingRuleArns: []*string{ jsii.String("pricingRuleArns"), }, tags: []cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, })
func NewCfnPricingPlan ¶
func NewCfnPricingPlan(scope constructs.Construct, id *string, props *CfnPricingPlanProps) CfnPricingPlan
Create a new `AWS::BillingConductor::PricingPlan`.
type CfnPricingPlanProps ¶
type CfnPricingPlanProps struct { // The name of a pricing plan. Name *string `field:"required" json:"name" yaml:"name"` // The pricing plan description. Description *string `field:"optional" json:"description" yaml:"description"` // The `PricingRuleArns` that are associated with the Pricing Plan. PricingRuleArns *[]*string `field:"optional" json:"pricingRuleArns" yaml:"pricingRuleArns"` // `AWS::BillingConductor::PricingPlan.Tags`. Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnPricingPlan`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnPricingPlanProps := &cfnPricingPlanProps{ name: jsii.String("name"), // the properties below are optional description: jsii.String("description"), pricingRuleArns: []*string{ jsii.String("pricingRuleArns"), }, tags: []cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, }
type CfnPricingRule ¶
type CfnPricingRule interface { awscdk.CfnResource awscdk.IInspectable // The Amazon Resource Name (ARN) used to uniquely identify a pricing rule. AttrArn() *string // The pricing plans count that this pricing rule is associated with. AttrAssociatedPricingPlanCount() *float64 // The time the pricing rule was created. AttrCreationTime() *float64 // The most recent time the pricing rule was modified. AttrLastModifiedTime() *float64 // `AWS::BillingConductor::PricingRule.BillingEntity`. BillingEntity() *string SetBillingEntity(val *string) // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: 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. CreationStack() *[]*string // The pricing rule description. Description() *string SetDescription(val *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 `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // A percentage modifier applied on the public pricing rates. ModifierPercentage() *float64 SetModifierPercentage(val *float64) // The name of a pricing rule. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // 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 })`. Ref() *string // The scope of pricing rule that indicates if it is globally applicable, or if it is service-specific. Scope() *string SetScope(val *string) // If the `Scope` attribute is `SERVICE` , this attribute indicates which service the `PricingRule` is applicable for. Service() *string SetService(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // `AWS::BillingConductor::PricingRule.Tags`. Tags() awscdk.TagManager // `AWS::BillingConductor::PricingRule.Tiering`. Tiering() interface{} SetTiering(val interface{}) // The type of pricing rule. Type() *string SetType(val *string) // Deprecated. // 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. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // 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. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // 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. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` 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, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` 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. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // 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:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // 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. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // 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. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // 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. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
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 "github.com/aws/aws-cdk-go/awscdk" cfnPricingRule := awscdk.Aws_billingconductor.NewCfnPricingRule(this, jsii.String("MyCfnPricingRule"), &cfnPricingRuleProps{ name: jsii.String("name"), scope: jsii.String("scope"), type: jsii.String("type"), // the properties below are optional billingEntity: jsii.String("billingEntity"), description: jsii.String("description"), modifierPercentage: jsii.Number(123), service: jsii.String("service"), tags: []cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, tiering: &tieringProperty{ freeTier: &freeTierProperty{ activated: jsii.Boolean(false), }, }, })
func NewCfnPricingRule ¶
func NewCfnPricingRule(scope constructs.Construct, id *string, props *CfnPricingRuleProps) CfnPricingRule
Create a new `AWS::BillingConductor::PricingRule`.
type CfnPricingRuleProps ¶
type CfnPricingRuleProps struct { // The name of a pricing rule. Name *string `field:"required" json:"name" yaml:"name"` // The scope of pricing rule that indicates if it is globally applicable, or if it is service-specific. Scope *string `field:"required" json:"scope" yaml:"scope"` // The type of pricing rule. Type *string `field:"required" json:"type" yaml:"type"` // `AWS::BillingConductor::PricingRule.BillingEntity`. BillingEntity *string `field:"optional" json:"billingEntity" yaml:"billingEntity"` // The pricing rule description. Description *string `field:"optional" json:"description" yaml:"description"` // A percentage modifier applied on the public pricing rates. ModifierPercentage *float64 `field:"optional" json:"modifierPercentage" yaml:"modifierPercentage"` // If the `Scope` attribute is `SERVICE` , this attribute indicates which service the `PricingRule` is applicable for. Service *string `field:"optional" json:"service" yaml:"service"` // `AWS::BillingConductor::PricingRule.Tags`. Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` // `AWS::BillingConductor::PricingRule.Tiering`. Tiering interface{} `field:"optional" json:"tiering" yaml:"tiering"` }
Properties for defining a `CfnPricingRule`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnPricingRuleProps := &cfnPricingRuleProps{ name: jsii.String("name"), scope: jsii.String("scope"), type: jsii.String("type"), // the properties below are optional billingEntity: jsii.String("billingEntity"), description: jsii.String("description"), modifierPercentage: jsii.Number(123), service: jsii.String("service"), tags: []cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, tiering: &tieringProperty{ freeTier: &freeTierProperty{ activated: jsii.Boolean(false), }, }, }
type CfnPricingRule_FreeTierProperty ¶ added in v2.55.0
type CfnPricingRule_FreeTierProperty struct {
// `CfnPricingRule.FreeTierProperty.Activated`.
Activated interface{} `field:"required" json:"activated" yaml:"activated"`
}
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" freeTierProperty := &freeTierProperty{ activated: jsii.Boolean(false), }
type CfnPricingRule_TieringProperty ¶ added in v2.55.0
type CfnPricingRule_TieringProperty struct {
// `CfnPricingRule.TieringProperty.FreeTier`.
FreeTier interface{} `field:"optional" json:"freeTier" yaml:"freeTier"`
}
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" tieringProperty := &tieringProperty{ freeTier: &freeTierProperty{ activated: jsii.Boolean(false), }, }
Source Files
¶
- awsbillingconductor.go
- awsbillingconductor_CfnBillingGroup.go
- awsbillingconductor_CfnBillingGroupProps.go
- awsbillingconductor_CfnBillingGroup_AccountGroupingProperty.go
- awsbillingconductor_CfnBillingGroup_ComputationPreferenceProperty.go
- awsbillingconductor_CfnBillingGroup__runtime_type_checks.go
- awsbillingconductor_CfnCustomLineItem.go
- awsbillingconductor_CfnCustomLineItemProps.go
- awsbillingconductor_CfnCustomLineItem_BillingPeriodRangeProperty.go
- awsbillingconductor_CfnCustomLineItem_CustomLineItemChargeDetailsProperty.go
- awsbillingconductor_CfnCustomLineItem_CustomLineItemFlatChargeDetailsProperty.go
- awsbillingconductor_CfnCustomLineItem_CustomLineItemPercentageChargeDetailsProperty.go
- awsbillingconductor_CfnCustomLineItem__runtime_type_checks.go
- awsbillingconductor_CfnPricingPlan.go
- awsbillingconductor_CfnPricingPlanProps.go
- awsbillingconductor_CfnPricingPlan__runtime_type_checks.go
- awsbillingconductor_CfnPricingRule.go
- awsbillingconductor_CfnPricingRuleProps.go
- awsbillingconductor_CfnPricingRule_FreeTierProperty.go
- awsbillingconductor_CfnPricingRule_TieringProperty.go
- awsbillingconductor_CfnPricingRule__runtime_type_checks.go