AWS Rotated Secret
You can create a Rotated Secret for an AWS user. Before you get started, ensure creating an AWS Target that includes the AWS region, as well as credentials for a privileged user authorized to rotate credentials.
When a client requests a Rotated Secret value, the Akeyless Platform connects to the AWS Cloud through your Gateway to rotate the user password on your target AWS account.
Create a Rotated AWS Secret from the CLI
To create a Rotated AWS Secret using the Akeyless CLI, run the following command:
akeyless rotated-secret create aws \
--name <Rotated secret name> \
--gateway-url 'https://<Your-Akeyless-GW-URL:8000>' \
--target-name <target name to associate> \
--authentication-credentials <use-user-creds|use-target-creds> \
--rotator-type <api-key|target> \
--api-id <access id> \
--api-key <access key> \
--grace-rotation <true|false>
--auto-rotate <true|false> \
--rotation-interval <1-365> \
--rotation-hour <hour in UTC>
Where:
-
name
: A unique name of the Rotated Secret. The name can include the path to the virtual folder where you want to create the new Rotated Secret, using slash/
separators. If the folder does not exist, it will be created together with the Rotated Secret. -
gateway-url
: Akeyless Gateway Configuration Manager URL (port8000
). -
target-name
: The name of the AWS Target with which the Rotated Secret should be associated. -
authentication-credentials
: Determines how to connect to the target AWS account.use-user-creds
- Use the credentials defined on the Rotated Secret item.use-target-creds
- Use the credentials defined on the AWS Target item.
Note
Select
use-target-creds
if the Rotated Secret user is not authorized to change their own Access Key, and a privileged user, like the AWS Target user, is required to change the Access Key on behalf of the Rotated Secret user.
-
rotator-type
: The type of credentials to be rotated. For AWS Targets, choose:api-key
- to rotate the Access Key specified in the Rotated Secret.target
- to rotate the Access Key for the user specified in the AWS Target.
-
api-id
: The Access Key ID of the AWS user whose Access Key should be rotated. If left empty, the rotated secret will try to create a new key and manage its rotation only. -
api-key
: The Access Key to rotate. -
grace-rotation
: A boolean flag, when enabled, a graceful mode of rotation will be conducted, where only the older AWS Access Key will be rotated. When there is only one Access Key, a new version will be created - to maintain 2 values at the same time, following AWS best practice. -
auto-rotate
: Enable auto-rotation if you need to update the Access Key regularly. If this value is set to true, specify therotation-interval
in days, and optionally also therotation-hour
.
You can find the complete list of parameters for this command in the CLI Reference - Rotated Secrets section.
Create a Rotated AWS Secret in the Akeyless Console
Note
To start working with Rotated Secrets from the Akeyless Console, you need to configure the Gateway URL thus enabling communication between the Akeyless SaaS and the Akeyless Gateway.
To create rotated secrets directly from the Akeyless Gateway, you can use the Gateway Configuration Manager.
-
Log in to the Akeyless Console, and go to Items > New > Rotated Secret > AWS.
-
Define a Name of the Rotated Secret, and specify the Location as a path to the virtual folder where you want to create the new Rotated Secret, using slash
/
separators. If the folder does not exist, it will be created together with the Rotated Secret. -
Define the remaining settings as follows:
-
Delete Protection: When enabled, protects the Rotated Secret from accidental deletion.
-
Target: Defines the name of the AWS Target to be associated with the Rotated Secret.
-
Authenticate with the following credentials: Determines how to connect to the target AWS account:
- User credentials: Use the credentials defined inside the Rotated Secret item.
- Target credentials: Use the credentials defined inside the AWS Target item.
Note
Select Target credentials if the Rotated Secret user is not authorized to change their own Access Key, and a privileged user, like the AWS Target user, is required to change the Access Key on behalf of the Rotated Secret user.
-
Graceful Rotation: When enabled, a graceful mode of rotation will be conducted, where only the older AWS Access Key will be rotated. When there is only one Access Key, a new version will be created - to maintain 2 values at the same time, following AWS best practice.
-
Rotator type: Determines the rotator type:
- API Key: Rotates the Access Key defined inside the Rotated Secret item.
- Target: Rotates the Access Key defined inside the AWS Target item.
-
Access Key ID: Defines the Access Key ID of the AWS user whose Access Key should be rotated.
-
Access Key: Defines the Access Key to rotate.
Note
You can rotate the Access Key for the AWS Target too, by creating a Rotated Secret with the Rotator type set to Target. When you're using a Target rotator, the access role with which this Rotated Secret is associated must have read and update permissions on the corresponding Target.
-
Gateway: Select the Gateway through which the secret will be rotated.
-
Protection Key: To enable Zero-Knowledge, select a key with a Customer Fragment. For more information about Zero-Knowledge, see Implement Zero Knowledge
-
Auto rotate: Determines if automatic rotation is enabled.
-
Rotation interval (in days): Defines the number of days (1-365) to wait between automatic Access Key rotations when Auto Rotate is enabled.
-
Rotation hour (local time zone): Defines the time when the Access Key should be rotated if Auto Rotate is enabled.
-
Rotation Notification: If you wish to get a notification before the next Automatic Rotation, click on ⊕ Add Notification and adjust the day count to any number you desire. This can be done multiple times to be notified more than once.
- Click Finish.
Updated 3 months ago