Package software.amazon.awscdk.services.sagemaker

Class CfnCodeRepository

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.sagemaker.CfnCodeRepository
All Implemented Interfaces:
IInspectable, ITaggable, ICodeRepositoryRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-29T11:15:47.928Z") @Stability(Stable) public class CfnCodeRepository extends CfnResource implements IInspectable, ICodeRepositoryRef, ITaggable
Creates a Git repository as a resource in your SageMaker AI account.

You can associate the repository with notebook instances so that you can use Git source control for the notebooks you create. The Git repository is a resource in your SageMaker AI account, so it can be associated with more than one notebook instance, and it persists independently from the lifecycle of any notebook instances it is associated with.

The repository can be hosted either in AWS CodeCommit or in any other Git repository.

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.sagemaker.*;
 CfnCodeRepository cfnCodeRepository = CfnCodeRepository.Builder.create(this, "MyCfnCodeRepository")
         .gitConfig(GitConfigProperty.builder()
                 .repositoryUrl("repositoryUrl")
                 // the properties below are optional
                 .branch("branch")
                 .secretArn("secretArn")
                 .build())
         // the properties below are optional
         .codeRepositoryName("codeRepositoryName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnCodeRepository

      protected CfnCodeRepository(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnCodeRepository

      protected CfnCodeRepository(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnCodeRepository

      @Stability(Stable) public CfnCodeRepository(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnCodeRepositoryProps 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

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      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 class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrCodeRepositoryName

      @Stability(Stable) @NotNull public String getAttrCodeRepositoryName()
      The name of the code repository, such as myCodeRepo .

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getCodeRepositoryRef

      @Stability(Stable) @NotNull public CodeRepositoryReference getCodeRepositoryRef()
      A reference to a CodeRepository resource.
      Specified by:
      getCodeRepositoryRef in interface ICodeRepositoryRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getGitConfig

      @Stability(Stable) @NotNull public Object getGitConfig()
      Configuration details for the Git repository, including the URL where it is located and the ARN of the AWS Secrets Manager secret that contains the credentials used to access the repository.

      Returns union: either IResolvable or CfnCodeRepository.GitConfigProperty

    • setGitConfig

      @Stability(Stable) public void setGitConfig(@NotNull IResolvable value)
      Configuration details for the Git repository, including the URL where it is located and the ARN of the AWS Secrets Manager secret that contains the credentials used to access the repository.

    • setGitConfig

      @Stability(Stable) public void setGitConfig(@NotNull CfnCodeRepository.GitConfigProperty value)
      Configuration details for the Git repository, including the URL where it is located and the ARN of the AWS Secrets Manager secret that contains the credentials used to access the repository.

    • getCodeRepositoryName

      @Stability(Stable) @Nullable public String getCodeRepositoryName()
      The name of the Git repository.

    • setCodeRepositoryName

      @Stability(Stable) public void setCodeRepositoryName(@Nullable String value)
      The name of the Git repository.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      List of tags for Code Repository.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      List of tags for Code Repository.