secretbundles
Creates, updates, deletes, gets or lists a secretbundles resource.
Overview​
| Name | secretbundles |
| Type | Resource |
| Id | oci.secrets.secretbundles |
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 |
|---|---|---|---|---|
get_secret_bundle_by_name | exec | secretName, vaultId, region | opc-request-id, versionNumber, secretVersionName, stage | Gets a secret bundle by secret name and vault ID, and secret version that matches either the specified stage, secretVersionName, or versionNumber parameter.<br />If none of these parameters are provided, the bundle for the secret version marked as CURRENT is returned.<br /> |
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 |
|---|---|---|
region | string | OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION) |
secretName | string | A user-friendly name for the secret. Secret names are unique within a vault. Secret names are case-sensitive. |
vaultId | string | The OCID of the vault that contains the secret. |
opc-request-id | string | Unique identifier for the request. |
secretVersionName | string | The name of the secret. (This might be referred to as the name of the secret version. Names are unique across the different versions of a secret.) |
stage | string | The rotation state of the secret version. |
versionNumber | integer (int64) | The version number of the secret. |
Lifecycle Methods​
- get_secret_bundle_by_name
Gets a secret bundle by secret name and vault ID, and secret version that matches either the specified stage, secretVersionName, or versionNumber parameter.<br />If none of these parameters are provided, the bundle for the secret version marked as CURRENT is returned.<br />
EXEC oci.secrets.secretbundles.get_secret_bundle_by_name
@secretName='{{ secretName }}' --required,
@vaultId='{{ vaultId }}' --required,
@region='{{ region }}' --required,
@opc-request-id='{{ opc-request-id }}',
@versionNumber='{{ versionNumber }}',
@secretVersionName='{{ secretVersionName }}',
@stage='{{ stage }}'
;