1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. rekognition
  5. Collection

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

aws-native.rekognition.Collection

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

The AWS::Rekognition::Collection type creates an Amazon Rekognition Collection. A collection is a logical grouping of information about detected faces which can later be referenced for searches on the group

Create Collection Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Collection(name: string, args: CollectionArgs, opts?: CustomResourceOptions);
@overload
def Collection(resource_name: str,
               args: CollectionArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def Collection(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               collection_id: Optional[str] = None,
               tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
func NewCollection(ctx *Context, name string, args CollectionArgs, opts ...ResourceOption) (*Collection, error)
public Collection(string name, CollectionArgs args, CustomResourceOptions? opts = null)
public Collection(String name, CollectionArgs args)
public Collection(String name, CollectionArgs args, CustomResourceOptions options)
type: aws-native:rekognition:Collection
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. CollectionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. CollectionArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. CollectionArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. CollectionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. CollectionArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Collection Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Collection resource accepts the following input properties:

CollectionId This property is required. string
ID for the collection that you are creating.
Tags List<Pulumi.AwsNative.Inputs.Tag>
An array of key-value pairs to apply to this resource.
CollectionId This property is required. string
ID for the collection that you are creating.
Tags TagArgs
An array of key-value pairs to apply to this resource.
collectionId This property is required. String
ID for the collection that you are creating.
tags List<Tag>
An array of key-value pairs to apply to this resource.
collectionId This property is required. string
ID for the collection that you are creating.
tags Tag[]
An array of key-value pairs to apply to this resource.
collection_id This property is required. str
ID for the collection that you are creating.
tags Sequence[TagArgs]
An array of key-value pairs to apply to this resource.
collectionId This property is required. String
ID for the collection that you are creating.
tags List<Property Map>
An array of key-value pairs to apply to this resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the Collection resource produces the following output properties:

Arn string
Returns the Amazon Resource Name of the collection.
Id string
The provider-assigned unique ID for this managed resource.
Arn string
Returns the Amazon Resource Name of the collection.
Id string
The provider-assigned unique ID for this managed resource.
arn String
Returns the Amazon Resource Name of the collection.
id String
The provider-assigned unique ID for this managed resource.
arn string
Returns the Amazon Resource Name of the collection.
id string
The provider-assigned unique ID for this managed resource.
arn str
Returns the Amazon Resource Name of the collection.
id str
The provider-assigned unique ID for this managed resource.
arn String
Returns the Amazon Resource Name of the collection.
id String
The provider-assigned unique ID for this managed resource.

Supporting Types

Tag
, TagArgs

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi