deployment_resource_pools

Creates, updates, deletes, gets or lists a deployment_resource_pools resource.

Overview

Name	deployment_resource_pools
Type	Resource
Id	google.aiplatform.deployment_resource_pools

Fields

Name	Datatype	Description
name	string	Immutable. The resource name of the DeploymentResourcePool. Format: projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}
createTime	string	Output only. Timestamp when this DeploymentResourcePool was created.
dedicatedResources	object	A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration.
disableContainerLogging	boolean	If the DeploymentResourcePool is deployed with custom-trained Models or AutoML Tabular Models, the container(s) of the DeploymentResourcePool will send stderr and stdout streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to Cloud Logging pricing. User can disable container logging by setting this flag to true.
encryptionSpec	object	Represents a customer-managed encryption key spec that can be applied to a top-level resource.
satisfiesPzi	boolean	Output only. Reserved for future use.
satisfiesPzs	boolean	Output only. Reserved for future use.
serviceAccount	string	The service account that the DeploymentResourcePool's container(s) run as. Specify the email address of the service account. If this service account is not specified, the container(s) run as a service account that doesn't have access to the resource project. Users deploying the Models to this DeploymentResourcePool must have the iam.serviceAccounts.actAs permission on this service account.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	deploymentResourcePoolsId, locationsId, projectsId	Get a DeploymentResourcePool.
list	SELECT	locationsId, projectsId	List DeploymentResourcePools in a location.
query_deployed_models	SELECT	deploymentResourcePoolsId, locationsId, projectsId	List DeployedModels that have been deployed on this DeploymentResourcePool.
create	INSERT	locationsId, projectsId	Create a DeploymentResourcePool.
delete	DELETE	deploymentResourcePoolsId, locationsId, projectsId	Delete a DeploymentResourcePool.
patch	UPDATE	deploymentResourcePoolsId, locationsId, projectsId	Update a DeploymentResourcePool.

SELECT examples

List DeploymentResourcePools in a location.

SELECT
name,
createTime,
dedicatedResources,
disableContainerLogging,
encryptionSpec,
satisfiesPzi,
satisfiesPzs,
serviceAccount
FROM google.aiplatform.deployment_resource_pools
WHERE locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

INSERT example

Use the following StackQL query and manifest file to create a new deployment_resource_pools resource.

All Properties

/*+ create */
INSERT INTO google.aiplatform.deployment_resource_pools (
locationsId,
projectsId,
deploymentResourcePool,
deploymentResourcePoolId
)
SELECT 
'{{ locationsId }}',
'{{ projectsId }}',
'{{ deploymentResourcePool }}',
'{{ deploymentResourcePoolId }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: deploymentResourcePool
      value:
        - name: satisfiesPzi
          value: boolean
        - name: satisfiesPzs
          value: boolean
        - name: name
          value: string
        - name: serviceAccount
          value: string
        - name: disableContainerLogging
          value: boolean
        - name: encryptionSpec
          value:
            - name: kmsKeyName
              value: string
        - name: dedicatedResources
          value:
            - name: machineSpec
              value:
                - name: acceleratorCount
                  value: integer
                - name: tpuTopology
                  value: string
                - name: machineType
                  value: string
                - name: acceleratorType
                  value: string
                - name: reservationAffinity
                  value:
                    - name: reservationAffinityType
                      value: string
                    - name: values
                      value:
                        - string
                    - name: key
                      value: string
            - name: autoscalingMetricSpecs
              value:
                - - name: target
                    value: integer
                  - name: metricName
                    value: string
            - name: maxReplicaCount
              value: integer
            - name: minReplicaCount
              value: integer
            - name: spot
              value: boolean
        - name: createTime
          value: string
    - name: deploymentResourcePoolId
      value: string

UPDATE example

Updates a deployment_resource_pools resource.

/*+ update */
UPDATE google.aiplatform.deployment_resource_pools
SET 
name = '{{ name }}',
serviceAccount = '{{ serviceAccount }}',
disableContainerLogging = true|false,
encryptionSpec = '{{ encryptionSpec }}',
dedicatedResources = '{{ dedicatedResources }}'
WHERE 
deploymentResourcePoolsId = '{{ deploymentResourcePoolsId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

DELETE example

Deletes the specified deployment_resource_pools resource.

/*+ delete */
DELETE FROM google.aiplatform.deployment_resource_pools
WHERE deploymentResourcePoolsId = '{{ deploymentResourcePoolsId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';