Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
google-native.aiplatform/v1beta1.getPersistentResource
Explore with Pulumi AI
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
Gets a PersistentResource.
Using getPersistentResource
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getPersistentResource(args: GetPersistentResourceArgs, opts?: InvokeOptions): Promise<GetPersistentResourceResult>
function getPersistentResourceOutput(args: GetPersistentResourceOutputArgs, opts?: InvokeOptions): Output<GetPersistentResourceResult>
def get_persistent_resource(location: Optional[str] = None,
persistent_resource_id: Optional[str] = None,
project: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetPersistentResourceResult
def get_persistent_resource_output(location: Optional[pulumi.Input[str]] = None,
persistent_resource_id: Optional[pulumi.Input[str]] = None,
project: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetPersistentResourceResult]
func LookupPersistentResource(ctx *Context, args *LookupPersistentResourceArgs, opts ...InvokeOption) (*LookupPersistentResourceResult, error)
func LookupPersistentResourceOutput(ctx *Context, args *LookupPersistentResourceOutputArgs, opts ...InvokeOption) LookupPersistentResourceResultOutput
> Note: This function is named LookupPersistentResource
in the Go SDK.
public static class GetPersistentResource
{
public static Task<GetPersistentResourceResult> InvokeAsync(GetPersistentResourceArgs args, InvokeOptions? opts = null)
public static Output<GetPersistentResourceResult> Invoke(GetPersistentResourceInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetPersistentResourceResult> getPersistentResource(GetPersistentResourceArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: google-native:aiplatform/v1beta1:getPersistentResource
arguments:
# arguments dictionary
The following arguments are supported:
- Location string
- Persistent
Resource stringId - Project string
- Location string
- Persistent
Resource stringId - Project string
- location String
- persistent
Resource StringId - project String
- location string
- persistent
Resource stringId - project string
- location str
- persistent_
resource_ strid - project str
- location String
- persistent
Resource StringId - project String
getPersistentResource Result
The following output properties are available:
- Create
Time string - Time when the PersistentResource was created.
- Display
Name string - Optional. The display name of the PersistentResource. The name can be up to 128 characters long and can consist of any UTF-8 characters.
- Encryption
Spec Pulumi.Google Native. Aiplatform. V1Beta1. Outputs. Google Cloud Aiplatform V1beta1Encryption Spec Response - Optional. Customer-managed encryption key spec for a PersistentResource. If set, this PersistentResource and all sub-resources of this PersistentResource will be secured by this key.
- Error
Pulumi.
Google Native. Aiplatform. V1Beta1. Outputs. Google Rpc Status Response - Only populated when persistent resource's state is
STOPPING
orERROR
. - Labels Dictionary<string, string>
- Optional. The labels with user-defined metadata to organize PersistentResource. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
- Name string
- Immutable. Resource name of a PersistentResource.
- Network string
- Optional. The full name of the Compute Engine network to peered with Vertex AI to host the persistent resources. For example,
projects/12345/global/networks/myVPC
. Format is of the formprojects/{project}/global/networks/{network}
. Where {project} is a project number, as in12345
, and {network} is a network name. To specify this field, you must have already configured VPC Network Peering for Vertex AI. If this field is left unspecified, the resources aren't peered with any network. - Reserved
Ip List<string>Ranges - Optional. A list of names for the reserved IP ranges under the VPC network that can be used for this persistent resource. If set, we will deploy the persistent resource within the provided IP ranges. Otherwise, the persistent resource is deployed to any IP ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
- Resource
Pools List<Pulumi.Google Native. Aiplatform. V1Beta1. Outputs. Google Cloud Aiplatform V1beta1Resource Pool Response> - The spec of the pools of different resources.
- Resource
Runtime Pulumi.Google Native. Aiplatform. V1Beta1. Outputs. Google Cloud Aiplatform V1beta1Resource Runtime Response - Runtime information of the Persistent Resource.
- Resource
Runtime Pulumi.Spec Google Native. Aiplatform. V1Beta1. Outputs. Google Cloud Aiplatform V1beta1Resource Runtime Spec Response - Optional. Persistent Resource runtime spec. For example, used for Ray cluster configuration.
- Start
Time string - Time when the PersistentResource for the first time entered the
RUNNING
state. - State string
- The detailed state of a Study.
- Update
Time string - Time when the PersistentResource was most recently updated.
- Create
Time string - Time when the PersistentResource was created.
- Display
Name string - Optional. The display name of the PersistentResource. The name can be up to 128 characters long and can consist of any UTF-8 characters.
- Encryption
Spec GoogleCloud Aiplatform V1beta1Encryption Spec Response - Optional. Customer-managed encryption key spec for a PersistentResource. If set, this PersistentResource and all sub-resources of this PersistentResource will be secured by this key.
- Error
Google
Rpc Status Response - Only populated when persistent resource's state is
STOPPING
orERROR
. - Labels map[string]string
- Optional. The labels with user-defined metadata to organize PersistentResource. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
- Name string
- Immutable. Resource name of a PersistentResource.
- Network string
- Optional. The full name of the Compute Engine network to peered with Vertex AI to host the persistent resources. For example,
projects/12345/global/networks/myVPC
. Format is of the formprojects/{project}/global/networks/{network}
. Where {project} is a project number, as in12345
, and {network} is a network name. To specify this field, you must have already configured VPC Network Peering for Vertex AI. If this field is left unspecified, the resources aren't peered with any network. - Reserved
Ip []stringRanges - Optional. A list of names for the reserved IP ranges under the VPC network that can be used for this persistent resource. If set, we will deploy the persistent resource within the provided IP ranges. Otherwise, the persistent resource is deployed to any IP ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
- Resource
Pools []GoogleCloud Aiplatform V1beta1Resource Pool Response - The spec of the pools of different resources.
- Resource
Runtime GoogleCloud Aiplatform V1beta1Resource Runtime Response - Runtime information of the Persistent Resource.
- Resource
Runtime GoogleSpec Cloud Aiplatform V1beta1Resource Runtime Spec Response - Optional. Persistent Resource runtime spec. For example, used for Ray cluster configuration.
- Start
Time string - Time when the PersistentResource for the first time entered the
RUNNING
state. - State string
- The detailed state of a Study.
- Update
Time string - Time when the PersistentResource was most recently updated.
- create
Time String - Time when the PersistentResource was created.
- display
Name String - Optional. The display name of the PersistentResource. The name can be up to 128 characters long and can consist of any UTF-8 characters.
- encryption
Spec GoogleCloud Aiplatform V1beta1Encryption Spec Response - Optional. Customer-managed encryption key spec for a PersistentResource. If set, this PersistentResource and all sub-resources of this PersistentResource will be secured by this key.
- error
Google
Rpc Status Response - Only populated when persistent resource's state is
STOPPING
orERROR
. - labels Map<String,String>
- Optional. The labels with user-defined metadata to organize PersistentResource. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
- name String
- Immutable. Resource name of a PersistentResource.
- network String
- Optional. The full name of the Compute Engine network to peered with Vertex AI to host the persistent resources. For example,
projects/12345/global/networks/myVPC
. Format is of the formprojects/{project}/global/networks/{network}
. Where {project} is a project number, as in12345
, and {network} is a network name. To specify this field, you must have already configured VPC Network Peering for Vertex AI. If this field is left unspecified, the resources aren't peered with any network. - reserved
Ip List<String>Ranges - Optional. A list of names for the reserved IP ranges under the VPC network that can be used for this persistent resource. If set, we will deploy the persistent resource within the provided IP ranges. Otherwise, the persistent resource is deployed to any IP ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
- resource
Pools List<GoogleCloud Aiplatform V1beta1Resource Pool Response> - The spec of the pools of different resources.
- resource
Runtime GoogleCloud Aiplatform V1beta1Resource Runtime Response - Runtime information of the Persistent Resource.
- resource
Runtime GoogleSpec Cloud Aiplatform V1beta1Resource Runtime Spec Response - Optional. Persistent Resource runtime spec. For example, used for Ray cluster configuration.
- start
Time String - Time when the PersistentResource for the first time entered the
RUNNING
state. - state String
- The detailed state of a Study.
- update
Time String - Time when the PersistentResource was most recently updated.
- create
Time string - Time when the PersistentResource was created.
- display
Name string - Optional. The display name of the PersistentResource. The name can be up to 128 characters long and can consist of any UTF-8 characters.
- encryption
Spec GoogleCloud Aiplatform V1beta1Encryption Spec Response - Optional. Customer-managed encryption key spec for a PersistentResource. If set, this PersistentResource and all sub-resources of this PersistentResource will be secured by this key.
- error
Google
Rpc Status Response - Only populated when persistent resource's state is
STOPPING
orERROR
. - labels {[key: string]: string}
- Optional. The labels with user-defined metadata to organize PersistentResource. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
- name string
- Immutable. Resource name of a PersistentResource.
- network string
- Optional. The full name of the Compute Engine network to peered with Vertex AI to host the persistent resources. For example,
projects/12345/global/networks/myVPC
. Format is of the formprojects/{project}/global/networks/{network}
. Where {project} is a project number, as in12345
, and {network} is a network name. To specify this field, you must have already configured VPC Network Peering for Vertex AI. If this field is left unspecified, the resources aren't peered with any network. - reserved
Ip string[]Ranges - Optional. A list of names for the reserved IP ranges under the VPC network that can be used for this persistent resource. If set, we will deploy the persistent resource within the provided IP ranges. Otherwise, the persistent resource is deployed to any IP ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
- resource
Pools GoogleCloud Aiplatform V1beta1Resource Pool Response[] - The spec of the pools of different resources.
- resource
Runtime GoogleCloud Aiplatform V1beta1Resource Runtime Response - Runtime information of the Persistent Resource.
- resource
Runtime GoogleSpec Cloud Aiplatform V1beta1Resource Runtime Spec Response - Optional. Persistent Resource runtime spec. For example, used for Ray cluster configuration.
- start
Time string - Time when the PersistentResource for the first time entered the
RUNNING
state. - state string
- The detailed state of a Study.
- update
Time string - Time when the PersistentResource was most recently updated.
- create_
time str - Time when the PersistentResource was created.
- display_
name str - Optional. The display name of the PersistentResource. The name can be up to 128 characters long and can consist of any UTF-8 characters.
- encryption_
spec GoogleCloud Aiplatform V1beta1Encryption Spec Response - Optional. Customer-managed encryption key spec for a PersistentResource. If set, this PersistentResource and all sub-resources of this PersistentResource will be secured by this key.
- error
Google
Rpc Status Response - Only populated when persistent resource's state is
STOPPING
orERROR
. - labels Mapping[str, str]
- Optional. The labels with user-defined metadata to organize PersistentResource. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
- name str
- Immutable. Resource name of a PersistentResource.
- network str
- Optional. The full name of the Compute Engine network to peered with Vertex AI to host the persistent resources. For example,
projects/12345/global/networks/myVPC
. Format is of the formprojects/{project}/global/networks/{network}
. Where {project} is a project number, as in12345
, and {network} is a network name. To specify this field, you must have already configured VPC Network Peering for Vertex AI. If this field is left unspecified, the resources aren't peered with any network. - reserved_
ip_ Sequence[str]ranges - Optional. A list of names for the reserved IP ranges under the VPC network that can be used for this persistent resource. If set, we will deploy the persistent resource within the provided IP ranges. Otherwise, the persistent resource is deployed to any IP ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
- resource_
pools Sequence[GoogleCloud Aiplatform V1beta1Resource Pool Response] - The spec of the pools of different resources.
- resource_
runtime GoogleCloud Aiplatform V1beta1Resource Runtime Response - Runtime information of the Persistent Resource.
- resource_
runtime_ Googlespec Cloud Aiplatform V1beta1Resource Runtime Spec Response - Optional. Persistent Resource runtime spec. For example, used for Ray cluster configuration.
- start_
time str - Time when the PersistentResource for the first time entered the
RUNNING
state. - state str
- The detailed state of a Study.
- update_
time str - Time when the PersistentResource was most recently updated.
- create
Time String - Time when the PersistentResource was created.
- display
Name String - Optional. The display name of the PersistentResource. The name can be up to 128 characters long and can consist of any UTF-8 characters.
- encryption
Spec Property Map - Optional. Customer-managed encryption key spec for a PersistentResource. If set, this PersistentResource and all sub-resources of this PersistentResource will be secured by this key.
- error Property Map
- Only populated when persistent resource's state is
STOPPING
orERROR
. - labels Map<String>
- Optional. The labels with user-defined metadata to organize PersistentResource. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels.
- name String
- Immutable. Resource name of a PersistentResource.
- network String
- Optional. The full name of the Compute Engine network to peered with Vertex AI to host the persistent resources. For example,
projects/12345/global/networks/myVPC
. Format is of the formprojects/{project}/global/networks/{network}
. Where {project} is a project number, as in12345
, and {network} is a network name. To specify this field, you must have already configured VPC Network Peering for Vertex AI. If this field is left unspecified, the resources aren't peered with any network. - reserved
Ip List<String>Ranges - Optional. A list of names for the reserved IP ranges under the VPC network that can be used for this persistent resource. If set, we will deploy the persistent resource within the provided IP ranges. Otherwise, the persistent resource is deployed to any IP ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
- resource
Pools List<Property Map> - The spec of the pools of different resources.
- resource
Runtime Property Map - Runtime information of the Persistent Resource.
- resource
Runtime Property MapSpec - Optional. Persistent Resource runtime spec. For example, used for Ray cluster configuration.
- start
Time String - Time when the PersistentResource for the first time entered the
RUNNING
state. - state String
- The detailed state of a Study.
- update
Time String - Time when the PersistentResource was most recently updated.
Supporting Types
GoogleCloudAiplatformV1beta1DiskSpecResponse
- Boot
Disk intSize Gb - Size in GB of the boot disk (default is 100GB).
- Boot
Disk stringType - Type of the boot disk (default is "pd-ssd"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).
- Boot
Disk intSize Gb - Size in GB of the boot disk (default is 100GB).
- Boot
Disk stringType - Type of the boot disk (default is "pd-ssd"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).
- boot
Disk IntegerSize Gb - Size in GB of the boot disk (default is 100GB).
- boot
Disk StringType - Type of the boot disk (default is "pd-ssd"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).
- boot
Disk numberSize Gb - Size in GB of the boot disk (default is 100GB).
- boot
Disk stringType - Type of the boot disk (default is "pd-ssd"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).
- boot_
disk_ intsize_ gb - Size in GB of the boot disk (default is 100GB).
- boot_
disk_ strtype - Type of the boot disk (default is "pd-ssd"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).
- boot
Disk NumberSize Gb - Size in GB of the boot disk (default is 100GB).
- boot
Disk StringType - Type of the boot disk (default is "pd-ssd"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).
GoogleCloudAiplatformV1beta1EncryptionSpecResponse
- Kms
Key stringName - The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form:
projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key
. The key needs to be in the same region as where the compute resource is created.
- Kms
Key stringName - The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form:
projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key
. The key needs to be in the same region as where the compute resource is created.
- kms
Key StringName - The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form:
projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key
. The key needs to be in the same region as where the compute resource is created.
- kms
Key stringName - The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form:
projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key
. The key needs to be in the same region as where the compute resource is created.
- kms_
key_ strname - The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form:
projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key
. The key needs to be in the same region as where the compute resource is created.
- kms
Key StringName - The Cloud KMS resource identifier of the customer managed encryption key used to protect a resource. Has the form:
projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key
. The key needs to be in the same region as where the compute resource is created.
GoogleCloudAiplatformV1beta1MachineSpecResponse
- Accelerator
Count int - The number of accelerators to attach to the machine.
- Accelerator
Type string - Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.
- Machine
Type string - Immutable. The type of the machine. See the list of machine types supported for prediction See the list of machine types supported for custom training. For DeployedModel this field is optional, and the default value is
n1-standard-2
. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - Tpu
Topology string - Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1").
- Accelerator
Count int - The number of accelerators to attach to the machine.
- Accelerator
Type string - Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.
- Machine
Type string - Immutable. The type of the machine. See the list of machine types supported for prediction See the list of machine types supported for custom training. For DeployedModel this field is optional, and the default value is
n1-standard-2
. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - Tpu
Topology string - Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1").
- accelerator
Count Integer - The number of accelerators to attach to the machine.
- accelerator
Type String - Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.
- machine
Type String - Immutable. The type of the machine. See the list of machine types supported for prediction See the list of machine types supported for custom training. For DeployedModel this field is optional, and the default value is
n1-standard-2
. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - tpu
Topology String - Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1").
- accelerator
Count number - The number of accelerators to attach to the machine.
- accelerator
Type string - Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.
- machine
Type string - Immutable. The type of the machine. See the list of machine types supported for prediction See the list of machine types supported for custom training. For DeployedModel this field is optional, and the default value is
n1-standard-2
. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - tpu
Topology string - Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1").
- accelerator_
count int - The number of accelerators to attach to the machine.
- accelerator_
type str - Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.
- machine_
type str - Immutable. The type of the machine. See the list of machine types supported for prediction See the list of machine types supported for custom training. For DeployedModel this field is optional, and the default value is
n1-standard-2
. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - tpu_
topology str - Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1").
- accelerator
Count Number - The number of accelerators to attach to the machine.
- accelerator
Type String - Immutable. The type of accelerator(s) that may be attached to the machine as per accelerator_count.
- machine
Type String - Immutable. The type of the machine. See the list of machine types supported for prediction See the list of machine types supported for custom training. For DeployedModel this field is optional, and the default value is
n1-standard-2
. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. - tpu
Topology String - Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1").
GoogleCloudAiplatformV1beta1RaySpecResponse
- Head
Node stringResource Pool Id - Optional. This will be used to indicate which resource pool will serve as the Ray head node(the first node within that pool). Will use the machine from the first workerpool as the head node by default if this field isn't set.
- Image
Uri string - Optional. Default image for user to choose a preferred ML framework (for example, TensorFlow or Pytorch) by choosing from Vertex prebuilt images. Either this or the resource_pool_images is required. Use this field if you need all the resource pools to have the same Ray image. Otherwise, use the {@code resource_pool_images} field.
- Resource
Pool Dictionary<string, string>Images - Optional. Required if image_uri isn't set. A map of resource_pool_id to prebuild Ray image if user need to use different images for different head/worker pools. This map needs to cover all the resource pool ids. Example: { "ray_head_node_pool": "head image" "ray_worker_node_pool1": "worker image" "ray_worker_node_pool2": "another worker image" }
- Head
Node stringResource Pool Id - Optional. This will be used to indicate which resource pool will serve as the Ray head node(the first node within that pool). Will use the machine from the first workerpool as the head node by default if this field isn't set.
- Image
Uri string - Optional. Default image for user to choose a preferred ML framework (for example, TensorFlow or Pytorch) by choosing from Vertex prebuilt images. Either this or the resource_pool_images is required. Use this field if you need all the resource pools to have the same Ray image. Otherwise, use the {@code resource_pool_images} field.
- Resource
Pool map[string]stringImages - Optional. Required if image_uri isn't set. A map of resource_pool_id to prebuild Ray image if user need to use different images for different head/worker pools. This map needs to cover all the resource pool ids. Example: { "ray_head_node_pool": "head image" "ray_worker_node_pool1": "worker image" "ray_worker_node_pool2": "another worker image" }
- head
Node StringResource Pool Id - Optional. This will be used to indicate which resource pool will serve as the Ray head node(the first node within that pool). Will use the machine from the first workerpool as the head node by default if this field isn't set.
- image
Uri String - Optional. Default image for user to choose a preferred ML framework (for example, TensorFlow or Pytorch) by choosing from Vertex prebuilt images. Either this or the resource_pool_images is required. Use this field if you need all the resource pools to have the same Ray image. Otherwise, use the {@code resource_pool_images} field.
- resource
Pool Map<String,String>Images - Optional. Required if image_uri isn't set. A map of resource_pool_id to prebuild Ray image if user need to use different images for different head/worker pools. This map needs to cover all the resource pool ids. Example: { "ray_head_node_pool": "head image" "ray_worker_node_pool1": "worker image" "ray_worker_node_pool2": "another worker image" }
- head
Node stringResource Pool Id - Optional. This will be used to indicate which resource pool will serve as the Ray head node(the first node within that pool). Will use the machine from the first workerpool as the head node by default if this field isn't set.
- image
Uri string - Optional. Default image for user to choose a preferred ML framework (for example, TensorFlow or Pytorch) by choosing from Vertex prebuilt images. Either this or the resource_pool_images is required. Use this field if you need all the resource pools to have the same Ray image. Otherwise, use the {@code resource_pool_images} field.
- resource
Pool {[key: string]: string}Images - Optional. Required if image_uri isn't set. A map of resource_pool_id to prebuild Ray image if user need to use different images for different head/worker pools. This map needs to cover all the resource pool ids. Example: { "ray_head_node_pool": "head image" "ray_worker_node_pool1": "worker image" "ray_worker_node_pool2": "another worker image" }
- head_
node_ strresource_ pool_ id - Optional. This will be used to indicate which resource pool will serve as the Ray head node(the first node within that pool). Will use the machine from the first workerpool as the head node by default if this field isn't set.
- image_
uri str - Optional. Default image for user to choose a preferred ML framework (for example, TensorFlow or Pytorch) by choosing from Vertex prebuilt images. Either this or the resource_pool_images is required. Use this field if you need all the resource pools to have the same Ray image. Otherwise, use the {@code resource_pool_images} field.
- resource_
pool_ Mapping[str, str]images - Optional. Required if image_uri isn't set. A map of resource_pool_id to prebuild Ray image if user need to use different images for different head/worker pools. This map needs to cover all the resource pool ids. Example: { "ray_head_node_pool": "head image" "ray_worker_node_pool1": "worker image" "ray_worker_node_pool2": "another worker image" }
- head
Node StringResource Pool Id - Optional. This will be used to indicate which resource pool will serve as the Ray head node(the first node within that pool). Will use the machine from the first workerpool as the head node by default if this field isn't set.
- image
Uri String - Optional. Default image for user to choose a preferred ML framework (for example, TensorFlow or Pytorch) by choosing from Vertex prebuilt images. Either this or the resource_pool_images is required. Use this field if you need all the resource pools to have the same Ray image. Otherwise, use the {@code resource_pool_images} field.
- resource
Pool Map<String>Images - Optional. Required if image_uri isn't set. A map of resource_pool_id to prebuild Ray image if user need to use different images for different head/worker pools. This map needs to cover all the resource pool ids. Example: { "ray_head_node_pool": "head image" "ray_worker_node_pool1": "worker image" "ray_worker_node_pool2": "another worker image" }
GoogleCloudAiplatformV1beta1ResourcePoolAutoscalingSpecResponse
- Max
Replica stringCount - Optional. max replicas in the node pool, must be ≥ replica_count and > min_replica_count or will throw error
- Min
Replica stringCount - Optional. min replicas in the node pool, must be ≤ replica_count and < max_replica_count or will throw error
- Max
Replica stringCount - Optional. max replicas in the node pool, must be ≥ replica_count and > min_replica_count or will throw error
- Min
Replica stringCount - Optional. min replicas in the node pool, must be ≤ replica_count and < max_replica_count or will throw error
- max
Replica StringCount - Optional. max replicas in the node pool, must be ≥ replica_count and > min_replica_count or will throw error
- min
Replica StringCount - Optional. min replicas in the node pool, must be ≤ replica_count and < max_replica_count or will throw error
- max
Replica stringCount - Optional. max replicas in the node pool, must be ≥ replica_count and > min_replica_count or will throw error
- min
Replica stringCount - Optional. min replicas in the node pool, must be ≤ replica_count and < max_replica_count or will throw error
- max_
replica_ strcount - Optional. max replicas in the node pool, must be ≥ replica_count and > min_replica_count or will throw error
- min_
replica_ strcount - Optional. min replicas in the node pool, must be ≤ replica_count and < max_replica_count or will throw error
- max
Replica StringCount - Optional. max replicas in the node pool, must be ≥ replica_count and > min_replica_count or will throw error
- min
Replica StringCount - Optional. min replicas in the node pool, must be ≤ replica_count and < max_replica_count or will throw error
GoogleCloudAiplatformV1beta1ResourcePoolResponse
- Autoscaling
Spec Pulumi.Google Native. Aiplatform. V1Beta1. Inputs. Google Cloud Aiplatform V1beta1Resource Pool Autoscaling Spec Response - Optional. Optional spec to configure GKE autoscaling
- Disk
Spec Pulumi.Google Native. Aiplatform. V1Beta1. Inputs. Google Cloud Aiplatform V1beta1Disk Spec Response - Optional. Disk spec for the machine in this node pool.
- Machine
Spec Pulumi.Google Native. Aiplatform. V1Beta1. Inputs. Google Cloud Aiplatform V1beta1Machine Spec Response - Immutable. The specification of a single machine.
- Replica
Count string - Optional. The total number of machines to use for this resource pool.
- Used
Replica stringCount - The number of machines currently in use by training jobs for this resource pool. Will replace idle_replica_count.
- Autoscaling
Spec GoogleCloud Aiplatform V1beta1Resource Pool Autoscaling Spec Response - Optional. Optional spec to configure GKE autoscaling
- Disk
Spec GoogleCloud Aiplatform V1beta1Disk Spec Response - Optional. Disk spec for the machine in this node pool.
- Machine
Spec GoogleCloud Aiplatform V1beta1Machine Spec Response - Immutable. The specification of a single machine.
- Replica
Count string - Optional. The total number of machines to use for this resource pool.
- Used
Replica stringCount - The number of machines currently in use by training jobs for this resource pool. Will replace idle_replica_count.
- autoscaling
Spec GoogleCloud Aiplatform V1beta1Resource Pool Autoscaling Spec Response - Optional. Optional spec to configure GKE autoscaling
- disk
Spec GoogleCloud Aiplatform V1beta1Disk Spec Response - Optional. Disk spec for the machine in this node pool.
- machine
Spec GoogleCloud Aiplatform V1beta1Machine Spec Response - Immutable. The specification of a single machine.
- replica
Count String - Optional. The total number of machines to use for this resource pool.
- used
Replica StringCount - The number of machines currently in use by training jobs for this resource pool. Will replace idle_replica_count.
- autoscaling
Spec GoogleCloud Aiplatform V1beta1Resource Pool Autoscaling Spec Response - Optional. Optional spec to configure GKE autoscaling
- disk
Spec GoogleCloud Aiplatform V1beta1Disk Spec Response - Optional. Disk spec for the machine in this node pool.
- machine
Spec GoogleCloud Aiplatform V1beta1Machine Spec Response - Immutable. The specification of a single machine.
- replica
Count string - Optional. The total number of machines to use for this resource pool.
- used
Replica stringCount - The number of machines currently in use by training jobs for this resource pool. Will replace idle_replica_count.
- autoscaling_
spec GoogleCloud Aiplatform V1beta1Resource Pool Autoscaling Spec Response - Optional. Optional spec to configure GKE autoscaling
- disk_
spec GoogleCloud Aiplatform V1beta1Disk Spec Response - Optional. Disk spec for the machine in this node pool.
- machine_
spec GoogleCloud Aiplatform V1beta1Machine Spec Response - Immutable. The specification of a single machine.
- replica_
count str - Optional. The total number of machines to use for this resource pool.
- used_
replica_ strcount - The number of machines currently in use by training jobs for this resource pool. Will replace idle_replica_count.
- autoscaling
Spec Property Map - Optional. Optional spec to configure GKE autoscaling
- disk
Spec Property Map - Optional. Disk spec for the machine in this node pool.
- machine
Spec Property Map - Immutable. The specification of a single machine.
- replica
Count String - Optional. The total number of machines to use for this resource pool.
- used
Replica StringCount - The number of machines currently in use by training jobs for this resource pool. Will replace idle_replica_count.
GoogleCloudAiplatformV1beta1ResourceRuntimeResponse
- Access
Uris Dictionary<string, string> - URIs for user to connect to the Cluster. Example: { "RAY_HEAD_NODE_INTERNAL_IP": "head-node-IP:10001" "RAY_DASHBOARD_URI": "ray-dashboard-address:8888" }
- Notebook
Runtime stringTemplate - The resource name of NotebookRuntimeTemplate for the RoV Persistent Cluster The NotebokRuntimeTemplate is created in the same VPC (if set), and with the same Ray and Python version as the Persistent Cluster. Example: "projects/1000/locations/us-central1/notebookRuntimeTemplates/abc123"
- Access
Uris map[string]string - URIs for user to connect to the Cluster. Example: { "RAY_HEAD_NODE_INTERNAL_IP": "head-node-IP:10001" "RAY_DASHBOARD_URI": "ray-dashboard-address:8888" }
- Notebook
Runtime stringTemplate - The resource name of NotebookRuntimeTemplate for the RoV Persistent Cluster The NotebokRuntimeTemplate is created in the same VPC (if set), and with the same Ray and Python version as the Persistent Cluster. Example: "projects/1000/locations/us-central1/notebookRuntimeTemplates/abc123"
- access
Uris Map<String,String> - URIs for user to connect to the Cluster. Example: { "RAY_HEAD_NODE_INTERNAL_IP": "head-node-IP:10001" "RAY_DASHBOARD_URI": "ray-dashboard-address:8888" }
- notebook
Runtime StringTemplate - The resource name of NotebookRuntimeTemplate for the RoV Persistent Cluster The NotebokRuntimeTemplate is created in the same VPC (if set), and with the same Ray and Python version as the Persistent Cluster. Example: "projects/1000/locations/us-central1/notebookRuntimeTemplates/abc123"
- access
Uris {[key: string]: string} - URIs for user to connect to the Cluster. Example: { "RAY_HEAD_NODE_INTERNAL_IP": "head-node-IP:10001" "RAY_DASHBOARD_URI": "ray-dashboard-address:8888" }
- notebook
Runtime stringTemplate - The resource name of NotebookRuntimeTemplate for the RoV Persistent Cluster The NotebokRuntimeTemplate is created in the same VPC (if set), and with the same Ray and Python version as the Persistent Cluster. Example: "projects/1000/locations/us-central1/notebookRuntimeTemplates/abc123"
- access_
uris Mapping[str, str] - URIs for user to connect to the Cluster. Example: { "RAY_HEAD_NODE_INTERNAL_IP": "head-node-IP:10001" "RAY_DASHBOARD_URI": "ray-dashboard-address:8888" }
- notebook_
runtime_ strtemplate - The resource name of NotebookRuntimeTemplate for the RoV Persistent Cluster The NotebokRuntimeTemplate is created in the same VPC (if set), and with the same Ray and Python version as the Persistent Cluster. Example: "projects/1000/locations/us-central1/notebookRuntimeTemplates/abc123"
- access
Uris Map<String> - URIs for user to connect to the Cluster. Example: { "RAY_HEAD_NODE_INTERNAL_IP": "head-node-IP:10001" "RAY_DASHBOARD_URI": "ray-dashboard-address:8888" }
- notebook
Runtime StringTemplate - The resource name of NotebookRuntimeTemplate for the RoV Persistent Cluster The NotebokRuntimeTemplate is created in the same VPC (if set), and with the same Ray and Python version as the Persistent Cluster. Example: "projects/1000/locations/us-central1/notebookRuntimeTemplates/abc123"
GoogleCloudAiplatformV1beta1ResourceRuntimeSpecResponse
- Ray
Spec Pulumi.Google Native. Aiplatform. V1Beta1. Inputs. Google Cloud Aiplatform V1beta1Ray Spec Response - Optional. Ray cluster configuration. Required when creating a dedicated RayCluster on the PersistentResource.
- Service
Account Pulumi.Spec Google Native. Aiplatform. V1Beta1. Inputs. Google Cloud Aiplatform V1beta1Service Account Spec Response - Optional. Configure the use of workload identity on the PersistentResource
- Ray
Spec GoogleCloud Aiplatform V1beta1Ray Spec Response - Optional. Ray cluster configuration. Required when creating a dedicated RayCluster on the PersistentResource.
- Service
Account GoogleSpec Cloud Aiplatform V1beta1Service Account Spec Response - Optional. Configure the use of workload identity on the PersistentResource
- ray
Spec GoogleCloud Aiplatform V1beta1Ray Spec Response - Optional. Ray cluster configuration. Required when creating a dedicated RayCluster on the PersistentResource.
- service
Account GoogleSpec Cloud Aiplatform V1beta1Service Account Spec Response - Optional. Configure the use of workload identity on the PersistentResource
- ray
Spec GoogleCloud Aiplatform V1beta1Ray Spec Response - Optional. Ray cluster configuration. Required when creating a dedicated RayCluster on the PersistentResource.
- service
Account GoogleSpec Cloud Aiplatform V1beta1Service Account Spec Response - Optional. Configure the use of workload identity on the PersistentResource
- ray_
spec GoogleCloud Aiplatform V1beta1Ray Spec Response - Optional. Ray cluster configuration. Required when creating a dedicated RayCluster on the PersistentResource.
- service_
account_ Googlespec Cloud Aiplatform V1beta1Service Account Spec Response - Optional. Configure the use of workload identity on the PersistentResource
- ray
Spec Property Map - Optional. Ray cluster configuration. Required when creating a dedicated RayCluster on the PersistentResource.
- service
Account Property MapSpec - Optional. Configure the use of workload identity on the PersistentResource
GoogleCloudAiplatformV1beta1ServiceAccountSpecResponse
- Enable
Custom boolService Account - If true, custom user-managed service account is enforced to run any workloads (for example, Vertex Jobs) on the resource. Otherwise, uses the Vertex AI Custom Code Service Agent.
- Service
Account string - Optional. Default service account that this PersistentResource's workloads run as. The workloads include: * Any runtime specified via
ResourceRuntimeSpec
on creation time, for example, Ray. * Jobs submitted to PersistentResource, if no other service account specified in the job specs. Only works when custom service account is enabled and users have theiam.serviceAccounts.actAs
permission on this service account. Required if any containers are specified inResourceRuntimeSpec
.
- Enable
Custom boolService Account - If true, custom user-managed service account is enforced to run any workloads (for example, Vertex Jobs) on the resource. Otherwise, uses the Vertex AI Custom Code Service Agent.
- Service
Account string - Optional. Default service account that this PersistentResource's workloads run as. The workloads include: * Any runtime specified via
ResourceRuntimeSpec
on creation time, for example, Ray. * Jobs submitted to PersistentResource, if no other service account specified in the job specs. Only works when custom service account is enabled and users have theiam.serviceAccounts.actAs
permission on this service account. Required if any containers are specified inResourceRuntimeSpec
.
- enable
Custom BooleanService Account - If true, custom user-managed service account is enforced to run any workloads (for example, Vertex Jobs) on the resource. Otherwise, uses the Vertex AI Custom Code Service Agent.
- service
Account String - Optional. Default service account that this PersistentResource's workloads run as. The workloads include: * Any runtime specified via
ResourceRuntimeSpec
on creation time, for example, Ray. * Jobs submitted to PersistentResource, if no other service account specified in the job specs. Only works when custom service account is enabled and users have theiam.serviceAccounts.actAs
permission on this service account. Required if any containers are specified inResourceRuntimeSpec
.
- enable
Custom booleanService Account - If true, custom user-managed service account is enforced to run any workloads (for example, Vertex Jobs) on the resource. Otherwise, uses the Vertex AI Custom Code Service Agent.
- service
Account string - Optional. Default service account that this PersistentResource's workloads run as. The workloads include: * Any runtime specified via
ResourceRuntimeSpec
on creation time, for example, Ray. * Jobs submitted to PersistentResource, if no other service account specified in the job specs. Only works when custom service account is enabled and users have theiam.serviceAccounts.actAs
permission on this service account. Required if any containers are specified inResourceRuntimeSpec
.
- enable_
custom_ boolservice_ account - If true, custom user-managed service account is enforced to run any workloads (for example, Vertex Jobs) on the resource. Otherwise, uses the Vertex AI Custom Code Service Agent.
- service_
account str - Optional. Default service account that this PersistentResource's workloads run as. The workloads include: * Any runtime specified via
ResourceRuntimeSpec
on creation time, for example, Ray. * Jobs submitted to PersistentResource, if no other service account specified in the job specs. Only works when custom service account is enabled and users have theiam.serviceAccounts.actAs
permission on this service account. Required if any containers are specified inResourceRuntimeSpec
.
- enable
Custom BooleanService Account - If true, custom user-managed service account is enforced to run any workloads (for example, Vertex Jobs) on the resource. Otherwise, uses the Vertex AI Custom Code Service Agent.
- service
Account String - Optional. Default service account that this PersistentResource's workloads run as. The workloads include: * Any runtime specified via
ResourceRuntimeSpec
on creation time, for example, Ray. * Jobs submitted to PersistentResource, if no other service account specified in the job specs. Only works when custom service account is enabled and users have theiam.serviceAccounts.actAs
permission on this service account. Required if any containers are specified inResourceRuntimeSpec
.
GoogleRpcStatusResponse
- Code int
- The status code, which should be an enum value of google.rpc.Code.
- Details
List<Immutable
Dictionary<string, string>> - A list of messages that carry the error details. There is a common set of message types for APIs to use.
- Message string
- A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
- Code int
- The status code, which should be an enum value of google.rpc.Code.
- Details []map[string]string
- A list of messages that carry the error details. There is a common set of message types for APIs to use.
- Message string
- A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
- code Integer
- The status code, which should be an enum value of google.rpc.Code.
- details List<Map<String,String>>
- A list of messages that carry the error details. There is a common set of message types for APIs to use.
- message String
- A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
- code number
- The status code, which should be an enum value of google.rpc.Code.
- details {[key: string]: string}[]
- A list of messages that carry the error details. There is a common set of message types for APIs to use.
- message string
- A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
- code int
- The status code, which should be an enum value of google.rpc.Code.
- details Sequence[Mapping[str, str]]
- A list of messages that carry the error details. There is a common set of message types for APIs to use.
- message str
- A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
- code Number
- The status code, which should be an enum value of google.rpc.Code.
- details List<Map<String>>
- A list of messages that carry the error details. There is a common set of message types for APIs to use.
- message String
- A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
Package Details
- Repository
- Google Cloud Native pulumi/pulumi-google-native
- License
- Apache-2.0
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi