software.amazon.awscdk.services.billingconductor

Class CfnBillingGroup

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.billingconductor.CfnBillingGroup

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:35.522Z")
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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnBillingGroup.AccountGroupingProperty The set of accounts that will be under the billing group.
static class	CfnBillingGroup.Builder A fluent builder for CfnBillingGroup.
static interface	CfnBillingGroup.ComputationPreferenceProperty The preferences and settings that will be used to compute the AWS charges for a billing group.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnBillingGroup(Construct scope, java.lang.String id, CfnBillingGroupProps props) Create a new `AWS::BillingConductor::BillingGroup`.
protected	CfnBillingGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnBillingGroup(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getAccountGrouping() The set of accounts that will be under the billing group.
java.lang.String	getAttrArn() The Amazon Resource Name (ARN) of the created billing group.
java.lang.Number	getAttrCreationTime() The time the billing group was created.
java.lang.Number	getAttrLastModifiedTime() The most recent time the billing group was modified.
java.lang.Number	getAttrSize() The number of accounts in the particular billing group.
java.lang.String	getAttrStatus() The billing group status.
java.lang.String	getAttrStatusReason() The reason why the billing group is in its current status.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.Object	getComputationPreference() The preferences and settings that will be used to compute the AWS charges for a billing group.
java.lang.String	getDescription() The description of the billing group.
java.lang.String	getName() The billing group's name.
java.lang.String	getPrimaryAccountId() The account ID that serves as the main account in a billing group.
TagManager	getTags() `AWS::BillingConductor::BillingGroup.Tags`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setAccountGrouping(CfnBillingGroup.AccountGroupingProperty value) The set of accounts that will be under the billing group.
void	setAccountGrouping(IResolvable value) The set of accounts that will be under the billing group.
void	setComputationPreference(CfnBillingGroup.ComputationPreferenceProperty value) The preferences and settings that will be used to compute the AWS charges for a billing group.
void	setComputationPreference(IResolvable value) The preferences and settings that will be used to compute the AWS charges for a billing group.
void	setDescription(java.lang.String value) The description of the billing group.
void	setName(java.lang.String value) The billing group's name.
void	setPrimaryAccountId(java.lang.String value) The account ID that serves as the main account in a billing group.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnBillingGroup

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

CfnBillingGroup

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

CfnBillingGroup

public CfnBillingGroup(Construct scope,
                       java.lang.String id,
                       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 Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

public java.lang.String getAttrArn()

The Amazon Resource Name (ARN) of the created billing group.

getAttrCreationTime

public java.lang.Number getAttrCreationTime()

The time the billing group was created.

getAttrLastModifiedTime

public java.lang.Number getAttrLastModifiedTime()

The most recent time the billing group was modified.

getAttrSize

public java.lang.Number getAttrSize()

The number of accounts in the particular billing group.

getAttrStatus

public java.lang.String getAttrStatus()

The billing group status.

Only one of the valid values can be used.

getAttrStatusReason

public java.lang.String getAttrStatusReason()

The reason why the billing group is in its current status.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

`AWS::BillingConductor::BillingGroup.Tags`.

getAccountGrouping

public java.lang.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

public void setAccountGrouping(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

public void setAccountGrouping(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

public java.lang.Object getComputationPreference()

The preferences and settings that will be used to compute the AWS charges for a billing group.

setComputationPreference

public void setComputationPreference(IResolvable value)

The preferences and settings that will be used to compute the AWS charges for a billing group.

setComputationPreference

public void setComputationPreference(CfnBillingGroup.ComputationPreferenceProperty value)

The preferences and settings that will be used to compute the AWS charges for a billing group.

getName

public java.lang.String getName()

The billing group's name.

setName

public void setName(java.lang.String value)

The billing group's name.

getPrimaryAccountId

public java.lang.String getPrimaryAccountId()

The account ID that serves as the main account in a billing group.

setPrimaryAccountId

public void setPrimaryAccountId(java.lang.String value)

The account ID that serves as the main account in a billing group.

getDescription

public java.lang.String getDescription()

The description of the billing group.

setDescription

public void setDescription(java.lang.String value)

The description of the billing group.