Skip to content
v2.273.0

Experimental

@aws-cdk/aws-apprunner-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

CodeRepositoryProps Struct ​

Properties of the CodeRepository.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as apprunner_alpha from '@aws-cdk/aws-apprunner-alpha';

declare const gitHubConnection: apprunner_alpha.GitHubConnection;
declare const runtime: apprunner_alpha.Runtime;
declare const secret: apprunner_alpha.Secret;
const codeRepositoryProps: apprunner_alpha.CodeRepositoryProps = {
  codeConfiguration: {
    configurationSource: apprunner_alpha.ConfigurationSourceType.REPOSITORY,

    // the properties below are optional
    configurationValues: {
      runtime: runtime,

      // the properties below are optional
      buildCommand: 'buildCommand',
      environment: {
        environmentKey: 'environment',
      },
      environmentSecrets: {
        environmentSecretsKey: secret,
      },
      environmentVariables: {
        environmentVariablesKey: 'environmentVariables',
      },
      port: 'port',
      startCommand: 'startCommand',
    },
  },
  connection: gitHubConnection,
  repositoryUrl: 'repositoryUrl',
  sourceCodeVersion: {
    type: 'type',
    value: 'value',
  },
};

Properties ​

codeConfigurationCodeConfigurationcode_configurationCodeConfigurationcodeConfigurationCodeConfigurationCodeConfigurationCodeConfigurationCodeConfigurationCodeConfigurationrequired#
Configuration for building and running the service from a source code repository.
connectionGitHubConnectionconnectionGitHubConnectionconnectionGitHubConnectionConnectionGitHubConnectionConnectionGitHubConnectionrequired#
The App Runner connection for GitHub.
repositoryUrlstringrepository_urlstrrepositoryUrlStringRepositoryUrlstringRepositoryUrl*stringrequired#
The location of the repository that contains the source code.
sourceCodeVersionSourceCodeVersionsource_code_versionSourceCodeVersionsourceCodeVersionSourceCodeVersionSourceCodeVersionSourceCodeVersionSourceCodeVersionSourceCodeVersionrequired#
The version that should be used within the source code repository.