interface SourceConfigurationProperty

Language	Type name
.NET	`Amazon.CDK.AWS.AppRunner.CfnService.SourceConfigurationProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsapprunner#CfnService_SourceConfigurationProperty`
Java	`software.amazon.awscdk.services.apprunner.CfnService.SourceConfigurationProperty`
Python	`aws_cdk.aws_apprunner.CfnService.SourceConfigurationProperty`
TypeScript	`aws-cdk-lib` » `aws_apprunner` » `CfnService` » `SourceConfigurationProperty`

Describes the source deployed to an AWS App Runner service.

It can be a code or an image repository.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_apprunner as apprunner } from 'aws-cdk-lib';
const sourceConfigurationProperty: apprunner.CfnService.SourceConfigurationProperty = {
  authenticationConfiguration: {
    accessRoleArn: 'accessRoleArn',
    connectionArn: 'connectionArn',
  },
  autoDeploymentsEnabled: false,
  codeRepository: {
    repositoryUrl: 'repositoryUrl',
    sourceCodeVersion: {
      type: 'type',
      value: 'value',
    },

    // the properties below are optional
    codeConfiguration: {
      configurationSource: 'configurationSource',

      // the properties below are optional
      codeConfigurationValues: {
        runtime: 'runtime',

        // the properties below are optional
        buildCommand: 'buildCommand',
        port: 'port',
        runtimeEnvironmentSecrets: [{
          name: 'name',
          value: 'value',
        }],
        runtimeEnvironmentVariables: [{
          name: 'name',
          value: 'value',
        }],
        startCommand: 'startCommand',
      },
    },
    sourceDirectory: 'sourceDirectory',
  },
  imageRepository: {
    imageIdentifier: 'imageIdentifier',
    imageRepositoryType: 'imageRepositoryType',

    // the properties below are optional
    imageConfiguration: {
      port: 'port',
      runtimeEnvironmentSecrets: [{
        name: 'name',
        value: 'value',
      }],
      runtimeEnvironmentVariables: [{
        name: 'name',
        value: 'value',
      }],
      startCommand: 'startCommand',
    },
  },
};

Properties

Name	Type	Description
authenticationConfiguration?	`IResolvable` `\|` `AuthenticationConfigurationProperty`	Describes the resources that are needed to authenticate access to some source repositories.
autoDeploymentsEnabled?	`boolean \|` `IResolvable`	If `true` , continuous integration from the source repository is enabled for the App Runner service.
codeRepository?	`IResolvable` `\|` `CodeRepositoryProperty`	The description of a source code repository.
imageRepository?	`IResolvable` `\|` `ImageRepositoryProperty`	The description of a source image repository.

authenticationConfiguration?

Type: IResolvable | AuthenticationConfigurationProperty (optional)

Describes the resources that are needed to authenticate access to some source repositories.

autoDeploymentsEnabled?

Type: boolean | IResolvable (optional)

If true , continuous integration from the source repository is enabled for the App Runner service.

Each repository change (including any source code commit or new image version) starts a deployment.

Default: App Runner sets to false for a source image that uses an ECR Public repository or an ECR repository that's in an AWS account other than the one that the service is in. App Runner sets to true in all other cases (which currently include a source code repository or a source image using a same-account ECR repository).

codeRepository?

Type: IResolvable | CodeRepositoryProperty (optional)

The description of a source code repository.

You must provide either this member or ImageRepository (but not both).

imageRepository?

Type: IResolvable | ImageRepositoryProperty (optional)

The description of a source image repository.

You must provide either this member or CodeRepository (but not both).