gcp.spanner.InstancePartition

Example coming soon!

Example coming soon!

name string

The unique name of the resource.

args InstancePartitionArgs

The arguments to resource properties.

opts CustomResourceOptions

Bag of options to control resource's behavior.

resource_name str

The unique name of the resource.

args InstancePartitionArgs

The arguments to resource properties.

opts ResourceOptions

Bag of options to control resource's behavior.

ctx Context

Context object for the current deployment.

name string

The unique name of the resource.

args InstancePartitionArgs

The arguments to resource properties.

opts ResourceOption

Bag of options to control resource's behavior.

name string

The unique name of the resource.

args InstancePartitionArgs

The arguments to resource properties.

opts CustomResourceOptions

Bag of options to control resource's behavior.

name String

The unique name of the resource.

args InstancePartitionArgs

The arguments to resource properties.

options CustomResourceOptions

Bag of options to control resource's behavior.

Config string

The name of the instance partition's configuration (similar to a region) which defines the geographic placement and replication of data in this instance partition.

DisplayName string

The descriptive name for this instance partition as it appears in UIs. Must be unique per project and between 4 and 30 characters in length.

Instance string

The instance to create the instance partition in.

AutoscalingConfig InstancePartitionAutoscalingConfig

The autoscaling configuration. Autoscaling is enabled if this field is set. Exactly one of either node_count, processing_units, or autoscalingConfig must be present. When autoscaling is enabled, nodeCount and processingUnits are treated as OUTPUT_ONLY fields and reflect the current compute capacity allocated to the instance partition. Structure is documented below.

Name string

A unique identifier for the instance partition, which cannot be changed after the instance partition is created. The name must be between 2 and 64 characters and match the regular expression [a-z][a-z0-9\-]{0,61}[a-z0-9].

NodeCount int

The number of nodes allocated to this instance partition. One node equals 1000 processing units. Exactly one of either node_count, processing_units, or autoscalingConfig must be present.

ProcessingUnits int

The number of processing units allocated to this instance partition. Exactly one of either node_count, processing_units, or autoscalingConfig must be present.

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Config string

The name of the instance partition's configuration (similar to a region) which defines the geographic placement and replication of data in this instance partition.

DisplayName string

The descriptive name for this instance partition as it appears in UIs. Must be unique per project and between 4 and 30 characters in length.

Instance string

The instance to create the instance partition in.

AutoscalingConfig InstancePartitionAutoscalingConfigArgs

The autoscaling configuration. Autoscaling is enabled if this field is set. Exactly one of either node_count, processing_units, or autoscalingConfig must be present. When autoscaling is enabled, nodeCount and processingUnits are treated as OUTPUT_ONLY fields and reflect the current compute capacity allocated to the instance partition. Structure is documented below.

Name string

A unique identifier for the instance partition, which cannot be changed after the instance partition is created. The name must be between 2 and 64 characters and match the regular expression [a-z][a-z0-9\-]{0,61}[a-z0-9].

NodeCount int

The number of nodes allocated to this instance partition. One node equals 1000 processing units. Exactly one of either node_count, processing_units, or autoscalingConfig must be present.

ProcessingUnits int

The number of processing units allocated to this instance partition. Exactly one of either node_count, processing_units, or autoscalingConfig must be present.

Project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

config string

The name of the instance partition's configuration (similar to a region) which defines the geographic placement and replication of data in this instance partition.

display_name string

The descriptive name for this instance partition as it appears in UIs. Must be unique per project and between 4 and 30 characters in length.

instance string

The instance to create the instance partition in.

autoscaling_config object

The autoscaling configuration. Autoscaling is enabled if this field is set. Exactly one of either node_count, processing_units, or autoscalingConfig must be present. When autoscaling is enabled, nodeCount and processingUnits are treated as OUTPUT_ONLY fields and reflect the current compute capacity allocated to the instance partition. Structure is documented below.

name string

A unique identifier for the instance partition, which cannot be changed after the instance partition is created. The name must be between 2 and 64 characters and match the regular expression [a-z][a-z0-9\-]{0,61}[a-z0-9].

node_count number

The number of nodes allocated to this instance partition. One node equals 1000 processing units. Exactly one of either node_count, processing_units, or autoscalingConfig must be present.

processing_units number

The number of processing units allocated to this instance partition. Exactly one of either node_count, processing_units, or autoscalingConfig must be present.

project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

config String

The name of the instance partition's configuration (similar to a region) which defines the geographic placement and replication of data in this instance partition.

displayName String

The descriptive name for this instance partition as it appears in UIs. Must be unique per project and between 4 and 30 characters in length.

instance String

The instance to create the instance partition in.

autoscalingConfig InstancePartitionAutoscalingConfig

The autoscaling configuration. Autoscaling is enabled if this field is set. Exactly one of either node_count, processing_units, or autoscalingConfig must be present. When autoscaling is enabled, nodeCount and processingUnits are treated as OUTPUT_ONLY fields and reflect the current compute capacity allocated to the instance partition. Structure is documented below.

name String

A unique identifier for the instance partition, which cannot be changed after the instance partition is created. The name must be between 2 and 64 characters and match the regular expression [a-z][a-z0-9\-]{0,61}[a-z0-9].

nodeCount Integer

The number of nodes allocated to this instance partition. One node equals 1000 processing units. Exactly one of either node_count, processing_units, or autoscalingConfig must be present.

processingUnits Integer

The number of processing units allocated to this instance partition. Exactly one of either node_count, processing_units, or autoscalingConfig must be present.

project String

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

config string

The name of the instance partition's configuration (similar to a region) which defines the geographic placement and replication of data in this instance partition.

displayName string

The descriptive name for this instance partition as it appears in UIs. Must be unique per project and between 4 and 30 characters in length.

instance string

The instance to create the instance partition in.

autoscalingConfig InstancePartitionAutoscalingConfig

The autoscaling configuration. Autoscaling is enabled if this field is set. Exactly one of either node_count, processing_units, or autoscalingConfig must be present. When autoscaling is enabled, nodeCount and processingUnits are treated as OUTPUT_ONLY fields and reflect the current compute capacity allocated to the instance partition. Structure is documented below.

name string

A unique identifier for the instance partition, which cannot be changed after the instance partition is created. The name must be between 2 and 64 characters and match the regular expression [a-z][a-z0-9\-]{0,61}[a-z0-9].

nodeCount number

The number of nodes allocated to this instance partition. One node equals 1000 processing units. Exactly one of either node_count, processing_units, or autoscalingConfig must be present.

processingUnits number

The number of processing units allocated to this instance partition. Exactly one of either node_count, processing_units, or autoscalingConfig must be present.

project string

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

config str

The name of the instance partition's configuration (similar to a region) which defines the geographic placement and replication of data in this instance partition.

display_name str

The descriptive name for this instance partition as it appears in UIs. Must be unique per project and between 4 and 30 characters in length.

instance str

The instance to create the instance partition in.

autoscaling_config InstancePartitionAutoscalingConfigArgs

The autoscaling configuration. Autoscaling is enabled if this field is set. Exactly one of either node_count, processing_units, or autoscalingConfig must be present. When autoscaling is enabled, nodeCount and processingUnits are treated as OUTPUT_ONLY fields and reflect the current compute capacity allocated to the instance partition. Structure is documented below.

name str

A unique identifier for the instance partition, which cannot be changed after the instance partition is created. The name must be between 2 and 64 characters and match the regular expression [a-z][a-z0-9\-]{0,61}[a-z0-9].

node_count int

The number of nodes allocated to this instance partition. One node equals 1000 processing units. Exactly one of either node_count, processing_units, or autoscalingConfig must be present.

processing_units int

The number of processing units allocated to this instance partition. Exactly one of either node_count, processing_units, or autoscalingConfig must be present.

project str

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

config String

The name of the instance partition's configuration (similar to a region) which defines the geographic placement and replication of data in this instance partition.

displayName String

The descriptive name for this instance partition as it appears in UIs. Must be unique per project and between 4 and 30 characters in length.

