/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::SecretsManager::UpdateSecretVersionStage

NAME

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

DESCRIPTION

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

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

SYNOPSIS

  my $secretsmanager = Paws->service('SecretsManager');
# To add a staging label attached to a version of a secret
# The following example shows you how to add a staging label to a version of a
# secret. You can review the results by running the operation
# ListSecretVersionIds and viewing the VersionStages response field for the
# affected version.
  my $UpdateSecretVersionStageResponse =
    $secretsmanager->UpdateSecretVersionStage(
    'MoveToVersionId' => 'EXAMPLE1-90ab-cdef-fedc-ba987SECRET1',
    'SecretId'        => 'MyTestDatabaseSecret',
    'VersionStage'    => 'STAGINGLABEL1'
    );

  # Results:
  my $ARN  = $UpdateSecretVersionStageResponse->ARN;
  my $Name = $UpdateSecretVersionStageResponse->Name;

# Returns a Paws::SecretsManager::UpdateSecretVersionStageResponse object. # To delete a staging label attached to a version of a secret # The following example shows you how to delete a staging label that is attached # to a version of a secret. You can review the results by running the operation # ListSecretVersionIds and viewing the VersionStages response field for the # affected version. my $UpdateSecretVersionStageResponse = $secretsmanager->UpdateSecretVersionStage( 'RemoveFromVersionId' => 'EXAMPLE1-90ab-cdef-fedc-ba987SECRET1', 'SecretId' => 'MyTestDatabaseSecret', 'VersionStage' => 'STAGINGLABEL1' );

   # Results:
   my $ARN  = $UpdateSecretVersionStageResponse->ARN;
   my $Name = $UpdateSecretVersionStageResponse->Name;

# Returns a L<Paws::SecretsManager::UpdateSecretVersionStageResponse> object.
# To move a staging label from one version of a secret to another
# The following example shows you how to move a staging label that is attached
# to one version of a secret to a different version. You can review the results
# by running the operation ListSecretVersionIds and viewing the VersionStages
# response field for the affected version.
   my $UpdateSecretVersionStageResponse =
     $secretsmanager->UpdateSecretVersionStage(
     'MoveToVersionId'     => 'EXAMPLE2-90ab-cdef-fedc-ba987SECRET2',
     'RemoveFromVersionId' => 'EXAMPLE1-90ab-cdef-fedc-ba987SECRET1',
     'SecretId'            => 'MyTestDatabaseSecret',
     'VersionStage'        => 'AWSCURRENT'
     );

   # Results:
   my $ARN  = $UpdateSecretVersionStageResponse->ARN;
   my $Name = $UpdateSecretVersionStageResponse->Name;

  # Returns a L<Paws::SecretsManager::UpdateSecretVersionStageResponse> 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/UpdateSecretVersionStage

ATTRIBUTES

MoveToVersionId => Str

(Optional) The secret version ID that you want to add the staging label. If you want to remove a label from a version, then do not specify this parameter.

If the staging label is already attached to a different version of the secret, then you must also specify the RemoveFromVersionId parameter.

RemoveFromVersionId => Str

Specifies the secret version ID of the version that the staging label is to be removed from. If the staging label you are trying to attach to one version is already attached to a different version, then you must include this parameter and specify the version that the label is to be removed from. If the label is attached and you either do not specify this parameter, or the version ID does not match, then the operation fails.

REQUIRED SecretId => Str

Specifies the secret with the version with the list of staging labels you want to modify. 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.

REQUIRED VersionStage => Str

The staging label to add to this version.

SEE ALSO

This class forms part of Paws, documenting arguments for method UpdateSecretVersionStage 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