Amazonka.CodeStar.Types.GitHubCodeDestination

Documentation

data GitHubCodeDestination

Information about the GitHub repository to be created in AWS CodeStar. This is where the source code files provided with the project request will be uploaded after project creation.

See: newGitHubCodeDestination smart constructor.

Constructors

GitHubCodeDestination'

Fields

• description :: Maybe Text

  Description for the GitHub repository to be created in AWS CodeStar. This description displays in GitHub after the repository is created.

• name :: Text

  Name of the GitHub repository to be created in AWS CodeStar.

• type' :: Text

  The type of GitHub repository to be created in AWS CodeStar. Valid values are User or Organization.

• owner :: Text

  The GitHub username for the owner of the GitHub repository to be created in AWS CodeStar. If this repository should be owned by a GitHub organization, provide its name.

• privateRepository :: Bool

  Whether the GitHub repository is to be a private repository.

• issuesEnabled :: Bool

  Whether to enable issues for the GitHub repository.

• token :: Sensitive Text

  The GitHub user's personal access token for the GitHub repository.

Instances

ToJSON GitHubCodeDestination

Defined in Amazonka.CodeStar.Types.GitHubCodeDestination

Methods

toJSON :: GitHubCodeDestination -> Value

toEncoding :: GitHubCodeDestination -> Encoding

toJSONList :: [GitHubCodeDestination] -> Value

toEncodingList :: [GitHubCodeDestination] -> Encoding

Generic GitHubCodeDestination

Defined in Amazonka.CodeStar.Types.GitHubCodeDestination

Associated Types

type Rep GitHubCodeDestination :: Type -> Type

Methods

from :: GitHubCodeDestination -> Rep GitHubCodeDestination x

to :: Rep GitHubCodeDestination x -> GitHubCodeDestination

Show GitHubCodeDestination

Defined in Amazonka.CodeStar.Types.GitHubCodeDestination

Methods

showsPrec :: Int -> GitHubCodeDestination -> ShowS

show :: GitHubCodeDestination -> String

showList :: [GitHubCodeDestination] -> ShowS

NFData GitHubCodeDestination

Defined in Amazonka.CodeStar.Types.GitHubCodeDestination

Methods

rnf :: GitHubCodeDestination -> ()

Eq GitHubCodeDestination

Defined in Amazonka.CodeStar.Types.GitHubCodeDestination

Methods

(==) :: GitHubCodeDestination -> GitHubCodeDestination -> Bool

(/=) :: GitHubCodeDestination -> GitHubCodeDestination -> Bool

Hashable GitHubCodeDestination

Defined in Amazonka.CodeStar.Types.GitHubCodeDestination

Methods

hashWithSalt :: Int -> GitHubCodeDestination -> Int

hash :: GitHubCodeDestination -> Int

type Rep GitHubCodeDestination

Defined in Amazonka.CodeStar.Types.GitHubCodeDestination

type Rep GitHubCodeDestination = D1 ('MetaData "GitHubCodeDestination" "Amazonka.CodeStar.Types.GitHubCodeDestination" "amazonka-codestar-2.0-J6u0QgMrENu7wBmwByxQnV" 'False) (C1 ('MetaCons "GitHubCodeDestination'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :*: ((S1 ('MetaSel ('Just "owner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "privateRepository") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)) :*: (S1 ('MetaSel ('Just "issuesEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "token") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text))))))

newGitHubCodeDestination

Arguments

:: Text

$sel:name:GitHubCodeDestination'

-> Text

$sel:type':GitHubCodeDestination'

-> Text

$sel:owner:GitHubCodeDestination'

-> Bool

$sel:privateRepository:GitHubCodeDestination'

-> Bool

$sel:issuesEnabled:GitHubCodeDestination'

-> Text

$sel:token:GitHubCodeDestination'

-> GitHubCodeDestination

Create a value of GitHubCodeDestination with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:description:GitHubCodeDestination', gitHubCodeDestination_description - Description for the GitHub repository to be created in AWS CodeStar. This description displays in GitHub after the repository is created.

$sel:name:GitHubCodeDestination', gitHubCodeDestination_name - Name of the GitHub repository to be created in AWS CodeStar.

$sel:type':GitHubCodeDestination', gitHubCodeDestination_type - The type of GitHub repository to be created in AWS CodeStar. Valid values are User or Organization.

$sel:owner:GitHubCodeDestination', gitHubCodeDestination_owner - The GitHub username for the owner of the GitHub repository to be created in AWS CodeStar. If this repository should be owned by a GitHub organization, provide its name.

$sel:privateRepository:GitHubCodeDestination', gitHubCodeDestination_privateRepository - Whether the GitHub repository is to be a private repository.

$sel:issuesEnabled:GitHubCodeDestination', gitHubCodeDestination_issuesEnabled - Whether to enable issues for the GitHub repository.

$sel:token:GitHubCodeDestination', gitHubCodeDestination_token - The GitHub user's personal access token for the GitHub repository.

gitHubCodeDestination_description :: Lens' GitHubCodeDestination (Maybe Text)

Description for the GitHub repository to be created in AWS CodeStar. This description displays in GitHub after the repository is created.

gitHubCodeDestination_name :: Lens' GitHubCodeDestination Text

Name of the GitHub repository to be created in AWS CodeStar.

gitHubCodeDestination_type :: Lens' GitHubCodeDestination Text

The type of GitHub repository to be created in AWS CodeStar. Valid values are User or Organization.

gitHubCodeDestination_owner :: Lens' GitHubCodeDestination Text

The GitHub username for the owner of the GitHub repository to be created in AWS CodeStar. If this repository should be owned by a GitHub organization, provide its name.

gitHubCodeDestination_privateRepository :: Lens' GitHubCodeDestination Bool

Whether the GitHub repository is to be a private repository.

gitHubCodeDestination_issuesEnabled :: Lens' GitHubCodeDestination Bool

Whether to enable issues for the GitHub repository.

gitHubCodeDestination_token :: Lens' GitHubCodeDestination Text

The GitHub user's personal access token for the GitHub repository.