SecretAttributes¶
-
class
aws_cdk.aws_secretsmanager.
SecretAttributes
(*, encryption_key=None, secret_arn=None, secret_complete_arn=None, secret_partial_arn=None)¶ Bases:
object
Attributes required to import an existing secret into the Stack.
One ARN format (
secretArn
,secretCompleteArn
,secretPartialArn
) must be provided.- Parameters
encryption_key (
Optional
[IKey
]) – The encryption key that is used to encrypt the secret, unless the default SecretsManager key is used.secret_arn (
Optional
[str
]) – (deprecated) The ARN of the secret in SecretsManager. Cannot be used withsecretCompleteArn
orsecretPartialArn
.secret_complete_arn (
Optional
[str
]) – The complete ARN of the secret in SecretsManager. This is the ARN including the Secrets Manager 6-character suffix. Cannot be used withsecretArn
orsecretPartialArn
.secret_partial_arn (
Optional
[str
]) – The partial ARN of the secret in SecretsManager. This is the ARN without the Secrets Manager 6-character suffix. Cannot be used withsecretArn
orsecretCompleteArn
.
Attributes
-
encryption_key
¶ The encryption key that is used to encrypt the secret, unless the default SecretsManager key is used.
- Return type
Optional
[IKey
]
-
secret_arn
¶ (deprecated) The ARN of the secret in SecretsManager.
Cannot be used with
secretCompleteArn
orsecretPartialArn
.- Deprecated
use
secretCompleteArn
orsecretPartialArn
instead.- Stability
deprecated
- Return type
Optional
[str
]
-
secret_complete_arn
¶ The complete ARN of the secret in SecretsManager.
This is the ARN including the Secrets Manager 6-character suffix. Cannot be used with
secretArn
orsecretPartialArn
.- Return type
Optional
[str
]
-
secret_partial_arn
¶ The partial ARN of the secret in SecretsManager.
This is the ARN without the Secrets Manager 6-character suffix. Cannot be used with
secretArn
orsecretCompleteArn
.- Return type
Optional
[str
]