stdlib: added package doc strings
Signed-off-by: Sam Alba <sam.alba@gmail.com>
This commit is contained in:
@@ -1,3 +1,4 @@
|
||||
// AWS base package
|
||||
package aws
|
||||
|
||||
import (
|
||||
@@ -6,7 +7,7 @@ import (
|
||||
"dagger.io/alpine"
|
||||
)
|
||||
|
||||
// Base AWS Config
|
||||
// AWS Config shared by all AWS packages
|
||||
#Config: {
|
||||
// AWS region
|
||||
region: string @dagger(input)
|
||||
|
@@ -1,3 +1,4 @@
|
||||
// AWS Cloud Formation
|
||||
package cloudformation
|
||||
|
||||
import (
|
||||
|
@@ -1,3 +1,4 @@
|
||||
// Amazon Elastic Container Registry (ECR)
|
||||
package ecr
|
||||
|
||||
import (
|
||||
|
@@ -1,10 +1,11 @@
|
||||
// AWS Elastic Container Service (ECS)
|
||||
package ecs
|
||||
|
||||
import (
|
||||
"dagger.io/aws"
|
||||
)
|
||||
|
||||
// RunTask implement ecs run-task
|
||||
// RunTask implements ecs run-task for running a single container on ECS
|
||||
#RunTask: {
|
||||
|
||||
// AWS Config
|
||||
|
@@ -1,3 +1,4 @@
|
||||
// AWS Elastic Kubernetes Service (EKS)
|
||||
package eks
|
||||
|
||||
import (
|
||||
|
@@ -1,3 +1,4 @@
|
||||
// AWS Elastic Load Balancer (ELBv2)
|
||||
package elb
|
||||
|
||||
import (
|
||||
@@ -5,7 +6,7 @@ import (
|
||||
"dagger.io/aws"
|
||||
)
|
||||
|
||||
// Returns a non-taken rule priority (randomized)
|
||||
// Returns an unused rule priority (randomized in available range)
|
||||
#RandomRulePriority: {
|
||||
// AWS Config
|
||||
config: aws.#Config
|
||||
|
@@ -1,3 +1,4 @@
|
||||
// AWS Relational Database Service (RDS)
|
||||
package rds
|
||||
|
||||
import (
|
||||
@@ -6,6 +7,7 @@ import (
|
||||
"dagger.io/aws"
|
||||
)
|
||||
|
||||
// Creates a new Database on an existing RDS Instance
|
||||
#CreateDB: {
|
||||
// AWS Config
|
||||
config: aws.#Config
|
||||
@@ -19,6 +21,7 @@ import (
|
||||
// ARN of the database secret (for connecting via rds api)
|
||||
secretArn: string @dagger(input)
|
||||
|
||||
// Database type MySQL or PostgreSQL (Aurora Serverless only)
|
||||
dbType: "mysql" | "postgres" @dagger(input)
|
||||
|
||||
// Name of the DB created
|
||||
@@ -79,6 +82,7 @@ import (
|
||||
}
|
||||
}
|
||||
|
||||
// Creates a new user credentials on an existing RDS Instance
|
||||
#CreateUser: {
|
||||
// AWS Config
|
||||
config: aws.#Config
|
||||
@@ -95,8 +99,10 @@ import (
|
||||
// ARN of the database secret (for connecting via rds api)
|
||||
secretArn: string @dagger(input)
|
||||
|
||||
// Name of the database to grants access to
|
||||
grantDatabase: string | *"" @dagger(input)
|
||||
|
||||
// Database type MySQL or PostgreSQL (Aurora Serverless only)
|
||||
dbType: "mysql" | "postgres" @dagger(input)
|
||||
|
||||
// Outputed username
|
||||
@@ -185,6 +191,7 @@ import (
|
||||
}
|
||||
}
|
||||
|
||||
// Fetches information on an existing RDS Instance
|
||||
#Instance: {
|
||||
// AWS Config
|
||||
config: aws.#Config
|
||||
|
@@ -1,3 +1,4 @@
|
||||
// AWS Simple Storage Service
|
||||
package s3
|
||||
|
||||
import (
|
||||
@@ -6,7 +7,7 @@ import (
|
||||
"dagger.io/aws"
|
||||
)
|
||||
|
||||
// S3 file or Directory upload
|
||||
// S3 Bucket upload (file or directory)
|
||||
#Put: {
|
||||
|
||||
// AWS Config
|
||||
@@ -91,7 +92,7 @@ import (
|
||||
}
|
||||
}
|
||||
|
||||
// S3 Sync
|
||||
// S3 Bucket sync
|
||||
#Sync: {
|
||||
// AWS Config
|
||||
config: aws.#Config
|
||||
|
Reference in New Issue
Block a user