Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: updated README #48

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

chore: updated README #48

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 24 additions & 1 deletion generators/pulumi-s3-backend/templates/pulumi-s3-backend/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,12 +66,35 @@ One instance of `aws.s3.Bucket`.
## Configuration settings

| Setting | Type | Default | Required | Description |
|---------|------|---------|-------------|
|---------|------|---------|-------------|----------|
| aws-account-arns | string | `ARN1` | No | Grants access to the backend for different roles. The format should be <Account ID>:role/<Role Name> for roles <Account ID>:user/<Username> for users. |
| forceDestroy | Boolean | `false` | No | Indicates whether all objects should be destroyed when the bucket is destroyed. See `aws.s3.Bucket` `forceDestroy` |
| name | String | `{organization}-pulumi-state` | No | The name of the S3 bucket to provision. |
| protect | boolean | false | No | Protect resources from accidental deletion |
| retainOnDelete | boolean | false | No | Retain resources when destroyed |

### aws-account-arns example

##### Granting access to a role of an account
< AccountID >:role/< FederatedUser>

For example:

123456789:role/AWSReservedSSO_Devops-AdministratorAccess_ABC123/

##### Granting access to a user of an account
< AccountID >:user/< Username >

For example:

123456789:user/[email protected]

##### Granting access to an account
< AccountID >:root

For example:

123456789:root

## Outputs

Expand Down