CapacityCommitment class

Creates a new capacity commitment resource. Auto-naming is currently not supported for this resource.

Constructors

CapacityCommitment(String name, {CapacityCommitmentArgs? args, CustomResourceOptions? options})

Creates a new CapacityCommitment. name The Pulumi resource name. args Arguments used to configure this CapacityCommitment. The set of arguments for CapacityCommitment. options Resource options controlling this resource's behavior.

Properties

capacityCommitmentId ↔ Output<String?>

The optional capacity commitment ID. Capacity commitment name will be generated automatically if this field is empty. This field must only contain lower case alphanumeric characters or dashes. The first and last character cannot be a dash. Max length is 64 characters. NOTE: this ID won't be kept if the capacity commitment is split or merged.

late, final

childResources → Set<Resource>

final, inherited

commitmentEndTime ↔ Output<String>

The end of the current commitment period. It is applicable only for ACTIVE capacity commitments.

late, final

commitmentStartTime ↔ Output<String>

The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.

late, final

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

edition ↔ Output<String>

Edition of the capacity commitment.

late, final

enforceSingleAdminProjectPerOrg ↔ Output<bool?>

If true, fail the request if another project in the organization has a capacity commitment.

late, final

failureStatus ↔ Output<StatusResponse>

For FAILED commitment plan, provides the reason of failure.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isFlatRate ↔ Output<bool>

If true, the commitment is a flat-rate commitment, otherwise, it's an edition commitment.

late, final

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

location ↔ Output<String>

late, final

multiRegionAuxiliary ↔ Output<bool>

Applicable only for commitments located within one of the BigQuery multi-regions (US or EU). If set to true, this commitment is placed in the organization's secondary region which is designated for disaster recovery purposes. If false, this commitment is placed in the organization's default region. NOTE: this is a preview feature. Project must be allow-listed in order to set this field.

late, final

name ↔ Output<String>

The resource name of the capacity commitment, e.g., projects/myproject/locations/US/capacityCommitments/123 The commitment_id must only contain lower case alphanumeric characters or dashes. It must start with a letter and must not end with a dash. Its maximum length is 64 characters.

late, final

plan ↔ Output<String>

Capacity commitment commitment plan.

late, final

project ↔ Output<String>

late, final

renewalPlan ↔ Output<String>

The plan this capacity commitment is converted to after commitment_end_time passes. Once the plan is changed, committed period is extended according to commitment plan. Only applicable for ANNUAL and TRIAL commitments.

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

slotCount ↔ Output<String>

Number of slots in this commitment.

late, final

state ↔ Output<String>

State of the commitment.

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

urn ↔ Output<String>

late, final, inherited

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited