@@ -43,7 +43,7 @@ Create a Lambda function with the following parameters:
4343
4444##### Step 2.2 - Insert code
4545After you create the function, you will be able to insert the code included with this
46- sample into the code box and click "Deployed " to save it.
46+ sample into the code box and click "Deploy " to save it.
4747
4848##### Step 2.3 - Change permissisons
4949Change to the ` Configuration ` tab and select ` Permissions ` and add a ` Resource-based policy ` statement that will allow the
@@ -56,23 +56,25 @@ secretsmanager AWS service to invoke the Lambda function. Do that do the followi
5656- Set action to ` lambda:InvokeFunction `
5757
5858#### Step 3 - Enable Secrets Manager Rotation
59- To enable the rotation of the secret, go will need to the Secrets Manager page of the AWS console
59+ To enable the rotation of the secret, you will need go to the Secrets Manager page of the AWS console
6060and click on the secret you want to rotate, then:
6161##### Step 3.1 - Set the tags
62- The way Lambda function knows which FSxN file system, or which SVM, to update the password on is
62+ The way Lambda function knows which FSxN file system, or which SVM, to update the password for is
6363via the tags associated with the secret. The following are the tags that the program looks for:
6464| Tag Key| Tag Value| Description|
6565| :------| :--------| :----------|
6666| region| \< region\> | The region the FSxN file system resides in.|
6767| fsx_id| \< file-System-id\> | The FSxN file system id.|
6868| svm_id| \< svm-id\> | The Storage Virtual Machine id.|
69+
6970Note that the Lambda function can only manage one password, so either set the value for the ` fsx_id ` or the ` svm_id ` tag, both not both.
71+
7072:warning : ** Warning:** If both the ` fsx_id ` and ` svm_id ` tags are set, the ` svm_id ` tag will be used and the fsx_id will be silently ignored.
7173
7274##### Step 3.2 - Enable rotation feature
7375Click on the Rotation tab and then click on the "Edit rotation" button. That should bring up a
7476pop-up window. Click on the "Automatic rotation" slider to enable the feature and then configure
75- the rotation schedule you want. The last step is to
77+ the rotation schedule the way you want. The last step is to
7678select the rotation function that you created in the steps above and click on the "Save" button.
7779
7880### Terraform Method
@@ -153,16 +155,17 @@ module "fsxn_rotate_secret" {
153155 rotationFrequency = "rate(30 days)"
154156}
155157```
156- Note that the Lambda function can only manage one password, so either set the value for the ` fsxId ` or the ` svmId ` tag, both not both.
158+ Note that the Lambda function can only manage one password, so either set the value for the ` fsxId ` or the ` svmId ` tag, but not both.
159+
157160:warning : ** Warning:** If both the ` fsxId ` and ` svmId ` tags are set, the ` svmId ` tag will be used and the fsxId will be silently ignored.
158161
159162At this point, you can run ` terraform init ` and ` terraform apply ` to create the secret that will automatically rotate
160163the password for the FSxN file system or SVM.
161164
162165#### Inputs
163166The following are the inputs for the module:
164- | Name | Description | Type | Default | Required |
165- | ------ | ------------- | ------| ---------| :--------:|
167+ | Name | Description | Type | Default | Required |
168+ | : -----| : ------------| : ------: | : ---------: | :--------:|
166169| fsx_region | The region where the FSxN file system resides in. | string | | yes |
167170| secret_region | The region where the secret will resides in. | string | | yes |
168171| aws_account_id | The AWS account id that the FSxN file system resides in. Used to create roles with least privilege. | string | \* | no |
0 commit comments