com.amazonaws.greengrass.javasdk.model

Class GetSecretValueRequest

java.lang.Object

com.amazonaws.greengrass.javasdk.model.GetSecretValueRequest

public class GetSecretValueRequest
extends Object

Request for getting a secret value.

Constructor Summary

Constructors

Constructor and Description
GetSecretValueRequest()

Method Summary

Modifier and Type	Method and Description
String	getSecretId() Specifies the secret containing the version that you want to retrieve.
String	getVersionId() Specifies the unique identifier of the version of the secret that you want to retrieve.
String	getVersionStage() Specifies the secret version that you want to retrieve by the staging label attached to the version.
void	setSecretId(String secretId) Specifies the secret containing the version that you want to retrieve.
void	setVersionId(String versionId) Specifies the unique identifier of the version of the secret that you want to retrieve.
void	setVersionStage(String versionStage) Specifies the secret version that you want to retrieve by the staging label attached to the version.
GetSecretValueRequest	withSecretId(String inputSecretId) Specifies the secret containing the version that you want to retrieve.
GetSecretValueRequest	withVersionId(String inputVersionId) Specifies the unique identifier of the version of the secret that you want to retrieve.
GetSecretValueRequest	withVersionStage(String inputVersionStage) Specifies the secret version that you want to retrieve by the staging label attached to the version.

Methods inherited from class java.lang.Object

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

Constructor Detail

GetSecretValueRequest

public GetSecretValueRequest()

Method Detail

getSecretId

public String getSecretId()

Specifies the secret containing the version that you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

Returns:

Specifies the secret containing the version that you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

setSecretId

public void setSecretId(String secretId)

Specifies the secret containing the version that you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

Parameters:

secretId - Specifies the secret containing the version that you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

getVersionId

public String getVersionId()

Specifies the unique identifier of the version of the secret that you want to retrieve. If you specify this parameter then don't specify VersionStage. If you don't specify either a VersionStage or VersionId then the default is to perform the operation on the version with the VersionStage value of AWSCURRENT. This value is typically a UUID-type value with 32 hexadecimal digits.

Returns:

Specifies the unique identifier of the version of the secret that you want to retrieve. If you specify this parameter then don't specify VersionStage. If you don't specify either a VersionStage or VersionId then the default is to perform the operation on the version with the VersionStage value of AWSCURRENT. This value is typically a UUID-type value with 32 hexadecimal digits.

setVersionId

public void setVersionId(String versionId)

Specifies the unique identifier of the version of the secret that you want to retrieve. If you specify this parameter then don't specify VersionStage. If you don't specify either a VersionStage or VersionId then the default is to perform the operation on the version with the VersionStage value of AWSCURRENT. This value is typically a UUID-type value with 32 hexadecimal digits.

Parameters:

versionId - Specifies the unique identifier of the version of the secret that you want to retrieve. If you specify this parameter then don't specify VersionStage. If you don't specify either a VersionStage or VersionId then the default is to perform the operation on the version with the VersionStage value of AWSCURRENT. This value is typically a UUID-type value with 32 hexadecimal digits.

getVersionStage

public String getVersionStage()

Specifies the secret version that you want to retrieve by the staging label attached to the version. Staging labels are used to keep track of different versions during the rotation process. If you use this parameter then don't specify VersionId. If you don't specify either a VersionStage or VersionId, then the default is to perform the operation on the version with the VersionStage value of AWSCURRENT.

Returns:

Specifies the secret version that you want to retrieve by the staging label attached to the version. Staging labels are used to keep track of different versions during the rotation process. If you use this parameter then don't specify VersionId. If you don't specify either a VersionStage or VersionId, then the default is to perform the operation on the version with the VersionStage value of AWSCURRENT.

setVersionStage

public void setVersionStage(String versionStage)

Specifies the secret version that you want to retrieve by the staging label attached to the version. Staging labels are used to keep track of different versions during the rotation process. If you use this parameter then don't specify VersionId. If you don't specify either a VersionStage or VersionId, then the default is to perform the operation on the version with the VersionStage value of AWSCURRENT.

Parameters:

versionStage - Specifies the secret version that you want to retrieve by the staging label attached to the version. Staging labels are used to keep track of different versions during the rotation process. If you use this parameter then don't specify VersionId. If you don't specify either a VersionStage or VersionId, then the default is to perform the operation on the version with the VersionStage value of AWSCURRENT.

withSecretId

public GetSecretValueRequest withSecretId(String inputSecretId)

Specifies the secret containing the version that you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

Parameters:

inputSecretId - Specifies the secret containing the version that you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

Returns:

Returns a reference to this object so that method calls can be chained together.

withVersionId

public GetSecretValueRequest withVersionId(String inputVersionId)

Specifies the unique identifier of the version of the secret that you want to retrieve. If you specify this parameter then don't specify VersionStage. If you don't specify either a VersionStage or VersionId then the default is to perform the operation on the version with the VersionStage value of AWSCURRENT. This value is typically a UUID-type value with 32 hexadecimal digits.

Parameters:

inputVersionId - Specifies the unique identifier of the version of the secret that you want to retrieve. If you specify this parameter then don't specify VersionStage. If you don't specify either a VersionStage or VersionId then the default is to perform the operation on the version with the VersionStage value of AWSCURRENT. This value is typically a UUID-type value with 32 hexadecimal digits.

Returns:

Returns a reference to this object so that method calls can be chained together.

withVersionStage

public GetSecretValueRequest withVersionStage(String inputVersionStage)

Specifies the secret version that you want to retrieve by the staging label attached to the version. Staging labels are used to keep track of different versions during the rotation process. If you use this parameter then don't specify VersionId. If you don't specify either a VersionStage or VersionId, then the default is to perform the operation on the version with the VersionStage value of AWSCURRENT.

Parameters:

inputVersionStage - Specifies the secret version that you want to retrieve by the staging label attached to the version. Staging labels are used to keep track of different versions during the rotation process. If you use this parameter then don't specify VersionId. If you don't specify either a VersionStage or VersionId, then the default is to perform the operation on the version with the VersionStage value of AWSCURRENT.

Returns:

Returns a reference to this object so that method calls can be chained together.