LinuxArmBuildImage (software.amazon.awscdk:aws-cdk-lib 2.42.1 API)

java.lang.Object
- software.amazon.jsii.JsiiObject
- - software.amazon.awscdk.services.codebuild.LinuxArmBuildImage

All Implemented Interfaces:: IBuildImage, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.345Z")
 @Stability(value=Stable)
public class LinuxArmBuildImage
extends software.amazon.jsii.JsiiObject
implements IBuildImage

A CodeBuild image running aarch64 Linux.

This class has a bunch of public constants that represent the CodeBuild ARM images.

You can also specify a custom image using the static method:

LinuxBuildImage.fromEcrRepository(repo[, tag])

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.codebuild.*;
 IBuildImage linuxArmBuildImage = LinuxArmBuildImage.fromCodeBuildImageId("id");

See Also:: https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-available.html

Nested Class Summary
- Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
  software.amazon.jsii.JsiiObject.InitializationMode
- Nested classes/interfaces inherited from interface software.amazon.awscdk.services.codebuild.IBuildImage
  IBuildImage.Jsii$Default, IBuildImage.Jsii$Proxy

Field Summary

Fields
Modifier and Type	Field and Description
`static IBuildImage`	`AMAZON_LINUX_2_STANDARD_1_0` Image "aws/codebuild/amazonlinux2-aarch64-standard:1.0".
`static IBuildImage`	`AMAZON_LINUX_2_STANDARD_2_0` Image "aws/codebuild/amazonlinux2-aarch64-standard:2.0".

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`LinuxArmBuildImage(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`LinuxArmBuildImage(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static IBuildImage`	`fromCodeBuildImageId(String id)` Uses a Docker image provided by CodeBuild.
`static IBuildImage`	`fromEcrRepository(IRepository repository)` Returns an ARM image running Linux from an ECR repository.
`static IBuildImage`	`fromEcrRepository(IRepository repository, String tagOrDigest)` Returns an ARM image running Linux from an ECR repository.
`ComputeType`	`getDefaultComputeType()` The default `ComputeType` to use with this image, if one was not specified in `BuildEnvironment#computeType` explicitly.
`String`	`getImageId()` The Docker image identifier that the build environment uses.
`ImagePullPrincipalType`	`getImagePullPrincipalType()` The type of principal that CodeBuild will use to pull this build Docker image.
`IRepository`	`getRepository()` An optional ECR repository that the image is hosted in.
`ISecret`	`getSecretsManagerCredentials()` The secretsManagerCredentials for access to a private registry.
`String`	`getType()` The type of build environment.
`BuildSpec`	`runScriptBuildspec(String entrypoint)` Make a buildspec to run the indicated script.
`List<String>`	`validate(BuildEnvironment buildEnvironment)` Validates by checking the BuildEnvironment computeType as aarch64 images only support ComputeType.SMALL and ComputeType.LARGE.

Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

- Field Detail
  - AMAZON_LINUX_2_STANDARD_1_0
```
@Stability(value=Stable)
public static final IBuildImage AMAZON_LINUX_2_STANDARD_1_0
```
    Image "aws/codebuild/amazonlinux2-aarch64-standard:1.0".
  - AMAZON_LINUX_2_STANDARD_2_0
```
@Stability(value=Stable)
public static final IBuildImage AMAZON_LINUX_2_STANDARD_2_0
```
    Image "aws/codebuild/amazonlinux2-aarch64-standard:2.0".
- Constructor Detail
  - LinuxArmBuildImage
```
protected LinuxArmBuildImage(software.amazon.jsii.JsiiObjectRef objRef)
```
  - LinuxArmBuildImage
```
protected LinuxArmBuildImage(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
- Method Detail
  - fromCodeBuildImageId
```
@Stability(value=Stable)
 @NotNull
public static IBuildImage fromCodeBuildImageId(@NotNull
                                                                                  String id)
```
    Uses a Docker image provided by CodeBuild.
    Example:
    "aws/codebuild/amazonlinux2-aarch64-standard:1.0";
    Parameters:
    
    id - The image identifier. This parameter is required.
    
    Returns:
    
    A Docker image provided by CodeBuild.
    
    See Also:
    
    https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-available.html
  - fromEcrRepository
```
@Stability(value=Stable)
 @NotNull
public static IBuildImage fromEcrRepository(@NotNull
                                                                               IRepository repository,
                                                                               @Nullable
                                                                               String tagOrDigest)
```
    Returns an ARM image running Linux from an ECR repository.
    NOTE: if the repository is external (i.e. imported), then we won't be able to add a resource policy statement for it so CodeBuild can pull the image.
    
    Parameters:
    
    repository - The ECR repository. This parameter is required.
    
    tagOrDigest - Image tag or digest (default "latest", digests must start with `sha256:`).
    
    Returns:
    
    An aarch64 Linux build image from an ECR repository.
    
    See Also:
    
    https://docs.aws.amazon.com/codebuild/latest/userguide/sample-ecr.html
  - fromEcrRepository
```
@Stability(value=Stable)
 @NotNull
public static IBuildImage fromEcrRepository(@NotNull
                                                                               IRepository repository)
```
    Returns an ARM image running Linux from an ECR repository.
    NOTE: if the repository is external (i.e. imported), then we won't be able to add a resource policy statement for it so CodeBuild can pull the image.
    
    Parameters:
    
    repository - The ECR repository. This parameter is required.
    
    Returns:
    
    An aarch64 Linux build image from an ECR repository.
    
    See Also:
    
    https://docs.aws.amazon.com/codebuild/latest/userguide/sample-ecr.html
  - runScriptBuildspec
```
@Stability(value=Stable)
 @NotNull
public BuildSpec runScriptBuildspec(@NotNull
                                                                       String entrypoint)
```
    Make a buildspec to run the indicated script.
    
    Specified by:
    
    runScriptBuildspec in interface IBuildImage
    
    Parameters:
    
    entrypoint - This parameter is required.
  - validate
```
@Stability(value=Stable)
 @NotNull
public List<String> validate(@NotNull
                                                                BuildEnvironment buildEnvironment)
```
    Validates by checking the BuildEnvironment computeType as aarch64 images only support ComputeType.SMALL and ComputeType.LARGE.
    
    Specified by:
    
    validate in interface IBuildImage
    
    Parameters:
    
    buildEnvironment - BuildEnvironment. This parameter is required.
  - getDefaultComputeType
```
@Stability(value=Stable)
 @NotNull
public ComputeType getDefaultComputeType()
```
    The default ComputeType to use with this image, if one was not specified in BuildEnvironment#computeType explicitly.
    
    Specified by:
    
    getDefaultComputeType in interface IBuildImage
  - getImageId
```
@Stability(value=Stable)
 @NotNull
public String getImageId()
```
    The Docker image identifier that the build environment uses.
    
    Specified by:
    
    getImageId in interface IBuildImage
    
    See Also:
    
    https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-available.html
  - getType
```
@Stability(value=Stable)
 @NotNull
public String getType()
```
    The type of build environment.
    
    Specified by:
    
    getType in interface IBuildImage
  - getImagePullPrincipalType
```
@Stability(value=Stable)
 @Nullable
public ImagePullPrincipalType getImagePullPrincipalType()
```
    The type of principal that CodeBuild will use to pull this build Docker image.
    
    Specified by:
    
    getImagePullPrincipalType in interface IBuildImage
  - getRepository
```
@Stability(value=Stable)
 @Nullable
public IRepository getRepository()
```
    An optional ECR repository that the image is hosted in.
    
    Specified by:
    
    getRepository in interface IBuildImage
  - getSecretsManagerCredentials
```
@Stability(value=Stable)
 @Nullable
public ISecret getSecretsManagerCredentials()
```
    The secretsManagerCredentials for access to a private registry.
    
    Specified by:
    
    getSecretsManagerCredentials in interface IBuildImage

Class LinuxArmBuildImage

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.codebuild.IBuildImage

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Field Detail

AMAZON_LINUX_2_STANDARD_1_0

AMAZON_LINUX_2_STANDARD_2_0

Constructor Detail

LinuxArmBuildImage

LinuxArmBuildImage

Method Detail

fromCodeBuildImageId

fromEcrRepository

fromEcrRepository

runScriptBuildspec

validate

getDefaultComputeType

getImageId

getType

getImagePullPrincipalType

getRepository

getSecretsManagerCredentials