software.amazon.awscdk.services.billingconductor

Class CfnBillingGroup

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.billingconductor.CfnBillingGroup

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.921Z")
 @Stability(value=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();
 

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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnBillingGroup(software.constructs.Construct scope, 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
Object	getAccountGrouping() The set of accounts that will be under the billing group.
String	getAttrArn() The Amazon Resource Name (ARN) of the created billing group.
Number	getAttrCreationTime() The time the billing group was created.
Number	getAttrLastModifiedTime() The most recent time the billing group was modified.
Number	getAttrSize() The number of accounts in the particular billing group.
String	getAttrStatus() The billing group status.
String	getAttrStatusReason() The reason why the billing group is in its current status.
protected Map<String,Object>	getCfnProperties()
Object	getComputationPreference() The preferences and settings that will be used to compute the AWS charges for a billing group.
String	getDescription() The billing group description.
String	getName() The billing group's name.
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 Map<String,Object>	renderProperties(Map<String,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(String value) The billing group description.
void	setName(String value) The billing group's name.
void	setPrimaryAccountId(String value) The account ID that serves as the main account in a billing group.

Methods inherited from class software.amazon.awscdk.CfnResource

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

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnBillingGroup

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

CfnBillingGroup

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

CfnBillingGroup

@Stability(value=Stable)
public CfnBillingGroup(@NotNull
                                                software.constructs.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 Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

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

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

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

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

getAttrCreationTime

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

The time the billing group was created.

getAttrLastModifiedTime

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

The most recent time the billing group was modified.

getAttrSize

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

The number of accounts in the particular billing group.

getAttrStatus

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

The billing group status.

Only one of the valid values can be used.

getAttrStatusReason

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

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

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

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

getAccountGrouping

@Stability(value=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(value=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(value=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(value=Stable)
 @NotNull
public Object getComputationPreference()

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

setComputationPreference

@Stability(value=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.

setComputationPreference

@Stability(value=Stable)
public void setComputationPreference(@NotNull
                                                              IResolvable value)

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

getName

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

The billing group's name.

setName

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

The billing group's name.

getPrimaryAccountId

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

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

setPrimaryAccountId

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

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

getDescription

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

The billing group description.

setDescription

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

The billing group description.