Documentation
¶
Overview ¶
Package secretapi provides interfaces for AWS Secrets Manager.
Index ¶
- Constants
- Variables
- type Client
- type CreateSecretAPI
- type CreateSecretInput
- type CreateSecretOutput
- type DeleteSecretAPI
- type DeleteSecretInput
- type DeleteSecretOutput
- type DescribeSecretAPI
- type DescribeSecretInput
- type DescribeSecretOutput
- type Filter
- type FilterNameStringType
- type GetSecretValueAPI
- type GetSecretValueInput
- type GetSecretValueOutput
- type ListSecretVersionIDsAPI
- type ListSecretVersionIDsInput
- type ListSecretVersionIDsOutput
- type ListSecretsAPI
- type ListSecretsInput
- type ListSecretsOutput
- type Options
- type PutSecretValueAPI
- type PutSecretValueInput
- type PutSecretValueOutput
- type ResourceNotFoundException
- type RestoreSecretAPI
- type RestoreSecretInput
- type RestoreSecretOutput
- type SecretListEntry
- type SecretVersionsListEntry
- type Tag
- type TagResourceAPI
- type TagResourceInput
- type TagResourceOutput
- type UntagResourceAPI
- type UntagResourceInput
- type UntagResourceOutput
- type UpdateSecretAPI
- type UpdateSecretInput
- type UpdateSecretOutput
Constants ¶
const (
FilterNameStringTypeName = types.FilterNameStringTypeName
)
Re-exported Secrets Manager constants.
Variables ¶
var NewFromConfig = secretsmanager.NewFromConfig
NewFromConfig is a re-exported Secrets Manager factory function for dependency injection.
var NewListSecretsPaginator = secretsmanager.NewListSecretsPaginator
NewListSecretsPaginator is a re-exported Secrets Manager factory function for dependency injection.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client = secretsmanager.Client
Client is a re-exported Secrets Manager client type for dependency injection.
type CreateSecretAPI ¶
type CreateSecretAPI interface {
CreateSecret(ctx context.Context, params *CreateSecretInput, optFns ...func(*Options)) (*CreateSecretOutput, error)
}
CreateSecretAPI is the interface for creating a secret.
type CreateSecretInput ¶
type CreateSecretInput = secretsmanager.CreateSecretInput
CreateSecretInput is a re-exported Secrets Manager input type.
type CreateSecretOutput ¶
type CreateSecretOutput = secretsmanager.CreateSecretOutput
CreateSecretOutput is a re-exported Secrets Manager output type.
type DeleteSecretAPI ¶
type DeleteSecretAPI interface {
DeleteSecret(ctx context.Context, params *DeleteSecretInput, optFns ...func(*Options)) (*DeleteSecretOutput, error)
}
DeleteSecretAPI is the interface for deleting a secret.
type DeleteSecretInput ¶
type DeleteSecretInput = secretsmanager.DeleteSecretInput
DeleteSecretInput is a re-exported Secrets Manager input type.
type DeleteSecretOutput ¶
type DeleteSecretOutput = secretsmanager.DeleteSecretOutput
DeleteSecretOutput is a re-exported Secrets Manager output type.
type DescribeSecretAPI ¶ added in v0.2.0
type DescribeSecretAPI interface {
DescribeSecret(ctx context.Context, params *DescribeSecretInput, optFns ...func(*Options)) (*DescribeSecretOutput, error)
}
DescribeSecretAPI is the interface for getting secret metadata including tags.
type DescribeSecretInput ¶ added in v0.2.0
type DescribeSecretInput = secretsmanager.DescribeSecretInput
DescribeSecretInput is a re-exported Secrets Manager input type.
type DescribeSecretOutput ¶ added in v0.2.0
type DescribeSecretOutput = secretsmanager.DescribeSecretOutput
DescribeSecretOutput is a re-exported Secrets Manager output type.
type FilterNameStringType ¶
type FilterNameStringType = types.FilterNameStringType
FilterNameStringType is a re-exported Secrets Manager model type.
type GetSecretValueAPI ¶
type GetSecretValueAPI interface {
GetSecretValue(ctx context.Context, params *GetSecretValueInput, optFns ...func(*Options)) (*GetSecretValueOutput, error)
}
GetSecretValueAPI is the interface for getting a secret value.
type GetSecretValueInput ¶
type GetSecretValueInput = secretsmanager.GetSecretValueInput
GetSecretValueInput is a re-exported Secrets Manager input type.
type GetSecretValueOutput ¶
type GetSecretValueOutput = secretsmanager.GetSecretValueOutput
GetSecretValueOutput is a re-exported Secrets Manager output type.
type ListSecretVersionIDsAPI ¶ added in v0.7.0
type ListSecretVersionIDsAPI interface {
ListSecretVersionIds(ctx context.Context, params *ListSecretVersionIDsInput, optFns ...func(*Options)) (*ListSecretVersionIDsOutput, error)
}
ListSecretVersionIDsAPI is the interface for listing secret versions.
type ListSecretVersionIDsInput ¶ added in v0.7.0
type ListSecretVersionIDsInput = secretsmanager.ListSecretVersionIdsInput
ListSecretVersionIDsInput is a re-exported Secrets Manager input type.
type ListSecretVersionIDsOutput ¶ added in v0.7.0
type ListSecretVersionIDsOutput = secretsmanager.ListSecretVersionIdsOutput
ListSecretVersionIDsOutput is a re-exported Secrets Manager output type.
type ListSecretsAPI ¶
type ListSecretsAPI interface {
ListSecrets(ctx context.Context, params *ListSecretsInput, optFns ...func(*Options)) (*ListSecretsOutput, error)
}
ListSecretsAPI is the interface for listing secrets.
type ListSecretsInput ¶
type ListSecretsInput = secretsmanager.ListSecretsInput
ListSecretsInput is a re-exported Secrets Manager input type.
type ListSecretsOutput ¶
type ListSecretsOutput = secretsmanager.ListSecretsOutput
ListSecretsOutput is a re-exported Secrets Manager output type.
type Options ¶
type Options = secretsmanager.Options
Options is a re-exported Secrets Manager options type.
type PutSecretValueAPI ¶
type PutSecretValueAPI interface {
PutSecretValue(ctx context.Context, params *PutSecretValueInput, optFns ...func(*Options)) (*PutSecretValueOutput, error)
}
PutSecretValueAPI is the interface for updating a secret value.
type PutSecretValueInput ¶
type PutSecretValueInput = secretsmanager.PutSecretValueInput
PutSecretValueInput is a re-exported Secrets Manager input type.
type PutSecretValueOutput ¶
type PutSecretValueOutput = secretsmanager.PutSecretValueOutput
PutSecretValueOutput is a re-exported Secrets Manager output type.
type ResourceNotFoundException ¶
type ResourceNotFoundException = types.ResourceNotFoundException
ResourceNotFoundException is a re-exported Secrets Manager error type.
type RestoreSecretAPI ¶
type RestoreSecretAPI interface {
RestoreSecret(ctx context.Context, params *RestoreSecretInput, optFns ...func(*Options)) (*RestoreSecretOutput, error)
}
RestoreSecretAPI is the interface for restoring a deleted secret.
type RestoreSecretInput ¶
type RestoreSecretInput = secretsmanager.RestoreSecretInput
RestoreSecretInput is a re-exported Secrets Manager input type.
type RestoreSecretOutput ¶
type RestoreSecretOutput = secretsmanager.RestoreSecretOutput
RestoreSecretOutput is a re-exported Secrets Manager output type.
type SecretListEntry ¶
type SecretListEntry = types.SecretListEntry
SecretListEntry is a re-exported Secrets Manager model type.
type SecretVersionsListEntry ¶
type SecretVersionsListEntry = types.SecretVersionsListEntry
SecretVersionsListEntry is a re-exported Secrets Manager model type.
type TagResourceAPI ¶
type TagResourceAPI interface {
TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
}
TagResourceAPI is the interface for tagging a secret.
type TagResourceInput ¶
type TagResourceInput = secretsmanager.TagResourceInput
TagResourceInput is a re-exported Secrets Manager input type.
type TagResourceOutput ¶
type TagResourceOutput = secretsmanager.TagResourceOutput
TagResourceOutput is a re-exported Secrets Manager output type.
type UntagResourceAPI ¶
type UntagResourceAPI interface {
UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
}
UntagResourceAPI is the interface for removing tags from a secret.
type UntagResourceInput ¶
type UntagResourceInput = secretsmanager.UntagResourceInput
UntagResourceInput is a re-exported Secrets Manager input type.
type UntagResourceOutput ¶
type UntagResourceOutput = secretsmanager.UntagResourceOutput
UntagResourceOutput is a re-exported Secrets Manager output type.
type UpdateSecretAPI ¶
type UpdateSecretAPI interface {
UpdateSecret(ctx context.Context, params *UpdateSecretInput, optFns ...func(*Options)) (*UpdateSecretOutput, error)
}
UpdateSecretAPI is the interface for updating secret metadata (description).
type UpdateSecretInput ¶
type UpdateSecretInput = secretsmanager.UpdateSecretInput
UpdateSecretInput is a re-exported Secrets Manager input type.
type UpdateSecretOutput ¶
type UpdateSecretOutput = secretsmanager.UpdateSecretOutput
UpdateSecretOutput is a re-exported Secrets Manager output type.