Package software.amazon.awscdk.services.apprunner

Interface CfnService.SourceConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnService.SourceConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnService

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

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 software.amazon.awscdk.services.apprunner.*;
 SourceConfigurationProperty sourceConfigurationProperty = SourceConfigurationProperty.builder()
         .authenticationConfiguration(AuthenticationConfigurationProperty.builder()
                 .accessRoleArn("accessRoleArn")
                 .connectionArn("connectionArn")
                 .build())
         .autoDeploymentsEnabled(false)
         .codeRepository(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())
         .imageRepository(ImageRepositoryProperty.builder()
                 .imageIdentifier("imageIdentifier")
                 .imageRepositoryType("imageRepositoryType")
                 // the properties below are optional
                 .imageConfiguration(ImageConfigurationProperty.builder()
                         .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())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnService.SourceConfigurationProperty.Builder	builder()
default Object	getAuthenticationConfiguration()	Describes the resources that are needed to authenticate access to some source repositories.
default Object	getAutoDeploymentsEnabled()	If true , continuous integration from the source repository is enabled for the App Runner service.
default Object	getCodeRepository()	The description of a source code repository.
default Object	getImageRepository()	The description of a source image repository.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAuthenticationConfiguration

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

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

See Also:

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

getAutoDeploymentsEnabled

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

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).

See Also:

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

getCodeRepository

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

The description of a source code repository.

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

See Also:

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

getImageRepository

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

The description of a source image repository.

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

See Also:

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

builder

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

Returns:

a CfnService.SourceConfigurationProperty.Builder of CfnService.SourceConfigurationProperty