AWS Code Sample


DeleteSecret.php demonstrates how to delete a secret from AWS Secrets Manager. The secret will be deleted in 30 days unless you specify a differently. During this time use RestoreSecret to reactive the secret.

<?php /** * Copyright 2010-2019, Inc. or its affiliates. All Rights Reserved. * * This file is licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. A copy of * the License is located at * * * * This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the * specific language governing permissions and limitations under the License. * * ABOUT THIS PHP SAMPLE: This sample is part of the KMS Developer Guide topic at * * */ require 'vendor/autoload.php'; use Aws\SecretsManager\SecretsManagerClient; use Aws\Exception\AwsException; /** * Delete a secret from AWS Secrets Manager. * * Secret will remain for 30 days before deletion unless specified with 'RecoveryWindowInDays'. * * This code expects that you have AWS credentials set up per: * */ //Create a Secrets Manager Client $client = new SecretsManagerClient([ 'profile' => 'default', 'version' => '2017-10-17', 'region' => 'us-west-2' ]); $secretName = '<<{{MySecretName}}>>'; try { $result = $client->deleteSecret([ 'SecretId' => $secretName, ]); var_dump($result); } catch (AwsException $e) { // output error message if fails echo $e->getMessage(); echo "\n"; }

Sample Details

Service: secretsmanager

Last tested: 2018-11-08

Author: jschwarzwalder (AWS)

Type: full-example

On this page: