csps

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

Overview

Name	csps
Type	Resource
Id	nvidia.catalog.csps

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Unique name of the Cloud Service Provider
display_name	string	Display name of the Cloud Service Provider (wire: displayName)
attributes	array
created_date	string	Creation date in ISO-8601 format (pattern: <code>\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d.\d+Z</code>) (wire: createdDate)
description	string	Description of the Cloud Service Provider
is_deployable	boolean	Determines if this Cloud Service Provider can be used to deploy artifacts (wire: isDeployable)
is_enabled	boolean	Determines if this Cloud Service Provider is enabled (wire: isEnabled)
labels	array
logo	string	URL for the logo image
updated_date	string	Updated date in ISO-8601 format (pattern: <code>\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d.\d+Z</code>) (wire: updatedDate)

list

Name	Datatype	Description
name	string	Unique name of the Cloud Service Provider
display_name	string	Display name of the Cloud Service Provider (wire: displayName)
attributes	array
created_date	string	Creation date in ISO-8601 format (pattern: <code>\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d.\d+Z</code>) (wire: createdDate)
description	string	Description of the Cloud Service Provider
is_deployable	boolean	Determines if this Cloud Service Provider can be used to deploy artifacts (wire: isDeployable)
is_enabled	boolean	Determines if this Cloud Service Provider is enabled (wire: isEnabled)
labels	array
logo	string	URL for the logo image
updated_date	string	Updated date in ISO-8601 format (pattern: <code>\d{4}-[01]\d-[0-3]\dT[0-2]\d:[0-5]\d:[0-5]\d.\d+Z</code>) (wire: updatedDate)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	csp_name		Get cloud service provider details
list	select		page_size, page_number, include_disabled	List cloud service providers
create	insert	name		Create cloud service provider
update	update	csp_name		Update cloud service provider
delete	delete	csp_name		Delete cloud service provider

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
csp_name	string (UTF-8)	Cloud service provider name
include_disabled	boolean	Include disabled
page_number	integer	Page number - zero based index
page_size	integer	Page size

SELECT examples

get

Get cloud service provider details

SELECT
name,
display_name,
attributes,
created_date,
description,
is_deployable,
is_enabled,
labels,
logo,
updated_date
FROM nvidia.catalog.csps
WHERE csp_name = '{{ csp_name }}' -- required
;

list

List cloud service providers

SELECT
name,
display_name,
attributes,
created_date,
description,
is_deployable,
is_enabled,
labels,
logo,
updated_date
FROM nvidia.catalog.csps
WHERE page_size = '{{ page_size }}'
AND page_number = '{{ page_number }}'
AND include_disabled = '{{ include_disabled }}'
;

INSERT examples

create

Create cloud service provider

INSERT INTO nvidia.catalog.csps (
attributes,
description,
display_name,
is_enabled,
labels,
logo,
name
)
SELECT 
'{{ attributes }}',
'{{ description }}',
'{{ display_name }}',
{{ is_enabled }},
'{{ labels }}',
'{{ logo }}',
'{{ name }}' /* required */
RETURNING
name,
display_name,
attributes,
created_date,
description,
is_deployable,
is_enabled,
labels,
logo,
updated_date
;

Manifest

# Description fields are for documentation purposes
- name: csps
props:
  - name: attributes
    value:
      - key: "{{ key }}"
        value: "{{ value }}"
  - name: description
    value: "{{ description }}"
    description: |
      Description of the Cloud Service Provider
  - name: display_name
    value: "{{ display_name }}"
    description: |
      Display name of the Cloud Service Provider
  - name: is_enabled
    value: {{ is_enabled }}
    description: |
      Determines if this Cloud Service Provider is enabled
  - name: labels
    value:
      - "{{ labels }}"
  - name: logo
    value: "{{ logo }}"
    description: |
      URL for the logo image
  - name: name
    value: "{{ name }}"
    description: |
      Unique name of the Cloud Service Provider

UPDATE examples

update

Update cloud service provider

UPDATE nvidia.catalog.csps
SET 
attributes = '{{ attributes }}',
description = '{{ description }}',
display_name = '{{ display_name }}',
is_enabled = {{ is_enabled }},
labels = '{{ labels }}',
logo = '{{ logo }}'
WHERE 
csp_name = '{{ csp_name }}' --required
RETURNING
name,
display_name,
attributes,
created_date,
description,
is_deployable,
is_enabled,
labels,
logo,
updated_date;

DELETE examples

delete

Delete cloud service provider

DELETE FROM nvidia.catalog.csps
WHERE csp_name = '{{ csp_name }}' --required
;