Skip to content
v2.278.0

CollectionReference Struct ​

A reference to a Collection resource.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_opensearchserverless as interfaces_opensearchserverless } from 'aws-cdk-lib/interfaces';
const collectionReference: interfaces_opensearchserverless.CollectionReference = {
  collectionArn: 'collectionArn',
  collectionId: 'collectionId',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.interfaces import aws_opensearchserverless as interfaces_opensearchserverless

collection_reference = interfaces_opensearchserverless.CollectionReference(
    collection_arn="collectionArn",
    collection_id="collectionId"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.interfaces.opensearchserverless.*;

CollectionReference collectionReference = CollectionReference.builder()
        .collectionArn("collectionArn")
        .collectionId("collectionId")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.Interfaces.OpenSearchServerless;

var collectionReference = new CollectionReference {
    CollectionArn = "collectionArn",
    CollectionId = "collectionId"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

collectionReference := &CollectionReference{
	CollectionArn: jsii.String("collectionArn"),
	CollectionId: jsii.String("collectionId"),
}

Properties ​

collectionArnstringcollection_arnstrcollectionArnStringCollectionArnstringCollectionArn*string required #
The ARN of the Collection resource.
collectionIdstringcollection_idstrcollectionIdStringCollectionIdstringCollectionId*string required #
The Id of the Collection resource.