Interface Secret

interface Secret {
    createdAt?: Date;
    description?: string;
    ephemeralPolicy?: Secret.v1beta1.EphemeralPolicy;
    id: string;
    managed: boolean;
    name: string;
    path: string;
    projectId: string;
    protected: boolean;
    region: Region;
    status: Secret.v1beta1.SecretStatus;
    tags: string[];
    type: Secret.v1beta1.SecretType;
    updatedAt?: Date;
    usedBy: Secret.v1beta1.Product[];
    versionCount: number;
}

Properties

createdAt? description? ephemeralPolicy? id managed name path projectId protected region status tags type updatedAt? usedBy versionCount

Properties

OptionalcreatedAt

createdAt?: Date

Date and time of the secret's creation.

Optionaldescription

description?: string

Updated description of the secret.

OptionalephemeralPolicy

ephemeralPolicy?: Secret.v1beta1.EphemeralPolicy

(Optional.) Policy that defines whether/when a secret's versions expire. By default, the policy is applied to all the secret's versions.

id

id: string

ID of the secret.

managed

managed: boolean

Returns true for secrets that are managed by another product.

name

name: string

Name of the secret.

path

path: string

Location of the secret in the directory structure.

projectId

projectId: string

ID of the Project containing the secret.

protected

protected: boolean

Returns true for protected secrets that cannot be deleted.

region

region: Region

Region of the secret.

status

status: Secret.v1beta1.SecretStatus
  • ready: the secret can be read, modified and deleted. locked: no action can be performed on the secret. This status can only be applied and removed by Scaleway.

tags

tags: string[]

List of the secret's tags.

type

type: Secret.v1beta1.SecretType

See the Secret.Type enum for a description of values.

OptionalupdatedAt

updatedAt?: Date

Last update of the secret.

usedBy

usedBy: Secret.v1beta1.Product[]

List of Scaleway resources that can access and manage the secret.

versionCount

versionCount: number

Number of versions for this secret.

Settings

On This Page

Properties