instance String

The instance to create the instance partition in.

autoscalingConfig Property Map

The autoscaling configuration. Autoscaling is enabled if this field is set. Exactly one of either node_count, processing_units, or autoscalingConfig must be present. When autoscaling is enabled, nodeCount and processingUnits are treated as OUTPUT_ONLY fields and reflect the current compute capacity allocated to the instance partition. Structure is documented below.

name String

A unique identifier for the instance partition, which cannot be changed after the instance partition is created. The name must be between 2 and 64 characters and match the regular expression [a-z][a-z0-9\-]{0,61}[a-z0-9].

nodeCount Number

The number of nodes allocated to this instance partition. One node equals 1000 processing units. Exactly one of either node_count, processing_units, or autoscalingConfig must be present.

processingUnits Number

The number of processing units allocated to this instance partition. Exactly one of either node_count, processing_units, or autoscalingConfig must be present.

project String

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Id string

The provider-assigned unique ID for this managed resource.

State string

The current instance partition state. Possible values are: CREATING: The instance partition is being created. Resources are being allocated for the instance partition. READY: The instance partition has been allocated resources and is ready for use.

Id string

The provider-assigned unique ID for this managed resource.

State string

The current instance partition state. Possible values are: CREATING: The instance partition is being created. Resources are being allocated for the instance partition. READY: The instance partition has been allocated resources and is ready for use.

id string

The provider-assigned unique ID for this managed resource.

state string

The current instance partition state. Possible values are: CREATING: The instance partition is being created. Resources are being allocated for the instance partition. READY: The instance partition has been allocated resources and is ready for use.

id String

The provider-assigned unique ID for this managed resource.

state String

The current instance partition state. Possible values are: CREATING: The instance partition is being created. Resources are being allocated for the instance partition. READY: The instance partition has been allocated resources and is ready for use.

id string

The provider-assigned unique ID for this managed resource.

state string

The current instance partition state. Possible values are: CREATING: The instance partition is being created. Resources are being allocated for the instance partition. READY: The instance partition has been allocated resources and is ready for use.

id str

The provider-assigned unique ID for this managed resource.

state str

The current instance partition state. Possible values are: CREATING: The instance partition is being created. Resources are being allocated for the instance partition. READY: The instance partition has been allocated resources and is ready for use.

id String

The provider-assigned unique ID for this managed resource.

state String

The current instance partition state. Possible values are: CREATING: The instance partition is being created. Resources are being allocated for the instance partition. READY: The instance partition has been allocated resources and is ready for use.

name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

state

Any extra arguments used during the lookup.

opts

A bag of options that control this resource's behavior.

resource_name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

state

Any extra arguments used during the lookup.

opts

A bag of options that control this resource's behavior.

name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

state

Any extra arguments used during the lookup.

opts

A bag of options that control this resource's behavior.

name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

state

Any extra arguments used during the lookup.

opts

A bag of options that control this resource's behavior.

AutoscalingLimits InstancePartitionAutoscalingConfigAutoscalingLimits

Defines scale in controls to reduce the risk of response latency and outages due to abrupt scale-in events. Users can define the minimum and maximum compute capacity allocated to the instance partition, and the autoscaler will only scale within that range. Users can either use nodes or processing units to specify the limits, but should use the same unit to set both the minLimit and max_limit. Structure is documented below.

AutoscalingTargets InstancePartitionAutoscalingConfigAutoscalingTargets

Defines scale in controls to reduce the risk of response latency and outages due to abrupt scale-in events Structure is documented below.

AutoscalingLimits InstancePartitionAutoscalingConfigAutoscalingLimits

Defines scale in controls to reduce the risk of response latency and outages due to abrupt scale-in events. Users can define the minimum and maximum compute capacity allocated to the instance partition, and the autoscaler will only scale within that range. Users can either use nodes or processing units to specify the limits, but should use the same unit to set both the minLimit and max_limit. Structure is documented below.

AutoscalingTargets InstancePartitionAutoscalingConfigAutoscalingTargets

