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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.857Z")
 @Stability(value=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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnCodeRepository.Builder A fluent builder for CfnCodeRepository.
static interface	CfnCodeRepository.GitConfigProperty Specifies configuration details for a Git repository in your AWS account.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnCodeRepository(software.constructs.Construct scope, String id, CfnCodeRepositoryProps props) Create a new `AWS::SageMaker::CodeRepository`.
protected	CfnCodeRepository(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnCodeRepository(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrCodeRepositoryName() The name of the code repository, such as `myCodeRepo` .
protected Map<String,Object>	getCfnProperties()
String	getCodeRepositoryName() The name of the Git repository.
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.
TagManager	getTags() List of tags for Code Repository.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setCodeRepositoryName(String value) The name of the Git repository.
void	setGitConfig(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.
void	setGitConfig(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.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, 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 Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnCodeRepository

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

CfnCodeRepository

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

CfnCodeRepository

@Stability(value=Stable)
public CfnCodeRepository(@NotNull
                                                  software.constructs.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 Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getAttrCodeRepositoryName()

The name of the code repository, such as `myCodeRepo` .

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

List of tags for Code Repository.

getGitConfig

@Stability(value=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(value=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.

setGitConfig

@Stability(value=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.

getCodeRepositoryName

@Stability(value=Stable)
 @Nullable
public String getCodeRepositoryName()

The name of the Git repository.

setCodeRepositoryName

@Stability(value=Stable)
public void setCodeRepositoryName(@Nullable
                                                           String value)

The name of the Git repository.