Class CfnGitHubRepository
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.codestar.CfnGitHubRepository
- All Implemented Interfaces:
IInspectable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2024-11-06T23:25:06.258Z")
@Stability(Stable)
public class CfnGitHubRepository
extends CfnResource
implements IInspectable
The
AWS::CodeStar::GitHubRepository
resource creates a GitHub repository where users can store source code for use with AWS workflows.
You must provide a location for the source code ZIP file in the AWS CloudFormation template, so the code can be uploaded to the created repository. You must have created a personal access token in GitHub to provide in the AWS CloudFormation template. AWS uses this token to connect to GitHub on your behalf.
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.*; CfnGitHubRepository cfnGitHubRepository = CfnGitHubRepository.Builder.create(this, "MyCfnGitHubRepository") .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:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
A fluent builder forCfnGitHubRepository
.static interface
TheCode
property type specifies information about code to be committed.static interface
TheS3
property type specifies information about the Amazon S3 bucket that contains the code to be committed to the new repository.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnGitHubRepository
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnGitHubRepository
(software.amazon.jsii.JsiiObjectRef objRef) CfnGitHubRepository
(software.constructs.Construct scope, String id, CfnGitHubRepositoryProps props) -
Method Summary
Modifier and TypeMethodDescriptiongetCode()
Information about code to be committed to a repository after it is created in an AWS CloudFormation stack.Indicates whether to enable issues for the GitHub repository.Indicates whether the GitHub repository is a private repository.The GitHub user's personal access token for the GitHub repository.A comment or description about the new repository.The name of the repository you want to create in GitHub with AWS CloudFormation stack creation.The GitHub user name for the owner of the GitHub repository to be created.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setCode
(IResolvable value) Information about code to be committed to a repository after it is created in an AWS CloudFormation stack.void
Information about code to be committed to a repository after it is created in an AWS CloudFormation stack.void
setConnectionArn
(String value) void
setEnableIssues
(Boolean value) Indicates whether to enable issues for the GitHub repository.void
setEnableIssues
(IResolvable value) Indicates whether to enable issues for the GitHub repository.void
setIsPrivate
(Boolean value) Indicates whether the GitHub repository is a private repository.void
setIsPrivate
(IResolvable value) Indicates whether the GitHub repository is a private repository.void
setRepositoryAccessToken
(String value) The GitHub user's personal access token for the GitHub repository.void
setRepositoryDescription
(String value) A comment or description about the new repository.void
setRepositoryName
(String value) The name of the repository you want to create in GitHub with AWS CloudFormation stack creation.void
setRepositoryOwner
(String value) The GitHub user name for the owner of the GitHub repository to be created.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnGitHubRepository
protected CfnGitHubRepository(software.amazon.jsii.JsiiObjectRef objRef) -
CfnGitHubRepository
protected CfnGitHubRepository(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnGitHubRepository
@Stability(Stable) public CfnGitHubRepository(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnGitHubRepositoryProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrId
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getRepositoryName
The name of the repository you want to create in GitHub with AWS CloudFormation stack creation. -
setRepositoryName
The name of the repository you want to create in GitHub with AWS CloudFormation stack creation. -
getRepositoryOwner
The GitHub user name for the owner of the GitHub repository to be created. -
setRepositoryOwner
The GitHub user name for the owner of the GitHub repository to be created. -
getCode
Information about code to be committed to a repository after it is created in an AWS CloudFormation stack. -
setCode
Information about code to be committed to a repository after it is created in an AWS CloudFormation stack. -
setCode
Information about code to be committed to a repository after it is created in an AWS CloudFormation stack. -
getConnectionArn
-
setConnectionArn
-
getEnableIssues
Indicates whether to enable issues for the GitHub repository. -
setEnableIssues
Indicates whether to enable issues for the GitHub repository. -
setEnableIssues
Indicates whether to enable issues for the GitHub repository. -
getIsPrivate
Indicates whether the GitHub repository is a private repository. -
setIsPrivate
Indicates whether the GitHub repository is a private repository. -
setIsPrivate
Indicates whether the GitHub repository is a private repository. -
getRepositoryAccessToken
The GitHub user's personal access token for the GitHub repository. -
setRepositoryAccessToken
The GitHub user's personal access token for the GitHub repository. -
getRepositoryDescription
A comment or description about the new repository. -
setRepositoryDescription
A comment or description about the new repository.
-