Defines scale in controls to reduce the risk of response latency and outages due to abrupt scale-in events Structure is documented below.

autoscaling_limits object

Defines scale in controls to reduce the risk of response latency and outages due to abrupt scale-in events. Users can define the minimum and maximum compute capacity allocated to the instance partition, and the autoscaler will only scale within that range. Users can either use nodes or processing units to specify the limits, but should use the same unit to set both the minLimit and max_limit. Structure is documented below.

autoscaling_targets object

Defines scale in controls to reduce the risk of response latency and outages due to abrupt scale-in events Structure is documented below.

autoscalingLimits InstancePartitionAutoscalingConfigAutoscalingLimits

Defines scale in controls to reduce the risk of response latency and outages due to abrupt scale-in events. Users can define the minimum and maximum compute capacity allocated to the instance partition, and the autoscaler will only scale within that range. Users can either use nodes or processing units to specify the limits, but should use the same unit to set both the minLimit and max_limit. Structure is documented below.

autoscalingTargets InstancePartitionAutoscalingConfigAutoscalingTargets

Defines scale in controls to reduce the risk of response latency and outages due to abrupt scale-in events Structure is documented below.

autoscalingLimits InstancePartitionAutoscalingConfigAutoscalingLimits

Defines scale in controls to reduce the risk of response latency and outages due to abrupt scale-in events. Users can define the minimum and maximum compute capacity allocated to the instance partition, and the autoscaler will only scale within that range. Users can either use nodes or processing units to specify the limits, but should use the same unit to set both the minLimit and max_limit. Structure is documented below.

autoscalingTargets InstancePartitionAutoscalingConfigAutoscalingTargets

Defines scale in controls to reduce the risk of response latency and outages due to abrupt scale-in events Structure is documented below.

autoscaling_limits InstancePartitionAutoscalingConfigAutoscalingLimits

Defines scale in controls to reduce the risk of response latency and outages due to abrupt scale-in events. Users can define the minimum and maximum compute capacity allocated to the instance partition, and the autoscaler will only scale within that range. Users can either use nodes or processing units to specify the limits, but should use the same unit to set both the minLimit and max_limit. Structure is documented below.

autoscaling_targets InstancePartitionAutoscalingConfigAutoscalingTargets

Defines scale in controls to reduce the risk of response latency and outages due to abrupt scale-in events Structure is documented below.

autoscalingLimits Property Map

Defines scale in controls to reduce the risk of response latency and outages due to abrupt scale-in events. Users can define the minimum and maximum compute capacity allocated to the instance partition, and the autoscaler will only scale within that range. Users can either use nodes or processing units to specify the limits, but should use the same unit to set both the minLimit and max_limit. Structure is documented below.

autoscalingTargets Property Map

Defines scale in controls to reduce the risk of response latency and outages due to abrupt scale-in events Structure is documented below.

MaxNodes int

Specifies maximum number of nodes allocated to the instance partition. If set, this number should be greater than or equal to min_nodes.

MaxProcessingUnits int

Specifies maximum number of processing units allocated to the instance partition. If set, this number should be multiples of 1000 and be greater than or equal to min_processing_units.

MinNodes int

Specifies number of nodes allocated to the instance partition. If set, this number should be greater than or equal to 1.

MinProcessingUnits int

Specifies minimum number of processing units allocated to the instance partition. If set, this number should be multiples of 1000.

MaxNodes int

Specifies maximum number of nodes allocated to the instance partition. If set, this number should be greater than or equal to min_nodes.

MaxProcessingUnits int

Specifies maximum number of processing units allocated to the instance partition. If set, this number should be multiples of 1000 and be greater than or equal to min_processing_units.

MinNodes int

Specifies number of nodes allocated to the instance partition. If set, this number should be greater than or equal to 1.

MinProcessingUnits int

Specifies minimum number of processing units allocated to the instance partition. If set, this number should be multiples of 1000.

max_nodes number

Specifies maximum number of nodes allocated to the instance partition. If set, this number should be greater than or equal to min_nodes.

max_processing_units number

