Package software.amazon.awscdk

Class SecretsManagerSecretOptions.Builder

java.lang.Object

software.amazon.awscdk.SecretsManagerSecretOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<SecretsManagerSecretOptions>

Enclosing interface:

SecretsManagerSecretOptions

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

A builder for SecretsManagerSecretOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SecretsManagerSecretOptions	build()	Builds the configured instance.
SecretsManagerSecretOptions.Builder	jsonField(String jsonField)	Sets the value of SecretsManagerSecretOptions.getJsonField()
SecretsManagerSecretOptions.Builder	versionId(String versionId)	Sets the value of SecretsManagerSecretOptions.getVersionId()
SecretsManagerSecretOptions.Builder	versionStage(String versionStage)	Sets the value of SecretsManagerSecretOptions.getVersionStage()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

jsonField

@Stability(Stable)
public SecretsManagerSecretOptions.Builder jsonField(String jsonField)

Sets the value of SecretsManagerSecretOptions.getJsonField()

Parameters:

jsonField - The key of a JSON field to retrieve. This can only be used if the secret stores a JSON object.

Returns:

this

versionId

@Stability(Stable)
public SecretsManagerSecretOptions.Builder versionId(String versionId)

Sets the value of SecretsManagerSecretOptions.getVersionId()

Parameters:

versionId - Specifies the unique identifier of the version of the secret you want to use. Can specify at most one of versionId and versionStage.

Returns:

this

versionStage

@Stability(Stable)
public SecretsManagerSecretOptions.Builder versionStage(String versionStage)

Sets the value of SecretsManagerSecretOptions.getVersionStage()

Parameters:

versionStage - Specifies the secret version that you want to retrieve by the staging label attached to the version. Can specify at most one of versionId and versionStage.

Returns:

this

build

@Stability(Stable)
public SecretsManagerSecretOptions build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<SecretsManagerSecretOptions>

Returns:

a new instance of SecretsManagerSecretOptions

Throws:

NullPointerException - if any required attribute was not provided