Class CfnCollection
A CloudFormation AWS::Rekognition::Collection
.
Inherited Members
Namespace: Amazon.CDK.AWS.Rekognition
Assembly: Amazon.CDK.AWS.Rekognition.dll
Syntax (csharp)
public class CfnCollection : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnCollection
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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.
CloudformationResource: AWS::Rekognition::Collection
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Rekognition;
var cfnCollection = new CfnCollection(this, "MyCfnCollection", new CfnCollectionProps {
CollectionId = "collectionId",
// the properties below are optional
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnCollection(Construct, String, ICfnCollectionProps) | Create a new |
CfnCollection(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnCollection(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrArn | Returns the Amazon Resource Name of the collection. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
CollectionId | ID for the collection that you are creating. |
Tags | A set of tags (key-value pairs) that you want to attach to the collection. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnCollection(Construct, String, ICfnCollectionProps)
Create a new AWS::Rekognition::Collection
.
public CfnCollection(Construct scope, string id, ICfnCollectionProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnCollectionProps
- resource properties.
CfnCollection(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnCollection(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnCollection(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnCollection(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrArn
Returns the Amazon Resource Name of the collection.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
CollectionId
ID for the collection that you are creating.
public virtual string CollectionId { get; set; }
Property Value
System.String
Remarks
Tags
A set of tags (key-value pairs) that you want to attach to the collection.
public virtual TagManager Tags { get; }
Property Value
Remarks
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>