Package software.amazon.awscdk.services.secretsmanager

Class SecretAttributes.Builder

java.lang.Object
software.amazon.awscdk.services.secretsmanager.SecretAttributes.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<SecretAttributes>
Enclosing interface:
SecretAttributes
@Stability(Stable) public static final class SecretAttributes.Builder extends Object implements software.amazon.jsii.Builder<SecretAttributes>
A builder for SecretAttributes

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • encryptionKey

      @Stability(Stable) public SecretAttributes.Builder encryptionKey(IKey encryptionKey)
      Sets the value of SecretAttributes.getEncryptionKey()
      Parameters:
      encryptionKey - The encryption key that is used to encrypt the secret, unless the default SecretsManager key is used.
      Returns:
      this

    • secretArn

      @Stability(Deprecated) @Deprecated public SecretAttributes.Builder secretArn(String secretArn)
      Deprecated.
      use `secretCompleteArn` or `secretPartialArn` instead.
      Sets the value of SecretAttributes.getSecretArn()
      Parameters:
      secretArn - The ARN of the secret in SecretsManager. Cannot be used with secretCompleteArn or secretPartialArn.
      Returns:
      this

    • secretCompleteArn

      @Stability(Stable) public SecretAttributes.Builder secretCompleteArn(String secretCompleteArn)
      Sets the value of SecretAttributes.getSecretCompleteArn()
      Parameters:
      secretCompleteArn - The complete ARN of the secret in SecretsManager. This is the ARN including the Secrets Manager 6-character suffix. Cannot be used with secretArn or secretPartialArn.
      Returns:
      this

    • secretPartialArn

      @Stability(Stable) public SecretAttributes.Builder secretPartialArn(String secretPartialArn)
      Sets the value of SecretAttributes.getSecretPartialArn()
      Parameters:
      secretPartialArn - The partial ARN of the secret in SecretsManager. This is the ARN without the Secrets Manager 6-character suffix. Cannot be used with secretArn or secretCompleteArn.
      Returns:
      this

    • build

      @Stability(Stable) public SecretAttributes build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<SecretAttributes>
      Returns:
      a new instance of SecretAttributes
      Throws:
      NullPointerException - if any required attribute was not provided