Skip to content

Commit 9140802

Browse files
mwunderlmwunderl
authored
Merge pull request #32 from aws-samples/metadata-preview
Sample metadata
2 parents 49f07d9 + d7331e9 commit 9140802

60 files changed

Lines changed: 1241 additions & 69 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.doc_gen/metadata/api_gateway_apigateway_lambda_metadata.yaml‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
api_gateway_GettingStarted_087:
2+
title: Create a REST API with Lambda proxy integration
3+
title_abbrev: Create a REST API with Lambda proxy integration
4+
synopsis_list:
5+
- Create an IAM role for Lambda execution
6+
- Create and deploy a Lambda function
7+
- Create a REST API
8+
- Configure Lambda proxy integration
9+
- Deploy and test the API
10+
- Clean up resources
11+
category: Scenarios
12+
languages:
13+
Bash:
14+
versions:
15+
- sdk_version: 2
16+
github_name: "Sample developer tutorials"
17+
github: https://github.com/aws-samples/sample-developer-tutorials/tree/main/tuts/087-apigateway-lambda-integration
18+
excerpts:
19+
- description:
20+
snippet_files:
21+
- tuts/087-apigateway-lambda-integration/apigateway-lambda-integration.sh
22+
services:
23+
api-gateway: {CreateDeployment, CreateResource, CreateRestApi, DeleteRestApi, GetResources, GetRestApis, PutIntegration, PutMethod}
24+
iam: {AttachRolePolicy, CreateRole, DeleteRole, DetachRolePolicy}
25+
lambda: {AddPermission, CreateFunction, DeleteFunction}
26+
sts: {GetCallerIdentity}

‎.doc_gen/metadata/athena_amazon_athena_metadata.yaml‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
athena_GettingStarted_061:
2+
title: Getting started with Amazon Athena
3+
title_abbrev: Getting started with Amazon Athena
4+
synopsis_list:
5+
- Create an S3 bucket for query results
6+
- Create a database
7+
- Create a table
8+
- Run a query
9+
- Create and use named queries
10+
- Clean up resources
11+
category: Scenarios
12+
languages:
13+
Bash:
14+
versions:
15+
- sdk_version: 2
16+
github_name: "Sample developer tutorials"
17+
github: https://github.com/aws-samples/sample-developer-tutorials/tree/main/tuts/061-amazon-athena-gs
18+
excerpts:
19+
- description:
20+
snippet_files:
21+
- tuts/061-amazon-athena-gs/amazon-athena-gs.sh
22+
services:
23+
athena: {CreateNamedQuery, DeleteNamedQuery, GetNamedQuery, GetQueryExecution, GetQueryResults, ListDatabases, ListNamedQueries, ListTableMetadata, StartQueryExecution}
24+
s3: {Cp, Mb, Rb, Rm}

‎.doc_gen/metadata/cloudformation_cloudformation_gs_metadata.yaml‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
cloudformation_GettingStarted_021:
2+
title: Creating your first CloudFormation stack
3+
title_abbrev: Creating your first CloudFormation stack
4+
synopsis_list:
5+
- Create a CloudFormation template
6+
- Test the web server
7+
- Clean up resources
8+
category: Scenarios
9+
languages:
10+
Bash:
11+
versions:
12+
- sdk_version: 2
13+
github_name: "Sample developer tutorials"
14+
github: https://github.com/aws-samples/sample-developer-tutorials/tree/main/tuts/021-cloudformation-gs
15+
excerpts:
16+
- description:
17+
snippet_files:
18+
- tuts/021-cloudformation-gs/cloudformation-gs.sh
19+
services:
20+
cloudformation: {CreateStack, DeleteStack, DescribeStacks, ListStackResources, ValidateTemplate, Wait}

