bucket_s3_credentials

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

Overview

Name	bucket_s3_credentials
Type	Resource
Id	railway.storage.bucket_s3_credentials

Fields

The following fields are returned by SELECT queries:

list

One row per BucketS3CompatibleCredentials.

Name	Datatype	Description
access_key_id	string
bucket_name	string
created_at	string (date-time)
endpoint	string
region	string
secret_access_key	string
url_style	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	bucket_id, environment_id, project_id		Get the S3-compatible credentials for a bucket. Backed by the Railway GraphQL query bucketS3Credentials.
reset	exec	bucket_id, environment_id, project_id	redeploy_dependents	Reset the credentials for a bucket in an environment. Backed by the Railway GraphQL mutation bucketCredentialsReset.

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
bucket_id	string
environment_id	string
project_id	string
redeploy_dependents	string	Boolean passed as a string, for example 'true'.

SELECT examples

list

Get the S3-compatible credentials for a bucket. Backed by the Railway GraphQL query bucketS3Credentials.

SELECT
access_key_id,
bucket_name,
created_at,
endpoint,
region,
secret_access_key,
url_style
FROM railway.storage.bucket_s3_credentials
WHERE bucket_id = '{{ bucket_id }}' -- required
AND environment_id = '{{ environment_id }}' -- required
AND project_id = '{{ project_id }}' -- required
;

Lifecycle Methods

reset

Reset the credentials for a bucket in an environment. Backed by the Railway GraphQL mutation bucketCredentialsReset.

EXEC railway.storage.bucket_s3_credentials.reset 
@bucket_id='{{ bucket_id }}', --required
@environment_id='{{ environment_id }}', --required
@project_id='{{ project_id }}', --required
@redeploy_dependents='{{ redeploy_dependents }}'
;