Files
agent-claw/cdk/node_modules/aws-cdk-lib/aws-opensearchserverless/lib/opensearchserverless.generated.d.ts
2026-05-06 18:55:16 -05:00

1649 lines
68 KiB
TypeScript
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
import * as cdk from "../../core/lib";
import * as constructs from "constructs";
import * as cfn_parse from "../../core/lib/helpers-internal";
import { AccessPolicyReference, CollectionGroupReference, CollectionReference, IAccessPolicyRef, ICollectionGroupRef, ICollectionRef, IIndexRef, ILifecyclePolicyRef, IndexReference, ISecurityConfigRef, ISecurityPolicyRef, IVpcEndpointRef, LifecyclePolicyReference, SecurityConfigReference, SecurityPolicyReference, VpcEndpointReference } from "../../interfaces/generated/aws-opensearchserverless-interfaces.generated";
import { aws_ec2 as ec2Refs } from "../../interfaces";
/**
* Creates a data access policy for OpenSearch Serverless.
*
* Access policies limit access to collections and the resources within them, and allow a user to access that data irrespective of the access mechanism or network source. For more information, see [Data access control for Amazon OpenSearch Serverless](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-data-access.html) .
*
* @cloudformationResource AWS::OpenSearchServerless::AccessPolicy
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-accesspolicy.html
*/
export declare class CfnAccessPolicy extends cdk.CfnResource implements cdk.IInspectable, IAccessPolicyRef {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnAccessPolicy from CloudFormation properties
*
* A factory method that creates a new instance of this class from an object
* containing the CloudFormation properties of this resource.
* Used in the @aws-cdk/cloudformation-include module.
*
* @internal
*/
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnAccessPolicy;
/**
* Checks whether the given object is a CfnAccessPolicy
*/
static isCfnAccessPolicy(x: any): x is CfnAccessPolicy;
/**
* The description of the policy.
*/
private _description?;
/**
* The name of the policy.
*/
private _name;
/**
* The JSON policy document without any whitespaces.
*/
private _policy;
/**
* The type of access policy.
*/
private _type;
protected readonly cfnPropertyNames: Record<string, string>;
/**
* Create a new `AWS::OpenSearchServerless::AccessPolicy`.
*
* @param scope Scope in which this resource is defined
* @param id Construct identifier for this resource (unique in its scope)
* @param props Resource properties
*/
constructor(scope: constructs.Construct, id: string, props: CfnAccessPolicyProps);
get accessPolicyRef(): AccessPolicyReference;
/**
* The description of the policy.
*/
get description(): string | undefined;
/**
* The description of the policy.
*/
set description(value: string | undefined);
/**
* The name of the policy.
*/
get name(): string;
/**
* The name of the policy.
*/
set name(value: string);
/**
* The JSON policy document without any whitespaces.
*/
get policy(): string;
/**
* The JSON policy document without any whitespaces.
*/
set policy(value: string);
/**
* The type of access policy.
*/
get type(): string;
/**
* The type of access policy.
*/
set type(value: string);
protected get cfnProperties(): Record<string, any>;
/**
* Examines the CloudFormation resource and discloses attributes
*
* @param inspector tree inspector to collect and process attributes
*/
inspect(inspector: cdk.TreeInspector): void;
protected renderProperties(props: Record<string, any>): Record<string, any>;
}
/**
* Properties for defining a `CfnAccessPolicy`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-accesspolicy.html
*/
export interface CfnAccessPolicyProps {
/**
* The description of the policy.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-accesspolicy.html#cfn-opensearchserverless-accesspolicy-description
*/
readonly description?: string;
/**
* The name of the policy.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-accesspolicy.html#cfn-opensearchserverless-accesspolicy-name
*/
readonly name: string;
/**
* The JSON policy document without any whitespaces.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-accesspolicy.html#cfn-opensearchserverless-accesspolicy-policy
*/
readonly policy: string;
/**
* The type of access policy.
*
* Currently the only option is `data` .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-accesspolicy.html#cfn-opensearchserverless-accesspolicy-type
*/
readonly type: string;
}
/**
* Specifies an OpenSearch Serverless collection.
*
* For more information, see [Creating and managing Amazon OpenSearch Serverless collections](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-manage.html) in the *Amazon OpenSearch Service Developer Guide* .
*
* > You must create a matching [encryption policy](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-encryption.html) 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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) attribute. See [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-collection.html#aws-resource-opensearchserverless-collection--examples) for a sample template. Otherwise the encryption policy must already exist before you create the collection.
*
* @cloudformationResource AWS::OpenSearchServerless::Collection
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-collection.html
*/
export declare class CfnCollection extends cdk.CfnResource implements cdk.IInspectable, ICollectionRef, cdk.ITaggable {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnCollection from CloudFormation properties
*
* A factory method that creates a new instance of this class from an object
* containing the CloudFormation properties of this resource.
* Used in the @aws-cdk/cloudformation-include module.
*
* @internal
*/
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnCollection;
/**
* Checks whether the given object is a CfnCollection
*/
static isCfnCollection(x: any): x is CfnCollection;
/**
* Creates a new ICollectionRef from an ARN
*/
static fromCollectionArn(scope: constructs.Construct, id: string, arn: string): ICollectionRef;
/**
* Creates a new ICollectionRef from a collectionId
*/
static fromCollectionId(scope: constructs.Construct, id: string, collectionId: string): ICollectionRef;
static arnForCollection(resource: ICollectionRef): string;
/**
* The name of the collection group to associate with the collection.
*/
private _collectionGroupName?;
/**
* A description of the collection.
*/
private _description?;
/**
* Encryption settings for the collection.
*/
private _encryptionConfig?;
/**
* The name of the collection.
*/
private _name;
/**
* Indicates whether to use standby replicas for the collection.
*/
private _standbyReplicas?;
/**
* Tag Manager which manages the tags for this resource
*/
readonly tags: cdk.TagManager;
/**
* An arbitrary set of tags (keyvalue pairs) to associate with the collection.
*/
private _tagsRaw?;
/**
* The type of collection.
*/
private _type?;
/**
* Vector search configuration options for the collection.
*/
private _vectorOptions?;
protected readonly cfnPropertyNames: Record<string, string>;
/**
* Create a new `AWS::OpenSearchServerless::Collection`.
*
* @param scope Scope in which this resource is defined
* @param id Construct identifier for this resource (unique in its scope)
* @param props Resource properties
*/
constructor(scope: constructs.Construct, id: string, props: CfnCollectionProps);
get collectionRef(): CollectionReference;
/**
* The name of the collection group to associate with the collection.
*/
get collectionGroupName(): string | undefined;
/**
* The name of the collection group to associate with the collection.
*/
set collectionGroupName(value: string | undefined);
/**
* A description of the collection.
*/
get description(): string | undefined;
/**
* A description of the collection.
*/
set description(value: string | undefined);
/**
* Encryption settings for the collection.
*/
get encryptionConfig(): CfnCollection.EncryptionConfigProperty | cdk.IResolvable | undefined;
/**
* Encryption settings for the collection.
*/
set encryptionConfig(value: CfnCollection.EncryptionConfigProperty | cdk.IResolvable | undefined);
/**
* The name of the collection.
*/
get name(): string;
/**
* The name of the collection.
*/
set name(value: string);
/**
* Indicates whether to use standby replicas for the collection.
*/
get standbyReplicas(): string | undefined;
/**
* Indicates whether to use standby replicas for the collection.
*/
set standbyReplicas(value: string | undefined);
/**
* An arbitrary set of tags (keyvalue pairs) to associate with the collection.
*/
get tagsRaw(): Array<cdk.CfnTag> | undefined;
/**
* An arbitrary set of tags (keyvalue pairs) to associate with the collection.
*/
set tagsRaw(value: Array<cdk.CfnTag> | undefined);
/**
* The type of collection.
*/
get type(): string | undefined;
/**
* The type of collection.
*/
set type(value: string | undefined);
/**
* Vector search configuration options for the collection.
*/
get vectorOptions(): cdk.IResolvable | CfnCollection.VectorOptionsProperty | undefined;
/**
* Vector search configuration options for the collection.
*/
set vectorOptions(value: cdk.IResolvable | CfnCollection.VectorOptionsProperty | undefined);
/**
* The Amazon Resource Name (ARN) of the collection. For example, `arn:aws:aoss:us-east-1:123456789012:collection/07tjusf2h91cunochc` .
*
* @cloudformationAttribute Arn
*/
get attrArn(): string;
/**
* 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` .
*
* @cloudformationAttribute CollectionEndpoint
*/
get attrCollectionEndpoint(): string;
/**
* The collection-specific endpoint used to access OpenSearch Dashboards. For example, `https://07tjusf2h91cunochc.us-east-1.aoss.amazonaws.com/_dashboards` .
*
* @cloudformationAttribute DashboardEndpoint
*/
get attrDashboardEndpoint(): string;
/**
* @cloudformationAttribute FipsEndpoints
*/
get attrFipsEndpoints(): cdk.IResolvable;
/**
* A unique identifier for the collection. For example, `07tjusf2h91cunochc` .
*
* @cloudformationAttribute Id
*/
get attrId(): string;
/**
* The ARN of the AWS KMS key used to encrypt the collection.
*
* @cloudformationAttribute KmsKeyArn
*/
get attrKmsKeyArn(): string;
protected get cfnProperties(): Record<string, any>;
/**
* Examines the CloudFormation resource and discloses attributes
*
* @param inspector tree inspector to collect and process attributes
*/
inspect(inspector: cdk.TreeInspector): void;
protected renderProperties(props: Record<string, any>): Record<string, any>;
}
export declare namespace CfnCollection {
/**
* Encryption settings for the collection.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-collection-encryptionconfig.html
*/
interface EncryptionConfigProperty {
/**
* Indicates whether to use an AWS owned key for encryption.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-collection-encryptionconfig.html#cfn-opensearchserverless-collection-encryptionconfig-awsownedkey
*/
readonly awsOwnedKey?: boolean | cdk.IResolvable;
/**
* Key Management Service key used to encrypt the collection.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-collection-encryptionconfig.html#cfn-opensearchserverless-collection-encryptionconfig-kmskeyarn
*/
readonly kmsKeyArn?: string;
}
/**
* Vector search configuration options for the collection.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-collection-vectoroptions.html
*/
interface VectorOptionsProperty {
/**
* Indicates whether GPU acceleration is enabled for vector indexing.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-collection-vectoroptions.html#cfn-opensearchserverless-collection-vectoroptions-serverlessvectoracceleration
*/
readonly serverlessVectorAcceleration?: string;
}
/**
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-collection-fipsendpoints.html
*/
interface FipsEndpointsProperty {
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-collection-fipsendpoints.html#cfn-opensearchserverless-collection-fipsendpoints-collectionendpoint
*/
readonly collectionEndpoint?: string;
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-collection-fipsendpoints.html#cfn-opensearchserverless-collection-fipsendpoints-dashboardendpoint
*/
readonly dashboardEndpoint?: string;
}
}
/**
* Properties for defining a `CfnCollection`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-collection.html
*/
export interface CfnCollectionProps {
/**
* The name of the collection group to associate with the collection.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-collection.html#cfn-opensearchserverless-collection-collectiongroupname
*/
readonly collectionGroupName?: string;
/**
* A description of the collection.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-collection.html#cfn-opensearchserverless-collection-description
*/
readonly description?: string;
/**
* Encryption settings for the collection.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-collection.html#cfn-opensearchserverless-collection-encryptionconfig
*/
readonly encryptionConfig?: CfnCollection.EncryptionConfigProperty | cdk.IResolvable;
/**
* 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 (-)
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-collection.html#cfn-opensearchserverless-collection-name
*/
readonly name: string;
/**
* Indicates whether to use standby replicas for the collection.
*
* You can't update this property after the collection is already created. If you attempt to modify this property, the collection continues to use the original value.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-collection.html#cfn-opensearchserverless-collection-standbyreplicas
*/
readonly standbyReplicas?: string;
/**
* An arbitrary set of tags (keyvalue pairs) to associate with the collection.
*
* For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-collection.html#cfn-opensearchserverless-collection-tags
*/
readonly tags?: Array<cdk.CfnTag>;
/**
* The type of collection.
*
* Possible values are `SEARCH` , `TIMESERIES` , and `VECTORSEARCH` . For more information, see [Choosing a collection type](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-overview.html#serverless-usecase) .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-collection.html#cfn-opensearchserverless-collection-type
*/
readonly type?: string;
/**
* Vector search configuration options for the collection.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-collection.html#cfn-opensearchserverless-collection-vectoroptions
*/
readonly vectorOptions?: cdk.IResolvable | CfnCollection.VectorOptionsProperty;
}
/**
* Specifies a security configuration for OpenSearch Serverless.
*
* For more information, see [SAML authentication for Amazon OpenSearch Serverless](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-saml.html) .
*
* @cloudformationResource AWS::OpenSearchServerless::SecurityConfig
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-securityconfig.html
*/
export declare class CfnSecurityConfig extends cdk.CfnResource implements cdk.IInspectable, ISecurityConfigRef {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnSecurityConfig from CloudFormation properties
*
* A factory method that creates a new instance of this class from an object
* containing the CloudFormation properties of this resource.
* Used in the @aws-cdk/cloudformation-include module.
*
* @internal
*/
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnSecurityConfig;
/**
* Checks whether the given object is a CfnSecurityConfig
*/
static isCfnSecurityConfig(x: any): x is CfnSecurityConfig;
/**
* The description of the security configuration.
*/
private _description?;
/**
* Describes IAM federation options in the form of a key-value map.
*/
private _iamFederationOptions?;
/**
* Describes IAM Identity Center options in the form of a key-value map.
*/
private _iamIdentityCenterOptions?;
/**
* The name of the security configuration.
*/
private _name?;
/**
* SAML options for the security configuration in the form of a key-value map.
*/
private _samlOptions?;
/**
* The type of security configuration.
*/
private _type?;
protected readonly cfnPropertyNames: Record<string, string>;
/**
* Create a new `AWS::OpenSearchServerless::SecurityConfig`.
*
* @param scope Scope in which this resource is defined
* @param id Construct identifier for this resource (unique in its scope)
* @param props Resource properties
*/
constructor(scope: constructs.Construct, id: string, props?: CfnSecurityConfigProps);
get securityConfigRef(): SecurityConfigReference;
/**
* The description of the security configuration.
*/
get description(): string | undefined;
/**
* The description of the security configuration.
*/
set description(value: string | undefined);
/**
* Describes IAM federation options in the form of a key-value map.
*/
get iamFederationOptions(): CfnSecurityConfig.IamFederationConfigOptionsProperty | cdk.IResolvable | undefined;
/**
* Describes IAM federation options in the form of a key-value map.
*/
set iamFederationOptions(value: CfnSecurityConfig.IamFederationConfigOptionsProperty | cdk.IResolvable | undefined);
/**
* Describes IAM Identity Center options in the form of a key-value map.
*/
get iamIdentityCenterOptions(): CfnSecurityConfig.IamIdentityCenterConfigOptionsProperty | cdk.IResolvable | undefined;
/**
* Describes IAM Identity Center options in the form of a key-value map.
*/
set iamIdentityCenterOptions(value: CfnSecurityConfig.IamIdentityCenterConfigOptionsProperty | cdk.IResolvable | undefined);
/**
* The name of the security configuration.
*/
get name(): string | undefined;
/**
* The name of the security configuration.
*/
set name(value: string | undefined);
/**
* SAML options for the security configuration in the form of a key-value map.
*/
get samlOptions(): cdk.IResolvable | CfnSecurityConfig.SamlConfigOptionsProperty | undefined;
/**
* SAML options for the security configuration in the form of a key-value map.
*/
set samlOptions(value: cdk.IResolvable | CfnSecurityConfig.SamlConfigOptionsProperty | undefined);
/**
* The type of security configuration.
*/
get type(): string | undefined;
/**
* The type of security configuration.
*/
set type(value: string | undefined);
/**
* The ARN of the IAM Identity Center application used to integrate with OpenSearch Serverless.
*
* @cloudformationAttribute IamIdentityCenterOptions.ApplicationArn
*/
get attrIamIdentityCenterOptionsApplicationArn(): string;
/**
* The description of the IAM Identity Center application used to integrate with OpenSearch Serverless.
*
* @cloudformationAttribute IamIdentityCenterOptions.ApplicationDescription
*/
get attrIamIdentityCenterOptionsApplicationDescription(): string;
/**
* The name of the IAM Identity Center application used to integrate with OpenSearch Serverless.
*
* @cloudformationAttribute IamIdentityCenterOptions.ApplicationName
*/
get attrIamIdentityCenterOptionsApplicationName(): string;
/**
* The unique identifier of the security configuration. For example, `saml/123456789012/myprovider` .
*
* @cloudformationAttribute Id
*/
get attrId(): string;
protected get cfnProperties(): Record<string, any>;
/**
* Examines the CloudFormation resource and discloses attributes
*
* @param inspector tree inspector to collect and process attributes
*/
inspect(inspector: cdk.TreeInspector): void;
protected renderProperties(props: Record<string, any>): Record<string, any>;
}
export declare namespace CfnSecurityConfig {
/**
* Describes SAML options for an OpenSearch Serverless security configuration in the form of a key-value map.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-securityconfig-samlconfigoptions.html
*/
interface SamlConfigOptionsProperty {
/**
* The group attribute for this SAML integration.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-securityconfig-samlconfigoptions.html#cfn-opensearchserverless-securityconfig-samlconfigoptions-groupattribute
*/
readonly groupAttribute?: string;
/**
* The XML IdP metadata file generated from your identity provider.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-securityconfig-samlconfigoptions.html#cfn-opensearchserverless-securityconfig-samlconfigoptions-metadata
*/
readonly metadata: string;
/**
* Custom entity ID attribute to override the default entity ID for this SAML integration.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-securityconfig-samlconfigoptions.html#cfn-opensearchserverless-securityconfig-samlconfigoptions-opensearchserverlessentityid
*/
readonly openSearchServerlessEntityId?: string;
/**
* The session timeout, in minutes.
*
* Default is 60 minutes (12 hours).
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-securityconfig-samlconfigoptions.html#cfn-opensearchserverless-securityconfig-samlconfigoptions-sessiontimeout
*/
readonly sessionTimeout?: number;
/**
* A user attribute for this SAML integration.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-securityconfig-samlconfigoptions.html#cfn-opensearchserverless-securityconfig-samlconfigoptions-userattribute
*/
readonly userAttribute?: string;
}
/**
* Describes IAM Identity Center options for an OpenSearch Serverless security configuration in the form of a key-value map.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-securityconfig-iamidentitycenterconfigoptions.html
*/
interface IamIdentityCenterConfigOptionsProperty {
/**
* The ARN of the IAM Identity Center application used to integrate with OpenSearch Serverless.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-securityconfig-iamidentitycenterconfigoptions.html#cfn-opensearchserverless-securityconfig-iamidentitycenterconfigoptions-applicationarn
*/
readonly applicationArn?: string;
/**
* The description of the IAM Identity Center application used to integrate with OpenSearch Serverless.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-securityconfig-iamidentitycenterconfigoptions.html#cfn-opensearchserverless-securityconfig-iamidentitycenterconfigoptions-applicationdescription
*/
readonly applicationDescription?: string;
/**
* The name of the IAM Identity Center application used to integrate with OpenSearch Serverless.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-securityconfig-iamidentitycenterconfigoptions.html#cfn-opensearchserverless-securityconfig-iamidentitycenterconfigoptions-applicationname
*/
readonly applicationName?: string;
/**
* The group attribute for this IAM Identity Center integration.
*
* Defaults to `GroupId` .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-securityconfig-iamidentitycenterconfigoptions.html#cfn-opensearchserverless-securityconfig-iamidentitycenterconfigoptions-groupattribute
*/
readonly groupAttribute?: string;
/**
* The ARN of the IAM Identity Center instance used to integrate with OpenSearch Serverless.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-securityconfig-iamidentitycenterconfigoptions.html#cfn-opensearchserverless-securityconfig-iamidentitycenterconfigoptions-instancearn
*/
readonly instanceArn: string;
/**
* The user attribute for this IAM Identity Center integration.
*
* Defaults to `UserId`
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-securityconfig-iamidentitycenterconfigoptions.html#cfn-opensearchserverless-securityconfig-iamidentitycenterconfigoptions-userattribute
*/
readonly userAttribute?: string;
}
/**
* Describes IAM federation options for an OpenSearch Serverless security configuration in the form of a key-value map.
*
* These options define how OpenSearch Serverless integrates with external identity providers using federation.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-securityconfig-iamfederationconfigoptions.html
*/
interface IamFederationConfigOptionsProperty {
/**
* The group attribute for this IAM federation integration.
*
* This attribute is used to map identity provider groups to OpenSearch Serverless permissions.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-securityconfig-iamfederationconfigoptions.html#cfn-opensearchserverless-securityconfig-iamfederationconfigoptions-groupattribute
*/
readonly groupAttribute?: string;
/**
* The user attribute for this IAM federation integration.
*
* This attribute is used to identify users in the federated authentication process.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-securityconfig-iamfederationconfigoptions.html#cfn-opensearchserverless-securityconfig-iamfederationconfigoptions-userattribute
*/
readonly userAttribute?: string;
}
}
/**
* Properties for defining a `CfnSecurityConfig`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-securityconfig.html
*/
export interface CfnSecurityConfigProps {
/**
* The description of the security configuration.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-securityconfig.html#cfn-opensearchserverless-securityconfig-description
*/
readonly description?: string;
/**
* Describes IAM federation options in the form of a key-value map.
*
* Contains configuration details about how OpenSearch Serverless integrates with external identity providers through federation.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-securityconfig.html#cfn-opensearchserverless-securityconfig-iamfederationoptions
*/
readonly iamFederationOptions?: CfnSecurityConfig.IamFederationConfigOptionsProperty | cdk.IResolvable;
/**
* Describes IAM Identity Center options in the form of a key-value map.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-securityconfig.html#cfn-opensearchserverless-securityconfig-iamidentitycenteroptions
*/
readonly iamIdentityCenterOptions?: CfnSecurityConfig.IamIdentityCenterConfigOptionsProperty | cdk.IResolvable;
/**
* The name of the security configuration.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-securityconfig.html#cfn-opensearchserverless-securityconfig-name
*/
readonly name?: string;
/**
* SAML options for the security configuration in the form of a key-value map.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-securityconfig.html#cfn-opensearchserverless-securityconfig-samloptions
*/
readonly samlOptions?: cdk.IResolvable | CfnSecurityConfig.SamlConfigOptionsProperty;
/**
* The type of security configuration.
*
* Currently the only option is `saml` .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-securityconfig.html#cfn-opensearchserverless-securityconfig-type
*/
readonly type?: string;
}
/**
* Creates an encryption or network policy to be used by one or more OpenSearch Serverless collections.
*
* Network policies specify access to a collection and its OpenSearch Dashboards endpoint from public networks or specific VPC endpoints. For more information, see [Network access for Amazon OpenSearch Serverless](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-network.html) .
*
* Encryption policies specify a KMS encryption key to assign to particular collections. For more information, see [Encryption at rest for Amazon OpenSearch Serverless](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-encryption.html) .
*
* @cloudformationResource AWS::OpenSearchServerless::SecurityPolicy
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-securitypolicy.html
*/
export declare class CfnSecurityPolicy extends cdk.CfnResource implements cdk.IInspectable, ISecurityPolicyRef {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnSecurityPolicy from CloudFormation properties
*
* A factory method that creates a new instance of this class from an object
* containing the CloudFormation properties of this resource.
* Used in the @aws-cdk/cloudformation-include module.
*
* @internal
*/
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnSecurityPolicy;
/**
* Checks whether the given object is a CfnSecurityPolicy
*/
static isCfnSecurityPolicy(x: any): x is CfnSecurityPolicy;
/**
* The description of the security policy.
*/
private _description?;
/**
* The name of the policy.
*/
private _name;
/**
* The JSON policy document without any whitespaces.
*/
private _policy;
/**
* The type of security policy.
*/
private _type;
protected readonly cfnPropertyNames: Record<string, string>;
/**
* Create a new `AWS::OpenSearchServerless::SecurityPolicy`.
*
* @param scope Scope in which this resource is defined
* @param id Construct identifier for this resource (unique in its scope)
* @param props Resource properties
*/
constructor(scope: constructs.Construct, id: string, props: CfnSecurityPolicyProps);
get securityPolicyRef(): SecurityPolicyReference;
/**
* The description of the security policy.
*/
get description(): string | undefined;
/**
* The description of the security policy.
*/
set description(value: string | undefined);
/**
* The name of the policy.
*/
get name(): string;
/**
* The name of the policy.
*/
set name(value: string);
/**
* The JSON policy document without any whitespaces.
*/
get policy(): string;
/**
* The JSON policy document without any whitespaces.
*/
set policy(value: string);
/**
* The type of security policy.
*/
get type(): string;
/**
* The type of security policy.
*/
set type(value: string);
protected get cfnProperties(): Record<string, any>;
/**
* Examines the CloudFormation resource and discloses attributes
*
* @param inspector tree inspector to collect and process attributes
*/
inspect(inspector: cdk.TreeInspector): void;
protected renderProperties(props: Record<string, any>): Record<string, any>;
}
/**
* Properties for defining a `CfnSecurityPolicy`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-securitypolicy.html
*/
export interface CfnSecurityPolicyProps {
/**
* The description of the security policy.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-securitypolicy.html#cfn-opensearchserverless-securitypolicy-description
*/
readonly description?: string;
/**
* The name of the policy.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-securitypolicy.html#cfn-opensearchserverless-securitypolicy-name
*/
readonly name: string;
/**
* The JSON policy document without any whitespaces.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-securitypolicy.html#cfn-opensearchserverless-securitypolicy-policy
*/
readonly policy: string;
/**
* The type of security policy.
*
* Can be either `encryption` or `network` .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-securitypolicy.html#cfn-opensearchserverless-securitypolicy-type
*/
readonly type: string;
}
/**
* Creates an OpenSearch Serverless-managed interface VPC endpoint.
*
* For more information, see [Access Amazon OpenSearch Serverless using an interface endpoint](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-vpc.html) .
*
* @cloudformationResource AWS::OpenSearchServerless::VpcEndpoint
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-vpcendpoint.html
*/
export declare class CfnVpcEndpoint extends cdk.CfnResource implements cdk.IInspectable, IVpcEndpointRef {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnVpcEndpoint from CloudFormation properties
*
* A factory method that creates a new instance of this class from an object
* containing the CloudFormation properties of this resource.
* Used in the @aws-cdk/cloudformation-include module.
*
* @internal
*/
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnVpcEndpoint;
/**
* Checks whether the given object is a CfnVpcEndpoint
*/
static isCfnVpcEndpoint(x: any): x is CfnVpcEndpoint;
/**
* The name of the endpoint.
*/
private _name;
/**
* The unique identifiers of the security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.
*/
private _securityGroupIds?;
/**
* The ID of the subnets from which you access OpenSearch Serverless.
*/
private _subnetIds;
/**
* The ID of the VPC from which you access OpenSearch Serverless.
*/
private _vpcId;
protected readonly cfnPropertyNames: Record<string, string>;
/**
* Create a new `AWS::OpenSearchServerless::VpcEndpoint`.
*
* @param scope Scope in which this resource is defined
* @param id Construct identifier for this resource (unique in its scope)
* @param props Resource properties
*/
constructor(scope: constructs.Construct, id: string, props: CfnVpcEndpointProps);
get vpcEndpointRef(): VpcEndpointReference;
/**
* The name of the endpoint.
*/
get name(): string;
/**
* The name of the endpoint.
*/
set name(value: string);
/**
* The unique identifiers of the security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.
*/
get securityGroupIds(): Array<string> | undefined;
/**
* The unique identifiers of the security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.
*/
set securityGroupIds(value: Array<string> | undefined);
/**
* The ID of the subnets from which you access OpenSearch Serverless.
*/
get subnetIds(): Array<string>;
/**
* The ID of the subnets from which you access OpenSearch Serverless.
*/
set subnetIds(value: Array<string>);
/**
* The ID of the VPC from which you access OpenSearch Serverless.
*/
get vpcId(): string;
/**
* The ID of the VPC from which you access OpenSearch Serverless.
*/
set vpcId(value: string);
/**
* The unique identifier of the endpoint. For example, `vpce-050f79086ee71ac05` .
*
* @cloudformationAttribute Id
*/
get attrId(): string;
protected get cfnProperties(): Record<string, any>;
/**
* Examines the CloudFormation resource and discloses attributes
*
* @param inspector tree inspector to collect and process attributes
*/
inspect(inspector: cdk.TreeInspector): void;
protected renderProperties(props: Record<string, any>): Record<string, any>;
}
/**
* Properties for defining a `CfnVpcEndpoint`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-vpcendpoint.html
*/
export interface CfnVpcEndpointProps {
/**
* The name of the endpoint.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-vpcendpoint.html#cfn-opensearchserverless-vpcendpoint-name
*/
readonly name: string;
/**
* The unique identifiers of the security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-vpcendpoint.html#cfn-opensearchserverless-vpcendpoint-securitygroupids
*/
readonly securityGroupIds?: Array<ec2Refs.ISecurityGroupRef | string>;
/**
* The ID of the subnets from which you access OpenSearch Serverless.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-vpcendpoint.html#cfn-opensearchserverless-vpcendpoint-subnetids
*/
readonly subnetIds: Array<string>;
/**
* The ID of the VPC from which you access OpenSearch Serverless.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-vpcendpoint.html#cfn-opensearchserverless-vpcendpoint-vpcid
*/
readonly vpcId: string;
}
/**
* Resource Type definition for AWS::OpenSearchServerless::CollectionGroup.
*
* @cloudformationResource AWS::OpenSearchServerless::CollectionGroup
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-collectiongroup.html
*/
export declare class CfnCollectionGroup extends cdk.CfnResource implements cdk.IInspectable, ICollectionGroupRef, cdk.ITaggableV2 {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnCollectionGroup from CloudFormation properties
*
* A factory method that creates a new instance of this class from an object
* containing the CloudFormation properties of this resource.
* Used in the @aws-cdk/cloudformation-include module.
*
* @internal
*/
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnCollectionGroup;
/**
* Checks whether the given object is a CfnCollectionGroup
*/
static isCfnCollectionGroup(x: any): x is CfnCollectionGroup;
/**
* Creates a new ICollectionGroupRef from an ARN
*/
static fromCollectionGroupArn(scope: constructs.Construct, id: string, arn: string): ICollectionGroupRef;
/**
* Creates a new ICollectionGroupRef from a collectionGroupId
*/
static fromCollectionGroupId(scope: constructs.Construct, id: string, collectionGroupId: string): ICollectionGroupRef;
static arnForCollectionGroup(resource: ICollectionGroupRef): string;
private _capacityLimits?;
/**
* Tag Manager which manages the tags for this resource
*/
readonly cdkTagManager: cdk.TagManager;
/**
* The description of the collection group.
*/
private _description?;
/**
* The name of the collection group.
*/
private _name;
/**
* Indicates whether standby replicas are used for the collection group.
*/
private _standbyReplicas;
/**
* An array of key-value pairs to apply to this resource.
*/
private _tags?;
protected readonly cfnPropertyNames: Record<string, string>;
/**
* Create a new `AWS::OpenSearchServerless::CollectionGroup`.
*
* @param scope Scope in which this resource is defined
* @param id Construct identifier for this resource (unique in its scope)
* @param props Resource properties
*/
constructor(scope: constructs.Construct, id: string, props: CfnCollectionGroupProps);
get collectionGroupRef(): CollectionGroupReference;
get capacityLimits(): CfnCollectionGroup.CapacityLimitsProperty | cdk.IResolvable | undefined;
set capacityLimits(value: CfnCollectionGroup.CapacityLimitsProperty | cdk.IResolvable | undefined);
/**
* The description of the collection group.
*/
get description(): string | undefined;
/**
* The description of the collection group.
*/
set description(value: string | undefined);
/**
* The name of the collection group.
*/
get name(): string;
/**
* The name of the collection group.
*/
set name(value: string);
/**
* Indicates whether standby replicas are used for the collection group.
*/
get standbyReplicas(): string;
/**
* Indicates whether standby replicas are used for the collection group.
*/
set standbyReplicas(value: string);
/**
* An array of key-value pairs to apply to this resource.
*/
get tags(): Array<cdk.CfnTag> | undefined;
/**
* An array of key-value pairs to apply to this resource.
*/
set tags(value: Array<cdk.CfnTag> | undefined);
/**
* The Amazon Resource Name (ARN) of the collection group.
*
* @cloudformationAttribute Arn
*/
get attrArn(): string;
/**
* The unique identifier of the collection group.
*
* @cloudformationAttribute Id
*/
get attrId(): string;
protected get cfnProperties(): Record<string, any>;
/**
* Examines the CloudFormation resource and discloses attributes
*
* @param inspector tree inspector to collect and process attributes
*/
inspect(inspector: cdk.TreeInspector): void;
protected renderProperties(props: Record<string, any>): Record<string, any>;
}
export declare namespace CfnCollectionGroup {
/**
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-collectiongroup-capacitylimits.html
*/
interface CapacityLimitsProperty {
/**
* The maximum indexing capacity for collections in the group.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-collectiongroup-capacitylimits.html#cfn-opensearchserverless-collectiongroup-capacitylimits-maxindexingcapacityinocu
*/
readonly maxIndexingCapacityInOcu?: number;
/**
* The maximum search capacity for collections in the group.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-collectiongroup-capacitylimits.html#cfn-opensearchserverless-collectiongroup-capacitylimits-maxsearchcapacityinocu
*/
readonly maxSearchCapacityInOcu?: number;
/**
* The minimum indexing capacity for collections in the group.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-collectiongroup-capacitylimits.html#cfn-opensearchserverless-collectiongroup-capacitylimits-minindexingcapacityinocu
*/
readonly minIndexingCapacityInOcu?: number;
/**
* The minimum search capacity for collections in the group.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-collectiongroup-capacitylimits.html#cfn-opensearchserverless-collectiongroup-capacitylimits-minsearchcapacityinocu
*/
readonly minSearchCapacityInOcu?: number;
}
}
/**
* Properties for defining a `CfnCollectionGroup`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-collectiongroup.html
*/
export interface CfnCollectionGroupProps {
/**
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-collectiongroup.html#cfn-opensearchserverless-collectiongroup-capacitylimits
*/
readonly capacityLimits?: CfnCollectionGroup.CapacityLimitsProperty | cdk.IResolvable;
/**
* The description of the collection group.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-collectiongroup.html#cfn-opensearchserverless-collectiongroup-description
*/
readonly description?: string;
/**
* The name of the collection group.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-collectiongroup.html#cfn-opensearchserverless-collectiongroup-name
*/
readonly name: string;
/**
* Indicates whether standby replicas are used for the collection group.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-collectiongroup.html#cfn-opensearchserverless-collectiongroup-standbyreplicas
*/
readonly standbyReplicas: string;
/**
* An array of key-value pairs to apply to this resource.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-collectiongroup.html#cfn-opensearchserverless-collectiongroup-tags
*/
readonly tags?: Array<cdk.CfnTag>;
}
/**
* An OpenSearch Serverless index resource.
*
* @cloudformationResource AWS::OpenSearchServerless::Index
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-index.html
*/
export declare class CfnIndex extends cdk.CfnResource implements cdk.IInspectable, IIndexRef {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnIndex from CloudFormation properties
*
* A factory method that creates a new instance of this class from an object
* containing the CloudFormation properties of this resource.
* Used in the @aws-cdk/cloudformation-include module.
*
* @internal
*/
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnIndex;
/**
* Checks whether the given object is a CfnIndex
*/
static isCfnIndex(x: any): x is CfnIndex;
/**
* The endpoint for the collection.
*/
private _collectionEndpoint;
/**
* The name of the OpenSearch Serverless index.
*/
private _indexName;
/**
* Index mappings for the OpenSearch Serverless index.
*/
private _mappings?;
/**
* Index settings for the OpenSearch Serverless index.
*/
private _settings?;
protected readonly cfnPropertyNames: Record<string, string>;
/**
* Create a new `AWS::OpenSearchServerless::Index`.
*
* @param scope Scope in which this resource is defined
* @param id Construct identifier for this resource (unique in its scope)
* @param props Resource properties
*/
constructor(scope: constructs.Construct, id: string, props: CfnIndexProps);
get indexRef(): IndexReference;
/**
* The endpoint for the collection.
*/
get collectionEndpoint(): string;
/**
* The endpoint for the collection.
*/
set collectionEndpoint(value: string);
/**
* The name of the OpenSearch Serverless index.
*/
get indexName(): string;
/**
* The name of the OpenSearch Serverless index.
*/
set indexName(value: string);
/**
* Index mappings for the OpenSearch Serverless index.
*/
get mappings(): cdk.IResolvable | CfnIndex.MappingsProperty | undefined;
/**
* Index mappings for the OpenSearch Serverless index.
*/
set mappings(value: cdk.IResolvable | CfnIndex.MappingsProperty | undefined);
/**
* Index settings for the OpenSearch Serverless index.
*/
get settings(): CfnIndex.IndexSettingsProperty | cdk.IResolvable | undefined;
/**
* Index settings for the OpenSearch Serverless index.
*/
set settings(value: CfnIndex.IndexSettingsProperty | cdk.IResolvable | undefined);
/**
* The unique identifier for the index.
*
* @cloudformationAttribute Uuid
*/
get attrUuid(): string;
protected get cfnProperties(): Record<string, any>;
/**
* Examines the CloudFormation resource and discloses attributes
*
* @param inspector tree inspector to collect and process attributes
*/
inspect(inspector: cdk.TreeInspector): void;
protected renderProperties(props: Record<string, any>): Record<string, any>;
}
export declare namespace CfnIndex {
/**
* Index settings for the OpenSearch Serverless index.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-indexsettings.html
*/
interface IndexSettingsProperty {
/**
* Index settings.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-indexsettings.html#cfn-opensearchserverless-index-indexsettings-index
*/
readonly index?: CfnIndex.IndexProperty | cdk.IResolvable;
}
/**
* An OpenSearch Serverless index resource.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-index.html
*/
interface IndexProperty {
/**
* Enable or disable k-nearest neighbor search capability.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-index.html#cfn-opensearchserverless-index-index-knn
*/
readonly knn?: boolean | cdk.IResolvable;
/**
* The size of the dynamic list for the nearest neighbors.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-index.html#cfn-opensearchserverless-index-index-knnalgoparamefsearch
*/
readonly knnAlgoParamEfSearch?: number;
/**
* How often to perform a refresh operation.
*
* For example, 1s or 5s.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-index.html#cfn-opensearchserverless-index-index-refreshinterval
*/
readonly refreshInterval?: string;
}
/**
* Index mappings for the OpenSearch Serverless index.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-mappings.html
*/
interface MappingsProperty {
/**
* Nested fields within an object or nested field type.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-mappings.html#cfn-opensearchserverless-index-mappings-properties
*/
readonly properties?: cdk.IResolvable | Record<string, cdk.IResolvable | CfnIndex.PropertyMappingProperty>;
}
/**
* Property mappings for the OpenSearch Serverless index.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-propertymapping.html
*/
interface PropertyMappingProperty {
/**
* Dimension size for vector fields, defines the number of dimensions in the vector.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-propertymapping.html#cfn-opensearchserverless-index-propertymapping-dimension
*/
readonly dimension?: number;
/**
* Whether a field should be indexed.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-propertymapping.html#cfn-opensearchserverless-index-propertymapping-index
*/
readonly index?: boolean | cdk.IResolvable;
/**
* Configuration for k-NN search method.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-propertymapping.html#cfn-opensearchserverless-index-propertymapping-method
*/
readonly method?: cdk.IResolvable | CfnIndex.MethodProperty;
/**
* Defines the fields within the mapping, including their types and configurations.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-propertymapping.html#cfn-opensearchserverless-index-propertymapping-properties
*/
readonly properties?: cdk.IResolvable | Record<string, cdk.IResolvable | CfnIndex.PropertyMappingProperty>;
/**
* The field data type.
*
* Must be a valid OpenSearch field type.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-propertymapping.html#cfn-opensearchserverless-index-propertymapping-type
*/
readonly type: string;
/**
* Default value for the field when not specified in a document.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-propertymapping.html#cfn-opensearchserverless-index-propertymapping-value
*/
readonly value?: string;
}
/**
* Configuration for k-NN search method.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-method.html
*/
interface MethodProperty {
/**
* The k-NN search engine to use.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-method.html#cfn-opensearchserverless-index-method-engine
*/
readonly engine?: string;
/**
* The algorithm name for k-NN search.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-method.html#cfn-opensearchserverless-index-method-name
*/
readonly name: string;
/**
* Additional parameters for the k-NN algorithm.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-method.html#cfn-opensearchserverless-index-method-parameters
*/
readonly parameters?: cdk.IResolvable | CfnIndex.ParametersProperty;
/**
* The distance function used for k-NN search.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-method.html#cfn-opensearchserverless-index-method-spacetype
*/
readonly spaceType?: string;
}
/**
* Additional parameters for the k-NN algorithm.
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-parameters.html
*/
interface ParametersProperty {
/**
* The size of the dynamic list used during k-NN graph creation.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-parameters.html#cfn-opensearchserverless-index-parameters-efconstruction
*/
readonly efConstruction?: number;
/**
* Number of neighbors to consider during k-NN search.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-index-parameters.html#cfn-opensearchserverless-index-parameters-m
*/
readonly m?: number;
}
}
/**
* Properties for defining a `CfnIndex`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-index.html
*/
export interface CfnIndexProps {
/**
* The endpoint for the collection.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-index.html#cfn-opensearchserverless-index-collectionendpoint
*/
readonly collectionEndpoint: string;
/**
* The name of the OpenSearch Serverless index.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-index.html#cfn-opensearchserverless-index-indexname
*/
readonly indexName: string;
/**
* Index mappings for the OpenSearch Serverless index.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-index.html#cfn-opensearchserverless-index-mappings
*/
readonly mappings?: cdk.IResolvable | CfnIndex.MappingsProperty;
/**
* Index settings for the OpenSearch Serverless index.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-index.html#cfn-opensearchserverless-index-settings
*/
readonly settings?: CfnIndex.IndexSettingsProperty | cdk.IResolvable;
}
/**
* Creates a lifecyle policy to be applied to OpenSearch Serverless indexes.
*
* Lifecycle policies define the number of days or hours to retain the data on an OpenSearch Serverless index. For more information, see [Creating data lifecycle policies](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-lifecycle.html#serverless-lifecycle-create) .
*
* @cloudformationResource AWS::OpenSearchServerless::LifecyclePolicy
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-lifecyclepolicy.html
*/
export declare class CfnLifecyclePolicy extends cdk.CfnResource implements cdk.IInspectable, ILifecyclePolicyRef {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnLifecyclePolicy from CloudFormation properties
*
* A factory method that creates a new instance of this class from an object
* containing the CloudFormation properties of this resource.
* Used in the @aws-cdk/cloudformation-include module.
*
* @internal
*/
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnLifecyclePolicy;
/**
* Checks whether the given object is a CfnLifecyclePolicy
*/
static isCfnLifecyclePolicy(x: any): x is CfnLifecyclePolicy;
/**
* The description of the lifecycle policy.
*/
private _description?;
/**
* The name of the lifecycle policy.
*/
private _name;
/**
* The JSON policy document without any whitespaces.
*/
private _policy;
/**
* The type of lifecycle policy.
*/
private _type;
protected readonly cfnPropertyNames: Record<string, string>;
/**
* Create a new `AWS::OpenSearchServerless::LifecyclePolicy`.
*
* @param scope Scope in which this resource is defined
* @param id Construct identifier for this resource (unique in its scope)
* @param props Resource properties
*/
constructor(scope: constructs.Construct, id: string, props: CfnLifecyclePolicyProps);
get lifecyclePolicyRef(): LifecyclePolicyReference;
/**
* The description of the lifecycle policy.
*/
get description(): string | undefined;
/**
* The description of the lifecycle policy.
*/
set description(value: string | undefined);
/**
* The name of the lifecycle policy.
*/
get name(): string;
/**
* The name of the lifecycle policy.
*/
set name(value: string);
/**
* The JSON policy document without any whitespaces.
*/
get policy(): string;
/**
* The JSON policy document without any whitespaces.
*/
set policy(value: string);
/**
* The type of lifecycle policy.
*/
get type(): string;
/**
* The type of lifecycle policy.
*/
set type(value: string);
protected get cfnProperties(): Record<string, any>;
/**
* Examines the CloudFormation resource and discloses attributes
*
* @param inspector tree inspector to collect and process attributes
*/
inspect(inspector: cdk.TreeInspector): void;
protected renderProperties(props: Record<string, any>): Record<string, any>;
}
/**
* Properties for defining a `CfnLifecyclePolicy`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-lifecyclepolicy.html
*/
export interface CfnLifecyclePolicyProps {
/**
* The description of the lifecycle policy.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-lifecyclepolicy.html#cfn-opensearchserverless-lifecyclepolicy-description
*/
readonly description?: string;
/**
* The name of the lifecycle policy.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-lifecyclepolicy.html#cfn-opensearchserverless-lifecyclepolicy-name
*/
readonly name: string;
/**
* The JSON policy document without any whitespaces.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-lifecyclepolicy.html#cfn-opensearchserverless-lifecyclepolicy-policy
*/
readonly policy: string;
/**
* The type of lifecycle policy.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opensearchserverless-lifecyclepolicy.html#cfn-opensearchserverless-lifecyclepolicy-type
*/
readonly type: string;
}
export type { IAccessPolicyRef, AccessPolicyReference };
export type { ICollectionRef, CollectionReference };
export type { ISecurityConfigRef, SecurityConfigReference };
export type { ISecurityPolicyRef, SecurityPolicyReference };
export type { IVpcEndpointRef, VpcEndpointReference };
export type { ICollectionGroupRef, CollectionGroupReference };
export type { IIndexRef, IndexReference };
export type { ILifecyclePolicyRef, LifecyclePolicyReference };