NAME

Paws::SecretsManager::GetSecretValue - Arguments for method GetSecretValue on Paws::SecretsManager

DESCRIPTION

This class represents the parameters used for calling the method GetSecretValue on the AWS Secrets Manager service. Use the attributes of this class as arguments to method GetSecretValue.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetSecretValue.

SYNOPSIS

    my $secretsmanager = Paws->service('SecretsManager');
 # To retrieve the encrypted secret value of a secret
 # The following example shows how to retrieve the secret string value from the
 # version of the secret that has the AWSPREVIOUS staging label attached. If you
 # want to retrieve the AWSCURRENT version of the secret, then you can omit the
 # VersionStage parameter because it defaults to AWSCURRENT.
    my $GetSecretValueResponse = $secretsmanager->GetSecretValue(
      'SecretId'     => 'MyTestDatabaseSecret',
      'VersionStage' => 'AWSPREVIOUS'
    );

    # Results:
    my $ARN           = $GetSecretValueResponse->ARN;
    my $CreatedDate   = $GetSecretValueResponse->CreatedDate;
    my $Name          = $GetSecretValueResponse->Name;
    my $SecretString  = $GetSecretValueResponse->SecretString;
    my $VersionId     = $GetSecretValueResponse->VersionId;
    my $VersionStages = $GetSecretValueResponse->VersionStages;

    # Returns a L<Paws::SecretsManager::GetSecretValueResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/secretsmanager/GetSecretValue

ATTRIBUTES

REQUIRED SecretId => Str

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.

If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names ending with a hyphen followed by six characters.

If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you must not include the random suffix. If you do include the random suffix added by Secrets Manager, you receive either a ResourceNotFoundException or an AccessDeniedException error, depending on your permissions.

VersionId => Str

Specifies the unique identifier of the version of the secret that you want to retrieve. If you specify both this parameter and VersionStage, the two parameters must refer to the same secret version. 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 (https://wikipedia.org/wiki/Universally_unique_identifier) value with 32 hexadecimal digits.

VersionStage => Str

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 specify both this parameter and VersionId, the two parameters must refer to the same secret version . 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.

SEE ALSO

This class forms part of Paws, documenting arguments for method GetSecretValue in Paws::SecretsManager

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues