Struct AwsOpenSearch 

pub struct AwsOpenSearch {
    pub id: String,
    pub collection_type: AwsOpenSearchCollectionType,
    pub capacity: Option<AwsOpenSearchCapacity>,
}

An Amazon OpenSearch Serverless collection (next generation).

Experimental namespace

This is the first resource under the experimental/ resource-type namespace. Experimental resources are provider-specific (they do not abstract over clouds), may change or be promoted to a portable resource in a breaking way, and are only registered for the platforms they support. AwsOpenSearch registers an AWS CloudFormation emitter only; deploying it to any other platform fails with a typed ImportRegistrationMissing error at generation time.

What gets provisioned

The AWS emitter provisions next-generation OpenSearch Serverless: a collection group (Generation: NEXTGEN, compute/storage decoupled) plus a collection inside it, an AWS-owned-key encryption configuration, a public network policy, and a data-access policy for service-account roles granted experimental/aws-opensearch/data-access. Collection groups scale to zero by default; configure a non-zero minimum capacity when the workload requires predictable interactive latency. The collection endpoint is public but every request must be SigV4-signed and pass both IAM (aoss:APIAccessAll) and the data-access policy.

Naming

The physical collection (and collection group) name is {id}-{stack-suffix} and must satisfy the AOSS name grammar, so id must match [a-z][a-z0-9-]* and be at most 23 characters. The emitter rejects ids that don’t fit.

Runtime access

Workers reach the collection over HTTPS with SigV4. The SigV4 signing service name for OpenSearch Serverless is aoss (not es); the runtime binding payload carries "service": "aoss" so clients sign correctly. Requests with a body must also send an x-amz-content-sha256 header (the AOSS gateway rejects body-carrying requests without it with an empty 403); official OpenSearch clients with an aoss signer handle this automatically.

Fields

id: String

Identifier for the collection. Becomes part of the physical collection name, so it must match [a-z][a-z0-9-]* and be at most 23 characters.

collection_type: AwsOpenSearchCollectionType

Workload type of the collection. Immutable once the resource exists (AWS only allows the type at collection creation). Default Search.

capacity: Option<AwsOpenSearchCapacity>

Optional indexing and search OCU limits for the collection group.

When omitted, AWS uses zero minimum capacity for both components, so an idle next-generation collection can scale to zero.

Implementations

impl AwsOpenSearch

pub fn new(id: String) -> AwsOpenSearchBuilder

Create an instance of AwsOpenSearch using the builder syntax

impl AwsOpenSearch

pub const RESOURCE_TYPE: ResourceType

The resource type identifier for AwsOpenSearch.

The experimental/ prefix marks the experimental namespace; see the struct-level docs for the convention.

pub fn id(&self) -> &str

Returns the collection’s unique identifier.

pub fn validate_capacity(&self) -> Result<()>

Validates collection-group capacity values against AWS’s supported OCU increments and min/max ordering.

Trait Implementations

impl Clone for AwsOpenSearch

fn clone(&self) -> AwsOpenSearch

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AwsOpenSearch

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AwsOpenSearch

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for AwsOpenSearch

impl PartialEq for AwsOpenSearch

fn eq(&self, other: &AwsOpenSearch) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl ResourceDefinition for AwsOpenSearch

fn get_resource_type(&self) -> ResourceType

Returns the resource type for this instance

fn id(&self) -> &str

Returns the unique identifier for this specific resource instance

fn get_dependencies(&self) -> Vec<ResourceRef>

Returns the list of other resources this resource depends on

fn validate_update(&self, new_config: &dyn ResourceDefinition) -> Result<()>

Validates if an update from the current configuration to a new configuration is allowed

fn as_any(&self) -> &dyn Any

Provides access to the underlying concrete type for downcasting

fn as_any_mut(&mut self) -> &mut dyn Any

Provides mutable access to the underlying concrete type for downcasting

fn box_clone(&self) -> Box<dyn ResourceDefinition>

Creates a boxed clone of this resource definition

fn resource_eq(&self, other: &dyn ResourceDefinition) -> bool

For equality comparison between resource definitions

fn to_json_value(&self) -> Result<Value>

Serialize this resource to a JSON value (without the “type” tag - that’s added by Resource)

fn get_permissions(&self) -> Option<&str>

Returns the permission profile name for this resource, if it has one.

impl Serialize for AwsOpenSearch

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for AwsOpenSearch