Package software.amazon.awscdk.services.omics

Class CfnReference

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.omics.CfnReference
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IReferenceRef, 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:07.570Z") @Stability(Stable) public class CfnReference extends CfnResource implements IInspectable, IReferenceRef, ITaggableV2
Represents a genomic reference stored in an AWS HealthOmics reference store.

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.omics.*;
 CfnReference cfnReference = CfnReference.Builder.create(this, "MyCfnReference")
         .description("description")
         .name("name")
         .referenceStoreId("referenceStoreId")
         .tags(List.of(TagsItemsProperty.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

    • CfnReference

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

    • CfnReference

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

    • CfnReference

      @Stability(Stable) public CfnReference(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnReferenceProps props)
      Create a new AWS::Omics::Reference.

      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.

    • CfnReference

      @Stability(Stable) public CfnReference(@NotNull software.constructs.Construct scope, @NotNull String id)
      Create a new AWS::Omics::Reference.

      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.

  • Method Details

    • arnForReference

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

    • isCfnReference

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

      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.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The reference's ARN.

    • getAttrCreationJobId

      @Stability(Stable) @NotNull public String getAttrCreationJobId()
      The reference's creation job ID.

    • getAttrCreationTime

      @Stability(Stable) @NotNull public String getAttrCreationTime()
      When the reference was created.

    • getAttrCreationType

      @Stability(Stable) @NotNull public String getAttrCreationType()
      The reference's creation type.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The reference's ID.

    • getAttrMd5

      @Stability(Stable) @NotNull public String getAttrMd5()
      The reference's MD5 checksum.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      The reference's status.

    • getAttrUpdateTime

      @Stability(Stable) @NotNull public String getAttrUpdateTime()
      When the reference was updated.

    • 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

    • getReferenceRef

      @Stability(Stable) @NotNull public ReferenceReference getReferenceRef()
      A reference to a Reference resource.
      Specified by:
      getReferenceRef in interface IReferenceRef

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The reference's description.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The reference's description.

    • getName

      @Stability(Stable) @Nullable public String getName()
      The reference's name.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      The reference's name.

    • getReferenceStoreId

      @Stability(Stable) @Nullable public String getReferenceStoreId()
      The reference's reference store ID.

    • setReferenceStoreId

      @Stability(Stable) public void setReferenceStoreId(@Nullable String value)
      The reference's reference store ID.

    • getTags

      @Stability(Stable) @Nullable public List<CfnReference.TagsItemsProperty> getTags()
      Tags for the reference.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnReference.TagsItemsProperty> value)
      Tags for the reference.