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

     1  # Example::GitHub::Repo
     2  
     3  Manages a GitHub Repo
     4  
     5  ## Syntax
     6  
     7  To declare this entity in your AWS CloudFormation template, use the following syntax:
     8  
     9  ### JSON
    10  
    11  <pre>
    12  {
    13      "Type" : "Example::GitHub::Repo",
    14      "Properties" : {
    15          "<a href="#name" title="Name">Name</a>" : <i>String</i>,
    16          "<a href="#owner" title="Owner">Owner</a>" : <i>String</i>,
    17          "<a href="#description" title="Description">Description</a>" : <i>String</i>,
    18          "<a href="#homepage" title="Homepage">Homepage</a>" : <i>String</i>,
    19          "<a href="#oauthtoken" title="OauthToken">OauthToken</a>" : <i>String</i>,
    20      }
    21  }
    22  </pre>
    23  
    24  ### YAML
    25  
    26  <pre>
    27  Type: Example::GitHub::Repo
    28  Properties:
    29      <a href="#name" title="Name">Name</a>: <i>String</i>
    30      <a href="#owner" title="Owner">Owner</a>: <i>String</i>
    31      <a href="#description" title="Description">Description</a>: <i>String</i>
    32      <a href="#homepage" title="Homepage">Homepage</a>: <i>String</i>
    33      <a href="#oauthtoken" title="OauthToken">OauthToken</a>: <i>String</i>
    34  </pre>
    35  
    36  ## Properties
    37  
    38  #### Name
    39  
    40  Name of the repository on GitHub
    41  
    42  _Required_: Yes
    43  
    44  _Type_: String
    45  
    46  _Minimum_: <code>1</code>
    47  
    48  _Maximum_: <code>50</code>
    49  
    50  _Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
    51  
    52  #### Owner
    53  
    54  Where to create the repository, either a user or an organization
    55  
    56  _Required_: Yes
    57  
    58  _Type_: String
    59  
    60  _Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
    61  
    62  #### Description
    63  
    64  The title of the TPS report is a mandatory element.
    65  
    66  _Required_: No
    67  
    68  _Type_: String
    69  
    70  _Minimum_: <code>20</code>
    71  
    72  _Maximum_: <code>250</code>
    73  
    74  _Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
    75  
    76  #### Homepage
    77  
    78  Homepage of the project
    79  
    80  _Required_: No
    81  
    82  _Type_: String
    83  
    84  _Minimum_: <code>20</code>
    85  
    86  _Maximum_: <code>250</code>
    87  
    88  _Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
    89  
    90  #### OauthToken
    91  
    92  OAuth token from GitHub
    93  
    94  _Required_: Yes
    95  
    96  _Type_: String
    97  
    98  _Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
    99  
   100  ## Return Values
   101  
   102  ### Ref
   103  
   104  When you pass the logical ID of this resource to the intrinsic `Ref` function, Ref returns the URL.
   105  
   106  ### Fn::GetAtt
   107  
   108  The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.
   109  
   110  For more information about using the `Fn::GetAtt` intrinsic function, see [Fn::GetAtt](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html).
   111  
   112  #### URL
   113  
   114  URL to the repository