Package software.amazon.awscdk.services.sagemaker

Class CfnCodeRepository

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.sagemaker.CfnCodeRepository
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:35.085Z") @Stability(Stable) public class CfnCodeRepository extends CfnResource implements IInspectable
A CloudFormation AWS::SageMaker::CodeRepository.

Creates a Git repository as a resource in your SageMaker 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 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();

  • 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 Construct scope, @NotNull String id, @NotNull CfnCodeRepositoryProps props)
      Create a new AWS::SageMaker::CodeRepository.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      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 .

    • getCfnProperties

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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      List of tags for Code Repository.

    • 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.

    • 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.