Skip to main content
Version: 7 - Gugelhupf

VaultConfig

class resources.vault_config.VaultConfig

Base class: Resource

A configuration about a HashiCorp Vault which Cloudomation can access to fetch secrets.

Either a vault token or the AppRoles authentification method can be used.

See the corresponding Flow Api class at VaultConfig

PropertyDescriptionTypeImport/Export
approle_pathPath for AppRole authentification method (final path for this authentification method will be "/auth/[approle_path]" and must be the same path where you enabled this method on your Vault)String(length=1024)both
bundle_idReference to the bundle this record is associated with. Allowed for CONNECTOR, FILE, FLOW, PLUGIN, ROLE, SCHEDULER, SCHEMA, SETTING, TAG, WRAPPER. Not allowed for BUNDLE, BUNDLE_REPOSITORY, EXECUTION, GIT_CONFIG, MESSAGE, OAUTH, ORGANIZATION, PROCESS, PROJECT, SCHEDULE, SYNC_CONFIG, USER, VAULT_CONFIG, WEBHOOK, WORKSPACE. Mutually exclusive with project_idUUID()both
cacertString(length=40960)both
created_atDateTime(timezone=True)export only
created_byUUID()export only
deleted_atDateTime(timezone=True)export only
deleted_byUUID()export only
descriptionText()both
engine_pathString(length=1024)both
has_tokenBoolean()neither
idUUID()neither
is_archivedBoolean()both
is_auto_renew_enabledBoolean()both
is_bundle_readonlyBoolean()neither
is_enabledBoolean()both
is_project_readonlyBoolean()neither
is_readonlyA flag to control if the record can be modified. Allowed for BUNDLE, BUNDLE_REPOSITORY, CONNECTOR, FILE, FLOW, GIT_CONFIG, OAUTH, PLUGIN, PROJECT, ROLE, SCHEDULE, SCHEDULER, SCHEMA, SETTING, SYNC_CONFIG, TAG, VAULT_CONFIG, WEBHOOK, WRAPPER. Not allowed for EXECUTION, MESSAGE, ORGANIZATION, PROCESS, USER, WORKSPACEBoolean()both
modified_atDateTime(timezone=True)export only
modified_byUUID()export only
nameString(length=128)both
organization_idUUID()export only
project_idReference to the project this record is associated with. Allowed for CONNECTOR, EXECUTION, FILE, FLOW, GIT_CONFIG, MESSAGE, OAUTH, PLUGIN, SCHEDULE, SCHEDULER, SCHEMA, SETTING, SYNC_CONFIG, TAG, VAULT_CONFIG, WEBHOOK, WRAPPER. Not allowed for BUNDLE, BUNDLE_REPOSITORY, ORGANIZATION, PROCESS, PROJECT, ROLE, USER, WORKSPACE. Mutually exclusive with bundle_id.UUID()both
record_typeEnum('BUNDLE', 'BUNDLE_REPOSITORY', 'CONNECTOR', 'EXECUTION', 'FILE', 'FLOW', 'GIT_CONFIG', 'MESSAGE', 'OAUTH', 'ORGANIZATION', 'PLUGIN', 'PROCESS', 'PROJECT', 'ROLE', 'SCHEDULE', 'SCHEDULER', 'SCHEMA', 'SETTING', 'SYNC_CONFIG', 'TAG', 'USER', 'VAULT_CONFIG', 'WEBHOOK', 'WORKSPACE', 'WRAPPER', name='recordtype')neither
resource_typeEnum('BUNDLE', 'BUNDLE_REPOSITORY', 'CONNECTOR', 'FILE', 'FLOW', 'GIT_CONFIG', 'OAUTH', 'ORGANIZATION', 'PLUGIN', 'PROJECT', 'ROLE', 'SCHEDULE', 'SCHEDULER', 'SCHEMA', 'SETTING', 'SYNC_CONFIG', 'TAG', 'USER', 'VAULT_CONFIG', 'WEBHOOK', 'WORKSPACE', 'WRAPPER', name='resourcetype')neither
runner_role_idFor AppRole authentification: RoleID for the runner.String(length=1024)import only
runner_role_nameFor AppRole authentification: name of a role used by a runner, with permission to retrieve secrets from vault.String(length=1024)import only
schema_versionString(length=128)neither
tokenString(length=1024)import only
vault_urlString(length=1024)both
worker_role_idFor AppRole authentification: RoleID of worker. Associated with a role with permission to request wrapped SecretIDs.String(length=1024)import only
worker_secret_idFor AppRole authentification: SecretID of worker.String(length=1024)import only
workspace_idUUID()export only