Interface CreditData.Builder

All Superinterfaces:
Buildable, CopyableBuilder<CreditData.Builder,CreditData>, SdkBuilder<CreditData.Builder,CreditData>, SdkPojo
Enclosing class:
CreditData
@Mutable @NotThreadSafe public static interface CreditData.Builder extends SdkPojo, CopyableBuilder<CreditData.Builder,CreditData>

  • Method Details

    • creditId

      CreditData.Builder creditId(String creditId)

      The unique identifier for the credit.

      Parameters:
      creditId - The unique identifier for the credit.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • accountId

      CreditData.Builder accountId(String accountId)

      The Amazon Web Services account ID that owns the credit.

      Parameters:
      accountId - The Amazon Web Services account ID that owns the credit.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • creditType

      CreditData.Builder creditType(String creditType)

      The type of credit. Examples: Promotion, Refund, TrueUp.

      Parameters:
      creditType - The type of credit. Examples: Promotion, Refund, TrueUp.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • initialAmount

      CreditData.Builder initialAmount(Amount initialAmount)

      The initial amount of the credit when it was issued.

      Parameters:
      initialAmount - The initial amount of the credit when it was issued.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • initialAmount

      default CreditData.Builder initialAmount(Consumer<Amount.Builder> initialAmount)

      The initial amount of the credit when it was issued.

      This is a convenience method that creates an instance of the Amount.Builder avoiding the need to create one manually via Amount.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to initialAmount(Amount).

      Parameters:
      initialAmount - a consumer that will call methods on Amount.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • remainingAmount

      CreditData.Builder remainingAmount(Amount remainingAmount)

      The unused balance of the credit.

      Parameters:
      remainingAmount - The unused balance of the credit.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • remainingAmount

      default CreditData.Builder remainingAmount(Consumer<Amount.Builder> remainingAmount)

      The unused balance of the credit.

      This is a convenience method that creates an instance of the Amount.Builder avoiding the need to create one manually via Amount.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to remainingAmount(Amount).

      Parameters:
      remainingAmount - a consumer that will call methods on Amount.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • estimatedAmount

      CreditData.Builder estimatedAmount(Amount estimatedAmount)

      The estimated remaining balance, including in-flight (open) bills that have not yet been finalized.

      Parameters:
      estimatedAmount - The estimated remaining balance, including in-flight (open) bills that have not yet been finalized.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • estimatedAmount

      default CreditData.Builder estimatedAmount(Consumer<Amount.Builder> estimatedAmount)

      The estimated remaining balance, including in-flight (open) bills that have not yet been finalized.

      This is a convenience method that creates an instance of the Amount.Builder avoiding the need to create one manually via Amount.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to estimatedAmount(Amount).

      Parameters:
      estimatedAmount - a consumer that will call methods on Amount.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • applicableProductNames

      CreditData.Builder applicableProductNames(Collection<String> applicableProductNames)

      The names of Amazon Web Services services this credit applies to.

      Parameters:
      applicableProductNames - The names of Amazon Web Services services this credit applies to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • applicableProductNames

      CreditData.Builder applicableProductNames(String... applicableProductNames)

      The names of Amazon Web Services services this credit applies to.

      Parameters:
      applicableProductNames - The names of Amazon Web Services services this credit applies to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      CreditData.Builder description(String description)

      A human-readable description of the credit.

      Parameters:
      description - A human-readable description of the credit.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • startDate

      CreditData.Builder startDate(Instant startDate)

      The date the credit becomes valid, as Unix epoch seconds.

      Parameters:
      startDate - The date the credit becomes valid, as Unix epoch seconds.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endDate

      CreditData.Builder endDate(Instant endDate)

      The date the credit expires, as Unix epoch seconds.

      Parameters:
      endDate - The date the credit expires, as Unix epoch seconds.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • exhaustDate

      CreditData.Builder exhaustDate(Instant exhaustDate)

      The date the credit balance reached zero, as Unix epoch seconds.

      Parameters:
      exhaustDate - The date the credit balance reached zero, as Unix epoch seconds.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • applicationType

      CreditData.Builder applicationType(String applicationType)

      When the credit is applied during bill computation. Valid values: BEFORE_CROSS_SERVICE_DISCOUNTS, AFTER_DISCOUNTS.

      Parameters:
      applicationType - When the credit is applied during bill computation. Valid values: BEFORE_CROSS_SERVICE_DISCOUNTS, AFTER_DISCOUNTS.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • applicationType

      CreditData.Builder applicationType(ApplicationType applicationType)

      When the credit is applied during bill computation. Valid values: BEFORE_CROSS_SERVICE_DISCOUNTS, AFTER_DISCOUNTS.

      Parameters:
      applicationType - When the credit is applied during bill computation. Valid values: BEFORE_CROSS_SERVICE_DISCOUNTS, AFTER_DISCOUNTS.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • shareableAccounts

      CreditData.Builder shareableAccounts(Collection<String> shareableAccounts)

      The Amazon Web Services account IDs entitled to apply this credit.

      Parameters:
      shareableAccounts - The Amazon Web Services account IDs entitled to apply this credit.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • shareableAccounts

      CreditData.Builder shareableAccounts(String... shareableAccounts)

      The Amazon Web Services account IDs entitled to apply this credit.

      Parameters:
      shareableAccounts - The Amazon Web Services account IDs entitled to apply this credit.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • accountHasCreditSharingEnabled

      CreditData.Builder accountHasCreditSharingEnabled(Boolean accountHasCreditSharingEnabled)

      Whether the owning account has account-level credit sharing turned on.

      Parameters:
      accountHasCreditSharingEnabled - Whether the owning account has account-level credit sharing turned on.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • creditConsoleVisibility

      CreditData.Builder creditConsoleVisibility(String creditConsoleVisibility)

      The display configuration for the credit in the Amazon Web Services Billing console.

      Parameters:
      creditConsoleVisibility - The display configuration for the credit in the Amazon Web Services Billing console.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • creditSharingType

      CreditData.Builder creditSharingType(String creditSharingType)

      The sharing configuration for the credit. Valid values: DEFAULT, DISABLED, CUSTOM, COST_CATEGORY_RULE.

      Parameters:
      creditSharingType - The sharing configuration for the credit. Valid values: DEFAULT, DISABLED, CUSTOM, COST_CATEGORY_RULE.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • creditSharingType

      CreditData.Builder creditSharingType(CreditSharingType creditSharingType)

      The sharing configuration for the credit. Valid values: DEFAULT, DISABLED, CUSTOM, COST_CATEGORY_RULE.

      Parameters:
      creditSharingType - The sharing configuration for the credit. Valid values: DEFAULT, DISABLED, CUSTOM, COST_CATEGORY_RULE.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • costCategoryArn

      CreditData.Builder costCategoryArn(String costCategoryArn)

      The Amazon Resource Name (ARN) of the Cost Category controlling the credit's sharing scope. Present only when creditSharingType is COST_CATEGORY_RULE.

      Parameters:
      costCategoryArn - The Amazon Resource Name (ARN) of the Cost Category controlling the credit's sharing scope. Present only when creditSharingType is COST_CATEGORY_RULE.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ruleName

      CreditData.Builder ruleName(String ruleName)

      The rule name within the Cost Category. Present only when creditSharingType is COST_CATEGORY_RULE.

      Parameters:
      ruleName - The rule name within the Cost Category. Present only when creditSharingType is COST_CATEGORY_RULE.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • creditStatus

      CreditData.Builder creditStatus(String creditStatus)

      Whether the credit participates in billing runs. Valid values: ENABLED, DISABLED.

      Parameters:
      creditStatus - Whether the credit participates in billing runs. Valid values: ENABLED, DISABLED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • creditStatus

      CreditData.Builder creditStatus(CreditStatus creditStatus)

      Whether the credit participates in billing runs. Valid values: ENABLED, DISABLED.

      Parameters:
      creditStatus - Whether the credit participates in billing runs. Valid values: ENABLED, DISABLED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • purchaseTypeApplications

      CreditData.Builder purchaseTypeApplications(Collection<String> purchaseTypeApplications)

      Restricts which purchase types this credit applies to. When null or omitted, the credit applies to all purchase types.

      Parameters:
      purchaseTypeApplications - Restricts which purchase types this credit applies to. When null or omitted, the credit applies to all purchase types.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • purchaseTypeApplications

      CreditData.Builder purchaseTypeApplications(String... purchaseTypeApplications)

      Restricts which purchase types this credit applies to. When null or omitted, the credit applies to all purchase types.

      Parameters:
      purchaseTypeApplications - Restricts which purchase types this credit applies to. When null or omitted, the credit applies to all purchase types.
      Returns:
      Returns a reference to this object so that method calls can be chained together.