Package software.amazon.awscdk.services.ecr.assets

Class TarballImageAsset

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.services.ecr.assets.TarballImageAsset
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.97.0 (build 729de35)", date="2024-04-24T21:00:29.060Z") @Stability(Stable) public class TarballImageAsset extends software.constructs.Construct
An asset that represents a Docker image.

The image will loaded from an existing tarball and uploaded to an ECR repository.

Example: 

 import software.amazon.awscdk.services.ecr.assets.TarballImageAsset;
 TarballImageAsset asset = TarballImageAsset.Builder.create(this, "MyBuildImage")
         .tarballFile("local-image.tar")
         .build();

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    TarballImageAsset.Builder
    A fluent builder for TarballImageAsset.

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

    software.amazon.jsii.JsiiObject.InitializationMode

    Nested classes/interfaces inherited from interface software.constructs.IConstruct

    software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    TarballImageAsset(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    TarballImageAsset(software.amazon.jsii.JsiiObjectRef objRef)
     
     
    TarballImageAsset(software.constructs.Construct scope, String id, TarballImageAssetProps props)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getAssetHash()
    A hash of this asset, which is available at construction time.
    String
    getImageTag()
    The tag of this asset when it is uploaded to ECR.
    String
    getImageUri()
    The full URI of the image (including a tag).
    IRepository
    getRepository()
    Repository where the image is stored.
    void
    setImageUri(String value)
    The full URI of the image (including a tag).
    void
    setRepository(IRepository value)
    Repository where the image is stored.

    Methods inherited from class software.constructs.Construct

    getNode, isConstruct, toString

    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, wait, wait, wait

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Constructor Details

    • TarballImageAsset

      protected TarballImageAsset(software.amazon.jsii.JsiiObjectRef objRef)

    • TarballImageAsset

      protected TarballImageAsset(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • TarballImageAsset

      @Stability(Stable) public TarballImageAsset(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull TarballImageAssetProps props)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      props - This parameter is required.

  • Method Details

    • getAssetHash

      @Stability(Stable) @NotNull public String getAssetHash()
      A hash of this asset, which is available at construction time.

      As this is a plain string, it can be used in construct IDs in order to enforce creation of a new resource when the content hash has changed.

    • getImageTag

      @Stability(Stable) @NotNull public String getImageTag()
      The tag of this asset when it is uploaded to ECR.

      The tag may differ from the assetHash if a stack synthesizer adds a dockerTagPrefix.

    • getImageUri

      @Stability(Stable) @NotNull public String getImageUri()
      The full URI of the image (including a tag).

      Use this reference to pull the asset.

    • setImageUri

      @Stability(Stable) public void setImageUri(@NotNull String value)
      The full URI of the image (including a tag).

      Use this reference to pull the asset.

    • getRepository

      @Stability(Stable) @NotNull public IRepository getRepository()
      Repository where the image is stored.

    • setRepository

      @Stability(Stable) public void setRepository(@NotNull IRepository value)
      Repository where the image is stored.