-
Notifications
You must be signed in to change notification settings - Fork 1.1k
add example for tags, remove existing example #7987
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.
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
Merged
Merged
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
c1b05d5
add example for tags, remove existing example
josefaidt 5dda852
format code using docs prettier
josefaidt cfb0c7f
Update src/pages/[platform]/build-a-backend/add-aws-services/tagging-…
josefaidt 456f7bf
Update src/pages/[platform]/build-a-backend/add-aws-services/tagging-…
josefaidt File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
68 changes: 68 additions & 0 deletions
68
src/pages/[platform]/build-a-backend/add-aws-services/tagging-resources/index.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,68 @@ | ||
import { getCustomStaticPath } from '@/utils/getCustomStaticPath'; | ||
|
||
export const meta = { | ||
title: 'Tagging resources', | ||
description: 'Decorate resources with tags for categorization.', | ||
platforms: [ | ||
'android', | ||
'angular', | ||
'flutter', | ||
'javascript', | ||
'nextjs', | ||
'react', | ||
'react-native', | ||
'swift', | ||
'vue' | ||
], | ||
}; | ||
|
||
export async function getStaticPaths() { | ||
return getCustomStaticPath(meta.platforms); | ||
} | ||
|
||
export function getStaticProps(context) { | ||
return { | ||
props: { | ||
platform: context.params.platform, | ||
meta | ||
} | ||
}; | ||
} | ||
|
||
Tags are a key-value pair that are applied to AWS resources to hold metadata. Tags are often used to decorate resources with metadata that helps categorize resources for billing or viewing purposes. Learn more about tags by visiting the [AWS documentation for best practices for tagging resources](https://docs.aws.amazon.com/whitepapers/latest/tagging-best-practices/what-are-tags.html). | ||
|
||
Amplify applies the following tags by default: | ||
|
||
| Deployment type | Tag key | Tag value | | ||
|-----------------|---------------------------|--------------------------| | ||
| sandbox | `created-by` | `amplify` | | ||
| sandbox | `amplify:deployment-type` | `sandbox` | | ||
| branch | `created-by` | `amplify` | | ||
| branch | `amplify:deployment-type` | `branch` | | ||
| branch | `amplify:app-id` | `<your-amplify-app-id>` | | ||
| branch | `amplify:branch-name` | `<your-git-branch-name>` | | ||
|
||
In your Amplify backend your can use the [`Tags`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.Tags.html) class from the [AWS Cloud Development Kit (CDK)](https://docs.aws.amazon.com/cdk/latest/guide/home.html) to apply tags at the root level, which cascades tag application to child resources. | ||
|
||
```ts title="amplify/backend.ts" | ||
import { Tags } from 'aws-cdk-lib'; | ||
import { defineBackend } from '@aws-amplify/backend'; | ||
import { auth } from './auth/resource'; | ||
import { data } from './data/resource'; | ||
|
||
/** | ||
* @see https://docs.amplify.aws/react/build-a-backend/ to add storage, functions, and more | ||
*/ | ||
const backend = defineBackend({ | ||
auth, | ||
data | ||
}); | ||
|
||
const tags = Tags.of(backend.stack); | ||
// add a new tag | ||
tags.add('my-key', 'my-value'); | ||
// remove tags | ||
tags.remove('my-key'); | ||
``` | ||
|
||
{/* Alternatively you can apply tags to individual resource stacks... */} | ||
josefaidt marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
josefaidt marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.