AWS::OpenSearchServerless::VpcEndpoint - AWS CloudFormation
SyntaxPropertiesReturn valuesExamples

AWS::OpenSearchServerless::VpcEndpoint

Creates an OpenSearch Serverless-managed interface VPC endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::OpenSearchServerless::VpcEndpoint",
  "Properties" : {
      "Name" : String,
      "SecurityGroupIds" : [ String, ... ],
      "SubnetIds" : [ String, ... ],
      "VpcId" : String
    }
}

YAML

Type: AWS::OpenSearchServerless::VpcEndpoint
Properties:
  Name: String
  SecurityGroupIds: 
    - String
  SubnetIds: 
    - String
  VpcId: String

Properties

Name

The name of the endpoint.

Required: Yes

Type: String

Pattern: ^[a-z][a-z0-9-]{2,31}$

Minimum: 3

Maximum: 32

Update requires: Replacement

SecurityGroupIds

The unique identifiers of the security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.

Required: No

Type: Array of String

Minimum: 1 | 1

Maximum: 128 | 5

Update requires: No interruption

SubnetIds

The ID of the subnets from which you access OpenSearch Serverless.

Required: Yes

Type: Array of String

Minimum: 1 | 1

Maximum: 32 | 6

Update requires: No interruption

VpcId

The ID of the VPC from which you access OpenSearch Serverless.

Required: Yes

Type: String

Pattern: ^vpc-[0-9a-z]*$

Minimum: 1

Maximum: 255

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the endpoint ID. For more information about using the Ref function, see Ref.

Fn::GetAtt

GetAtt returns a value for a specified attribute of this type. For more information, see Fn::GetAtt. The following are the available attributes and sample return values.

Id

The unique identifier of the endpoint. For example, vpce-050f79086ee71ac05.

Examples

Create a VPC endpoint

The following example specifies an OpenSearch Serverless-managed interface VPC endpoint named test-vpcendpoint. The endpoint has one subnet and one security group.

JSON

{
   "Description":"OpenSearch Serverless VPC endpoint template",
   "Resources":{
      "TestAOSSVpcEndpoint":{
         "Type":"AWS::OpenSearchServerless::VpcEndpoint",
         "Properties":{
            "Name":"test-vpcendpoint",
            "VpcId":"vpc-0d728b8430292b3f4",
            "SubnetIds":[
               "subnet-0e855f5722a9598ee"
            ],
            "SecurityGroupIds":[
               "sg-03843b03f369eb245"
            ]
         }
      }
   }
}

YAML

AAWSTemplateFormatVersion: '2010-09-09'
Description: OpenSearch Serverless VPC endpoint template
Resources:
  TestAOSSVpcEndpoint:
    Type: 'AWS::OpenSearchServerless::VpcEndpoint'
    Properties:
      Name: test-vpcendpoint
      VpcId: vpc-0d728b8430292b3f4
      SubnetIds:
        - subnet-0e855f5722a9598ee
      SecurityGroupIds:
        - sg-03843b03f369eb245