java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.secretsmanager.CfnSecretPropsMixin.Builder

All Implemented Interfaces:: software.amazon.jsii.Builder<CfnSecretPropsMixin>

Enclosing class:: CfnSecretPropsMixin

@Stability(Stable) public static final class CfnSecretPropsMixin.Builder extends Object implements software.amazon.jsii.Builder<CfnSecretPropsMixin>

A fluent builder for CfnSecretPropsMixin.

Method Summary

Modifier and Type

Method

Description

CfnSecretPropsMixin

build()

static CfnSecretPropsMixin.Builder

create()

static CfnSecretPropsMixin.Builder

create(CfnPropertyMixinOptions options)

CfnSecretPropsMixin.Builder

description(String description)

The description of the secret.

CfnSecretPropsMixin.Builder

generateSecretString(CfnSecretPropsMixin.GenerateSecretStringProperty generateSecretString)

A structure that specifies how to generate a password to encrypt and store in the secret.

CfnSecretPropsMixin.Builder

generateSecretString(IResolvable generateSecretString)

A structure that specifies how to generate a password to encrypt and store in the secret.

CfnSecretPropsMixin.Builder

kmsKeyId(String kmsKeyId)

The ARN, key ID, or alias of the AWS key that Secrets Manager uses to encrypt the secret value in the secret.

CfnSecretPropsMixin.Builder

kmsKeyId(IKeyRef kmsKeyId)

The ARN, key ID, or alias of the AWS key that Secrets Manager uses to encrypt the secret value in the secret.

CfnSecretPropsMixin.Builder

name(String name)

The name of the new secret.

CfnSecretPropsMixin.Builder

replicaRegions(List<? extends Object> replicaRegions)

A custom type that specifies a Region and the KmsKeyId for a replica secret.

CfnSecretPropsMixin.Builder

replicaRegions(IResolvable replicaRegions)

A custom type that specifies a Region and the KmsKeyId for a replica secret.

CfnSecretPropsMixin.Builder

secretString(String secretString)

The text to encrypt and store in the secret.

CfnSecretPropsMixin.Builder

tags(List<? extends CfnTag> tags)

A list of tags to attach to the secret.

CfnSecretPropsMixin.Builder

type(String type)

The exact string that identifies the third-party partner that holds the external secret.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details
- create
  
  @Stability(Stable) public static CfnSecretPropsMixin.Builder create(CfnPropertyMixinOptions options)
  
  Parameters:
  
  options - Mixin options.
  
  Returns:
  
  a new instance of CfnSecretPropsMixin.Builder.
- create
  
  @Stability(Stable) public static CfnSecretPropsMixin.Builder create()
  
  Returns:
  
  a new instance of CfnSecretPropsMixin.Builder.
- description
  
  @Stability(Stable) public CfnSecretPropsMixin.Builder description(String description)
  
  The description of the secret.
  Parameters:
  
  description - The description of the secret. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secret.html#cfn-secretsmanager-secret-description
- generateSecretString
  
  @Stability(Stable) public CfnSecretPropsMixin.Builder generateSecretString(IResolvable generateSecretString)
  
  A structure that specifies how to generate a password to encrypt and store in the secret.
  To include a specific string in the secret, use SecretString instead. If you omit both GenerateSecretString and SecretString , you create an empty secret. When you make a change to this property, a new secret version is created.
  We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support.
  Parameters:
  
  generateSecretString - A structure that specifies how to generate a password to encrypt and store in the secret. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secret.html#cfn-secretsmanager-secret-generatesecretstring
- generateSecretString
  
  @Stability(Stable) public CfnSecretPropsMixin.Builder generateSecretString(CfnSecretPropsMixin.GenerateSecretStringProperty generateSecretString)
  
  A structure that specifies how to generate a password to encrypt and store in the secret.
  To include a specific string in the secret, use SecretString instead. If you omit both GenerateSecretString and SecretString , you create an empty secret. When you make a change to this property, a new secret version is created.
  We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support.
  Parameters:
  
  generateSecretString - A structure that specifies how to generate a password to encrypt and store in the secret. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secret.html#cfn-secretsmanager-secret-generatesecretstring
