Package software.amazon.awscdk.services.codecommit

Interface RepositoryProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

RepositoryProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:38.265Z")
@Stability(Stable)
public interface RepositoryProps
extends software.amazon.jsii.JsiiSerializable

Example:

 // Source stage: read from repository
 Repository repo = Repository.Builder.create(stack, "TemplateRepo")
         .repositoryName("template-repo")
         .build();
 Artifact sourceOutput = new Artifact("SourceArtifact");
 CodeCommitSourceAction source = CodeCommitSourceAction.Builder.create()
         .actionName("Source")
         .repository(repo)
         .output(sourceOutput)
         .trigger(CodeCommitTrigger.POLL)
         .build();
 Map<String, Object> sourceStage = Map.of(
         "stageName", "Source",
         "actions", List.of(source));
 // Deployment stage: create and deploy changeset with manual approval
 String stackName = "OurStack";
 String changeSetName = "StagedChangeSet";
 Map<String, Object> prodStage = Map.of(
         "stageName", "Deploy",
         "actions", List.of(
             CloudFormationCreateReplaceChangeSetAction.Builder.create()
                     .actionName("PrepareChanges")
                     .stackName(stackName)
                     .changeSetName(changeSetName)
                     .adminPermissions(true)
                     .templatePath(sourceOutput.atPath("template.yaml"))
                     .runOrder(1)
                     .build(),
             ManualApprovalAction.Builder.create()
                     .actionName("ApproveChanges")
                     .runOrder(2)
                     .build(),
             CloudFormationExecuteChangeSetAction.Builder.create()
                     .actionName("ExecuteChanges")
                     .stackName(stackName)
                     .changeSetName(changeSetName)
                     .runOrder(3)
                     .build()));
 Pipeline.Builder.create(stack, "Pipeline")
         .stages(List.of(sourceStage, prodStage))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static RepositoryProps.Builder	builder()
default Code	getCode()	The contents with which to initialize the repository after it has been created.
default String	getDescription()	A description of the repository.
String	getRepositoryName()	Name of the repository.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getRepositoryName

@Stability(Stable)
@NotNull
String getRepositoryName()

Name of the repository.

This property is required for all CodeCommit repositories.

getCode

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

The contents with which to initialize the repository after it has been created.

Default: - No initialization (create empty repo)

getDescription

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

A description of the repository.

Use the description to identify the purpose of the repository.

Default: - No description.

builder

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

Returns:

a RepositoryProps.Builder of RepositoryProps