software.amazon.awscdk.services.opensearchserverless

Class CfnCollection

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.opensearchserverless.CfnCollection

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:39.013Z")
public class CfnCollection
extends CfnResource
implements IInspectable

A CloudFormation `AWS::OpenSearchServerless::Collection`.

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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.opensearchserverless.*;
 CfnCollection cfnCollection = CfnCollection.Builder.create(this, "MyCfnCollection")
         .name("name")
         // the properties below are optional
         .description("description")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .type("type")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnCollection.Builder A fluent builder for CfnCollection.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnCollection(Construct scope, java.lang.String id, CfnCollectionProps props) Create a new `AWS::OpenSearchServerless::Collection`.
protected	CfnCollection(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnCollection(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrArn() The Amazon Resource Name (ARN) of the collection.
java.lang.String	getAttrCollectionEndpoint() Collection-specific endpoint used to submit index, search, and data upload requests to an OpenSearch Serverless collection.
java.lang.String	getAttrDashboardEndpoint() Collection-specific endpoint used to access OpenSearch Dashboards.
java.lang.String	getAttrId() A unique identifier for the collection.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getDescription() A description of the collection.
java.lang.String	getName() The name of the collection.
TagManager	getTags() An arbitrary set of tags (key–value pairs) to associate with the collection.
java.lang.String	getType() The type of collection.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setDescription(java.lang.String value) A description of the collection.
void	setName(java.lang.String value) The name of the collection.
void	setType(java.lang.String value) The type of collection.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnCollection

protected CfnCollection(software.amazon.jsii.JsiiObjectRef objRef)

CfnCollection

protected CfnCollection(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnCollection

public CfnCollection(Construct scope,
                     java.lang.String id,
                     CfnCollectionProps props)

Create a new `AWS::OpenSearchServerless::Collection`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

public java.lang.String getAttrArn()

The Amazon Resource Name (ARN) of the collection.

For example, arn:aws:aoss:us-east-1:123456789012:collection/07tjusf2h91cunochc .

getAttrCollectionEndpoint

public java.lang.String getAttrCollectionEndpoint()

Collection-specific endpoint used to submit index, search, and data upload requests to an OpenSearch Serverless collection.

For example, https://07tjusf2h91cunochc.us-east-1.aoss.amazonaws.com .

getAttrDashboardEndpoint

public java.lang.String getAttrDashboardEndpoint()

Collection-specific endpoint used to access OpenSearch Dashboards.

For example, https://07tjusf2h91cunochc.us-east-1.aoss.amazonaws.com/_dashboards .

getAttrId

public java.lang.String getAttrId()

A unique identifier for the collection.

For example, 07tjusf2h91cunochc .

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

An arbitrary set of tags (key–value pairs) to associate with the collection.

For more information, see Tag .

getName

public java.lang.String getName()

The name of the collection.

Collection names must meet the following criteria:

• Starts with a lowercase letter
• Unique to your account and AWS Region
• Contains between 3 and 28 characters
• Contains only lowercase letters a-z, the numbers 0-9, and the hyphen (-)

setName

public void setName(java.lang.String value)

The name of the collection.

Collection names must meet the following criteria:

• Starts with a lowercase letter
• Unique to your account and AWS Region
• Contains between 3 and 28 characters
• Contains only lowercase letters a-z, the numbers 0-9, and the hyphen (-)

getDescription

public java.lang.String getDescription()

A description of the collection.

setDescription

public void setDescription(java.lang.String value)

A description of the collection.

getType

public java.lang.String getType()

The type of collection.

Possible values are SEARCH and TIMESERIES . For more information, see Choosing a collection type .

setType

public void setType(java.lang.String value)

The type of collection.

Possible values are SEARCH and TIMESERIES . For more information, see Choosing a collection type .