Class default

SecretsManagerAPI is the implementation for the SecretsManager facade.

Hierarchy

default

Implements

Facade

Constructors

constructor

new default(transport: Transport, info: ConnectionInfo): default
Parameters
- transport: Transport
- info: ConnectionInfo
Returns default
- Defined in api/facades/secrets-manager/SecretsManagerV1.ts:241

Properties

NAME

NAME: string = "SecretsManager"

VERSION

VERSION: number = 1

_info

_info: ConnectionInfo

_transport

_transport: Transport

`Static` NAME

NAME: string = "SecretsManager"

`Static` VERSION

VERSION: number = 1

Methods

createSecretURIs

createSecretURIs(params: CreateSecretURIsArg): Promise<StringResults>
CreateSecretURIs creates new secret URIs.
Parameters
- params: CreateSecretURIsArg
Returns Promise<StringResults>
- Defined in api/facades/secrets-manager/SecretsManagerV1.ts:251

createSecrets

createSecrets(params: CreateSecretArgs): Promise<StringResults>
CreateSecrets creates new secrets.
Parameters
- params: CreateSecretArgs
Returns Promise<StringResults>
- Defined in api/facades/secrets-manager/SecretsManagerV1.ts:267

getConsumerSecretsRevisionInfo

getConsumerSecretsRevisionInfo(params: GetSecretConsumerInfoArgs): Promise<SecretConsumerInfoResults>
GetConsumerSecretsRevisionInfo returns the latest secret revisions for the specified secrets.
Parameters
- params: GetSecretConsumerInfoArgs
Returns Promise<SecretConsumerInfoResults>
- Defined in api/facades/secrets-manager/SecretsManagerV1.ts:283

getSecretContentInfo

getSecretContentInfo(params: GetSecretContentArgs): Promise<SecretContentResults>
GetSecretContentInfo returns the secret values for the specified secrets.
Parameters
- params: GetSecretContentArgs
Returns Promise<SecretContentResults>
- Defined in api/facades/secrets-manager/SecretsManagerV1.ts:301

getSecretMetadata

getSecretMetadata(params: any): Promise<ListSecretResults>
GetSecretMetadata returns metadata for the caller's secrets.
Parameters
- params: any
Returns Promise<ListSecretResults>
- Defined in api/facades/secrets-manager/SecretsManagerV1.ts:319

getSecretStoreConfig

getSecretStoreConfig(params: any): Promise<SecretStoreConfig>
GetSecretStoreConfig gets the config needed to create a client to the model's secret store.
Parameters
- params: any
Returns Promise<SecretStoreConfig>
- Defined in api/facades/secrets-manager/SecretsManagerV1.ts:335

removeSecrets

removeSecrets(params: DeleteSecretArgs): Promise<ErrorResults>
RemoveSecrets removes the specified secrets.
Parameters
- params: DeleteSecretArgs
Returns Promise<ErrorResults>
- Defined in api/facades/secrets-manager/SecretsManagerV1.ts:351

secretsGrant

secretsGrant(params: GrantRevokeSecretArgs): Promise<ErrorResults>
SecretsGrant grants access to a secret for the specified subjects.
Parameters
- params: GrantRevokeSecretArgs
Returns Promise<ErrorResults>
- Defined in api/facades/secrets-manager/SecretsManagerV1.ts:367

secretsRevoke

secretsRevoke(params: GrantRevokeSecretArgs): Promise<ErrorResults>
SecretsRevoke revokes access to a secret for the specified subjects.
Parameters
- params: GrantRevokeSecretArgs
Returns Promise<ErrorResults>
- Defined in api/facades/secrets-manager/SecretsManagerV1.ts:383

secretsRotated

secretsRotated(params: SecretRotatedArgs): Promise<ErrorResults>
SecretsRotated records when secrets were last rotated.
Parameters
- params: SecretRotatedArgs
Returns Promise<ErrorResults>
- Defined in api/facades/secrets-manager/SecretsManagerV1.ts:399

updateSecrets

updateSecrets(params: UpdateSecretArgs): Promise<ErrorResults>
UpdateSecrets updates the specified secrets.
Parameters
- params: UpdateSecretArgs
Returns Promise<ErrorResults>
- Defined in api/facades/secrets-manager/SecretsManagerV1.ts:415

watchConsumedSecretsChanges

watchConsumedSecretsChanges(params: Entities): Promise<StringsWatchResults>
WatchConsumedSecretsChanges sets up a watcher to notify of changes to secret revisions for the specified consumers.
Parameters
- params: Entities
Returns Promise<StringsWatchResults>
- Defined in api/facades/secrets-manager/SecretsManagerV1.ts:431

watchObsolete

watchObsolete(params: Entities): Promise<StringsWatchResult>
WatchObsolete returns a watcher for notifying when:
- a secret owned by the entity is deleted
- a secret revision owed by the entity no longer has any consumers
Obsolete revisions results are "uri/revno" and deleted secret results are "uri".
Parameters
- params: Entities
Returns Promise<StringsWatchResult>
- Defined in api/facades/secrets-manager/SecretsManagerV1.ts:453

watchSecretRevisionsExpiryChanges

watchSecretRevisionsExpiryChanges(params: Entities): Promise<SecretTriggerWatchResult>
WatchSecretRevisionsExpiryChanges sets up a watcher to notify of changes to secret revision expiry config.
Parameters
- params: Entities
Returns Promise<SecretTriggerWatchResult>
- Defined in api/facades/secrets-manager/SecretsManagerV1.ts:469

watchSecretsRotationChanges

watchSecretsRotationChanges(params: Entities): Promise<SecretTriggerWatchResult>
WatchSecretsRotationChanges sets up a watcher to notify of changes to secret rotation config.
Parameters
- params: Entities
Returns Promise<SecretTriggerWatchResult>
- Defined in api/facades/secrets-manager/SecretsManagerV1.ts:487

Generated using TypeDoc