Package software.amazon.awscdk.services.rekognition

Class CfnCollection

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.rekognition.CfnCollection
All Implemented Interfaces:
IInspectable, ITaggable, ICollectionRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-29T11:15:47.245Z") @Stability(Stable) public class CfnCollection extends CfnResource implements IInspectable, ICollectionRef, ITaggable
The AWS::Rekognition::Collection type creates a server-side container called a collection.

You can use a collection to store information about detected faces and search for known faces in images, stored videos, and streaming videos.

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.rekognition.*;
 CfnCollection cfnCollection = CfnCollection.Builder.create(this, "MyCfnCollection")
         .collectionId("collectionId")
         // the properties below are optional
         .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

    • CfnCollection

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

    • CfnCollection

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

    • CfnCollection

      @Stability(Stable) public CfnCollection(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnCollectionProps props)
      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

    • fromCollectionArn

      @Stability(Stable) @NotNull public static ICollectionRef fromCollectionArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn)
      Creates a new ICollectionRef from an ARN.

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

    • fromCollectionId

      @Stability(Stable) @NotNull public static ICollectionRef fromCollectionId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String collectionId)
      Creates a new ICollectionRef from a collectionId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      collectionId - 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()
      Returns the Amazon Resource Name of the collection.

    • getCfnProperties

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

    • getCollectionRef

      @Stability(Stable) @NotNull public CollectionReference getCollectionRef()
      A reference to a Collection resource.
      Specified by:
      getCollectionRef in interface ICollectionRef

    • getTags

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

    • getCollectionId

      @Stability(Stable) @NotNull public String getCollectionId()
      ID for the collection that you are creating.

    • setCollectionId

      @Stability(Stable) public void setCollectionId(@NotNull String value)
      ID for the collection that you are creating.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      A set of tags (key-value pairs) that you want to attach to the collection.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      A set of tags (key-value pairs) that you want to attach to the collection.