Package software.amazon.awscdk.services.apprunner

Interface CfnService.CodeRepositoryProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnService.CodeRepositoryProperty.Jsii$Proxy

Enclosing class:

CfnService

@Stability(Stable)
public static interface CfnService.CodeRepositoryProperty
extends software.amazon.jsii.JsiiSerializable

Describes a source code 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.apprunner.*;
 CodeRepositoryProperty codeRepositoryProperty = CodeRepositoryProperty.builder()
         .repositoryUrl("repositoryUrl")
         .sourceCodeVersion(SourceCodeVersionProperty.builder()
                 .type("type")
                 .value("value")
                 .build())
         // the properties below are optional
         .codeConfiguration(CodeConfigurationProperty.builder()
                 .configurationSource("configurationSource")
                 // the properties below are optional
                 .codeConfigurationValues(CodeConfigurationValuesProperty.builder()
                         .runtime("runtime")
                         // the properties below are optional
                         .buildCommand("buildCommand")
                         .port("port")
                         .runtimeEnvironmentSecrets(List.of(KeyValuePairProperty.builder()
                                 .name("name")
                                 .value("value")
                                 .build()))
                         .runtimeEnvironmentVariables(List.of(KeyValuePairProperty.builder()
                                 .name("name")
                                 .value("value")
                                 .build()))
                         .startCommand("startCommand")
                         .build())
                 .build())
         .sourceDirectory("sourceDirectory")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-coderepository.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnService.CodeRepositoryProperty.Builder	builder()
default Object	getCodeConfiguration()	Configuration for building and running the service from a source code repository.
String	getRepositoryUrl()	The location of the repository that contains the source code.
Object	getSourceCodeVersion()	The version that should be used within the source code repository.
default String	getSourceDirectory()	The path of the directory that stores source code and configuration files.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getRepositoryUrl

@Stability(Stable)
@NotNull
String getRepositoryUrl()

The location of the repository that contains the source code.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-coderepository.html#cfn-apprunner-service-coderepository-repositoryurl

getSourceCodeVersion

@Stability(Stable)
@NotNull
Object getSourceCodeVersion()

The version that should be used within the source code repository.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-coderepository.html#cfn-apprunner-service-coderepository-sourcecodeversion

getCodeConfiguration

@Stability(Stable)
@Nullable
default Object getCodeConfiguration()

Configuration for building and running the service from a source code repository.

CodeConfiguration is required only for CreateService request.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-coderepository.html#cfn-apprunner-service-coderepository-codeconfiguration

getSourceDirectory

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

The path of the directory that stores source code and configuration files.

The build and start commands also execute from here. The path is absolute from root and, if not specified, defaults to the repository root.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-coderepository.html#cfn-apprunner-service-coderepository-sourcedirectory

builder

@Stability(Stable)
static CfnService.CodeRepositoryProperty.Builder builder()

Returns:

a CfnService.CodeRepositoryProperty.Builder of CfnService.CodeRepositoryProperty