byoc_infrastructures

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

Overview

Name	byoc_infrastructures
Type	Resource
Id	clickhouse.organizations.byoc_infrastructures

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
create	insert	organization_id		Create a new BYOC Infrastructure in the organization. Returns the configuration of the newly created infrastructure
update	update	byoc_infrastructure_id, organization_id		Update configuration of the BYOC infrastructure. Returns the modified infrastructure
delete	delete	byoc_infrastructure_id, organization_id		Removes a BYOC Infrastructure from the organization

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
byoc_infrastructure_id	string (uuid)	ID of the requested BYOC Infrastructure (wire: byocInfrastructureId)
organization_id	string	ClickHouse Cloud organization ID. Resolved from the CLICKHOUSE_ORG_ID environment variable when it is set (x-stackQL-envVar); otherwise it must be supplied on every query as WHERE organization_id = <uuid>. A WHERE value always takes precedence over the environment. (x-stackQL-envVar: CLICKHOUSE_ORG_ID)

INSERT examples

create

Create a new BYOC Infrastructure in the organization. Returns the configuration of the newly created infrastructure

INSERT INTO clickhouse.organizations.byoc_infrastructures (
region_id,
account_id,
availability_zone_suffixes,
vpc_cidr_range,
display_name,
organization_id
)
SELECT 
'{{ region_id }}',
'{{ account_id }}',
'{{ availability_zone_suffixes }}',
'{{ vpc_cidr_range }}',
'{{ display_name }}',
'{{ organization_id }}'
RETURNING
request_id,
result,
status
;

Manifest

# Description fields are for documentation purposes
- name: byoc_infrastructures
props:
  - name: organization_id
    value: "{{ organization_id }}"
    description: Required parameter for the byoc_infrastructures resource.
  - name: region_id
    value: "{{ region_id }}"
    description: |
      Region in which the BYOC infrastructure will be located
    valid_values: ['ap-northeast-1', 'ap-northeast-2', 'ap-south-1', 'ap-southeast-1', 'ap-southeast-2', 'ca-central-1', 'eu-central-1', 'eu-west-1', 'eu-west-2', 'il-central-1', 'us-east-1', 'us-east-2', 'us-west-2', 'us-east1', 'us-central1', 'europe-west2', 'europe-west4', 'asia-southeast1', 'asia-northeast1', 'eastus', 'eastus2', 'westus3', 'germanywestcentral', 'centralus']
  - name: account_id
    value: "{{ account_id }}"
    description: |
      Cloud account ID the BYOC infrastructure is configured for
  - name: availability_zone_suffixes
    value:
      - "{{ availability_zone_suffixes }}"
    description: |
      List of availability zone suffixes
  - name: vpc_cidr_range
    value: "{{ vpc_cidr_range }}"
    description: |
      CIDR range for VPC
  - name: display_name
    value: "{{ display_name }}"
    description: |
      Human readable name for infrastructure

UPDATE examples

update

Update configuration of the BYOC infrastructure. Returns the modified infrastructure

UPDATE clickhouse.organizations.byoc_infrastructures
SET 
display_name = '{{ display_name }}'
WHERE 
byoc_infrastructure_id = '{{ byoc_infrastructure_id }}' --required
AND organization_id = '{{ organization_id }}' --required unless CLICKHOUSE_ORG_ID is set
RETURNING
request_id,
result,
status;

DELETE examples

delete

Removes a BYOC Infrastructure from the organization

DELETE FROM clickhouse.organizations.byoc_infrastructures
WHERE byoc_infrastructure_id = '{{ byoc_infrastructure_id }}' --required
AND organization_id = '{{ organization_id }}' --required unless CLICKHOUSE_ORG_ID is set
;