- kmsKeyId
  
  @Stability(Stable) public CfnSecretPropsMixin.Builder kmsKeyId(String kmsKeyId)
  
  The ARN, key ID, or alias of the AWS 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 AWS 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 AWS 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 AWS key.
  Parameters:
  
  kmsKeyId - The ARN, key ID, or alias of the AWS key that Secrets Manager uses to encrypt the secret value in the secret. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secret.html#cfn-secretsmanager-secret-kmskeyid
- kmsKeyId
  
  @Stability(Stable) public CfnSecretPropsMixin.Builder kmsKeyId(IKeyRef kmsKeyId)
  
  The ARN, key ID, or alias of the AWS 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 AWS 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 AWS 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 AWS key.
  Parameters:
  
  kmsKeyId - The ARN, key ID, or alias of the AWS key that Secrets Manager uses to encrypt the secret value in the secret. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secret.html#cfn-secretsmanager-secret-kmskeyid
- name
  
  @Stability(Stable) public CfnSecretPropsMixin.Builder name(String name)
  
  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.
  Parameters:
  
  name - The name of the new secret. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secret.html#cfn-secretsmanager-secret-name
- replicaRegions
  
  @Stability(Stable) public CfnSecretPropsMixin.Builder replicaRegions(IResolvable replicaRegions)
  
  A custom type that specifies a Region and the KmsKeyId for a replica secret.
  Parameters:
  
  replicaRegions - A custom type that specifies a Region and the KmsKeyId for a replica secret. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secret.html#cfn-secretsmanager-secret-replicaregions
- replicaRegions
  
  @Stability(Stable) public CfnSecretPropsMixin.Builder replicaRegions(List<? extends Object> replicaRegions)
  
  A custom type that specifies a Region and the KmsKeyId for a replica secret.
  Parameters:
  
  replicaRegions - A custom type that specifies a Region and the KmsKeyId for a replica secret. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secret.html#cfn-secretsmanager-secret-replicaregions
- secretString
  
  @Stability(Stable) public CfnSecretPropsMixin.Builder secretString(String secretString)
  
  The text to encrypt and store in the secret.
  We recommend you use a JSON structure of key/value pairs for your secret value. To generate a random password, use GenerateSecretString instead. If you omit both GenerateSecretString and SecretString , you create an empty secret. When you make a change to this property, a new secret version is created.
  Parameters:
  
  secretString - The text to encrypt and store in the secret. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secret.html#cfn-secretsmanager-secret-secretstring
- tags
  
  @Stability(Stable) public CfnSecretPropsMixin.Builder tags(List<? extends CfnTag> tags)
  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".
  Stack-level tags, tags you apply to the CloudFormation stack, are also attached to the secret.
  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.
  The following restrictions apply to tags:
  
  Maximum number of tags per secret: 50
  
  Maximum key length: 127 Unicode characters in UTF-8
  
  Maximum value length: 255 Unicode characters in UTF-8
  
  Tag keys and values are case sensitive.
  
  Do not use the aws: prefix in your tag names or values because AWS reserves it for AWS use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.
  
  If you use your tagging schema across multiple services and resources, other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : /
  Parameters:
  
  tags - A list of tags to attach to the secret. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secret.html#cfn-secretsmanager-secret-tags
- type
  
  @Stability(Stable) public CfnSecretPropsMixin.Builder type(String type)
  
  The exact string that identifies the third-party partner that holds the external secret.
  For more information, see Managed external secret partners .
  Parameters:
  
  type - The exact string that identifies the third-party partner that holds the external secret. This parameter is required.
  
  Returns:
  
  this
  
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-secretsmanager-secret.html#cfn-secretsmanager-secret-type
- build
  
  @Stability(Stable) public CfnSecretPropsMixin build()
  
  Specified by:
  
  build in interface software.amazon.jsii.Builder<CfnSecretPropsMixin>
  
  Returns:
  
  a newly built instance of CfnSecretPropsMixin.

Class CfnSecretPropsMixin.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Details

create

create

description

generateSecretString

generateSecretString

kmsKeyId

kmsKeyId

name

replicaRegions

replicaRegions

secretString

tags

type

build