Package software.amazon.awscdk.services.codestar

Interface CfnGitHubRepositoryProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnGitHubRepositoryProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-23T05:56:13.202Z")
@Stability(Stable)
public interface CfnGitHubRepositoryProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnGitHubRepository.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.codestar.*;
 CfnGitHubRepositoryProps cfnGitHubRepositoryProps = CfnGitHubRepositoryProps.builder()
         .repositoryName("repositoryName")
         .repositoryOwner("repositoryOwner")
         // the properties below are optional
         .code(CodeProperty.builder()
                 .s3(S3Property.builder()
                         .bucket("bucket")
                         .key("key")
                         // the properties below are optional
                         .objectVersion("objectVersion")
                         .build())
                 .build())
         .connectionArn("connectionArn")
         .enableIssues(false)
         .isPrivate(false)
         .repositoryAccessToken("repositoryAccessToken")
         .repositoryDescription("repositoryDescription")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestar-githubrepository.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnGitHubRepositoryProps.Builder	A builder for CfnGitHubRepositoryProps
static final class	CfnGitHubRepositoryProps.Jsii$Proxy	An implementation for CfnGitHubRepositoryProps

Method Summary

Modifier and Type	Method	Description
static CfnGitHubRepositoryProps.Builder	builder()
default Object	getCode()	Information about code to be committed to a repository after it is created in an AWS CloudFormation stack.
default String	getConnectionArn()
default Object	getEnableIssues()	Indicates whether to enable issues for the GitHub repository.
default Object	getIsPrivate()	Indicates whether the GitHub repository is a private repository.
default String	getRepositoryAccessToken()	The GitHub user's personal access token for the GitHub repository.
default String	getRepositoryDescription()	A comment or description about the new repository.
String	getRepositoryName()	The name of the repository you want to create in GitHub with AWS CloudFormation stack creation.
String	getRepositoryOwner()	The GitHub user name for the owner of the GitHub repository to be created.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getRepositoryName

@Stability(Stable)
@NotNull
String getRepositoryName()

The name of the repository you want to create in GitHub with AWS CloudFormation stack creation.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestar-githubrepository.html#cfn-codestar-githubrepository-repositoryname

getRepositoryOwner

@Stability(Stable)
@NotNull
String getRepositoryOwner()

The GitHub user name for the owner of the GitHub repository to be created.

If this repository should be owned by a GitHub organization, provide its name.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestar-githubrepository.html#cfn-codestar-githubrepository-repositoryowner

getCode

@Stability(Stable)
@Nullable
default Object getCode()

Information about code to be committed to a repository after it is created in an AWS CloudFormation stack.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestar-githubrepository.html#cfn-codestar-githubrepository-code

getConnectionArn

@Stability(Stable)
@Nullable
default String getConnectionArn()

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestar-githubrepository.html#cfn-codestar-githubrepository-connectionarn

getEnableIssues

@Stability(Stable)
@Nullable
default Object getEnableIssues()

Indicates whether to enable issues for the GitHub repository.

You can use GitHub issues to track information and bugs for your repository.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestar-githubrepository.html#cfn-codestar-githubrepository-enableissues

getIsPrivate

@Stability(Stable)
@Nullable
default Object getIsPrivate()

Indicates whether the GitHub repository is a private repository.

If so, you choose who can see and commit to this repository.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestar-githubrepository.html#cfn-codestar-githubrepository-isprivate

getRepositoryAccessToken

@Stability(Stable)
@Nullable
default String getRepositoryAccessToken()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestar-githubrepository.html#cfn-codestar-githubrepository-repositoryaccesstoken

getRepositoryDescription

@Stability(Stable)
@Nullable
default String getRepositoryDescription()

A comment or description about the new repository.

This description is displayed in GitHub after the repository is created.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codestar-githubrepository.html#cfn-codestar-githubrepository-repositorydescription

builder

@Stability(Stable)
static CfnGitHubRepositoryProps.Builder builder()

Returns:

a CfnGitHubRepositoryProps.Builder of CfnGitHubRepositoryProps