Skip to main content
Version: 3.0.0

AWS Secrets Manager Vault

Retrieve secrets from AWS Secrets Manager.

Examples​

vault:
aws_secrets_manager:
region: us-west-2
secret_name_prefix: my-secret-prefix

AwsSecretsManagerVault​

info

AwsSecretsManagerVault is defined beneath the following ancestor nodes in the YAML structure:

Below are the properties for the AwsSecretsManagerVault. Each property links to the specific details section further down in this page.

PropertyDefaultTypeRequiredDescription
descriptionstring
NoA brief description of what the model does.
metadataNoMeta information of a resource. In most cases it doesn't affect the system behavior but may be helpful to analyze project resources.
namestringYesThe name of the model
aws_secrets_managerNo

Property Details​

Vault​

A way of storing secrets for use in your project and associating it with the desired service account

PropertyDefaultTypeRequiredDescription
vaultOne of:
  LocalFileVault
  GcpSecretManagerVault
  AwsSecretsManagerVault
  AzureKeyVault
  AscendEnvironmentVault
Yes

AwsSecretsManagerVaultOptions​

Options for reading secrets from AWS Secrets Manager.

PropertyDefaultTypeRequiredDescription
regionstring
NoThe AWS region that contains secrets managed by Secrets Manager.
authNoAWS authentication options.
secret_name_prefixstring
NoA prefix that is added to all secret names referenced in this vault.

AwsAuthOptions​

Options for authenticating with AWS.

PropertyDefaultTypeRequiredDescription
role_arnstring
NoRole ARN to assume when reading from S3.

ResourceMetadata​

Meta information of a resource. In most cases it doesn't affect the system behavior but may be helpful to analyze project resources.

PropertyDefaultTypeRequiredDescription
sourceNoThe origin or source information for the resource.
source_event_uuidstring
NoUUID of the event that is associated with creation of this resource.

ResourceLocation​

The origin or source information for the resource.

PropertyDefaultTypeRequiredDescription
pathstringYesPath within repository files where the resource is defined.
first_line_numberinteger
NoFirst line number within path file where the resource is defined.