Instance class
Creates an instance. When creating from a backup, the capacity of the new instance needs to be equal to or larger than the capacity of the backup (and also equal to or larger than the minimum capacity of the tier). Auto-naming is currently not supported for this resource.
Constructors
- Instance(String name, {InstanceArgs? args, CustomResourceOptions? options})
-
Creates a new Instance.
nameThe Pulumi resource name.argsArguments used to configure this Instance. The set of arguments for Instance.optionsResource options controlling this resource's behavior.
Properties
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
createTime
↔ Output<
String> -
The time when the instance was created.
latefinal
-
description
↔ Output<
String> -
The description of the instance (2048 characters or less).
latefinal
-
etag
↔ Output<
String> -
Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other.
latefinal
-
File system shares on the instance. For this version, only a single file share is supported.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
-
instanceId
↔ Output<
String> -
Required. The name of the instance to create. The name must be unique for the specified project and location.
latefinal
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
kmsKeyName
↔ Output<
String> -
KMS key name used for data encryption.
latefinal
-
labels
↔ Output<
Map< String, String> > -
Resource labels to represent user provided metadata.
latefinal
-
location
↔ Output<
String> -
latefinal
-
name
↔ Output<
String> -
The resource name of the instance, in the format
projects/{project}/locations/{location}/instances/{instance}.latefinal -
networks
↔ Output<
List< Map< >String, dynamic> > -
VPC networks to which the instance is connected. For this version, only a single network is supported.
latefinal
-
project
↔ Output<
String> -
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
satisfiesPzs
↔ Output<
bool> -
Reserved for future use.
latefinal
-
state
↔ Output<
String> -
The instance state.
latefinal
-
statusMessage
↔ Output<
String> -
Additional information about the instance state, if available.
latefinal
-
suspensionReasons
↔ Output<
List< String> > -
Field indicates all the reasons the instance is in "SUSPENDED" state.
latefinal
-
tier
↔ Output<
String> -
The service tier of the instance.
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
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