github.com/aws-cloudformation/cloudformation-cli-go-plugin@v1.2.0/examples/github-repo/README.md (about)

     1  # Example::GitHub::Repo
     2  
     3  Manages a public GitHub repository.
     4  
     5  ## Build
     6  You can create a build of the resource for local testing by running `make`, it will create
     7  a build of your resource that can be used with AWS SAM CLI.
     8  
     9  ### Local testing
    10  
    11  ```bash
    12  $ sam local invoke -e ./events/create.json TypeFunction
    13  ```
    14  
    15  Will executed your function without calling any AWS resources, unless your code interacts
    16  with AWS.
    17  
    18  ### Deploy
    19  Using `make deploy` will create a production version of the resource, which will interact
    20  with CloudFormation and CloudWatch Logs.
    21  
    22  ## Run
    23  
    24  | Name | Description | Required |
    25  |:-----|:------------|:---------|
    26  | Name | Repository Name | ✅ |
    27  | Owner | Organization/User where the repo will be created | ✅ |
    28  | Description | Description of the repository | |
    29  | Homepage | Home page of the project | |
    30  | OauthToken | Personal Access Token | ✅ |
    31  
    32  Every input property of a resource is usable as an output.