bucket_exports

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

Overview

Name	bucket_exports
Type	Resource
Id	ovh.finops.bucket_exports

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string	Unique identifier of the billing account
checksum	string	Checksum of the Bucket Export Configuration
current_state	object	Current state of the billing account (wire: currentState)
current_tasks	array	Task to do on this billing account (wire: currentTasks)
resource_status	string	Billing account readiness in the system (CREATING, CREATION_PLANNED, DELETING, ERROR, OUT_OF_SYNC, READY, SUSPENDED, UNKNOWN, UPDATING) (wire: resourceStatus)
target_spec	object	Target Spec for the FinOps Bucket Export Configuration (wire: targetSpec)

list

Bucket Export Configuration

Name	Datatype	Description
id	string	Unique identifier of the billing account
checksum	string	Checksum of the Bucket Export Configuration
current_state	object	Current state of the billing account (wire: currentState)
current_tasks	array	Task to do on this billing account (wire: currentTasks)
resource_status	string	Billing account readiness in the system (CREATING, CREATION_PLANNED, DELETING, ERROR, OUT_OF_SYNC, READY, SUSPENDED, UNKNOWN, UPDATING) (wire: resourceStatus)
target_spec	object	Target Spec for the FinOps Bucket Export Configuration (wire: targetSpec)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	id		<sup>*</sup> S3 is a trademark filed by Amazon Technologies,Inc. OVHcloud's service is not sponsored by, endorsed by, or otherwise affiliated with Amazon Technologies,Inc. (Beta version)
list	select		x_pagination_cursor, x_pagination_size	<sup>*</sup> S3 is a trademark filed by Amazon Technologies,Inc. OVHcloud's service is not sponsored by, endorsed by, or otherwise affiliated with Amazon Technologies,Inc. (Beta version)
create	insert	target_spec		<sup>*</sup> S3 is a trademark filed by Amazon Technologies,Inc. OVHcloud's service is not sponsored by, endorsed by, or otherwise affiliated with Amazon Technologies,Inc. (Beta version)
update	update	id		<sup>*</sup> S3 is a trademark filed by Amazon Technologies,Inc. OVHcloud's service is not sponsored by, endorsed by, or otherwise affiliated with Amazon Technologies,Inc. (Beta version)
delete	delete	id		<sup>*</sup> S3 is a trademark filed by Amazon Technologies,Inc. OVHcloud's service is not sponsored by, endorsed by, or otherwise affiliated with Amazon Technologies,Inc. (Beta version)

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
api_host	string	The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}})
id	string	Id
x_pagination_cursor	string	Pagination cursor (wire: X-Pagination-Cursor)
x_pagination_size	integer	Pagination size (wire: X-Pagination-Size)

SELECT examples

get

^* S3 is a trademark filed by Amazon Technologies,Inc. OVHcloud's service is not sponsored by, endorsed by, or otherwise affiliated with Amazon Technologies,Inc. (Beta version)

SELECT
id,
checksum,
current_state,
current_tasks,
resource_status,
target_spec
FROM ovh.finops.bucket_exports
WHERE id = '{{ id }}' -- required
;

list

^* S3 is a trademark filed by Amazon Technologies,Inc. OVHcloud's service is not sponsored by, endorsed by, or otherwise affiliated with Amazon Technologies,Inc. (Beta version)

SELECT
id,
checksum,
current_state,
current_tasks,
resource_status,
target_spec
FROM ovh.finops.bucket_exports
WHERE x_pagination_cursor = '{{ x_pagination_cursor }}'
AND x_pagination_size = '{{ x_pagination_size }}'
;

INSERT examples

create

^* S3 is a trademark filed by Amazon Technologies,Inc. OVHcloud's service is not sponsored by, endorsed by, or otherwise affiliated with Amazon Technologies,Inc. (Beta version)

INSERT INTO ovh.finops.bucket_exports (
target_spec
)
SELECT 
'{{ target_spec }}' /* required */
RETURNING
id,
checksum,
current_state,
current_tasks,
resource_status,
target_spec
;

Manifest

# Description fields are for documentation purposes
- name: bucket_exports
props:
  - name: target_spec
    description: |
      Target Spec for the bucket export configuration
    value:
      bucketConfiguration:
        accessKey: "{{ accessKey }}"
        bucketName: "{{ bucketName }}"
        endpointURL: "{{ endpointURL }}"
        pathPrefix: "{{ pathPrefix }}"
        region: "{{ region }}"
        secretKey: "{{ secretKey }}"
      exportHour: {{ exportHour }}
      filePolicy: "{{ filePolicy }}"
      period: "{{ period }}"
      scope: "{{ scope }}"

UPDATE examples

update

^* S3 is a trademark filed by Amazon Technologies,Inc. OVHcloud's service is not sponsored by, endorsed by, or otherwise affiliated with Amazon Technologies,Inc. (Beta version)

UPDATE ovh.finops.bucket_exports
SET 
checksum = '{{ checksum }}',
target_spec = '{{ target_spec }}'
WHERE 
id = '{{ id }}' --required
RETURNING
id,
checksum,
current_state,
current_tasks,
resource_status,
target_spec;

DELETE examples

delete

^* S3 is a trademark filed by Amazon Technologies,Inc. OVHcloud's service is not sponsored by, endorsed by, or otherwise affiliated with Amazon Technologies,Inc. (Beta version)

DELETE FROM ovh.finops.bucket_exports
WHERE id = '{{ id }}' --required
;