Class: Aws::AccessAnalyzer::Types::SecretsManagerSecretConfiguration

Inherits:

Struct

Object
Struct
Aws::AccessAnalyzer::Types::SecretsManagerSecretConfiguration

show all

Includes:: Structure

Defined in:: lib/aws-sdk-accessanalyzer/types.rb

Overview

The configuration for a Secrets Manager secret. For more information, see [CreateSecret].

You can propose a configuration for a new secret or an existing secret that you own by specifying the secret policy and optional KMS encryption key. If the configuration is for an existing secret and you do not specify the secret policy, the access preview uses the existing policy for the secret. If the access preview is for a new resource and you do not specify the policy, the access preview assumes a secret without a policy. To propose deletion of an existing policy, you can specify an empty string. If the proposed configuration is for a new secret and you do not specify the KMS key ID, the access preview uses the Amazon Web Services managed key ‘aws/secretsmanager`. If you specify an empty string for the KMS key ID, the access preview uses the Amazon Web Services managed key of the Amazon Web Services account. For more information about secret policy limits, see [Quotas for Secrets Manager.].

[1]: docs.aws.amazon.com/secretsmanager/latest/apireference/API_CreateSecret.html [2]: docs.aws.amazon.com/secretsmanager/latest/userguide/reference_limits.html

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#kms_key_id ⇒ String

The proposed ARN, key ID, or alias of the KMS key.
#secret_policy ⇒ String

The proposed resource policy defining who can access or manage the secret.

Instance Attribute Details

#kms_key_id ⇒ `String`

The proposed ARN, key ID, or alias of the KMS key.

Returns:

(String)

# File 'lib/aws-sdk-accessanalyzer/types.rb', line 3706

class SecretsManagerSecretConfiguration < Struct.new(
  :kms_key_id,
  :secret_policy)
  SENSITIVE = []
  include Aws::Structure
end

#secret_policy ⇒ `String`

The proposed resource policy defining who can access or manage the secret.