Specifies maximum number of processing units allocated to the instance partition. If set, this number should be multiples of 1000 and be greater than or equal to min_processing_units.

min_nodes number

Specifies number of nodes allocated to the instance partition. If set, this number should be greater than or equal to 1.

min_processing_units number

Specifies minimum number of processing units allocated to the instance partition. If set, this number should be multiples of 1000.

maxNodes Integer

Specifies maximum number of nodes allocated to the instance partition. If set, this number should be greater than or equal to min_nodes.

maxProcessingUnits Integer

Specifies maximum number of processing units allocated to the instance partition. If set, this number should be multiples of 1000 and be greater than or equal to min_processing_units.

minNodes Integer

Specifies number of nodes allocated to the instance partition. If set, this number should be greater than or equal to 1.

minProcessingUnits Integer

Specifies minimum number of processing units allocated to the instance partition. If set, this number should be multiples of 1000.

maxNodes number

Specifies maximum number of nodes allocated to the instance partition. If set, this number should be greater than or equal to min_nodes.

maxProcessingUnits number

Specifies maximum number of processing units allocated to the instance partition. If set, this number should be multiples of 1000 and be greater than or equal to min_processing_units.

minNodes number

Specifies number of nodes allocated to the instance partition. If set, this number should be greater than or equal to 1.

minProcessingUnits number

Specifies minimum number of processing units allocated to the instance partition. If set, this number should be multiples of 1000.

max_nodes int

Specifies maximum number of nodes allocated to the instance partition. If set, this number should be greater than or equal to min_nodes.

max_processing_units int

Specifies maximum number of processing units allocated to the instance partition. If set, this number should be multiples of 1000 and be greater than or equal to min_processing_units.

min_nodes int

Specifies number of nodes allocated to the instance partition. If set, this number should be greater than or equal to 1.

min_processing_units int

Specifies minimum number of processing units allocated to the instance partition. If set, this number should be multiples of 1000.

maxNodes Number

Specifies maximum number of nodes allocated to the instance partition. If set, this number should be greater than or equal to min_nodes.

maxProcessingUnits Number

Specifies maximum number of processing units allocated to the instance partition. If set, this number should be multiples of 1000 and be greater than or equal to min_processing_units.

minNodes Number

Specifies number of nodes allocated to the instance partition. If set, this number should be greater than or equal to 1.

minProcessingUnits Number

Specifies minimum number of processing units allocated to the instance partition. If set, this number should be multiples of 1000.

HighPriorityCpuUtilizationPercent int

Specifies the target high priority cpu utilization percentage that the autoscaler should be trying to achieve for the instance partition. This number is on a scale from 0 (no utilization) to 100 (full utilization).

StorageUtilizationPercent int

Specifies the target storage utilization percentage that the autoscaler should be trying to achieve for the instance partition. This number is on a scale from 0 (no utilization) to 100 (full utilization).

TotalCpuUtilizationPercent int

Specifies the target total cpu utilization percentage that the autoscaler should be trying to achieve for the instance partition. This number is on a scale from 0 (no utilization) to 100 (full utilization). The valid range is [10, 90] inclusive. If not specified or set to 0, the autoscaler will skip scaling based on total cpu utilization. The value should be higher than highPriorityCpuUtilizationPercent if present.

HighPriorityCpuUtilizationPercent int

Specifies the target high priority cpu utilization percentage that the autoscaler should be trying to achieve for the instance partition. This number is on a scale from 0 (no utilization) to 100 (full utilization).

StorageUtilizationPercent int

Specifies the target storage utilization percentage that the autoscaler should be trying to achieve for the instance partition. This number is on a scale from 0 (no utilization) to 100 (full utilization).

TotalCpuUtilizationPercent int

Specifies the target total cpu utilization percentage that the autoscaler should be trying to achieve for the instance partition. This number is on a scale from 0 (no utilization) to 100 (full utilization). The valid range is [10, 90] inclusive. If not specified or set to 0, the autoscaler will skip scaling based on total cpu utilization. The value should be higher than highPriorityCpuUtilizationPercent if present.

