Collection class
Resource for managing an AWS Rekognition Collection.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.rekognition.Collection("example", {
collectionId: "my-collection",
tags: {
example: "1",
},
});
import pulumi
import pulumi_aws as aws
example = aws.rekognition.Collection("example",
collection_id="my-collection",
tags={
"example": "1",
})
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Rekognition.Collection("example", new()
{
CollectionId = "my-collection",
Tags =
{
{ "example", "1" },
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/rekognition"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := rekognition.NewCollection(ctx, "example", &rekognition.CollectionArgs{
CollectionId: pulumi.String("my-collection"),
Tags: pulumi.StringMap{
"example": pulumi.String("1"),
},
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_rekognition_collection" "example" {
collection_id = "my-collection"
tags = {
"example" = 1
}
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.rekognition.Collection;
import com.pulumi.aws.rekognition.CollectionArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new Collection("example", CollectionArgs.builder()
.collectionId("my-collection")
.tags(Map.of("example", "1"))
.build());
}
}
resources:
example:
type: aws:rekognition:Collection
properties:
collectionId: my-collection
tags:
example: 1
Import
Identity Schema
Required
collectionId- (String) The name of the collection.
Optional
accountId- (String) AWS Account where this resource is managed.region- (String) Region where this resource is managed.
Using pulumi import, import Rekognition Collection using the collectionId. For example:
$ pulumi import aws:rekognition/collection:Collection example collection-id-12345678
Constructors
- Collection(String name, {CollectionArgs? args, CustomResourceOptions? options})
-
Creates a new Collection.
nameThe Pulumi resource name.argsArguments used to configure this Collection. The set of arguments for Collection.optionsResource options controlling this resource's behavior. - Collection.reference(String urn)
- Creates a typed reference to an existing Collection resource.
Properties
-
arn
↔ Output<
String> -
ARN of the Collection.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
collectionId
↔ Output<
String> -
Name of the collection
latefinal
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
faceModelVersion
↔ Output<
String> -
Face Model Version that the collection was initialized with
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
Map of tags assigned to the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.latefinal -
timeouts
↔ Output<
CollectionTimeouts?> -
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {CollectionState? state, CustomResourceOptions? options}) → Collection -
Gets an existing Collection resource's state with the given
nameandid.