Package software.amazon.awscdk.services.storagegateway

Class CfnTapePool

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.storagegateway.CfnTapePool
All Implemented Interfaces:
IInspectable, IEnvironmentAware, ITapePoolRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.138.0 (build 0ca7ee8)", date="2026-08-10T14:51:13.228Z") @Stability(Stable) public class CfnTapePool extends CfnResource implements IInspectable, ITapePoolRef, ITaggableV2
Creates a custom tape pool for archiving virtual tapes with optional retention lock.

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.storagegateway.*;
 CfnTapePool cfnTapePool = CfnTapePool.Builder.create(this, "MyCfnTapePool")
         .poolName("poolName")
         .storageClass("storageClass")
         // the properties below are optional
         .retentionLockTimeInDays(123)
         .retentionLockType("retentionLockType")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnTapePool

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

    • CfnTapePool

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

    • CfnTapePool

      @Stability(Stable) public CfnTapePool(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnTapePoolProps props)
      Create a new AWS::StorageGateway::TapePool.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForTapePool

      @Stability(Stable) @NotNull public static String arnForTapePool(@NotNull ITapePoolRef resource)
      Parameters:
      resource - This parameter is required.

    • fromPoolId

      @Stability(Stable) @NotNull public static ITapePoolRef fromPoolId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String poolId)
      Creates a new ITapePoolRef from a poolId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      poolId - This parameter is required.

    • isCfnTapePool

      @Stability(Stable) @NotNull public static Boolean isCfnTapePool(@NotNull Object x)
      Checks whether the given object is a CfnTapePool.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrPoolArn

      @Stability(Stable) @NotNull public String getAttrPoolArn()
      The Amazon Resource Name (ARN) of the custom tape pool.

    • getAttrPoolId

      @Stability(Stable) @NotNull public String getAttrPoolId()
      The unique identifier of the custom tape pool, extracted from the ARN.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getCfnPropertyNames

      @Stability(Stable) @NotNull protected Map<String,String> getCfnPropertyNames()
      Overrides:
      getCfnPropertyNames in class CfnResource

    • getTapePoolRef

      @Stability(Stable) @NotNull public TapePoolReference getTapePoolRef()
      A reference to a TapePool resource.
      Specified by:
      getTapePoolRef in interface ITapePoolRef

    • getPoolName

      @Stability(Stable) @NotNull public String getPoolName()
      The name of the custom tape pool.

    • setPoolName

      @Stability(Stable) public void setPoolName(@NotNull String value)
      The name of the custom tape pool.

    • getStorageClass

      @Stability(Stable) @NotNull public String getStorageClass()
      The storage class associated with the custom pool (S3 Glacier or S3 Glacier Deep Archive).

    • setStorageClass

      @Stability(Stable) public void setStorageClass(@NotNull String value)
      The storage class associated with the custom pool (S3 Glacier or S3 Glacier Deep Archive).

    • getRetentionLockTimeInDays

      @Stability(Stable) @Nullable public Number getRetentionLockTimeInDays()
      Tape retention lock time in days (up to 36,500 days / 100 years).

    • setRetentionLockTimeInDays

      @Stability(Stable) public void setRetentionLockTimeInDays(@Nullable Number value)
      Tape retention lock time in days (up to 36,500 days / 100 years).

    • getRetentionLockType

      @Stability(Stable) @Nullable public String getRetentionLockType()
      Tape retention lock type.

    • setRetentionLockType

      @Stability(Stable) public void setRetentionLockType(@Nullable String value)
      Tape retention lock type.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      A list of up to 50 tags for the tape pool.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      A list of up to 50 tags for the tape pool.