Documentation
¶
Overview ¶
Package secretsmanager provides the API client, operations, and parameter types for AWS Secrets Manager.
Amazon Web Services Secrets Manager ¶
Amazon Web Services Secrets Manager provides a service to enable you to store, manage, and retrieve, secrets.
This guide provides descriptions of the Secrets Manager API. For more information about using this service, see the Amazon Web Services Secrets Manager User Guide.
API Version ¶
This version of the Secrets Manager API Reference documents the Secrets Manager API version 2017-10-17.
For a list of endpoints, see Amazon Web Services Secrets Manager endpoints.
Support and Feedback for Amazon Web Services Secrets Manager ¶
We welcome your feedback. Send your comments to awssecretsmanager-feedback@amazon.com, or post your feedback and questions in the Amazon Web Services Secrets Manager Discussion Forum. For more information about the Amazon Web Services Discussion Forums, see Forums Help.
Logging API Requests ¶
Amazon Web Services Secrets Manager supports Amazon Web Services CloudTrail, a service that records Amazon Web Services API calls for your Amazon Web Services account and delivers log files to an Amazon S3 bucket. By using information that's collected by Amazon Web Services CloudTrail, you can determine the requests successfully made to Secrets Manager, who made the request, when it was made, and so on. For more about Amazon Web Services Secrets Manager and support for Amazon Web Services CloudTrail, see Logging Amazon Web Services Secrets Manager Events with Amazon Web Services CloudTrailin the Amazon Web Services Secrets Manager User Guide. To learn more about CloudTrail, including enabling it and find your log files, see the Amazon Web Services CloudTrail User Guide.
Index ¶
- Constants
- Variables
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
- func WithEndpointResolver(v EndpointResolver) func(*Options)deprecated
- func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)
- func WithSigV4SigningName(name string) func(*Options)
- func WithSigV4SigningRegion(region string) func(*Options)
- type AssociateCrossAccountReplicaInput
- type AssociateCrossAccountReplicaOutput
- type AuthResolverParameters
- type AuthSchemeResolver
- type BatchGetSecretValueAPIClient
- type BatchGetSecretValueInput
- type BatchGetSecretValueOutput
- type BatchGetSecretValuePaginator
- type BatchGetSecretValuePaginatorOptions
- type CancelRotateSecretInput
- type CancelRotateSecretOutput
- type Client
- func (c *Client) AssociateCrossAccountReplica(ctx context.Context, params *AssociateCrossAccountReplicaInput, ...) (*AssociateCrossAccountReplicaOutput, error)
- func (c *Client) BatchGetSecretValue(ctx context.Context, params *BatchGetSecretValueInput, ...) (*BatchGetSecretValueOutput, error)
- func (c *Client) CancelRotateSecret(ctx context.Context, params *CancelRotateSecretInput, optFns ...func(*Options)) (*CancelRotateSecretOutput, error)
- func (c *Client) CreateSecret(ctx context.Context, params *CreateSecretInput, optFns ...func(*Options)) (*CreateSecretOutput, error)
- func (c *Client) DeleteResourcePolicy(ctx context.Context, params *DeleteResourcePolicyInput, ...) (*DeleteResourcePolicyOutput, error)
- func (c *Client) DeleteSecret(ctx context.Context, params *DeleteSecretInput, optFns ...func(*Options)) (*DeleteSecretOutput, error)
- func (c *Client) DescribeSecret(ctx context.Context, params *DescribeSecretInput, optFns ...func(*Options)) (*DescribeSecretOutput, error)
- func (c *Client) DisassociateCrossAccountReplica(ctx context.Context, params *DisassociateCrossAccountReplicaInput, ...) (*DisassociateCrossAccountReplicaOutput, error)
- func (c *Client) GetRandomPassword(ctx context.Context, params *GetRandomPasswordInput, optFns ...func(*Options)) (*GetRandomPasswordOutput, error)
- func (c *Client) GetResourcePolicy(ctx context.Context, params *GetResourcePolicyInput, optFns ...func(*Options)) (*GetResourcePolicyOutput, error)
- func (c *Client) GetSecretValue(ctx context.Context, params *GetSecretValueInput, optFns ...func(*Options)) (*GetSecretValueOutput, error)
- func (c *Client) ListResourcePolicies(ctx context.Context, params *ListResourcePoliciesInput, ...) (*ListResourcePoliciesOutput, error)
- func (c *Client) ListSecretVersionIds(ctx context.Context, params *ListSecretVersionIdsInput, ...) (*ListSecretVersionIdsOutput, error)
- func (c *Client) ListSecrets(ctx context.Context, params *ListSecretsInput, optFns ...func(*Options)) (*ListSecretsOutput, error)
- func (c *Client) Options() Options
- func (c *Client) PutResourcePolicy(ctx context.Context, params *PutResourcePolicyInput, optFns ...func(*Options)) (*PutResourcePolicyOutput, error)
- func (c *Client) PutSecretValue(ctx context.Context, params *PutSecretValueInput, optFns ...func(*Options)) (*PutSecretValueOutput, error)
- func (c *Client) RemoveRegionsFromReplication(ctx context.Context, params *RemoveRegionsFromReplicationInput, ...) (*RemoveRegionsFromReplicationOutput, error)
- func (c *Client) ReplicateSecretToRegions(ctx context.Context, params *ReplicateSecretToRegionsInput, ...) (*ReplicateSecretToRegionsOutput, error)
- func (c *Client) RestoreSecret(ctx context.Context, params *RestoreSecretInput, optFns ...func(*Options)) (*RestoreSecretOutput, error)
- func (c *Client) RotateSecret(ctx context.Context, params *RotateSecretInput, optFns ...func(*Options)) (*RotateSecretOutput, error)
- func (c *Client) StopReplicationToReplica(ctx context.Context, params *StopReplicationToReplicaInput, ...) (*StopReplicationToReplicaOutput, error)
- func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
- func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
- func (c *Client) UpdateSecret(ctx context.Context, params *UpdateSecretInput, optFns ...func(*Options)) (*UpdateSecretOutput, error)
- func (c *Client) UpdateSecretVersionStage(ctx context.Context, params *UpdateSecretVersionStageInput, ...) (*UpdateSecretVersionStageOutput, error)
- func (c *Client) ValidateResourcePolicy(ctx context.Context, params *ValidateResourcePolicyInput, ...) (*ValidateResourcePolicyOutput, error)
- type CreateSecretInput
- type CreateSecretOutput
- type DeleteResourcePolicyInput
- type DeleteResourcePolicyOutput
- type DeleteSecretInput
- type DeleteSecretOutput
- type DescribeSecretInput
- type DescribeSecretOutput
- type DisassociateCrossAccountReplicaInput
- type DisassociateCrossAccountReplicaOutput
- type EndpointParameters
- type EndpointResolver
- type EndpointResolverFunc
- type EndpointResolverOptions
- type EndpointResolverV2
- type GetRandomPasswordInput
- type GetRandomPasswordOutput
- type GetResourcePolicyInput
- type GetResourcePolicyOutput
- type GetSecretValueInput
- type GetSecretValueOutput
- type HTTPClient
- type HTTPSignerV4
- type IdempotencyTokenProvider
- type ListResourcePoliciesAPIClient
- type ListResourcePoliciesInput
- type ListResourcePoliciesOutput
- type ListResourcePoliciesPaginator
- type ListResourcePoliciesPaginatorOptions
- type ListSecretVersionIdsAPIClient
- type ListSecretVersionIdsInput
- type ListSecretVersionIdsOutput
- type ListSecretVersionIdsPaginator
- type ListSecretVersionIdsPaginatorOptions
- type ListSecretsAPIClient
- type ListSecretsInput
- type ListSecretsOutput
- type ListSecretsPaginator
- type ListSecretsPaginatorOptions
- type Options
- type PutResourcePolicyInput
- type PutResourcePolicyOutput
- type PutSecretValueInput
- type PutSecretValueOutput
- type RemoveRegionsFromReplicationInput
- type RemoveRegionsFromReplicationOutput
- type ReplicateSecretToRegionsInput
- type ReplicateSecretToRegionsOutput
- type ResolveEndpoint
- type RestoreSecretInput
- type RestoreSecretOutput
- type RotateSecretInput
- type RotateSecretOutput
- type StopReplicationToReplicaInput
- type StopReplicationToReplicaOutput
- type TagResourceInput
- type TagResourceOutput
- type UntagResourceInput
- type UntagResourceOutput
- type UpdateSecretInput
- type UpdateSecretOutput
- type UpdateSecretVersionStageInput
- type UpdateSecretVersionStageOutput
- type ValidateResourcePolicyInput
- type ValidateResourcePolicyOutput
Constants ¶
const ServiceAPIVersion = "2017-10-17"
const ServiceID = "Secrets Manager"
Variables ¶
var TypeRegistry = &smithy.TypeRegistry{ Entries: map[string]*smithy.TypeRegistryEntry{ "com.amazonaws.secretsmanager#DecryptionFailure": { Schema: schemas.DecryptionFailure, New: func() any { return &types.DecryptionFailure{} }, }, "com.amazonaws.secretsmanager#EncryptionFailure": { Schema: schemas.EncryptionFailure, New: func() any { return &types.EncryptionFailure{} }, }, "com.amazonaws.secretsmanager#InternalServiceError": { Schema: schemas.InternalServiceError, New: func() any { return &types.InternalServiceError{} }, }, "com.amazonaws.secretsmanager#InvalidNextTokenException": { Schema: schemas.InvalidNextTokenException, New: func() any { return &types.InvalidNextTokenException{} }, }, "com.amazonaws.secretsmanager#InvalidParameterException": { Schema: schemas.InvalidParameterException, New: func() any { return &types.InvalidParameterException{} }, }, "com.amazonaws.secretsmanager#InvalidRequestException": { Schema: schemas.InvalidRequestException, New: func() any { return &types.InvalidRequestException{} }, }, "com.amazonaws.secretsmanager#LimitExceededException": { Schema: schemas.LimitExceededException, New: func() any { return &types.LimitExceededException{} }, }, "com.amazonaws.secretsmanager#MalformedPolicyDocumentException": { Schema: schemas.MalformedPolicyDocumentException, New: func() any { return &types.MalformedPolicyDocumentException{} }, }, "com.amazonaws.secretsmanager#PreconditionNotMetException": { Schema: schemas.PreconditionNotMetException, New: func() any { return &types.PreconditionNotMetException{} }, }, "com.amazonaws.secretsmanager#PublicPolicyException": { Schema: schemas.PublicPolicyException, New: func() any { return &types.PublicPolicyException{} }, }, "com.amazonaws.secretsmanager#ResourceExistsException": { Schema: schemas.ResourceExistsException, New: func() any { return &types.ResourceExistsException{} }, }, "com.amazonaws.secretsmanager#ResourceNotFoundException": { Schema: schemas.ResourceNotFoundException, New: func() any { return &types.ResourceNotFoundException{} }, }, }, }
TypeRegistry is the type registry for this service.
Functions ¶
func NewDefaultEndpointResolver ¶
func NewDefaultEndpointResolver() *internalendpoints.Resolver
NewDefaultEndpointResolver constructs a new service endpoint resolver
func WithAPIOptions ¶ added in v1.0.0
func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
WithAPIOptions returns a functional option for setting the Client's APIOptions option.
func WithEndpointResolver
deprecated
func WithEndpointResolver(v EndpointResolver) func(*Options)
Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.
To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.
func WithEndpointResolverV2 ¶ added in v1.20.0
func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)
WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.
func WithSigV4SigningName ¶ added in v1.23.2
WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.
This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.
func WithSigV4SigningRegion ¶ added in v1.23.2
WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.
This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.
Types ¶
type AssociateCrossAccountReplicaInput ¶ added in v1.51.0
type AssociateCrossAccountReplicaInput struct {
// The ARN of the replica secret in the other Amazon Web Services account. The
// replica secret must be in the same Region and partition as the primary secret.
// Additionally, the replica account owner must have created the replica secret as
// a cross-account replica of the primary secret. For more information see CreateSecret.
//
// This member is required.
CrossAccountReplicaARN *string
// The ARN or name of the primary secret in your account to replicate.
//
// For an ARN, we recommend that you specify a complete ARN rather than a partial
// ARN. See [Finding a secret from a partial ARN].
//
// [Finding a secret from a partial ARN]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
//
// This member is required.
SecretId *string
// Whether the replica account must belong to the same Amazon Web Services
// organization as the primary account:
//
// - SameOrg , which requires the replica account to be in the same organization
// as the primary account. This is the default.
//
// - NoRestriction , which allows the replica account to be in any organization.
ReplicaRestriction types.ReplicaRestrictionType
// The ARN of an IAM role in the primary account that Secrets Manager assumes to
// perform replication. If you don't include this field, Secrets Manager replicates
// using the credentials of caller who updates the primary secret. For more
// information, see [Cross-account replication permissions].
//
// [Cross-account replication permissions]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/cross-account-replicate-permissions.html
ReplicationRoleARN *string
// contains filtered or unexported fields
}
func (*AssociateCrossAccountReplicaInput) Serialize ¶ added in v1.51.0
func (v *AssociateCrossAccountReplicaInput) Serialize(s smithy.ShapeSerializer)
func (*AssociateCrossAccountReplicaInput) SerializeMembers ¶ added in v1.51.0
func (v *AssociateCrossAccountReplicaInput) SerializeMembers(s smithy.ShapeSerializer)
type AssociateCrossAccountReplicaOutput ¶ added in v1.51.0
type AssociateCrossAccountReplicaOutput struct {
// The ARN of the primary secret.
ARN *string
// The ARN of the replica secret in the other account.
CrossAccountReplicaARN *string
// The status of replication to the replica secret. Possible values:
//
// - InSync , which indicates that replication to the replica completed
// successfully and the replica is up to date.
//
// - Failed , which indicates that replication to the replica did not succeed.
//
// - InProgress , which indicates that Secrets Manager is replicating to the
// replica.
//
// - Pending , which indicates that replication has not yet started.
//
// - Detached , which indicates that primary secret is no longer linked to the
// replica secret.
ReplicationStatus types.StatusType
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*AssociateCrossAccountReplicaOutput) Deserialize ¶ added in v1.51.0
func (v *AssociateCrossAccountReplicaOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*AssociateCrossAccountReplicaOutput) Serialize ¶ added in v1.51.0
func (v *AssociateCrossAccountReplicaOutput) Serialize(s smithy.ShapeSerializer)
func (*AssociateCrossAccountReplicaOutput) SerializeMembers ¶ added in v1.51.0
func (v *AssociateCrossAccountReplicaOutput) SerializeMembers(s smithy.ShapeSerializer)
type AuthResolverParameters ¶ added in v1.23.2
type AuthResolverParameters struct {
// The name of the operation being invoked.
Operation string
// The region in which the operation is being invoked.
Region string
}
AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.
type AuthSchemeResolver ¶ added in v1.23.2
type AuthSchemeResolver interface {
ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}
AuthSchemeResolver returns a set of possible authentication options for an operation.
type BatchGetSecretValueAPIClient ¶ added in v1.24.0
type BatchGetSecretValueAPIClient interface {
BatchGetSecretValue(context.Context, *BatchGetSecretValueInput, ...func(*Options)) (*BatchGetSecretValueOutput, error)
}
BatchGetSecretValueAPIClient is a client that implements the BatchGetSecretValue operation.
type BatchGetSecretValueInput ¶ added in v1.24.0
type BatchGetSecretValueInput struct {
// The filters to choose which secrets to retrieve. You must include Filters or
// SecretIdList , but not both.
Filters []types.Filter
// The number of results to include in the response.
//
// If there are more results available, in the response, Secrets Manager includes
// NextToken . To get the next results, call BatchGetSecretValue again with the
// value from NextToken . To use this parameter, you must also use the Filters
// parameter.
MaxResults *int32
// A token that indicates where the output should continue from, if a previous
// call did not show all results. To get the next results, call BatchGetSecretValue
// again with this value.
NextToken *string
// The ARN or names of the secrets to retrieve. You must include Filters or
// SecretIdList , but not both.
SecretIdList []string
// contains filtered or unexported fields
}
func (*BatchGetSecretValueInput) Serialize ¶ added in v1.50.0
func (v *BatchGetSecretValueInput) Serialize(s smithy.ShapeSerializer)
func (*BatchGetSecretValueInput) SerializeMembers ¶ added in v1.50.0
func (v *BatchGetSecretValueInput) SerializeMembers(s smithy.ShapeSerializer)
type BatchGetSecretValueOutput ¶ added in v1.24.0
type BatchGetSecretValueOutput struct {
// A list of errors Secrets Manager encountered while attempting to retrieve
// individual secrets.
Errors []types.APIErrorType
// Secrets Manager includes this value if there's more output available than what
// is included in the current response. This can occur even when the response
// includes no values at all, such as when you ask for a filtered view of a long
// list. To get the next results, call BatchGetSecretValue again with this value.
NextToken *string
// A list of secret values.
SecretValues []types.SecretValueEntry
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*BatchGetSecretValueOutput) Deserialize ¶ added in v1.50.0
func (v *BatchGetSecretValueOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*BatchGetSecretValueOutput) Serialize ¶ added in v1.50.0
func (v *BatchGetSecretValueOutput) Serialize(s smithy.ShapeSerializer)
func (*BatchGetSecretValueOutput) SerializeMembers ¶ added in v1.50.0
func (v *BatchGetSecretValueOutput) SerializeMembers(s smithy.ShapeSerializer)
type BatchGetSecretValuePaginator ¶ added in v1.24.0
type BatchGetSecretValuePaginator struct {
// contains filtered or unexported fields
}
BatchGetSecretValuePaginator is a paginator for BatchGetSecretValue
func NewBatchGetSecretValuePaginator ¶ added in v1.24.0
func NewBatchGetSecretValuePaginator(client BatchGetSecretValueAPIClient, params *BatchGetSecretValueInput, optFns ...func(*BatchGetSecretValuePaginatorOptions)) *BatchGetSecretValuePaginator
NewBatchGetSecretValuePaginator returns a new BatchGetSecretValuePaginator
func (*BatchGetSecretValuePaginator) HasMorePages ¶ added in v1.24.0
func (p *BatchGetSecretValuePaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*BatchGetSecretValuePaginator) NextPage ¶ added in v1.24.0
func (p *BatchGetSecretValuePaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*BatchGetSecretValueOutput, error)
NextPage retrieves the next BatchGetSecretValue page.
type BatchGetSecretValuePaginatorOptions ¶ added in v1.24.0
type BatchGetSecretValuePaginatorOptions struct {
// The number of results to include in the response.
//
// If there are more results available, in the response, Secrets Manager includes
// NextToken . To get the next results, call BatchGetSecretValue again with the
// value from NextToken . To use this parameter, you must also use the Filters
// parameter.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
BatchGetSecretValuePaginatorOptions is the paginator options for BatchGetSecretValue
type CancelRotateSecretInput ¶
type CancelRotateSecretInput struct {
// The ARN or name of the secret.
//
// For an ARN, we recommend that you specify a complete ARN rather than a partial
// ARN. See [Finding a secret from a partial ARN].
//
// [Finding a secret from a partial ARN]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
//
// This member is required.
SecretId *string
// contains filtered or unexported fields
}
func (*CancelRotateSecretInput) Serialize ¶ added in v1.50.0
func (v *CancelRotateSecretInput) Serialize(s smithy.ShapeSerializer)
func (*CancelRotateSecretInput) SerializeMembers ¶ added in v1.50.0
func (v *CancelRotateSecretInput) SerializeMembers(s smithy.ShapeSerializer)
type CancelRotateSecretOutput ¶
type CancelRotateSecretOutput struct {
// The ARN of the secret.
ARN *string
// The name of the secret.
Name *string
// The unique identifier of the version of the secret created during the rotation.
// This version might not be complete, and should be evaluated for possible
// deletion. We recommend that you remove the VersionStage value AWSPENDING from
// this version so that Secrets Manager can delete it. Failing to clean up a
// cancelled rotation can block you from starting future rotations.
VersionId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*CancelRotateSecretOutput) Deserialize ¶ added in v1.50.0
func (v *CancelRotateSecretOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*CancelRotateSecretOutput) Serialize ¶ added in v1.50.0
func (v *CancelRotateSecretOutput) Serialize(s smithy.ShapeSerializer)
func (*CancelRotateSecretOutput) SerializeMembers ¶ added in v1.50.0
func (v *CancelRotateSecretOutput) SerializeMembers(s smithy.ShapeSerializer)
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client provides the API client to make operations call for AWS Secrets Manager.
func New ¶
New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.
func NewFromConfig ¶
NewFromConfig returns a new client from the provided config.
func (*Client) AssociateCrossAccountReplica ¶ added in v1.51.0
func (c *Client) AssociateCrossAccountReplica(ctx context.Context, params *AssociateCrossAccountReplicaInput, optFns ...func(*Options)) (*AssociateCrossAccountReplicaOutput, error)
Links a primary secret in your account to a replica secret in a different Amazon Web Services account and starts replication to this replica. The replica secret must already exist in the other Amazon Web Services account. Create the replica with CreateSecretand set its CrossAccountPrimaryARN field set to this primary secret's ARN. When you call AssociateCrossAccountReplica, Secrets Manager calls AcceptCrossAccountReplication on the replica secret on your behalf.
The primary and replica secrets must be in the same Amazon Web Services Region and partition, and you must call this operation from the account that owns the primary secret. A primary secret can have at most one cross-account replica. This operation is idempotent, so you can call it again for the same replica to repair replication. If the association fails, Secrets Manager does not modify either the primary or replica secret.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:AssociateCrossAccountReplica , secretsmanager:GetSecretValue on the primary secret, and secretsmanager:AcceptCrossAccountReplication on the replica secret. You must also have kms:Decrypt permission for the Key Management Service (KMS) key that encrypts the primary secret, and kms:Encrypt permission for the Amazon Web Services KMS key that encrypts the replica secret. If you supply ReplicationRoleARN , you also need iam:PassRole for that role. For more information, see IAM policy actions for Secrets Managerand Authentication and access control in Secrets Manager.
func (*Client) BatchGetSecretValue ¶ added in v1.24.0
func (c *Client) BatchGetSecretValue(ctx context.Context, params *BatchGetSecretValueInput, optFns ...func(*Options)) (*BatchGetSecretValueOutput, error)
Retrieves the contents of the encrypted fields SecretString or SecretBinary for up to 20 secrets. To retrieve a single secret, call GetSecretValue.
To choose which secrets to retrieve, you can specify a list of secrets by name or ARN, or you can use filters. If Secrets Manager encounters errors such as AccessDeniedException while attempting to retrieve any of the secrets, you can see the errors in Errors in the response.
Secrets Manager generates CloudTrail GetSecretValue log entries for each secret you request when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:BatchGetSecretValue , and you must have secretsmanager:GetSecretValue for each secret. If you use filters, you must also have secretsmanager:ListSecrets . If the secrets are encrypted using customer-managed keys instead of the Amazon Web Services managed key aws/secretsmanager , then you also need kms:Decrypt permissions for the keys. For more information, see IAM policy actions for Secrets Managerand Authentication and access control in Secrets Manager.
func (*Client) CancelRotateSecret ¶
func (c *Client) CancelRotateSecret(ctx context.Context, params *CancelRotateSecretInput, optFns ...func(*Options)) (*CancelRotateSecretOutput, error)
Turns off automatic rotation, and if a rotation is currently in progress, cancels the rotation.
If you cancel a rotation in progress, it can leave the VersionStage labels in an unexpected state. You might need to remove the staging label AWSPENDING from the partially created version. You also need to determine whether to roll back to the previous version of the secret by moving the staging label AWSCURRENT to the version that has AWSPENDING . To determine which version has a specific staging label, call DescribeSecret. Then use UpdateSecretVersionStage to change staging labels. For more information, see How rotation works.
To turn on automatic rotation again, call RotateSecret.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:CancelRotateSecret . For more information, see IAM policy actions for Secrets Managerand Authentication and access control in Secrets Manager.
func (*Client) CreateSecret ¶
func (c *Client) CreateSecret(ctx context.Context, params *CreateSecretInput, optFns ...func(*Options)) (*CreateSecretOutput, error)
Creates a new secret. A secret can be a password, a set of credentials such as a user name and password, an OAuth token, or other secret information that you store in an encrypted form in Secrets Manager. The secret also includes the connection information to access a database or other service. Secrets Manager does not encrypt this connection information. A secret in Secrets Manager consists of both the encrypted secret versions and the metadata that Secrets Manager uses to manage the secret.
For secrets that use managed rotation, you need to create the secret through the managing service. For more information, see Secrets Manager secrets managed by other Amazon Web Services services.
For information about creating a secret in the console, see Create a secret.
To create a secret, you can provide the secret value to be encrypted in either the SecretString parameter or the SecretBinary parameter, but not both. If you include SecretString or SecretBinary , then Secrets Manager creates an initial secret version and automatically attaches the staging label AWSCURRENT to it.
For database credentials you want to rotate, for Secrets Manager to be able to rotate the secret, you must make sure the JSON you store in the SecretString matches the JSON structure of a database secret.
If you don't specify an KMS encryption key, Secrets Manager uses the Amazon Web Services managed key aws/secretsmanager . If this key doesn't already exist in your account, then Secrets Manager creates it for you automatically. All users and roles in the Amazon Web Services account automatically have access to use aws/secretsmanager . Creating aws/secretsmanager can result in a one-time delay to complete the secret creation.
If the secret is in a different Amazon Web Services account from the credentials calling the API, then you can't use aws/secretsmanager to encrypt the secret, and you must create and use a customer managed KMS key.
To create a cross-account replica secret, include CrossAccountPrimaryARN . The replica must use a customer managed KMS key, and can't include AddReplicaRegions , Description , SecretBinary , SecretString , or Type .
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters except SecretBinary or SecretString because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:CreateSecret . If you include tags in the secret, you also need secretsmanager:TagResource . To add replica Regions, you must also have secretsmanager:ReplicateSecretToRegions . To create a cross-account replica secret, you must also have secretsmanager:PutResourcePolicy permissions. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
To encrypt the secret with a KMS key other than aws/secretsmanager , you need kms:GenerateDataKey and kms:Decrypt permission to the key.
When you enter commands in a command shell, there is a risk of the command history being accessed or utilities having access to your command parameters. This is a concern if the command includes the value of a secret. Learn how to Mitigate the risks of using command-line tools to store Secrets Manager secrets.
func (*Client) DeleteResourcePolicy ¶
func (c *Client) DeleteResourcePolicy(ctx context.Context, params *DeleteResourcePolicyInput, optFns ...func(*Options)) (*DeleteResourcePolicyOutput, error)
Deletes the resource-based permission policy attached to the secret. To attach a policy to a secret, use PutResourcePolicy.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:DeleteResourcePolicy . For more information, see IAM policy actions for Secrets Managerand Authentication and access control in Secrets Manager.
func (*Client) DeleteSecret ¶
func (c *Client) DeleteSecret(ctx context.Context, params *DeleteSecretInput, optFns ...func(*Options)) (*DeleteSecretOutput, error)
Deletes a secret and all of its versions. You can specify a recovery window during which you can restore the secret. The minimum recovery window is 7 days. The default recovery window is 30 days. Secrets Manager attaches a DeletionDate stamp to the secret that specifies the end of the recovery window. At the end of the recovery window, Secrets Manager deletes the secret permanently.
You can't delete a primary secret that is replicated to other Regions. You must first delete the replicas using RemoveRegionsFromReplication, and then delete the primary secret. When you delete a replica, it is deleted immediately.
You can't delete a cross-account primary secret that is associated with a cross-account replica secret. You must first disassociate each of the replicas using DisassociateCrossAccountReplica, before deleting the primary secret. Similarly, you can't delete a cross-account replica secret without first stopping replication. Call StopReplicationToReplicato stop replication, and then you can delete the secret.
You can't directly delete a version of a secret. Instead, you remove all staging labels from the version using UpdateSecretVersionStage. This marks the version as deprecated, and then Secrets Manager can automatically delete the version in the background.
To determine whether an application still uses a secret, you can create an Amazon CloudWatch alarm to alert you to any attempts to access a secret during the recovery window. For more information, see Monitor secrets scheduled for deletion.
Secrets Manager performs the permanent secret deletion at the end of the waiting period as a background task with low priority. There is no guarantee of a specific time after the recovery window for the permanent delete to occur.
At any time before recovery window ends, you can use RestoreSecret to remove the DeletionDate and cancel the deletion of the secret.
When a secret is scheduled for deletion, you cannot retrieve the secret value. You must first cancel the deletion with RestoreSecretand then you can retrieve the secret.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:DeleteSecret . For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
func (*Client) DescribeSecret ¶
func (c *Client) DescribeSecret(ctx context.Context, params *DescribeSecretInput, optFns ...func(*Options)) (*DescribeSecretOutput, error)
Retrieves the details of a secret. It does not include the encrypted secret value. Secrets Manager only returns fields that have a value in the response.
The VersionIdsToStages field in the response includes every version ID that has a staging label attached, even if that version doesn't contain a secret value. In contrast, ListSecretVersionIds only returns versions that contain a secret value. To check whether a secret version contains a value, call GetSecretValue.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:DescribeSecret . For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
func (*Client) DisassociateCrossAccountReplica ¶ added in v1.51.0
func (c *Client) DisassociateCrossAccountReplica(ctx context.Context, params *DisassociateCrossAccountReplicaInput, optFns ...func(*Options)) (*DisassociateCrossAccountReplicaOutput, error)
Removes the link between a primary secret in your account and a cross-account replica secret, and stops replication to the replica secret. Call this operation on the primary secret. This action removes the replica association created by AssociateCrossAccountReplica.
Disassociating the replica from the primary does not delete the replica secret or convert the replica secret to a standalone secret. The replica secret remains in the other account and its replication status changes to Detached . Secrets Manager no longer sends updates from the primary secret to the replica secret after disassociation. To convert a detached replica into a standalone secret, call StopReplicationToReplicaon the replica secret.
You must disassociate a cross-account replica before you call DeleteSecret for the primary secret. The DeleteSecretcall fails if any replicas are still associated with the primary secret.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:DisassociateCrossAccountReplica . For more information, see IAM policy actions for Secrets Managerand Authentication and access control in Secrets Manager.
func (*Client) GetRandomPassword ¶
func (c *Client) GetRandomPassword(ctx context.Context, params *GetRandomPasswordInput, optFns ...func(*Options)) (*GetRandomPasswordOutput, error)
Generates a random password. We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support. By default, Secrets Manager uses uppercase and lowercase letters, numbers, and the following characters in passwords: !\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~
Secrets Manager generates a CloudTrail log entry when you call this action.
Required permissions: secretsmanager:GetRandomPassword . For more information, see IAM policy actions for Secrets Managerand Authentication and access control in Secrets Manager.
func (*Client) GetResourcePolicy ¶
func (c *Client) GetResourcePolicy(ctx context.Context, params *GetResourcePolicyInput, optFns ...func(*Options)) (*GetResourcePolicyOutput, error)
Retrieves the JSON text of the resource-based policy document attached to the secret. For more information about permissions policies attached to a secret, see Permissions policies attached to a secret.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:GetResourcePolicy . For more information, see IAM policy actions for Secrets Managerand Authentication and access control in Secrets Manager.
func (*Client) GetSecretValue ¶
func (c *Client) GetSecretValue(ctx context.Context, params *GetSecretValueInput, optFns ...func(*Options)) (*GetSecretValueOutput, error)
Retrieves the contents of the encrypted fields SecretString or SecretBinary from the specified version of a secret, whichever contains content.
To retrieve the values for a group of secrets, call BatchGetSecretValue.
We recommend that you cache your secret values by using client-side caching. Caching secrets improves speed and reduces your costs. For more information, see Cache secrets for your applications.
To retrieve the previous version of a secret, use VersionStage and specify AWSPREVIOUS. To revert to the previous version of a secret, call UpdateSecretVersionStage.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:GetSecretValue . If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key aws/secretsmanager , then you also need kms:Decrypt permissions for that key. For more information, see IAM policy actions for Secrets Managerand Authentication and access control in Secrets Manager.
func (*Client) ListResourcePolicies ¶ added in v1.51.0
func (c *Client) ListResourcePolicies(ctx context.Context, params *ListResourcePoliciesInput, optFns ...func(*Options)) (*ListResourcePoliciesOutput, error)
Lists the resource-based policies attached to a secret. The response contains only the names of the policies, not their contents. Secrets Manager lists default first, followed by any other policies in alphabetical order. To get the contents of a policy, use GetResourcePolicy. You can modify only the default policy.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:ListResourcePolicies . For more information, see IAM policy actions for Secrets Managerand Authentication and access control in Secrets Manager.
func (*Client) ListSecretVersionIds ¶
func (c *Client) ListSecretVersionIds(ctx context.Context, params *ListSecretVersionIdsInput, optFns ...func(*Options)) (*ListSecretVersionIdsOutput, error)
Lists the versions of a secret. Secrets Manager uses staging labels to indicate the different versions of a secret. For more information, see Secrets Manager concepts: Versions.
To list the secrets in the account, use ListSecrets.
ListSecretVersionIds only returns versions that contain a secret value. To see all version IDs that have staging labels attached, including ones without a secret value, call DescribeSecret and check VersionIdsToStages .
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:ListSecretVersionIds . For more information, see IAM policy actions for Secrets Managerand Authentication and access control in Secrets Manager.
func (*Client) ListSecrets ¶
func (c *Client) ListSecrets(ctx context.Context, params *ListSecretsInput, optFns ...func(*Options)) (*ListSecretsOutput, error)
Lists the secrets that are stored by Secrets Manager in the Amazon Web Services account, not including secrets that are marked for deletion. To see secrets marked for deletion, use the Secrets Manager console.
All Secrets Manager operations are eventually consistent. ListSecrets might not reflect changes from the last five minutes. You can get more recent information for a specific secret by calling DescribeSecret.
To list the versions of a secret, use ListSecretVersionIds.
To retrieve the values for the secrets, call BatchGetSecretValue or GetSecretValue.
For information about finding secrets in the console, see Find secrets in Secrets Manager.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:ListSecrets . For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
func (*Client) Options ¶ added in v1.25.0
Options returns a copy of the client configuration.
Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.
func (*Client) PutResourcePolicy ¶
func (c *Client) PutResourcePolicy(ctx context.Context, params *PutResourcePolicyInput, optFns ...func(*Options)) (*PutResourcePolicyOutput, error)
Attaches a resource-based permission policy to a secret. A resource-based policy is optional. For more information, see Authentication and access control for Secrets Manager
For information about attaching a policy in the console, see Attach a permissions policy to a secret.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:PutResourcePolicy . For more information, see IAM policy actions for Secrets Managerand Authentication and access control in Secrets Manager.
func (*Client) PutSecretValue ¶
func (c *Client) PutSecretValue(ctx context.Context, params *PutSecretValueInput, optFns ...func(*Options)) (*PutSecretValueOutput, error)
Creates a new version of your secret by creating a new encrypted value and attaching it to the secret. version can contain a new SecretString value or a new SecretBinary value.
Do not call PutSecretValue at a sustained rate of more than once every 10 minutes. When you update the secret value, Secrets Manager creates a new version of the secret. Secrets Manager keeps 100 of the most recent versions, but it keeps all secret versions created in the last 24 hours. If you call PutSecretValue more than once every 10 minutes, you will create more versions than Secrets Manager removes, and you will reach the quota for secret versions.
You can specify the staging labels to attach to the new version in VersionStages . If you don't include VersionStages , then Secrets Manager automatically moves the staging label AWSCURRENT to this version. If this operation creates the first version for the secret, then Secrets Manager automatically attaches the staging label AWSCURRENT to it. If this operation moves the staging label AWSCURRENT from another version to this version, then Secrets Manager also automatically moves the staging label AWSPREVIOUS to the version that AWSCURRENT was removed from.
This operation is idempotent. If you call this operation with a ClientRequestToken that matches an existing version's VersionId, and you specify the same secret data, the operation succeeds but does nothing. However, if the secret data is different, then the operation fails because you can't modify an existing version; you can only create new ones.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters except SecretBinary , SecretString , or RotationToken because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:PutSecretValue . For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
When you enter commands in a command shell, there is a risk of the command history being accessed or utilities having access to your command parameters. This is a concern if the command includes the value of a secret. Learn how to Mitigate the risks of using command-line tools to store Secrets Manager secrets.
func (*Client) RemoveRegionsFromReplication ¶ added in v1.2.0
func (c *Client) RemoveRegionsFromReplication(ctx context.Context, params *RemoveRegionsFromReplicationInput, optFns ...func(*Options)) (*RemoveRegionsFromReplicationOutput, error)
For a secret that is replicated to other Regions, deletes the secret replicas from the Regions you specify.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:RemoveRegionsFromReplication . For more information, see IAM policy actions for Secrets Managerand Authentication and access control in Secrets Manager.
func (*Client) ReplicateSecretToRegions ¶ added in v1.2.0
func (c *Client) ReplicateSecretToRegions(ctx context.Context, params *ReplicateSecretToRegionsInput, optFns ...func(*Options)) (*ReplicateSecretToRegionsOutput, error)
Replicates the secret to a new Regions. See Multi-Region secrets.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:ReplicateSecretToRegions . If the primary secret is encrypted with a KMS key other than aws/secretsmanager , you also need kms:Decrypt permission to the key. To encrypt the replicated secret with a KMS key other than aws/secretsmanager , you need kms:GenerateDataKey and kms:Encrypt to the key. For more information, see IAM policy actions for Secrets Managerand Authentication and access control in Secrets Manager.
func (*Client) RestoreSecret ¶
func (c *Client) RestoreSecret(ctx context.Context, params *RestoreSecretInput, optFns ...func(*Options)) (*RestoreSecretOutput, error)
Cancels the scheduled deletion of a secret by removing the DeletedDate time stamp. You can access a secret again after it has been restored.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:RestoreSecret . For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
func (*Client) RotateSecret ¶
func (c *Client) RotateSecret(ctx context.Context, params *RotateSecretInput, optFns ...func(*Options)) (*RotateSecretOutput, error)
Configures and starts the asynchronous process of rotating the secret. For information about rotation, see Rotate secretsin the Secrets Manager User Guide. If you include the configuration parameters, the operation sets the values for the secret and then immediately starts a rotation. If you don't include the configuration parameters, the operation starts a rotation with the values already stored in the secret.
When rotation is successful, the AWSPENDING staging label might be attached to the same version as the AWSCURRENT version, or it might not be attached to any version. If the AWSPENDING staging label is present but not attached to the same version as AWSCURRENT , then any later invocation of RotateSecret assumes that a previous rotation request is still in progress and returns an error. When rotation is unsuccessful, the AWSPENDING staging label might be attached to an empty secret version. For more information, see Troubleshoot rotationin the Secrets Manager User Guide.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:RotateSecret . For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager. You also need lambda:InvokeFunction permissions on the rotation function. For more information, see Permissions for rotation.
func (*Client) StopReplicationToReplica ¶ added in v1.2.0
func (c *Client) StopReplicationToReplica(ctx context.Context, params *StopReplicationToReplicaInput, optFns ...func(*Options)) (*StopReplicationToReplicaOutput, error)
Removes the link between a replica secret and its primary secret, and stops replication to the replica. You call this operation from the replica account or Region. Depending on the type of replica, the behavior is:
Cross-Region replica: promotes the replica to a standalone primary secret in the replica Region.
Cross-account replica: promotes the replica in your account to a standalone secret and stops replication from its primary secret in the other account. Secrets Manager updates the primary secret's replication status to Detached for this replica.
To stop cross-account replication from the primary account instead, use DisassociateCrossAccountReplica.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:StopReplicationToReplica . For cross-account replica secrets, you must also have secretsmanager:DeleteResourcePolicy permissions. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager .
func (*Client) TagResource ¶
func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
Attaches tags to a secret. Tags consist of a key name and a value. Tags are part of the secret's metadata. They are not associated with specific versions of the secret. This operation appends tags to the existing list of tags.
For tag quotas and naming restrictions, see Service quotas for Tagging in the Amazon Web Services General Reference guide.
If you use tags as part of your security strategy, then adding or removing a tag can change permissions. If successfully completing this operation would result in you losing your permissions for this secret, then the operation is blocked and returns an Access Denied error.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:TagResource . For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
func (*Client) UntagResource ¶
func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
Removes specific tags from a secret.
This operation is idempotent. If a requested tag is not attached to the secret, no error is returned and the secret metadata is unchanged.
If you use tags as part of your security strategy, then removing a tag can change permissions. If successfully completing this operation would result in you losing your permissions for this secret, then the operation is blocked and returns an Access Denied error.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:UntagResource . For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
func (*Client) UpdateSecret ¶
func (c *Client) UpdateSecret(ctx context.Context, params *UpdateSecretInput, optFns ...func(*Options)) (*UpdateSecretOutput, error)
Modifies the details of a secret, including metadata and the secret value. To change the secret value, you can also use PutSecretValue.
To change the rotation configuration of a secret, use RotateSecret instead.
To change a secret so that it is managed by another service, you need to recreate the secret in that service. See Secrets Manager secrets managed by other Amazon Web Services services.
We recommend you avoid calling UpdateSecret at a sustained rate of more than once every 10 minutes. When you call UpdateSecret to update the secret value, Secrets Manager creates a new version of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not remove versions created less than 24 hours ago. If you update the secret value more than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach the quota for secret versions.
If you include SecretString or SecretBinary to create a new secret version, Secrets Manager automatically moves the staging label AWSCURRENT to the new version. Then it attaches the label AWSPREVIOUS to the version that AWSCURRENT was removed from.
If you call this operation with a ClientRequestToken that matches an existing version's VersionId , the operation results in an error. You can't modify an existing version, you can only create a new version. To remove a version, remove all staging labels from it. See UpdateSecretVersionStage.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters except SecretBinary or SecretString because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:UpdateSecret . For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager. If you use a customer managed key, you must also have kms:GenerateDataKey , kms:Encrypt , and kms:Decrypt permissions on the key. If you change the KMS key and you don't have kms:Encrypt permission to the new key, Secrets Manager does not re-encrypt existing secret versions with the new key. For more information, see Secret encryption and decryption.
When you enter commands in a command shell, there is a risk of the command history being accessed or utilities having access to your command parameters. This is a concern if the command includes the value of a secret. Learn how to Mitigate the risks of using command-line tools to store Secrets Manager secrets.
func (*Client) UpdateSecretVersionStage ¶
func (c *Client) UpdateSecretVersionStage(ctx context.Context, params *UpdateSecretVersionStageInput, optFns ...func(*Options)) (*UpdateSecretVersionStageOutput, error)
Modifies the staging labels attached to a version of a secret. Secrets Manager uses staging labels to track a version as it progresses through the secret rotation process. Each staging label can be attached to only one version at a time. To add a staging label to a version when it is already attached to another version, Secrets Manager first removes it from the other version first and then attaches it to this one. For more information about versions and staging labels, see Concepts: Version.
The staging labels that you specify in the VersionStage parameter are added to the existing list of staging labels for the version.
You can move the AWSCURRENT staging label to this version by including it in this call.
Whenever you move AWSCURRENT , Secrets Manager automatically moves the label AWSPREVIOUS to the version that AWSCURRENT was removed from.
If this action results in the last label being removed from a version, then the version is considered to be 'deprecated' and can be deleted by Secrets Manager.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:UpdateSecretVersionStage . For more information, see IAM policy actions for Secrets Managerand Authentication and access control in Secrets Manager.
func (*Client) ValidateResourcePolicy ¶
func (c *Client) ValidateResourcePolicy(ctx context.Context, params *ValidateResourcePolicyInput, optFns ...func(*Options)) (*ValidateResourcePolicyOutput, error)
Validates that a resource policy does not grant a wide range of principals access to your secret. A resource-based policy is optional for secrets.
The API performs three checks when validating the policy:
Sends a call to Zelkova, an automated reasoning engine, to ensure your resource policy does not allow broad access to your secret, for example policies that use a wildcard for the principal.
Checks for correct syntax in a policy.
Verifies the policy does not lock out a caller.
Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.
Required permissions: secretsmanager:ValidateResourcePolicy and secretsmanager:PutResourcePolicy . For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.
type CreateSecretInput ¶
type CreateSecretInput struct {
// The name of the new secret.
//
// The secret name can contain ASCII letters, numbers, and the following
// characters: /_+=.@-
//
// Do not end your secret name with a hyphen followed by six characters. If you do
// so, you risk confusion and unexpected results when searching for a secret by
// partial ARN. Secrets Manager automatically adds a hyphen and six random
// characters after the secret name at the end of the ARN.
//
// This member is required.
Name *string
// A list of Regions and KMS keys to replicate secrets.
AddReplicaRegions []types.ReplicaRegionType
// If you include SecretString or SecretBinary , then Secrets Manager creates an
// initial version for the secret, and this parameter specifies the unique
// identifier for the new version.
//
// If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs
// to call this operation, then you can leave this parameter empty. The CLI or SDK
// generates a random UUID for you and includes it as the value for this parameter
// in the request.
//
// If you generate a raw HTTP request to the Secrets Manager service endpoint,
// then you must generate a ClientRequestToken and include it in the request.
//
// This value helps ensure idempotency. Secrets Manager uses this value to prevent
// the accidental creation of duplicate versions if there are failures and retries
// during a rotation. We recommend that you generate a [UUID-type]value to ensure uniqueness
// of your versions within the specified secret.
//
// - If the ClientRequestToken value isn't already associated with a version of
// the secret then a new version of the secret is created.
//
// - If a version with this value already exists and the version SecretString and
// SecretBinary values are the same as those in the request, then the request is
// ignored.
//
// - If a version with this value already exists and that version's SecretString
// and SecretBinary values are different from those in the request, then the
// request fails because you cannot modify an existing version. Instead, use PutSecretValueto
// create a new version.
//
// This value becomes the VersionId of the new version.
//
// [UUID-type]: https://wikipedia.org/wiki/Universally_unique_identifier
ClientRequestToken *string
// The ARN of a primary secret in another Amazon Web Services account. Include
// this field to create a cross-account replica secret that receives replicated
// data from that primary secret. The primary secret must be in the same Amazon Web
// Services Region and partition as the replica, and you must specify a customer
// managed KMS key in KmsKeyId . You can't include SecretString , SecretBinary ,
// Description , AddReplicaRegions , or Type .
CrossAccountPrimaryARN *string
// The description of the secret.
Description *string
// Specifies whether to overwrite a secret with the same name in the destination
// Region. By default, secrets aren't overwritten.
ForceOverwriteReplicaSecret bool
// The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt
// the secret value in the secret. An alias is always prefixed by alias/ , for
// example alias/aws/secretsmanager . For more information, see [About aliases].
//
// To use a KMS key in a different account, use the key ARN or the alias ARN.
//
// If you don't specify this value, then Secrets Manager uses the key
// aws/secretsmanager . If that key doesn't yet exist, then Secrets Manager creates
// it for you automatically the first time it encrypts the secret value.
//
// If the secret is in a different Amazon Web Services account from the
// credentials calling the API, then you can't use aws/secretsmanager to encrypt
// the secret, and you must create and use a customer managed KMS key.
//
// [About aliases]: https://docs.aws.amazon.com/kms/latest/developerguide/alias-about.html
KmsKeyId *string
// The binary data to encrypt and store in the new version of the secret. We
// recommend that you store your binary data in a file and then pass the contents
// of the file as a parameter.
//
// Either SecretString or SecretBinary must have a value, but not both.
//
// This parameter is not available in the Secrets Manager console.
//
// Sensitive: This field contains sensitive information, so the service does not
// include it in CloudTrail log entries. If you create your own log entries, you
// must also avoid logging the information in this field.
SecretBinary []byte
// The text data to encrypt and store in this new version of the secret. We
// recommend you use a JSON structure of key/value pairs for your secret value.
//
// Either SecretString or SecretBinary must have a value, but not both.
//
// If you create a secret by using the Secrets Manager console then Secrets
// Manager puts the protected secret text in only the SecretString parameter. The
// Secrets Manager console stores the information as a JSON structure of key/value
// pairs that a Lambda rotation function can parse.
//
// Sensitive: This field contains sensitive information, so the service does not
// include it in CloudTrail log entries. If you create your own log entries, you
// must also avoid logging the information in this field.
SecretString *string
// A list of tags to attach to the secret. Each tag is a key and value pair of
// strings in a JSON text string, for example:
//
// [{"Key":"CostCenter","Value":"12345"},{"Key":"environment","Value":"production"}]
//
// Secrets Manager tag key names are case sensitive. A tag with the key "ABC" is a
// different tag from one with key "abc".
//
// If you check tags in permissions policies as part of your security strategy,
// then adding or removing a tag can change permissions. If the completion of this
// operation would result in you losing your permissions for this secret, then
// Secrets Manager blocks the operation and returns an Access Denied error. For
// more information, see [Control access to secrets using tags]and [Limit access to identities with tags that match secrets' tags].
//
// For information about how to format a JSON parameter for the various command
// line tool environments, see [Using JSON for Parameters]. If your command-line tool or SDK requires
// quotation marks around the parameter, you should use single quotes to avoid
// confusion with the double quotes required in the JSON text.
//
// For tag quotas and naming restrictions, see [Service quotas for Tagging] in the Amazon Web Services General
// Reference guide.
//
// [Limit access to identities with tags that match secrets' tags]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#auth-and-access_tags2
// [Using JSON for Parameters]: https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json
// [Service quotas for Tagging]: https://docs.aws.amazon.com/general/latest/gr/arg.html#taged-reference-quotas
// [Control access to secrets using tags]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#tag-secrets-abac
Tags []types.Tag
// The exact string that identifies the partner that holds the external secret.
// For more information, see [Using Secrets Manager managed external secrets].
//
// [Using Secrets Manager managed external secrets]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/managed-external-secrets.html
Type *string
// contains filtered or unexported fields
}
func (*CreateSecretInput) Serialize ¶ added in v1.50.0
func (v *CreateSecretInput) Serialize(s smithy.ShapeSerializer)
func (*CreateSecretInput) SerializeMembers ¶ added in v1.50.0
func (v *CreateSecretInput) SerializeMembers(s smithy.ShapeSerializer)
type CreateSecretOutput ¶
type CreateSecretOutput struct {
// The ARN of the new secret. The ARN includes the name of the secret followed by
// six random characters. This ensures that if you create a new secret with the
// same name as a deleted secret, then users with access to the old secret don't
// get access to the new secret because the ARNs are different.
ARN *string
// The name of the new secret.
Name *string
// A list of the replicas of this secret and their status:
//
// - Failed , which indicates that the replica was not created.
//
// - InProgress , which indicates that Secrets Manager is in the process of
// creating the replica.
//
// - InSync , which indicates that the replica was created.
ReplicationStatus []types.ReplicationStatusType
// The unique identifier associated with the version of the new secret.
VersionId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*CreateSecretOutput) Deserialize ¶ added in v1.50.0
func (v *CreateSecretOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*CreateSecretOutput) Serialize ¶ added in v1.50.0
func (v *CreateSecretOutput) Serialize(s smithy.ShapeSerializer)
func (*CreateSecretOutput) SerializeMembers ¶ added in v1.50.0
func (v *CreateSecretOutput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteResourcePolicyInput ¶
type DeleteResourcePolicyInput struct {
// The ARN or name of the secret to delete the attached resource-based policy for.
//
// For an ARN, we recommend that you specify a complete ARN rather than a partial
// ARN. See [Finding a secret from a partial ARN].
//
// [Finding a secret from a partial ARN]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
//
// This member is required.
SecretId *string
// The name of the resource policy to delete. If you don't specify this field,
// Secrets Manager uses default . You can only delete the default policy; if you
// specify any other name, the operation returns an InvalidParameterException .
PolicyName *string
// contains filtered or unexported fields
}
func (*DeleteResourcePolicyInput) Serialize ¶ added in v1.50.0
func (v *DeleteResourcePolicyInput) Serialize(s smithy.ShapeSerializer)
func (*DeleteResourcePolicyInput) SerializeMembers ¶ added in v1.50.0
func (v *DeleteResourcePolicyInput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteResourcePolicyOutput ¶
type DeleteResourcePolicyOutput struct {
// The ARN of the secret that the resource-based policy was deleted for.
ARN *string
// The name of the secret that the resource-based policy was deleted for.
Name *string
// The name of the deleted resource policy. If you didn't specify PolicyName in
// the request, this is default .
PolicyName *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DeleteResourcePolicyOutput) Deserialize ¶ added in v1.50.0
func (v *DeleteResourcePolicyOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DeleteResourcePolicyOutput) Serialize ¶ added in v1.50.0
func (v *DeleteResourcePolicyOutput) Serialize(s smithy.ShapeSerializer)
func (*DeleteResourcePolicyOutput) SerializeMembers ¶ added in v1.50.0
func (v *DeleteResourcePolicyOutput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteSecretInput ¶
type DeleteSecretInput struct {
// The ARN or name of the secret to delete.
//
// For an ARN, we recommend that you specify a complete ARN rather than a partial
// ARN. See [Finding a secret from a partial ARN].
//
// [Finding a secret from a partial ARN]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
//
// This member is required.
SecretId *string
// Specifies whether to delete the secret without any recovery window. You can't
// use both this parameter and RecoveryWindowInDays in the same call. If you don't
// use either, then by default Secrets Manager uses a 30 day recovery window.
//
// Secrets Manager performs the actual deletion with an asynchronous background
// process, so there might be a short delay before the secret is permanently
// deleted. If you delete a secret and then immediately create a secret with the
// same name, use appropriate back off and retry logic.
//
// If you forcibly delete an already deleted or nonexistent secret, the operation
// does not return ResourceNotFoundException .
//
// Use this parameter with caution. This parameter causes the operation to skip
// the normal recovery window before the permanent deletion that Secrets Manager
// would normally impose with the RecoveryWindowInDays parameter. If you delete a
// secret with the ForceDeleteWithoutRecovery parameter, then you have no
// opportunity to recover the secret. You lose the secret permanently.
ForceDeleteWithoutRecovery *bool
// The number of days from 7 to 30 that Secrets Manager waits before permanently
// deleting the secret. You can't use both this parameter and
// ForceDeleteWithoutRecovery in the same call. If you don't use either, then by
// default Secrets Manager uses a 30 day recovery window.
RecoveryWindowInDays *int64
// contains filtered or unexported fields
}
func (*DeleteSecretInput) Serialize ¶ added in v1.50.0
func (v *DeleteSecretInput) Serialize(s smithy.ShapeSerializer)
func (*DeleteSecretInput) SerializeMembers ¶ added in v1.50.0
func (v *DeleteSecretInput) SerializeMembers(s smithy.ShapeSerializer)
type DeleteSecretOutput ¶
type DeleteSecretOutput struct {
// The ARN of the secret.
ARN *string
// The date and time after which this secret Secrets Manager can permanently
// delete this secret, and it can no longer be restored. This value is the date and
// time of the delete request plus the number of days in RecoveryWindowInDays .
DeletionDate *time.Time
// The name of the secret.
Name *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DeleteSecretOutput) Deserialize ¶ added in v1.50.0
func (v *DeleteSecretOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DeleteSecretOutput) Serialize ¶ added in v1.50.0
func (v *DeleteSecretOutput) Serialize(s smithy.ShapeSerializer)
func (*DeleteSecretOutput) SerializeMembers ¶ added in v1.50.0
func (v *DeleteSecretOutput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeSecretInput ¶
type DescribeSecretInput struct {
// The ARN or name of the secret.
//
// For an ARN, we recommend that you specify a complete ARN rather than a partial
// ARN. See [Finding a secret from a partial ARN].
//
// [Finding a secret from a partial ARN]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
//
// This member is required.
SecretId *string
// contains filtered or unexported fields
}
func (*DescribeSecretInput) Serialize ¶ added in v1.50.0
func (v *DescribeSecretInput) Serialize(s smithy.ShapeSerializer)
func (*DescribeSecretInput) SerializeMembers ¶ added in v1.50.0
func (v *DescribeSecretInput) SerializeMembers(s smithy.ShapeSerializer)
type DescribeSecretOutput ¶
type DescribeSecretOutput struct {
// The ARN of the secret.
ARN *string
// The date the secret was created.
CreatedDate *time.Time
// Information about the primary secret in the other Amazon Web Services account
// that this cross-account replica secret replicates from, including the primary
// secret ARN and the replication status. This field is omitted if the secret is
// not a cross-account replica.
CrossAccountPrimary *types.CrossAccountPrimaryType
// A list of this secret's cross-account replica secrets and their replication
// status, if this secret is the primary for cross-account replication. This field
// is omitted if the secret has no cross-account replicas.
CrossAccountReplicas []types.CrossAccountReplicaEntry
// The date the secret is scheduled for deletion. If it is not scheduled for
// deletion, this field is omitted. When you delete a secret, Secrets Manager
// requires a recovery window of at least 7 days before deleting the secret. Some
// time after the deleted date, Secrets Manager deletes the secret, including all
// of its versions.
//
// If a secret is scheduled for deletion, then its details, including the
// encrypted secret value, is not accessible. To cancel a scheduled deletion and
// restore access to the secret, use RestoreSecret.
DeletedDate *time.Time
// The description of the secret.
Description *string
// The metadata needed to successfully rotate a managed external secret. A list of
// key value pairs in JSON format specified by the partner. For more information
// about the required information, see [Managed external secrets partners].
//
// [Managed external secrets partners]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/mes-partners.html
ExternalSecretRotationMetadata []types.ExternalSecretRotationMetadataItem
// The Amazon Resource Name (ARN) of the role that allows Secrets Manager to
// rotate a secret held by a third-party partner. For more information, see [Security and permissions].
//
// [Security and permissions]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/mes-security.html
ExternalSecretRotationRoleArn *string
// The key ID or alias ARN of the KMS key that Secrets Manager uses to encrypt the
// secret value. If the secret is encrypted with the Amazon Web Services managed
// key aws/secretsmanager , this field is omitted. Secrets created using the
// console use an KMS key ID.
KmsKeyId *string
// The date that the secret was last accessed in the Region. This field is omitted
// if the secret has never been retrieved in the Region.
LastAccessedDate *time.Time
// The last date and time that this secret was modified in any way.
LastChangedDate *time.Time
// The last date and time that Secrets Manager rotated the secret. If the secret
// isn't configured for rotation or rotation has been disabled, Secrets Manager
// returns null.
LastRotatedDate *time.Time
// The name of the secret.
Name *string
// The next rotation is scheduled to occur on or before this date. If the secret
// isn't configured for rotation or rotation has been disabled, Secrets Manager
// returns null. If rotation fails, Secrets Manager retries the entire rotation
// process multiple times. If rotation is unsuccessful, this date may be in the
// past.
//
// This date represents the latest date that rotation will occur, but it is not an
// approximate rotation date. In some cases, for example if you turn off automatic
// rotation and then turn it back on, the next rotation may occur much sooner than
// this date.
NextRotationDate *time.Time
// The ID of the service that created this secret. For more information, see [Secrets managed by other Amazon Web Services services].
//
// [Secrets managed by other Amazon Web Services services]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/service-linked-secrets.html
OwningService *string
// The Region the secret is in. If a secret is replicated to other Regions, the
// replicas are listed in ReplicationStatus .
PrimaryRegion *string
// A list of the replicas of this secret and their status:
//
// - Failed , which indicates that the replica was not created.
//
// - InProgress , which indicates that Secrets Manager is in the process of
// creating the replica.
//
// - InSync , which indicates that the replica was created.
ReplicationStatus []types.ReplicationStatusType
// Specifies whether automatic rotation is turned on for this secret. If the
// secret has never been configured for rotation, Secrets Manager returns null.
//
// To turn on rotation, use RotateSecret. To turn off rotation, use CancelRotateSecret.
RotationEnabled *bool
// The ARN of the Lambda function that Secrets Manager invokes to rotate the
// secret.
RotationLambdaARN *string
// The rotation schedule and Lambda function for this secret. If the secret
// previously had rotation turned on, but it is now turned off, this field shows
// the previous rotation schedule and rotation function. If the secret never had
// rotation turned on, this field is omitted.
RotationRules *types.RotationRulesType
// The list of tags attached to the secret. To add tags to a secret, use TagResource. To
// remove tags, use UntagResource.
Tags []types.Tag
// The exact string that identifies the partner that holds the external secret.
// For more information, see [Using Secrets Manager managed external secrets].
//
// [Using Secrets Manager managed external secrets]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/managed-external-secrets.html
Type *string
// A list of the versions of the secret that have staging labels attached.
// Versions that don't have staging labels are considered deprecated and Secrets
// Manager can delete them.
//
// Secrets Manager uses staging labels to indicate the status of a secret version
// during rotation. The three staging labels for rotation are:
//
// - AWSCURRENT , which indicates the current version of the secret.
//
// - AWSPENDING , which indicates the version of the secret that contains new
// secret information that will become the next current version when rotation
// finishes.
//
// During rotation, Secrets Manager creates an AWSPENDING version ID before
// creating the new secret version. To check if a secret version exists, call GetSecretValue.
//
// - AWSPREVIOUS , which indicates the previous current version of the secret.
// You can use this as the last known good version.
//
// For more information about rotation and staging labels, see [How rotation works].
//
// [How rotation works]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_how.html
VersionIdsToStages map[string][]string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DescribeSecretOutput) Deserialize ¶ added in v1.50.0
func (v *DescribeSecretOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DescribeSecretOutput) Serialize ¶ added in v1.50.0
func (v *DescribeSecretOutput) Serialize(s smithy.ShapeSerializer)
func (*DescribeSecretOutput) SerializeMembers ¶ added in v1.50.0
func (v *DescribeSecretOutput) SerializeMembers(s smithy.ShapeSerializer)
type DisassociateCrossAccountReplicaInput ¶ added in v1.51.0
type DisassociateCrossAccountReplicaInput struct {
// The ARN of the cross-account replica secret to unlink from the primary secret.
//
// This member is required.
CrossAccountReplicaARN *string
// The ARN or name of the primary secret in your account.
//
// For an ARN, we recommend that you specify a complete ARN rather than a partial
// ARN. See [Finding a secret from a partial ARN].
//
// [Finding a secret from a partial ARN]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
//
// This member is required.
SecretId *string
// contains filtered or unexported fields
}
func (*DisassociateCrossAccountReplicaInput) Serialize ¶ added in v1.51.0
func (v *DisassociateCrossAccountReplicaInput) Serialize(s smithy.ShapeSerializer)
func (*DisassociateCrossAccountReplicaInput) SerializeMembers ¶ added in v1.51.0
func (v *DisassociateCrossAccountReplicaInput) SerializeMembers(s smithy.ShapeSerializer)
type DisassociateCrossAccountReplicaOutput ¶ added in v1.51.0
type DisassociateCrossAccountReplicaOutput struct {
// The ARN of the primary secret.
ARN *string
// The ARN of the replica secret that was unlinked from the primary secret.
CrossAccountReplicaARN *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*DisassociateCrossAccountReplicaOutput) Deserialize ¶ added in v1.51.0
func (v *DisassociateCrossAccountReplicaOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*DisassociateCrossAccountReplicaOutput) Serialize ¶ added in v1.51.0
func (v *DisassociateCrossAccountReplicaOutput) Serialize(s smithy.ShapeSerializer)
func (*DisassociateCrossAccountReplicaOutput) SerializeMembers ¶ added in v1.51.0
func (v *DisassociateCrossAccountReplicaOutput) SerializeMembers(s smithy.ShapeSerializer)
type EndpointParameters ¶ added in v1.20.0
type EndpointParameters struct {
// The AWS region used to dispatch the request.
//
// Parameter is
// required.
//
// AWS::Region
Region *string
// When true, use the dual-stack endpoint. If the configured endpoint does not
// support dual-stack, dispatching the request MAY return an error.
//
// Defaults to
// false if no value is provided.
//
// AWS::UseDualStack
UseDualStack *bool
// When true, send this request to the FIPS-compliant regional endpoint. If the
// configured endpoint does not have a FIPS compliant endpoint, dispatching the
// request will return an error.
//
// Defaults to false if no value is
// provided.
//
// AWS::UseFIPS
UseFIPS *bool
// Override the endpoint used to send this request
//
// Parameter is
// required.
//
// SDK::Endpoint
Endpoint *string
}
EndpointParameters provides the parameters that influence how endpoints are resolved.
func (EndpointParameters) ValidateRequired ¶ added in v1.20.0
func (p EndpointParameters) ValidateRequired() error
ValidateRequired validates required parameters are set.
func (EndpointParameters) WithDefaults ¶ added in v1.20.0
func (p EndpointParameters) WithDefaults() EndpointParameters
WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.
type EndpointResolver ¶
type EndpointResolver interface {
ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}
EndpointResolver interface for resolving service endpoints.
func EndpointResolverFromURL ¶ added in v1.1.0
func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver
EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.
type EndpointResolverFunc ¶
type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)
EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.
func (EndpointResolverFunc) ResolveEndpoint ¶
func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)
type EndpointResolverOptions ¶ added in v0.29.0
type EndpointResolverOptions = internalendpoints.Options
EndpointResolverOptions is the service endpoint resolver options
type EndpointResolverV2 ¶ added in v1.20.0
type EndpointResolverV2 interface {
ResolveEndpoint(ctx context.Context, params EndpointParameters) (
smithyendpoints.Endpoint, error,
)
}
EndpointResolverV2 provides the interface for resolving service endpoints.
func NewDefaultEndpointResolverV2 ¶ added in v1.20.0
func NewDefaultEndpointResolverV2() EndpointResolverV2
type GetRandomPasswordInput ¶
type GetRandomPasswordInput struct {
// A string of the characters that you don't want in the password.
ExcludeCharacters *string
// Specifies whether to exclude lowercase letters from the password. If you don't
// include this switch, the password can contain lowercase letters.
ExcludeLowercase *bool
// Specifies whether to exclude numbers from the password. If you don't include
// this switch, the password can contain numbers.
ExcludeNumbers *bool
// Specifies whether to exclude the following punctuation characters from the
// password: ! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~ . If
// you don't include this switch, the password can contain punctuation.
ExcludePunctuation *bool
// Specifies whether to exclude uppercase letters from the password. If you don't
// include this switch, the password can contain uppercase letters.
ExcludeUppercase *bool
// Specifies whether to include the space character. If you include this switch,
// the password can contain space characters.
IncludeSpace *bool
// The length of the password. If you don't include this parameter, the default
// length is 32 characters.
PasswordLength *int64
// Specifies whether to include at least one upper and lowercase letter, one
// number, and one punctuation. If you don't include this switch, the password
// contains at least one of every character type.
RequireEachIncludedType *bool
// contains filtered or unexported fields
}
func (*GetRandomPasswordInput) Serialize ¶ added in v1.50.0
func (v *GetRandomPasswordInput) Serialize(s smithy.ShapeSerializer)
func (*GetRandomPasswordInput) SerializeMembers ¶ added in v1.50.0
func (v *GetRandomPasswordInput) SerializeMembers(s smithy.ShapeSerializer)
type GetRandomPasswordOutput ¶
type GetRandomPasswordOutput struct {
// A string with the password.
RandomPassword *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*GetRandomPasswordOutput) Deserialize ¶ added in v1.50.0
func (v *GetRandomPasswordOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*GetRandomPasswordOutput) Serialize ¶ added in v1.50.0
func (v *GetRandomPasswordOutput) Serialize(s smithy.ShapeSerializer)
func (*GetRandomPasswordOutput) SerializeMembers ¶ added in v1.50.0
func (v *GetRandomPasswordOutput) SerializeMembers(s smithy.ShapeSerializer)
type GetResourcePolicyInput ¶
type GetResourcePolicyInput struct {
// The ARN or name of the secret to retrieve the attached resource-based policy
// for.
//
// For an ARN, we recommend that you specify a complete ARN rather than a partial
// ARN. See [Finding a secret from a partial ARN].
//
// [Finding a secret from a partial ARN]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
//
// This member is required.
SecretId *string
// The name of the resource policy to retrieve. If you don't specify this field,
// Secrets Manager uses default . If you specify a name other than default and no
// policy with that name exists, the operation returns a ResourceNotFoundException .
PolicyName *string
// contains filtered or unexported fields
}
func (*GetResourcePolicyInput) Serialize ¶ added in v1.50.0
func (v *GetResourcePolicyInput) Serialize(s smithy.ShapeSerializer)
func (*GetResourcePolicyInput) SerializeMembers ¶ added in v1.50.0
func (v *GetResourcePolicyInput) SerializeMembers(s smithy.ShapeSerializer)
type GetResourcePolicyOutput ¶
type GetResourcePolicyOutput struct {
// The ARN of the secret that the resource-based policy was retrieved for.
ARN *string
// The name of the secret that the resource-based policy was retrieved for.
Name *string
// The name of the resource policy. If you didn't specify PolicyName in the
// request, this is default .
PolicyName *string
// A JSON-formatted string that contains the permissions policy attached to the
// secret. For more information about permissions policies, see [Authentication and access control for Secrets Manager].
//
// [Authentication and access control for Secrets Manager]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html
ResourcePolicy *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*GetResourcePolicyOutput) Deserialize ¶ added in v1.50.0
func (v *GetResourcePolicyOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*GetResourcePolicyOutput) Serialize ¶ added in v1.50.0
func (v *GetResourcePolicyOutput) Serialize(s smithy.ShapeSerializer)
func (*GetResourcePolicyOutput) SerializeMembers ¶ added in v1.50.0
func (v *GetResourcePolicyOutput) SerializeMembers(s smithy.ShapeSerializer)
type GetSecretValueInput ¶
type GetSecretValueInput struct {
// The ARN or name of the secret to retrieve. To retrieve a secret from another
// account, you must use an ARN.
//
// For an ARN, we recommend that you specify a complete ARN rather than a partial
// ARN. See [Finding a secret from a partial ARN].
//
// [Finding a secret from a partial ARN]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
//
// This member is required.
SecretId *string
// The unique identifier of the version of the secret to retrieve. If you include
// both this parameter and VersionStage , the two parameters must refer to the same
// secret version. If you don't specify either a VersionStage or VersionId , then
// Secrets Manager returns the AWSCURRENT version.
//
// This value is typically a [UUID-type] value with 32 hexadecimal digits.
//
// [UUID-type]: https://wikipedia.org/wiki/Universally_unique_identifier
VersionId *string
// The staging label of the version of the secret to retrieve.
//
// Secrets Manager uses staging labels to keep track of different versions during
// the rotation process. If you include both this parameter and VersionId , the two
// parameters must refer to the same secret version. If you don't specify either a
// VersionStage or VersionId , Secrets Manager returns the AWSCURRENT version.
VersionStage *string
// contains filtered or unexported fields
}
func (*GetSecretValueInput) Serialize ¶ added in v1.50.0
func (v *GetSecretValueInput) Serialize(s smithy.ShapeSerializer)
func (*GetSecretValueInput) SerializeMembers ¶ added in v1.50.0
func (v *GetSecretValueInput) SerializeMembers(s smithy.ShapeSerializer)
type GetSecretValueOutput ¶
type GetSecretValueOutput struct {
// The ARN of the secret.
ARN *string
// The date and time that this version of the secret was created. If you don't
// specify which version in VersionId or VersionStage , then Secrets Manager uses
// the AWSCURRENT version.
CreatedDate *time.Time
// The friendly name of the secret.
Name *string
// The decrypted secret value, if the secret value was originally provided as
// binary data in the form of a byte array. When you retrieve a SecretBinary using
// the HTTP API, the Python SDK, or the Amazon Web Services CLI, the value is
// Base64-encoded. Otherwise, it is not encoded.
//
// If the secret was created by using the Secrets Manager console, or if the
// secret value was originally provided as a string, then this field is omitted.
// The secret value appears in SecretString instead.
//
// Sensitive: This field contains sensitive information, so the service does not
// include it in CloudTrail log entries. If you create your own log entries, you
// must also avoid logging the information in this field.
SecretBinary []byte
// The decrypted secret value, if the secret value was originally provided as a
// string or through the Secrets Manager console.
//
// If this secret was created by using the console, then Secrets Manager stores
// the information as a JSON structure of key/value pairs.
//
// Sensitive: This field contains sensitive information, so the service does not
// include it in CloudTrail log entries. If you create your own log entries, you
// must also avoid logging the information in this field.
SecretString *string
// The unique identifier of this version of the secret.
VersionId *string
// A list of all of the staging labels currently attached to this version of the
// secret.
VersionStages []string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*GetSecretValueOutput) Deserialize ¶ added in v1.50.0
func (v *GetSecretValueOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*GetSecretValueOutput) Serialize ¶ added in v1.50.0
func (v *GetSecretValueOutput) Serialize(s smithy.ShapeSerializer)
func (*GetSecretValueOutput) SerializeMembers ¶ added in v1.50.0
func (v *GetSecretValueOutput) SerializeMembers(s smithy.ShapeSerializer)
type HTTPSignerV4 ¶
type IdempotencyTokenProvider ¶
IdempotencyTokenProvider interface for providing idempotency token
type ListResourcePoliciesAPIClient ¶ added in v1.51.0
type ListResourcePoliciesAPIClient interface {
ListResourcePolicies(context.Context, *ListResourcePoliciesInput, ...func(*Options)) (*ListResourcePoliciesOutput, error)
}
ListResourcePoliciesAPIClient is a client that implements the ListResourcePolicies operation.
type ListResourcePoliciesInput ¶ added in v1.51.0
type ListResourcePoliciesInput struct {
// The ARN or name of the secret.
//
// For an ARN, we recommend that you specify a complete ARN rather than a partial
// ARN. See [Finding a secret from a partial ARN].
//
// [Finding a secret from a partial ARN]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
//
// This member is required.
SecretId *string
// The number of results to include in the response. If you don't specify this
// value, the service returns up to 100 results.
//
// If there are more results available, in the response, Secrets Manager includes
// NextToken . To get the next results, call ListResourcePolicies again with the
// value from NextToken .
MaxResults *int32
// A token that indicates where the output should continue from, if a previous
// call did not show all results. To get the next results, call
// ListResourcePolicies again with this value.
NextToken *string
// contains filtered or unexported fields
}
func (*ListResourcePoliciesInput) Serialize ¶ added in v1.51.0
func (v *ListResourcePoliciesInput) Serialize(s smithy.ShapeSerializer)
func (*ListResourcePoliciesInput) SerializeMembers ¶ added in v1.51.0
func (v *ListResourcePoliciesInput) SerializeMembers(s smithy.ShapeSerializer)
type ListResourcePoliciesOutput ¶ added in v1.51.0
type ListResourcePoliciesOutput struct {
// A list of the resource policies attached to the secret.
//
// This member is required.
ResourcePolicies []types.ResourcePolicySummary
// Secrets Manager includes this value if there's more output available than what
// is included in the current response. To get the next results, call
// ListResourcePolicies again with this value.
NextToken *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*ListResourcePoliciesOutput) Deserialize ¶ added in v1.51.0
func (v *ListResourcePoliciesOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*ListResourcePoliciesOutput) Serialize ¶ added in v1.51.0
func (v *ListResourcePoliciesOutput) Serialize(s smithy.ShapeSerializer)
func (*ListResourcePoliciesOutput) SerializeMembers ¶ added in v1.51.0
func (v *ListResourcePoliciesOutput) SerializeMembers(s smithy.ShapeSerializer)
type ListResourcePoliciesPaginator ¶ added in v1.51.0
type ListResourcePoliciesPaginator struct {
// contains filtered or unexported fields
}
ListResourcePoliciesPaginator is a paginator for ListResourcePolicies
func NewListResourcePoliciesPaginator ¶ added in v1.51.0
func NewListResourcePoliciesPaginator(client ListResourcePoliciesAPIClient, params *ListResourcePoliciesInput, optFns ...func(*ListResourcePoliciesPaginatorOptions)) *ListResourcePoliciesPaginator
NewListResourcePoliciesPaginator returns a new ListResourcePoliciesPaginator
func (*ListResourcePoliciesPaginator) HasMorePages ¶ added in v1.51.0
func (p *ListResourcePoliciesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListResourcePoliciesPaginator) NextPage ¶ added in v1.51.0
func (p *ListResourcePoliciesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListResourcePoliciesOutput, error)
NextPage retrieves the next ListResourcePolicies page.
type ListResourcePoliciesPaginatorOptions ¶ added in v1.51.0
type ListResourcePoliciesPaginatorOptions struct {
// The number of results to include in the response. If you don't specify this
// value, the service returns up to 100 results.
//
// If there are more results available, in the response, Secrets Manager includes
// NextToken . To get the next results, call ListResourcePolicies again with the
// value from NextToken .
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
ListResourcePoliciesPaginatorOptions is the paginator options for ListResourcePolicies
type ListSecretVersionIdsAPIClient ¶ added in v0.30.0
type ListSecretVersionIdsAPIClient interface {
ListSecretVersionIds(context.Context, *ListSecretVersionIdsInput, ...func(*Options)) (*ListSecretVersionIdsOutput, error)
}
ListSecretVersionIdsAPIClient is a client that implements the ListSecretVersionIds operation.
type ListSecretVersionIdsInput ¶
type ListSecretVersionIdsInput struct {
// The ARN or name of the secret whose versions you want to list.
//
// For an ARN, we recommend that you specify a complete ARN rather than a partial
// ARN. See [Finding a secret from a partial ARN].
//
// [Finding a secret from a partial ARN]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
//
// This member is required.
SecretId *string
// Specifies whether to include versions of secrets that don't have any staging
// labels attached to them. Versions without staging labels are considered
// deprecated and are subject to deletion by Secrets Manager. By default, versions
// without staging labels aren't included.
IncludeDeprecated *bool
// The number of results to include in the response.
//
// If there are more results available, in the response, Secrets Manager includes
// NextToken . To get the next results, call ListSecretVersionIds again with the
// value from NextToken .
MaxResults *int32
// A token that indicates where the output should continue from, if a previous
// call did not show all results. To get the next results, call
// ListSecretVersionIds again with this value.
NextToken *string
// contains filtered or unexported fields
}
func (*ListSecretVersionIdsInput) Serialize ¶ added in v1.50.0
func (v *ListSecretVersionIdsInput) Serialize(s smithy.ShapeSerializer)
func (*ListSecretVersionIdsInput) SerializeMembers ¶ added in v1.50.0
func (v *ListSecretVersionIdsInput) SerializeMembers(s smithy.ShapeSerializer)
type ListSecretVersionIdsOutput ¶
type ListSecretVersionIdsOutput struct {
// The ARN of the secret.
ARN *string
// The name of the secret.
Name *string
// Secrets Manager includes this value if there's more output available than what
// is included in the current response. This can occur even when the response
// includes no values at all, such as when you ask for a filtered view of a long
// list. To get the next results, call ListSecretVersionIds again with this value.
NextToken *string
// A list of the versions of the secret.
Versions []types.SecretVersionsListEntry
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*ListSecretVersionIdsOutput) Deserialize ¶ added in v1.50.0
func (v *ListSecretVersionIdsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*ListSecretVersionIdsOutput) Serialize ¶ added in v1.50.0
func (v *ListSecretVersionIdsOutput) Serialize(s smithy.ShapeSerializer)
func (*ListSecretVersionIdsOutput) SerializeMembers ¶ added in v1.50.0
func (v *ListSecretVersionIdsOutput) SerializeMembers(s smithy.ShapeSerializer)
type ListSecretVersionIdsPaginator ¶ added in v0.30.0
type ListSecretVersionIdsPaginator struct {
// contains filtered or unexported fields
}
ListSecretVersionIdsPaginator is a paginator for ListSecretVersionIds
func NewListSecretVersionIdsPaginator ¶ added in v0.30.0
func NewListSecretVersionIdsPaginator(client ListSecretVersionIdsAPIClient, params *ListSecretVersionIdsInput, optFns ...func(*ListSecretVersionIdsPaginatorOptions)) *ListSecretVersionIdsPaginator
NewListSecretVersionIdsPaginator returns a new ListSecretVersionIdsPaginator
func (*ListSecretVersionIdsPaginator) HasMorePages ¶ added in v0.30.0
func (p *ListSecretVersionIdsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListSecretVersionIdsPaginator) NextPage ¶ added in v0.30.0
func (p *ListSecretVersionIdsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSecretVersionIdsOutput, error)
NextPage retrieves the next ListSecretVersionIds page.
type ListSecretVersionIdsPaginatorOptions ¶ added in v0.30.0
type ListSecretVersionIdsPaginatorOptions struct {
// The number of results to include in the response.
//
// If there are more results available, in the response, Secrets Manager includes
// NextToken . To get the next results, call ListSecretVersionIds again with the
// value from NextToken .
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
ListSecretVersionIdsPaginatorOptions is the paginator options for ListSecretVersionIds
type ListSecretsAPIClient ¶ added in v0.30.0
type ListSecretsAPIClient interface {
ListSecrets(context.Context, *ListSecretsInput, ...func(*Options)) (*ListSecretsOutput, error)
}
ListSecretsAPIClient is a client that implements the ListSecrets operation.
type ListSecretsInput ¶
type ListSecretsInput struct {
// The filters to apply to the list of secrets.
Filters []types.Filter
// Specifies whether to include secrets scheduled for deletion. By default,
// secrets scheduled for deletion aren't included.
IncludePlannedDeletion *bool
// The number of results to include in the response.
//
// If there are more results available, in the response, Secrets Manager includes
// NextToken . To get the next results, call ListSecrets again with the value from
// NextToken .
MaxResults *int32
// A token that indicates where the output should continue from, if a previous
// call did not show all results. To get the next results, call ListSecrets again
// with this value.
NextToken *string
// If not specified, secrets are listed by CreatedDate .
SortBy types.SortByType
// Secrets are listed by CreatedDate .
SortOrder types.SortOrderType
// contains filtered or unexported fields
}
func (*ListSecretsInput) Serialize ¶ added in v1.50.0
func (v *ListSecretsInput) Serialize(s smithy.ShapeSerializer)
func (*ListSecretsInput) SerializeMembers ¶ added in v1.50.0
func (v *ListSecretsInput) SerializeMembers(s smithy.ShapeSerializer)
type ListSecretsOutput ¶
type ListSecretsOutput struct {
// Secrets Manager includes this value if there's more output available than what
// is included in the current response. This can occur even when the response
// includes no values at all, such as when you ask for a filtered view of a long
// list. To get the next results, call ListSecrets again with this value.
NextToken *string
// A list of the secrets in the account.
SecretList []types.SecretListEntry
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*ListSecretsOutput) Deserialize ¶ added in v1.50.0
func (v *ListSecretsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*ListSecretsOutput) Serialize ¶ added in v1.50.0
func (v *ListSecretsOutput) Serialize(s smithy.ShapeSerializer)
func (*ListSecretsOutput) SerializeMembers ¶ added in v1.50.0
func (v *ListSecretsOutput) SerializeMembers(s smithy.ShapeSerializer)
type ListSecretsPaginator ¶ added in v0.30.0
type ListSecretsPaginator struct {
// contains filtered or unexported fields
}
ListSecretsPaginator is a paginator for ListSecrets
func NewListSecretsPaginator ¶ added in v0.30.0
func NewListSecretsPaginator(client ListSecretsAPIClient, params *ListSecretsInput, optFns ...func(*ListSecretsPaginatorOptions)) *ListSecretsPaginator
NewListSecretsPaginator returns a new ListSecretsPaginator
func (*ListSecretsPaginator) HasMorePages ¶ added in v0.30.0
func (p *ListSecretsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListSecretsPaginator) NextPage ¶ added in v0.30.0
func (p *ListSecretsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSecretsOutput, error)
NextPage retrieves the next ListSecrets page.
type ListSecretsPaginatorOptions ¶ added in v0.30.0
type ListSecretsPaginatorOptions struct {
// The number of results to include in the response.
//
// If there are more results available, in the response, Secrets Manager includes
// NextToken . To get the next results, call ListSecrets again with the value from
// NextToken .
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
ListSecretsPaginatorOptions is the paginator options for ListSecrets
type Options ¶
type Options struct {
// Set of options to modify how an operation is invoked. These apply to all
// operations invoked for this client. Use functional options on operation call to
// modify this list for per operation behavior.
APIOptions []func(*middleware.Stack) error
// The optional application specific identifier appended to the User-Agent header.
AppID string
// This endpoint will be given as input to an EndpointResolverV2. It is used for
// providing a custom base endpoint that is subject to modifications by the
// processing EndpointResolverV2.
BaseEndpoint *string
// Configures the events that will be sent to the configured logger.
ClientLogMode aws.ClientLogMode
// The credentials object to use when signing requests.
Credentials aws.CredentialsProvider
// The configuration DefaultsMode that the SDK should use when constructing the
// clients initial default settings.
DefaultsMode aws.DefaultsMode
// Disables SDK clock skew correction. When set, the SDK will not adjust request
// signing timestamps to compensate for clock drift between the client and the
// service.
DisableClockSkewCorrection bool
// The endpoint options to be used when attempting to resolve an endpoint.
EndpointOptions EndpointResolverOptions
// The service endpoint resolver.
//
// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
// value for this field will likely prevent you from using any endpoint-related
// service features released after the introduction of EndpointResolverV2 and
// BaseEndpoint.
//
// To migrate an EndpointResolver implementation that uses a custom endpoint, set
// the client option BaseEndpoint instead.
EndpointResolver EndpointResolver
// Resolves the endpoint used for a particular service operation.
EndpointResolverV2 EndpointResolverV2
// Signature Version 4 (SigV4) Signer
HTTPSignerV4 HTTPSignerV4
// Provides idempotency tokens values that will be automatically populated into
// idempotent API operations.
IdempotencyTokenProvider IdempotencyTokenProvider
// The logger writer interface to write logging messages to.
Logger logging.Logger
// The client meter provider.
MeterProvider metrics.MeterProvider
// The region to send requests to. (Required)
Region string
// RetryMaxAttempts specifies the maximum number attempts an API client will call
// an operation that fails with a retryable error. A value of 0 is ignored, and
// will not be used to configure the API client created default retryer, or modify
// per operation call's retry max attempts.
//
// If specified in an operation call's functional options with a value that is
// different than the constructed client's Options, the Client's Retryer will be
// wrapped to use the operation's specific RetryMaxAttempts value.
RetryMaxAttempts int
// RetryMode specifies the retry mode the API client will be created with, if
// Retryer option is not also specified.
//
// When creating a new API Clients this member will only be used if the Retryer
// Options member is nil. This value will be ignored if Retryer is not nil.
//
// Currently does not support per operation call overrides, may in the future.
RetryMode aws.RetryMode
// Retryer guides how HTTP requests should be retried in case of recoverable
// failures. When nil the API client will use a default retryer. The kind of
// default retry created by the API client can be changed with the RetryMode
// option.
Retryer aws.Retryer
// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
// should not populate this structure programmatically, or rely on the values here
// within your applications.
RuntimeEnvironment aws.RuntimeEnvironment
// The client tracer provider.
TracerProvider tracing.TracerProvider
Protocol smithyhttp.ClientProtocol
// The HTTP client to invoke API calls with. Defaults to client's default HTTP
// implementation if nil.
HTTPClient HTTPClient
// Client registry of operation interceptors.
Interceptors smithyhttp.InterceptorRegistry
// The auth scheme resolver which determines how to authenticate for each
// operation.
AuthSchemeResolver AuthSchemeResolver
// The list of auth schemes supported by the client.
AuthSchemes []smithyhttp.AuthScheme
// Priority list of preferred auth scheme names (e.g. sigv4a).
AuthSchemePreference []string
// contains filtered or unexported fields
}
func (Options) GetIdentityResolver ¶ added in v1.23.2
func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver
type PutResourcePolicyInput ¶
type PutResourcePolicyInput struct {
// A JSON-formatted string for an Amazon Web Services resource-based policy. For
// example policies, see [Permissions policy examples].
//
// [Permissions policy examples]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html
//
// This member is required.
ResourcePolicy *string
// The ARN or name of the secret to attach the resource-based policy.
//
// For an ARN, we recommend that you specify a complete ARN rather than a partial
// ARN. See [Finding a secret from a partial ARN].
//
// [Finding a secret from a partial ARN]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
//
// This member is required.
SecretId *string
// Specifies whether to block resource-based policies that allow broad access to
// the secret, for example those that use a wildcard for the principal. By default,
// public policies aren't blocked.
//
// Resource policy validation and the BlockPublicPolicy parameter help protect
// your resources by preventing public access from being granted through the
// resource policies that are directly attached to your secrets. In addition to
// using these features, carefully inspect the following policies to confirm that
// they do not grant public access:
//
// - Identity-based policies attached to associated Amazon Web Services
// principals (for example, IAM roles)
//
// - Resource-based policies attached to associated Amazon Web Services
// resources (for example, Key Management Service (KMS) keys)
//
// To review permissions to your secrets, see [Determine who has permissions to your secrets].
//
// [Determine who has permissions to your secrets]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/determine-acccess_examine-iam-policies.html
BlockPublicPolicy *bool
// The name of the resource policy to attach. If you don't specify this field,
// Secrets Manager uses default . You can only attach the default policy; if you
// specify any other name, the operation returns an InvalidParameterException .
PolicyName *string
// contains filtered or unexported fields
}
func (*PutResourcePolicyInput) Serialize ¶ added in v1.50.0
func (v *PutResourcePolicyInput) Serialize(s smithy.ShapeSerializer)
func (*PutResourcePolicyInput) SerializeMembers ¶ added in v1.50.0
func (v *PutResourcePolicyInput) SerializeMembers(s smithy.ShapeSerializer)
type PutResourcePolicyOutput ¶
type PutResourcePolicyOutput struct {
// The ARN of the secret.
ARN *string
// The name of the secret.
Name *string
// The name of the resource policy. If you didn't specify PolicyName in the
// request, this is default .
PolicyName *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*PutResourcePolicyOutput) Deserialize ¶ added in v1.50.0
func (v *PutResourcePolicyOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*PutResourcePolicyOutput) Serialize ¶ added in v1.50.0
func (v *PutResourcePolicyOutput) Serialize(s smithy.ShapeSerializer)
func (*PutResourcePolicyOutput) SerializeMembers ¶ added in v1.50.0
func (v *PutResourcePolicyOutput) SerializeMembers(s smithy.ShapeSerializer)
type PutSecretValueInput ¶
type PutSecretValueInput struct {
// The ARN or name of the secret to add a new version to.
//
// For an ARN, we recommend that you specify a complete ARN rather than a partial
// ARN. See [Finding a secret from a partial ARN].
//
// If the secret doesn't already exist, use CreateSecret instead.
//
// [Finding a secret from a partial ARN]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
//
// This member is required.
SecretId *string
// A unique identifier for the new version of the secret.
//
// If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs
// to call this operation, then you can leave this parameter empty. The CLI or SDK
// generates a random UUID for you and includes it as the value for this parameter
// in the request.
//
// If you generate a raw HTTP request to the Secrets Manager service endpoint,
// then you must generate a ClientRequestToken and include it in the request.
//
// This value helps ensure idempotency. Secrets Manager uses this value to prevent
// the accidental creation of duplicate versions if there are failures and retries
// during a rotation. We recommend that you generate a [UUID-type]value to ensure uniqueness
// of your versions within the specified secret.
//
// - If the ClientRequestToken value isn't already associated with a version of
// the secret then a new version of the secret is created.
//
// - If a version with this value already exists and that version's SecretString
// or SecretBinary values are the same as those in the request then the request
// is ignored. The operation is idempotent.
//
// - If a version with this value already exists and the version of the
// SecretString and SecretBinary values are different from those in the request,
// then the request fails because you can't modify a secret version. You can only
// create new versions to store new secret values.
//
// This value becomes the VersionId of the new version.
//
// [UUID-type]: https://wikipedia.org/wiki/Universally_unique_identifier
ClientRequestToken *string
// A unique identifier that indicates the source of the request. Required for
// secret rotations using an IAM assumed role or cross-account rotation, in which
// you rotate a secret in one account by using a Lambda rotation function in
// another account. In both cases, the rotation function assumes an IAM role to
// call Secrets Manager, and then Secrets Manager validates the identity using the
// token. For more information, see [How rotation works]and [Rotation by Lambda functions].
//
// Sensitive: This field contains sensitive information, so the service does not
// include it in CloudTrail log entries. If you create your own log entries, you
// must also avoid logging the information in this field.
//
// [Rotation by Lambda functions]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_lambda
// [How rotation works]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets.html
RotationToken *string
// The binary data to encrypt and store in the new version of the secret. To use
// this parameter in the command-line tools, we recommend that you store your
// binary data in a file and then pass the contents of the file as a parameter.
//
// You must include SecretBinary or SecretString , but not both.
//
// You can't access this value from the Secrets Manager console.
//
// Sensitive: This field contains sensitive information, so the service does not
// include it in CloudTrail log entries. If you create your own log entries, you
// must also avoid logging the information in this field.
SecretBinary []byte
// The text to encrypt and store in the new version of the secret.
//
// You must include SecretBinary or SecretString , but not both.
//
// We recommend you create the secret string as JSON key/value pairs, as shown in
// the example.
//
// Sensitive: This field contains sensitive information, so the service does not
// include it in CloudTrail log entries. If you create your own log entries, you
// must also avoid logging the information in this field.
SecretString *string
// A list of staging labels to attach to this version of the secret. Secrets
// Manager uses staging labels to track versions of a secret through the rotation
// process.
//
// If you specify a staging label that's already associated with a different
// version of the same secret, then Secrets Manager removes the label from the
// other version and attaches it to this version. If you specify AWSCURRENT , and
// it is already attached to another version, then Secrets Manager also moves the
// staging label AWSPREVIOUS to the version that AWSCURRENT was removed from.
//
// If you don't include VersionStages , then Secrets Manager automatically moves
// the staging label AWSCURRENT to this version.
VersionStages []string
// contains filtered or unexported fields
}
func (*PutSecretValueInput) Serialize ¶ added in v1.50.0
func (v *PutSecretValueInput) Serialize(s smithy.ShapeSerializer)
func (*PutSecretValueInput) SerializeMembers ¶ added in v1.50.0
func (v *PutSecretValueInput) SerializeMembers(s smithy.ShapeSerializer)
type PutSecretValueOutput ¶
type PutSecretValueOutput struct {
// The ARN of the secret.
ARN *string
// The name of the secret.
Name *string
// The unique identifier of the version of the secret.
VersionId *string
// The list of staging labels that are currently attached to this version of the
// secret. Secrets Manager uses staging labels to track a version as it progresses
// through the secret rotation process.
VersionStages []string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*PutSecretValueOutput) Deserialize ¶ added in v1.50.0
func (v *PutSecretValueOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*PutSecretValueOutput) Serialize ¶ added in v1.50.0
func (v *PutSecretValueOutput) Serialize(s smithy.ShapeSerializer)
func (*PutSecretValueOutput) SerializeMembers ¶ added in v1.50.0
func (v *PutSecretValueOutput) SerializeMembers(s smithy.ShapeSerializer)
type RemoveRegionsFromReplicationInput ¶ added in v1.2.0
type RemoveRegionsFromReplicationInput struct {
// The Regions of the replicas to remove.
//
// This member is required.
RemoveReplicaRegions []string
// The ARN or name of the secret.
//
// This member is required.
SecretId *string
// contains filtered or unexported fields
}
func (*RemoveRegionsFromReplicationInput) Serialize ¶ added in v1.50.0
func (v *RemoveRegionsFromReplicationInput) Serialize(s smithy.ShapeSerializer)
func (*RemoveRegionsFromReplicationInput) SerializeMembers ¶ added in v1.50.0
func (v *RemoveRegionsFromReplicationInput) SerializeMembers(s smithy.ShapeSerializer)
type RemoveRegionsFromReplicationOutput ¶ added in v1.2.0
type RemoveRegionsFromReplicationOutput struct {
// The ARN of the primary secret.
ARN *string
// The status of replicas for this secret after you remove Regions.
ReplicationStatus []types.ReplicationStatusType
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*RemoveRegionsFromReplicationOutput) Deserialize ¶ added in v1.50.0
func (v *RemoveRegionsFromReplicationOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*RemoveRegionsFromReplicationOutput) Serialize ¶ added in v1.50.0
func (v *RemoveRegionsFromReplicationOutput) Serialize(s smithy.ShapeSerializer)
func (*RemoveRegionsFromReplicationOutput) SerializeMembers ¶ added in v1.50.0
func (v *RemoveRegionsFromReplicationOutput) SerializeMembers(s smithy.ShapeSerializer)
type ReplicateSecretToRegionsInput ¶ added in v1.2.0
type ReplicateSecretToRegionsInput struct {
// A list of Regions in which to replicate the secret.
//
// This member is required.
AddReplicaRegions []types.ReplicaRegionType
// The ARN or name of the secret to replicate.
//
// This member is required.
SecretId *string
// Specifies whether to overwrite a secret with the same name in the destination
// Region. By default, secrets aren't overwritten.
ForceOverwriteReplicaSecret bool
// contains filtered or unexported fields
}
func (*ReplicateSecretToRegionsInput) Serialize ¶ added in v1.50.0
func (v *ReplicateSecretToRegionsInput) Serialize(s smithy.ShapeSerializer)
func (*ReplicateSecretToRegionsInput) SerializeMembers ¶ added in v1.50.0
func (v *ReplicateSecretToRegionsInput) SerializeMembers(s smithy.ShapeSerializer)
type ReplicateSecretToRegionsOutput ¶ added in v1.2.0
type ReplicateSecretToRegionsOutput struct {
// The ARN of the primary secret.
ARN *string
// The status of replication.
ReplicationStatus []types.ReplicationStatusType
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*ReplicateSecretToRegionsOutput) Deserialize ¶ added in v1.50.0
func (v *ReplicateSecretToRegionsOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*ReplicateSecretToRegionsOutput) Serialize ¶ added in v1.50.0
func (v *ReplicateSecretToRegionsOutput) Serialize(s smithy.ShapeSerializer)
func (*ReplicateSecretToRegionsOutput) SerializeMembers ¶ added in v1.50.0
func (v *ReplicateSecretToRegionsOutput) SerializeMembers(s smithy.ShapeSerializer)
type ResolveEndpoint ¶
type ResolveEndpoint struct {
Resolver EndpointResolver
Options EndpointResolverOptions
}
func (*ResolveEndpoint) HandleSerialize ¶
func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
func (*ResolveEndpoint) ID ¶
func (*ResolveEndpoint) ID() string
type RestoreSecretInput ¶
type RestoreSecretInput struct {
// The ARN or name of the secret to restore.
//
// For an ARN, we recommend that you specify a complete ARN rather than a partial
// ARN. See [Finding a secret from a partial ARN].
//
// [Finding a secret from a partial ARN]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
//
// This member is required.
SecretId *string
// contains filtered or unexported fields
}
func (*RestoreSecretInput) Serialize ¶ added in v1.50.0
func (v *RestoreSecretInput) Serialize(s smithy.ShapeSerializer)
func (*RestoreSecretInput) SerializeMembers ¶ added in v1.50.0
func (v *RestoreSecretInput) SerializeMembers(s smithy.ShapeSerializer)
type RestoreSecretOutput ¶
type RestoreSecretOutput struct {
// The ARN of the secret that was restored.
ARN *string
// The name of the secret that was restored.
Name *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*RestoreSecretOutput) Deserialize ¶ added in v1.50.0
func (v *RestoreSecretOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*RestoreSecretOutput) Serialize ¶ added in v1.50.0
func (v *RestoreSecretOutput) Serialize(s smithy.ShapeSerializer)
func (*RestoreSecretOutput) SerializeMembers ¶ added in v1.50.0
func (v *RestoreSecretOutput) SerializeMembers(s smithy.ShapeSerializer)
type RotateSecretInput ¶
type RotateSecretInput struct {
// The ARN or name of the secret to rotate.
//
// For an ARN, we recommend that you specify a complete ARN rather than a partial
// ARN. See [Finding a secret from a partial ARN].
//
// [Finding a secret from a partial ARN]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
//
// This member is required.
SecretId *string
// A unique identifier for the new version of the secret. You only need to specify
// this value if you implement your own retry logic and you want to ensure that
// Secrets Manager doesn't attempt to create a secret version twice.
//
// If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs
// to call this operation, then you can leave this parameter empty. The CLI or SDK
// generates a random UUID for you and includes it as the value for this parameter
// in the request.
//
// If you generate a raw HTTP request to the Secrets Manager service endpoint,
// then you must generate a ClientRequestToken and include it in the request.
//
// This value helps ensure idempotency. Secrets Manager uses this value to prevent
// the accidental creation of duplicate versions if there are failures and retries
// during a rotation. We recommend that you generate a [UUID-type]value to ensure uniqueness
// of your versions within the specified secret.
//
// [UUID-type]: https://wikipedia.org/wiki/Universally_unique_identifier
ClientRequestToken *string
// The metadata needed to successfully rotate a managed external secret. A list of
// key value pairs in JSON format specified by the partner. For more information
// about the required information, see [Using Secrets Manager managed external secrets]
//
// [Using Secrets Manager managed external secrets]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/managed-external-secrets.html
ExternalSecretRotationMetadata []types.ExternalSecretRotationMetadataItem
// The Amazon Resource Name (ARN) of the role that allows Secrets Manager to
// rotate a secret held by a third-party partner. For more information, see [Security and permissions].
//
// [Security and permissions]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/mes-security.html
ExternalSecretRotationRoleArn *string
// Specifies whether to rotate the secret immediately or wait until the next
// scheduled rotation window. The rotation schedule is defined in RotateSecretRequest$RotationRules.
//
// The default for RotateImmediately is true . If you don't specify this value,
// Secrets Manager rotates the secret immediately.
//
// If you set RotateImmediately to false , Secrets Manager tests the rotation
// configuration by running the [testSecret step]testSecret of the Lambda rotation function. This
// test creates an AWSPENDING version of the secret and then removes it.
//
// When changing an existing rotation schedule and setting RotateImmediately to
// false :
//
// - If using AutomaticallyAfterDays or a ScheduleExpression with rate() , the
// previously scheduled rotation might still occur.
//
// - To prevent unintended rotations, use a ScheduleExpression with cron() for
// granular control over rotation windows.
//
// Rotation is an asynchronous process. For more information, see [How rotation works].
//
// [How rotation works]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_how.html
// [testSecret step]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_how.html
RotateImmediately *bool
// For secrets that use a Lambda rotation function to rotate, the ARN of the
// Lambda rotation function.
//
// For secrets that use managed rotation, omit this field. For more information,
// see [Managed rotation]in the Secrets Manager User Guide.
//
// [Managed rotation]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotate-secrets_managed.html
RotationLambdaARN *string
// A structure that defines the rotation configuration for this secret.
//
// When changing an existing rotation schedule and setting RotateImmediately to
// false :
//
// - If using AutomaticallyAfterDays or a ScheduleExpression with rate() , the
// previously scheduled rotation might still occur.
//
// - To prevent unintended rotations, use a ScheduleExpression with cron() for
// granular control over rotation windows.
RotationRules *types.RotationRulesType
// contains filtered or unexported fields
}
func (*RotateSecretInput) Serialize ¶ added in v1.50.0
func (v *RotateSecretInput) Serialize(s smithy.ShapeSerializer)
func (*RotateSecretInput) SerializeMembers ¶ added in v1.50.0
func (v *RotateSecretInput) SerializeMembers(s smithy.ShapeSerializer)
type RotateSecretOutput ¶
type RotateSecretOutput struct {
// The ARN of the secret.
ARN *string
// The name of the secret.
Name *string
// The ID of the new version of the secret.
VersionId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*RotateSecretOutput) Deserialize ¶ added in v1.50.0
func (v *RotateSecretOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*RotateSecretOutput) Serialize ¶ added in v1.50.0
func (v *RotateSecretOutput) Serialize(s smithy.ShapeSerializer)
func (*RotateSecretOutput) SerializeMembers ¶ added in v1.50.0
func (v *RotateSecretOutput) SerializeMembers(s smithy.ShapeSerializer)
type StopReplicationToReplicaInput ¶ added in v1.2.0
type StopReplicationToReplicaInput struct {
// The ARN or name of the replica secret.
//
// For a cross-region replica, the replica ARN is the same as the original primary
// secret ARN except that the Region is changed to the replica Region. For a
// cross-account replica, this is the ARN or name of the replica secret in your
// account.
//
// This member is required.
SecretId *string
// contains filtered or unexported fields
}
func (*StopReplicationToReplicaInput) Serialize ¶ added in v1.50.0
func (v *StopReplicationToReplicaInput) Serialize(s smithy.ShapeSerializer)
func (*StopReplicationToReplicaInput) SerializeMembers ¶ added in v1.50.0
func (v *StopReplicationToReplicaInput) SerializeMembers(s smithy.ShapeSerializer)
type StopReplicationToReplicaOutput ¶ added in v1.2.0
type StopReplicationToReplicaOutput struct {
// The ARN of the promoted secret. For a cross-region replica, this ARN is the
// same as the original primary secret's ARN except that the Region is changed. For
// a cross-account replica, this is the ARN of the promoted secret in your account.
ARN *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*StopReplicationToReplicaOutput) Deserialize ¶ added in v1.50.0
func (v *StopReplicationToReplicaOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*StopReplicationToReplicaOutput) Serialize ¶ added in v1.50.0
func (v *StopReplicationToReplicaOutput) Serialize(s smithy.ShapeSerializer)
func (*StopReplicationToReplicaOutput) SerializeMembers ¶ added in v1.50.0
func (v *StopReplicationToReplicaOutput) SerializeMembers(s smithy.ShapeSerializer)
type TagResourceInput ¶
type TagResourceInput struct {
// The identifier for the secret to attach tags to. You can specify either the
// Amazon Resource Name (ARN) or the friendly name of the secret.
//
// For an ARN, we recommend that you specify a complete ARN rather than a partial
// ARN. See [Finding a secret from a partial ARN].
//
// [Finding a secret from a partial ARN]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
//
// This member is required.
SecretId *string
// The tags to attach to the secret as a JSON text string argument. Each element
// in the list consists of a Key and a Value .
//
// For storing multiple values, we recommend that you use a JSON text string
// argument and specify key/value pairs. For more information, see [Specifying parameter values for the Amazon Web Services CLI]in the Amazon
// Web Services CLI User Guide.
//
// [Specifying parameter values for the Amazon Web Services CLI]: https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters.html
//
// This member is required.
Tags []types.Tag
// contains filtered or unexported fields
}
func (*TagResourceInput) Serialize ¶ added in v1.50.0
func (v *TagResourceInput) Serialize(s smithy.ShapeSerializer)
func (*TagResourceInput) SerializeMembers ¶ added in v1.50.0
func (v *TagResourceInput) SerializeMembers(s smithy.ShapeSerializer)
type TagResourceOutput ¶
type TagResourceOutput struct {
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*TagResourceOutput) Deserialize ¶ added in v1.50.0
func (v *TagResourceOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*TagResourceOutput) Serialize ¶ added in v1.50.0
func (v *TagResourceOutput) Serialize(s smithy.ShapeSerializer)
func (*TagResourceOutput) SerializeMembers ¶ added in v1.50.0
func (v *TagResourceOutput) SerializeMembers(s smithy.ShapeSerializer)
type UntagResourceInput ¶
type UntagResourceInput struct {
// The ARN or name of the secret.
//
// For an ARN, we recommend that you specify a complete ARN rather than a partial
// ARN. See [Finding a secret from a partial ARN].
//
// [Finding a secret from a partial ARN]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
//
// This member is required.
SecretId *string
// A list of tag key names to remove from the secret. You don't specify the value.
// Both the key and its associated value are removed.
//
// This parameter requires a JSON text string argument.
//
// For storing multiple values, we recommend that you use a JSON text string
// argument and specify key/value pairs. For more information, see [Specifying parameter values for the Amazon Web Services CLI]in the Amazon
// Web Services CLI User Guide.
//
// [Specifying parameter values for the Amazon Web Services CLI]: https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters.html
//
// This member is required.
TagKeys []string
// contains filtered or unexported fields
}
func (*UntagResourceInput) Serialize ¶ added in v1.50.0
func (v *UntagResourceInput) Serialize(s smithy.ShapeSerializer)
func (*UntagResourceInput) SerializeMembers ¶ added in v1.50.0
func (v *UntagResourceInput) SerializeMembers(s smithy.ShapeSerializer)
type UntagResourceOutput ¶
type UntagResourceOutput struct {
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UntagResourceOutput) Deserialize ¶ added in v1.50.0
func (v *UntagResourceOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UntagResourceOutput) Serialize ¶ added in v1.50.0
func (v *UntagResourceOutput) Serialize(s smithy.ShapeSerializer)
func (*UntagResourceOutput) SerializeMembers ¶ added in v1.50.0
func (v *UntagResourceOutput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateSecretInput ¶
type UpdateSecretInput struct {
// The ARN or name of the secret.
//
// For an ARN, we recommend that you specify a complete ARN rather than a partial
// ARN. See [Finding a secret from a partial ARN].
//
// [Finding a secret from a partial ARN]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
//
// This member is required.
SecretId *string
// If you include SecretString or SecretBinary , then Secrets Manager creates a new
// version for the secret, and this parameter specifies the unique identifier for
// the new version.
//
// If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs
// to call this operation, then you can leave this parameter empty. The CLI or SDK
// generates a random UUID for you and includes it as the value for this parameter
// in the request.
//
// If you generate a raw HTTP request to the Secrets Manager service endpoint,
// then you must generate a ClientRequestToken and include it in the request.
//
// This value helps ensure idempotency. Secrets Manager uses this value to prevent
// the accidental creation of duplicate versions if there are failures and retries
// during a rotation. We recommend that you generate a [UUID-type]value to ensure uniqueness
// of your versions within the specified secret.
//
// [UUID-type]: https://wikipedia.org/wiki/Universally_unique_identifier
ClientRequestToken *string
// The description of the secret.
Description *string
// The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt
// new secret versions as well as any existing versions with the staging labels
// AWSCURRENT , AWSPENDING , or AWSPREVIOUS . If you don't have kms:Encrypt
// permission to the new key, Secrets Manager does not re-encrypt existing secret
// versions with the new key. For more information about versions and staging
// labels, see [Concepts: Version].
//
// A key alias is always prefixed by alias/ , for example alias/aws/secretsmanager
// . For more information, see [About aliases].
//
// If you set this to an empty string, Secrets Manager uses the Amazon Web
// Services managed key aws/secretsmanager . If this key doesn't already exist in
// your account, then Secrets Manager creates it for you automatically. All users
// and roles in the Amazon Web Services account automatically have access to use
// aws/secretsmanager . Creating aws/secretsmanager can result in a one-time
// significant delay in returning the result.
//
// You can only use the Amazon Web Services managed key aws/secretsmanager if you
// call this operation using credentials from the same Amazon Web Services account
// that owns the secret. If the secret is in a different account, then you must use
// a customer managed key and provide the ARN of that KMS key in this field. The
// user making the call must have permissions to both the secret and the KMS key in
// their respective accounts.
//
// [Concepts: Version]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/getting-started.html#term_version
// [About aliases]: https://docs.aws.amazon.com/kms/latest/developerguide/alias-about.html
KmsKeyId *string
// The binary data to encrypt and store in the new version of the secret. We
// recommend that you store your binary data in a file and then pass the contents
// of the file as a parameter.
//
// Either SecretBinary or SecretString must have a value, but not both.
//
// You can't access this parameter in the Secrets Manager console.
//
// Sensitive: This field contains sensitive information, so the service does not
// include it in CloudTrail log entries. If you create your own log entries, you
// must also avoid logging the information in this field.
SecretBinary []byte
// The text data to encrypt and store in the new version of the secret. We
// recommend you use a JSON structure of key/value pairs for your secret value.
//
// Either SecretBinary or SecretString must have a value, but not both.
//
// Sensitive: This field contains sensitive information, so the service does not
// include it in CloudTrail log entries. If you create your own log entries, you
// must also avoid logging the information in this field.
SecretString *string
// The exact string that identifies the third-party partner that holds the
// external secret. For more information, see [Managed external secret partners].
//
// [Managed external secret partners]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/mes-partners.html
Type *string
// contains filtered or unexported fields
}
func (*UpdateSecretInput) Serialize ¶ added in v1.50.0
func (v *UpdateSecretInput) Serialize(s smithy.ShapeSerializer)
func (*UpdateSecretInput) SerializeMembers ¶ added in v1.50.0
func (v *UpdateSecretInput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateSecretOutput ¶
type UpdateSecretOutput struct {
// The ARN of the secret that was updated.
ARN *string
// The name of the secret that was updated.
Name *string
// If Secrets Manager created a new version of the secret during this operation,
// then VersionId contains the unique identifier of the new version.
VersionId *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateSecretOutput) Deserialize ¶ added in v1.50.0
func (v *UpdateSecretOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateSecretOutput) Serialize ¶ added in v1.50.0
func (v *UpdateSecretOutput) Serialize(s smithy.ShapeSerializer)
func (*UpdateSecretOutput) SerializeMembers ¶ added in v1.50.0
func (v *UpdateSecretOutput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateSecretVersionStageInput ¶
type UpdateSecretVersionStageInput struct {
// The ARN or the name of the secret with the version and staging labelsto modify.
//
// For an ARN, we recommend that you specify a complete ARN rather than a partial
// ARN. See [Finding a secret from a partial ARN].
//
// [Finding a secret from a partial ARN]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen
//
// This member is required.
SecretId *string
// The staging label to add to this version.
//
// This member is required.
VersionStage *string
// The ID of the version to add the staging label to. To remove a label from a
// version, then do not specify this parameter.
//
// If the staging label is already attached to a different version of the secret,
// then you must also specify the RemoveFromVersionId parameter.
MoveToVersionId *string
// The ID of the version that the staging label is to be removed from. If the
// staging label you are trying to attach to one version is already attached to a
// different version, then you must include this parameter and specify the version
// that the label is to be removed from. If the label is attached and you either do
// not specify this parameter, or the version ID does not match, then the operation
// fails.
RemoveFromVersionId *string
// contains filtered or unexported fields
}
func (*UpdateSecretVersionStageInput) Serialize ¶ added in v1.50.0
func (v *UpdateSecretVersionStageInput) Serialize(s smithy.ShapeSerializer)
func (*UpdateSecretVersionStageInput) SerializeMembers ¶ added in v1.50.0
func (v *UpdateSecretVersionStageInput) SerializeMembers(s smithy.ShapeSerializer)
type UpdateSecretVersionStageOutput ¶
type UpdateSecretVersionStageOutput struct {
// The ARN of the secret that was updated.
ARN *string
// The name of the secret that was updated.
Name *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*UpdateSecretVersionStageOutput) Deserialize ¶ added in v1.50.0
func (v *UpdateSecretVersionStageOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*UpdateSecretVersionStageOutput) Serialize ¶ added in v1.50.0
func (v *UpdateSecretVersionStageOutput) Serialize(s smithy.ShapeSerializer)
func (*UpdateSecretVersionStageOutput) SerializeMembers ¶ added in v1.50.0
func (v *UpdateSecretVersionStageOutput) SerializeMembers(s smithy.ShapeSerializer)
type ValidateResourcePolicyInput ¶
type ValidateResourcePolicyInput struct {
// A JSON-formatted string that contains an Amazon Web Services resource-based
// policy. The policy in the string identifies who can access or manage this secret
// and its versions. For example policies, see [Permissions policy examples].
//
// [Permissions policy examples]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html
//
// This member is required.
ResourcePolicy *string
// The ARN or name of the secret with the resource-based policy you want to
// validate.
SecretId *string
// contains filtered or unexported fields
}
func (*ValidateResourcePolicyInput) Serialize ¶ added in v1.50.0
func (v *ValidateResourcePolicyInput) Serialize(s smithy.ShapeSerializer)
func (*ValidateResourcePolicyInput) SerializeMembers ¶ added in v1.50.0
func (v *ValidateResourcePolicyInput) SerializeMembers(s smithy.ShapeSerializer)
type ValidateResourcePolicyOutput ¶
type ValidateResourcePolicyOutput struct {
// True if your policy passes validation, otherwise false.
PolicyValidationPassed bool
// Validation errors if your policy didn't pass validation.
ValidationErrors []types.ValidationErrorsEntry
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
// contains filtered or unexported fields
}
func (*ValidateResourcePolicyOutput) Deserialize ¶ added in v1.50.0
func (v *ValidateResourcePolicyOutput) Deserialize(d smithy.ShapeDeserializer) error
func (*ValidateResourcePolicyOutput) Serialize ¶ added in v1.50.0
func (v *ValidateResourcePolicyOutput) Serialize(s smithy.ShapeSerializer)
func (*ValidateResourcePolicyOutput) SerializeMembers ¶ added in v1.50.0
func (v *ValidateResourcePolicyOutput) SerializeMembers(s smithy.ShapeSerializer)
Source Files
¶
- api_client.go
- api_op_AssociateCrossAccountReplica.go
- api_op_BatchGetSecretValue.go
- api_op_CancelRotateSecret.go
- api_op_CreateSecret.go
- api_op_DeleteResourcePolicy.go
- api_op_DeleteSecret.go
- api_op_DescribeSecret.go
- api_op_DisassociateCrossAccountReplica.go
- api_op_GetRandomPassword.go
- api_op_GetResourcePolicy.go
- api_op_GetSecretValue.go
- api_op_ListResourcePolicies.go
- api_op_ListSecretVersionIds.go
- api_op_ListSecrets.go
- api_op_PutResourcePolicy.go
- api_op_PutSecretValue.go
- api_op_RemoveRegionsFromReplication.go
- api_op_ReplicateSecretToRegions.go
- api_op_RestoreSecret.go
- api_op_RotateSecret.go
- api_op_StopReplicationToReplica.go
- api_op_TagResource.go
- api_op_UntagResource.go
- api_op_UpdateSecret.go
- api_op_UpdateSecretVersionStage.go
- api_op_ValidateResourcePolicy.go
- auth.go
- common_serde.go
- doc.go
- endpoints.go
- go_module_metadata.go
- options.go
- type_registry.go
- validators.go