‎.doc_gen/metadata/cloudfront_metadata.yaml‎

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,11 @@
11
cloudfront_GettingStarted:
2-
title: Get started with a basic CloudFront distribution using the CLI
3-
title_abbrev: Get started with CloudFront
2+
title: Get started with a basic CloudFront distribution
3+
title_abbrev: Get started with a basic CloudFront distribution
44
synopsis_list:
5-
- Create an Amazon S3 bucket for content storage
6-
- Upload sample content to the S3 bucket
7-
- Create an origin access control (OAC) for secure S3 access
8-
- Create a CloudFront distribution with S3 as origin
9-
- Update S3 bucket policy to allow CloudFront access
10-
- Wait for distribution deployment and test content access
11-
- Clean up resources including distribution, OAC, and S3 bucket
5+
- Create an Amazon S3 bucket
6+
- Upload content to the bucket
7+
- Create a CloudFront distribution with OAC
8+
- Clean up resources
129
category: Scenarios
1310
languages:
1411
Bash:

‎.doc_gen/metadata/cloudmap_metadata.yaml‎

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
11
cloudmap_CustomAttributes:
2-
title: Use custom attributes with Cloud Map
2+
title: Using Cloud Map service discovery with custom attributes
33
title_abbrev: Cloud Map custom attributes
44
synopsis_list:
5-
- Create an HTTP namespace for API-based service discovery
6-
- Create a DynamoDB table and register it as a data service with custom attributes
7-
- Create Lambda functions for reading and writing data
8-
- Register Lambda functions as service instances with custom attributes for action-based discovery
9-
- Build client applications that discover services using custom attributes
10-
- Clean up all resources including Lambda functions, DynamoDB table, and Cloud Map services
5+
- Create an Cloud Map namespace
6+
- Create a DynamoDB table
7+
- Create an Cloud Map data service and register the DynamoDB table
8+
- Create an IAM role for Lambda functions
9+
- Create the Lambda function to write data
10+
- Create an Cloud Map app service and register the Lambda write function
11+
- Create the Lambda function to read data
1112
category: Scenarios
1213
languages:
1314
Bash:

‎.doc_gen/metadata/cloudwatch_cloudwatch_dynamicdash_metadata.yaml‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
cloudwatch_GettingStarted_031:
2+
title: Creating a CloudWatch dashboard with function name as a variable
3+
title_abbrev: Creating a CloudWatch dashboard with function name as a variable
4+
synopsis_list:
5+
- Create a CloudWatch dashboard
6+
- Add Lambda metrics widgets with a function name variable
7+
- Verify the dashboard
8+
- Clean up resources
9+
category: Scenarios
10+
languages:
11+
Bash:
12+
versions:
13+
- sdk_version: 2
14+
github_name: "Sample developer tutorials"
15+
github: https://github.com/aws-samples/sample-developer-tutorials/tree/main/tuts/031-cloudwatch-dynamicdash
16+
excerpts:
17+
- description:
18+
snippet_files:
19+
- tuts/031-cloudwatch-dynamicdash/cloudwatch-dynamicdash.sh
20+
services:
21+
cloudwatch: {DeleteDashboards, GetDashboard, ListDashboards, PutDashboard}
22+
iam: {AttachRolePolicy, CreateRole, DeleteRole, DetachRolePolicy}
23+
lambda: {CreateFunction, DeleteFunction, Invoke, ListFunctions}
24+
sts: {GetCallerIdentity}

‎.doc_gen/metadata/cognito_identity_provider_amazon_cognito_metadata.yaml‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
cognito_identity_provider_GettingStarted_066:
2+
title: Getting started with Amazon Cognito user pools
3+
title_abbrev: Getting started with Amazon Cognito user pools
4+
synopsis_list:
5+
- Create a user pool
6+
- Create an app client
7+
- Set up a domain for your user pool
8+
- Create a user as an administrator
9+
- Enable self-registration
10+
- List users in the user pool
11+
- Clean up resources
12+
category: Scenarios
13+
languages:
14+
Bash:
15+
versions:
16+
- sdk_version: 2
17+
github_name: "Sample developer tutorials"
18+
github: https://github.com/aws-samples/sample-developer-tutorials/tree/main/tuts/066-amazon-cognito-gs
19+
excerpts:
20+
- description:
21+
snippet_files:
22+
- tuts/066-amazon-cognito-gs/amazon-cognito-gs.sh
23+
services:
24+
cognito-identity-provider: {AdminConfirmSignUp, AdminCreateUser, CreateUserPool, CreateUserPoolClient, CreateUserPoolDomain, DeleteUserPool, DeleteUserPoolDomain, DescribeUserPool, DescribeUserPoolClient, InitiateAuth, ListUsers, SignUp}

