Class CfnCollection
A CloudFormation AWS::OpenSearchServerless::Collection
.
Inherited Members
Namespace: Amazon.CDK.AWS.OpenSearchServerless
Assembly: Amazon.CDK.AWS.OpenSearchServerless.dll
Syntax (csharp)
public class CfnCollection : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnCollection
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Specifies an OpenSearch Serverless collection. For more information, see Creating and managing Amazon OpenSearch Serverless collections in the Amazon OpenSearch Service Developer Guide .
You must create a matching encryption policy in order for a collection to be created successfully. You can specify the policy resource within the same CloudFormation template as the collection resource if you use the DependsOn attribute. See Examples for a sample template. Otherwise the encryption policy must already exist before you create the collection.
CloudformationResource: AWS::OpenSearchServerless::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.OpenSearchServerless;
var cfnCollection = new CfnCollection(this, "MyCfnCollection", new CfnCollectionProps {
Name = "name",
// the properties below are optional
Description = "description",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
Type = "type"
});
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 | The Amazon Resource Name (ARN) of the collection. |
AttrCollectionEndpoint | Collection-specific endpoint used to submit index, search, and data upload requests to an OpenSearch Serverless collection. |
AttrDashboardEndpoint | Collection-specific endpoint used to access OpenSearch Dashboards. |
AttrId | A unique identifier for the collection. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Description | A description of the collection. |
Name | The name of the collection. |
Tags | An arbitrary set of tags (key–value pairs) to associate with the collection. |
Type | The type of collection. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnCollection(Construct, String, ICfnCollectionProps)
Create a new AWS::OpenSearchServerless::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
The Amazon Resource Name (ARN) of the collection.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
For example, arn:aws:aoss:us-east-1:123456789012:collection/07tjusf2h91cunochc
.
CloudformationAttribute: Arn
AttrCollectionEndpoint
Collection-specific endpoint used to submit index, search, and data upload requests to an OpenSearch Serverless collection.
public virtual string AttrCollectionEndpoint { get; }
Property Value
System.String
Remarks
For example, https://07tjusf2h91cunochc.us-east-1.aoss.amazonaws.com
.
CloudformationAttribute: CollectionEndpoint
AttrDashboardEndpoint
Collection-specific endpoint used to access OpenSearch Dashboards.
public virtual string AttrDashboardEndpoint { get; }
Property Value
System.String
Remarks
For example, https://07tjusf2h91cunochc.us-east-1.aoss.amazonaws.com/_dashboards
.
CloudformationAttribute: DashboardEndpoint
AttrId
A unique identifier for the collection.
public virtual string AttrId { get; }
Property Value
System.String
Remarks
For example, 07tjusf2h91cunochc
.
CloudformationAttribute: Id
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
Description
A description of the collection.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
Name
The name of the collection.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
Collection names must meet the following criteria:
Tags
An arbitrary set of tags (key–value pairs) to associate with the collection.
public virtual TagManager Tags { get; }
Property Value
Remarks
Type
The type of collection.
public virtual string Type { get; set; }
Property Value
System.String
Remarks
Possible values are SEARCH
and TIMESERIES
. For more information, see Choosing a collection type .
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>