Package software.amazon.awscdk.services.billingconductor

Class CfnBillingGroup

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.billingconductor.CfnBillingGroup
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:55.825Z") @Stability(Stable) public class CfnBillingGroup extends CfnResource implements IInspectable
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 software.amazon.awscdk.services.billingconductor.*;
 CfnBillingGroup cfnBillingGroup = CfnBillingGroup.Builder.create(this, "MyCfnBillingGroup")
         .accountGrouping(AccountGroupingProperty.builder()
                 .linkedAccountIds(List.of("linkedAccountIds"))
                 .build())
         .computationPreference(ComputationPreferenceProperty.builder()
                 .pricingPlanArn("pricingPlanArn")
                 .build())
         .name("name")
         .primaryAccountId("primaryAccountId")
         // the properties below are optional
         .description("description")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnBillingGroup

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

    • CfnBillingGroup

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

    • CfnBillingGroup

      @Stability(Stable) public CfnBillingGroup(@NotNull Construct scope, @NotNull String id, @NotNull CfnBillingGroupProps props)
      Create a new AWS::BillingConductor::BillingGroup.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the created billing group.

    • getAttrCreationTime

      @Stability(Stable) @NotNull public Number getAttrCreationTime()
      The time the billing group was created.

    • getAttrLastModifiedTime

      @Stability(Stable) @NotNull public Number getAttrLastModifiedTime()
      The most recent time the billing group was modified.

    • getAttrSize

      @Stability(Stable) @NotNull public Number getAttrSize()
      The number of accounts in the particular billing group.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      The billing group status.

      Only one of the valid values can be used.

    • getAttrStatusReason

      @Stability(Stable) @NotNull public String getAttrStatusReason()
      The reason why the billing group is in its current status.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      AWS::BillingConductor::BillingGroup.Tags.

    • getAccountGrouping

      @Stability(Stable) @NotNull public Object getAccountGrouping()
      The set of accounts that will be under the billing group.

      The set of accounts resemble the linked accounts in a consolidated family.

    • setAccountGrouping

      @Stability(Stable) public void setAccountGrouping(@NotNull CfnBillingGroup.AccountGroupingProperty value)
      The set of accounts that will be under the billing group.

      The set of accounts resemble the linked accounts in a consolidated family.

    • setAccountGrouping

      @Stability(Stable) public void setAccountGrouping(@NotNull IResolvable value)
      The set of accounts that will be under the billing group.

      The set of accounts resemble the linked accounts in a consolidated family.

    • getComputationPreference

      @Stability(Stable) @NotNull public Object getComputationPreference()
      The preferences and settings that will be used to compute the AWS charges for a billing group.

    • setComputationPreference

      @Stability(Stable) public void setComputationPreference(@NotNull IResolvable value)
      The preferences and settings that will be used to compute the AWS charges for a billing group.

    • setComputationPreference

      @Stability(Stable) public void setComputationPreference(@NotNull CfnBillingGroup.ComputationPreferenceProperty value)
      The preferences and settings that will be used to compute the AWS charges for a billing group.

    • getName

      @Stability(Stable) @NotNull public String getName()
      The billing group's name.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The billing group's name.

    • getPrimaryAccountId

      @Stability(Stable) @NotNull public String getPrimaryAccountId()
      The account ID that serves as the main account in a billing group.

    • setPrimaryAccountId

      @Stability(Stable) public void setPrimaryAccountId(@NotNull String value)
      The account ID that serves as the main account in a billing group.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the billing group.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the billing group.