‎.doc_gen/metadata/config_service_aws_config_metadata.yaml‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
config_service_GettingStarted_053:
2+
title: Getting started with Config
3+
title_abbrev: Getting started with Config
4+
synopsis_list:
5+
- Create an Amazon S3 bucket
6+
- Create an Amazon SNS topic
7+
- Create an IAM role for Config
8+
- Set up the Config configuration recorder
9+
- Set up the Config delivery channel
10+
- Start the configuration recorder
11+
- Verify the Config setup
12+
category: Scenarios
13+
languages:
14+
Bash:
15+
versions:
16+
- sdk_version: 2
17+
github_name: "Sample developer tutorials"
18+
github: https://github.com/aws-samples/sample-developer-tutorials/tree/main/tuts/053-aws-config-gs
19+
excerpts:
20+
- description:
21+
snippet_files:
22+
- tuts/053-aws-config-gs/aws-config-gs.sh
23+
services:
24+
config-service: {DeleteConfigurationRecorder, DeleteDeliveryChannel, DescribeConfigurationRecorderStatus, DescribeConfigurationRecorders, DescribeDeliveryChannels, PutConfigurationRecorder, PutDeliveryChannel, StartConfigurationRecorder, StopConfigurationRecorder}
25+
iam: {AttachRolePolicy, CreateRole, DeleteRole, DeleteRolePolicy, DetachRolePolicy, PutRolePolicy}
26+
s3: {CreateBucket, DeleteBucket, PutPublicAccessBlock, Rm}
27+
sns: {CreateTopic, DeleteTopic}
28+
sts: {GetCallerIdentity}

‎.doc_gen/metadata/connect_connect_gs_metadata.yaml‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
connect_GettingStarted_027:
2+
title: Creating an Amazon Connect instance
3+
title_abbrev: Creating an Amazon Connect instance
4+
synopsis_list:
5+
- Create an Amazon Connect instance
6+
- Configure an administrator user
7+
- Configure telephony options
8+
- Set up a phone number
9+
- Clean up resources
10+
category: Scenarios
11+
languages:
12+
Bash:
13+
versions:
14+
- sdk_version: 2
15+
github_name: "Sample developer tutorials"
16+
github: https://github.com/aws-samples/sample-developer-tutorials/tree/main/tuts/027-connect-gs
17+
excerpts:
18+
- description:
19+
snippet_files:
20+
- tuts/027-connect-gs/connect-gs.sh
21+
services:
22+
connect: {ClaimPhoneNumber, CreateInstance, CreateUser, DeleteInstance, DescribeInstance, ListInstanceStorageConfigs, ListInstances, ListRoutingProfiles, ListSecurityProfiles, ReleasePhoneNumber, SearchAvailablePhoneNumbers, UpdateInstanceAttribute}

‎.doc_gen/metadata/directconnect_aws_direct_metadata.yaml‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
directconnect_GettingStarted_051:
2+
title: Get started with Aws Direct Connect using the CLI
3+
title_abbrev: Get started with Aws Direct Connect
4+
synopsis_list:
5+
- Use ec2 CreateVpnGateway
6+
- Use ec2 DeleteVpnGateway
7+
- Use ec2 DescribeVpnGateways
8+
- Use directconnect CreateConnection
9+
- Use directconnect CreatePrivateVirtualInterface
10+
- Use directconnect DeleteConnection
11+
category: Scenarios
12+
languages:
13+
Bash:
14+
versions:
15+
- sdk_version: 2
16+
github_name: "Sample developer tutorials"
17+
github: https://github.com/aws-samples/sample-developer-tutorials/tree/main/tuts/051-aws-direct-connect-gs
18+
excerpts:
19+
- description:
20+
snippet_files:
21+
- tuts/051-aws-direct-connect-gs/aws-direct-connect-gs.sh
22+
services:
23+
direct-connect: {CreateConnection, CreatePrivateVirtualInterface, DeleteConnection, DeleteVirtualInterface, DescribeConnections, DescribeLoa, DescribeLocations, DescribeVirtualInterfaces, UpdateConnection}
24+
ec2: {CreateVpnGateway, DeleteVpnGateway, DescribeVpnGateways}

0 commit comments

Comments
 (0)