software.amazon.awscdk.services.codebuild

Enum ImagePullPrincipalType

java.lang.Object

java.lang.Enum<ImagePullPrincipalType>

software.amazon.awscdk.services.codebuild.ImagePullPrincipalType

All Implemented Interfaces:

Serializable, Comparable<ImagePullPrincipalType>

@Generated(value="jsii-pacmak/1.29.0 (build 41df200)",
           date="2021-06-02T09:55:06.754Z")
 @Stability(value=Experimental)
public enum ImagePullPrincipalType
extends Enum<ImagePullPrincipalType>

(experimental) The type of principal CodeBuild will use to pull your build Docker image.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CODEBUILD (experimental) CODEBUILD specifies that CodeBuild uses its own identity when pulling the image.
SERVICE_ROLE (experimental) SERVICE_ROLE specifies that AWS CodeBuild uses the project's role when pulling the image.

Method Summary

Modifier and Type	Method and Description
static ImagePullPrincipalType	valueOf(String name) Returns the enum constant of this type with the specified name.
static ImagePullPrincipalType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CODEBUILD

@Stability(value=Experimental)
public static final ImagePullPrincipalType CODEBUILD

(experimental) CODEBUILD specifies that CodeBuild uses its own identity when pulling the image.

This means the resource policy of the ECR repository that hosts the image will be modified to trust CodeBuild's service principal. This is the required principal type when using CodeBuild's pre-defined images.

SERVICE_ROLE

@Stability(value=Experimental)
public static final ImagePullPrincipalType SERVICE_ROLE

(experimental) SERVICE_ROLE specifies that AWS CodeBuild uses the project's role when pulling the image.

The role will be granted pull permissions on the ECR repository hosting the image.

Method Detail

values

public static ImagePullPrincipalType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ImagePullPrincipalType c : ImagePullPrincipalType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ImagePullPrincipalType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null