GitHub::Repositories::Repository

The GitHub::Repositories::Repository resource creates a GitHub personal or organizational repository.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
    "Type" : "GitHub::Repositories::Repository",
    "Properties" : {
        "Username" : String,
        "Password" : String,
        "Name" : String,
        "Owner" : String,
        "Description" : String,
        "IsPrivate" : Boolean,
        "Homepage" : String,
        "HasWiki" : Boolean,
        "HasIssues" : Boolean
    }
}

YAML

Type: GitHub::Repositories::Repository
Properties:
    Username: String
    Password: String
    Name: String
    Owner: String
    Description: String
    IsPrivate: Boolean
    Homepage: String
    HasWiki: Boolean
    HasIssues: Boolean

Properties

Username

The username of the authenticating user.

Required: Yes

Type: String

Update requires: Replacement

Password

The password or personal access token of the authenticating user.

Required: Yes

Type: String

Update requires: Replacement

Name

The name of the repository.

Required: Yes

Type: String

Update requires: Replacement

Owner

The organization in which the repository is located. This is required to make the repository organizational.

Required: No

Type: String

Update requires: Replacement

Description

A description of the repository.

Required: No

Type: String

Update requires: No interruption

IsPrivate

Whether the repository is a private repository. Repositories are created as public (e.g. open source) by default.

Required: No

Type: Boolean

Update requires: No interruption

Homepage

A URL of a page describing the project.

Required: No

Type: String

Update requires: No interruption

HasWiki

Whether the Wiki feature is enabled in the repository.

Required: No

Type: Boolean

Update requires: No interruption

HasIssues

Whether the Issues feature is enabled in the repository.

Required: No

Type: Boolean

Update requires: No interruption

Return Values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the short path (owner/name) of the repository.

Fn::GetAtt

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.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

RepoPath

The short path (owner/name) of the repository.