high_priority_cpu_utilization_percent number

Specifies the target high priority cpu utilization percentage that the autoscaler should be trying to achieve for the instance partition. This number is on a scale from 0 (no utilization) to 100 (full utilization).

storage_utilization_percent number

Specifies the target storage utilization percentage that the autoscaler should be trying to achieve for the instance partition. This number is on a scale from 0 (no utilization) to 100 (full utilization).

total_cpu_utilization_percent number

Specifies the target total cpu utilization percentage that the autoscaler should be trying to achieve for the instance partition. This number is on a scale from 0 (no utilization) to 100 (full utilization). The valid range is [10, 90] inclusive. If not specified or set to 0, the autoscaler will skip scaling based on total cpu utilization. The value should be higher than highPriorityCpuUtilizationPercent if present.

highPriorityCpuUtilizationPercent Integer

Specifies the target high priority cpu utilization percentage that the autoscaler should be trying to achieve for the instance partition. This number is on a scale from 0 (no utilization) to 100 (full utilization).

storageUtilizationPercent Integer

Specifies the target storage utilization percentage that the autoscaler should be trying to achieve for the instance partition. This number is on a scale from 0 (no utilization) to 100 (full utilization).

totalCpuUtilizationPercent Integer

Specifies the target total cpu utilization percentage that the autoscaler should be trying to achieve for the instance partition. This number is on a scale from 0 (no utilization) to 100 (full utilization). The valid range is [10, 90] inclusive. If not specified or set to 0, the autoscaler will skip scaling based on total cpu utilization. The value should be higher than highPriorityCpuUtilizationPercent if present.

highPriorityCpuUtilizationPercent number

Specifies the target high priority cpu utilization percentage that the autoscaler should be trying to achieve for the instance partition. This number is on a scale from 0 (no utilization) to 100 (full utilization).

storageUtilizationPercent number

Specifies the target storage utilization percentage that the autoscaler should be trying to achieve for the instance partition. This number is on a scale from 0 (no utilization) to 100 (full utilization).

totalCpuUtilizationPercent number

Specifies the target total cpu utilization percentage that the autoscaler should be trying to achieve for the instance partition. This number is on a scale from 0 (no utilization) to 100 (full utilization). The valid range is [10, 90] inclusive. If not specified or set to 0, the autoscaler will skip scaling based on total cpu utilization. The value should be higher than highPriorityCpuUtilizationPercent if present.

high_priority_cpu_utilization_percent int

Specifies the target high priority cpu utilization percentage that the autoscaler should be trying to achieve for the instance partition. This number is on a scale from 0 (no utilization) to 100 (full utilization).

storage_utilization_percent int

Specifies the target storage utilization percentage that the autoscaler should be trying to achieve for the instance partition. This number is on a scale from 0 (no utilization) to 100 (full utilization).

total_cpu_utilization_percent int

Specifies the target total cpu utilization percentage that the autoscaler should be trying to achieve for the instance partition. This number is on a scale from 0 (no utilization) to 100 (full utilization). The valid range is [10, 90] inclusive. If not specified or set to 0, the autoscaler will skip scaling based on total cpu utilization. The value should be higher than highPriorityCpuUtilizationPercent if present.

highPriorityCpuUtilizationPercent Number

Specifies the target high priority cpu utilization percentage that the autoscaler should be trying to achieve for the instance partition. This number is on a scale from 0 (no utilization) to 100 (full utilization).

storageUtilizationPercent Number

Specifies the target storage utilization percentage that the autoscaler should be trying to achieve for the instance partition. This number is on a scale from 0 (no utilization) to 100 (full utilization).

totalCpuUtilizationPercent Number

Specifies the target total cpu utilization percentage that the autoscaler should be trying to achieve for the instance partition. This number is on a scale from 0 (no utilization) to 100 (full utilization). The valid range is [10, 90] inclusive. If not specified or set to 0, the autoscaler will skip scaling based on total cpu utilization. The value should be higher than highPriorityCpuUtilizationPercent if present.