1.204.0

interface VPCOptionsProperty

LanguageType name
.NETAmazon.CDK.AWS.Elasticsearch.CfnDomain.VPCOptionsProperty
Javasoftware.amazon.awscdk.services.elasticsearch.CfnDomain.VPCOptionsProperty
Pythonaws_cdk.aws_elasticsearch.CfnDomain.VPCOptionsProperty
TypeScript @aws-cdk/aws-elasticsearch » CfnDomain » VPCOptionsProperty

The virtual private cloud (VPC) configuration for the OpenSearch Service domain.

For more information, see Launching your Amazon OpenSearch Service domains using a VPC in the Amazon OpenSearch Service Developer Guide .

The AWS::Elasticsearch::Domain resource is being replaced by the AWS::OpenSearchService::Domain resource. While the legacy Elasticsearch resource and options are still supported, we recommend modifying your existing Cloudformation templates to use the new OpenSearch Service resource, which supports both OpenSearch and Elasticsearch. For more information about the service rename, see New resource types in the Amazon OpenSearch Service Developer Guide .

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as elasticsearch from '@aws-cdk/aws-elasticsearch';
const vPCOptionsProperty: elasticsearch.CfnDomain.VPCOptionsProperty = {
  securityGroupIds: ['securityGroupIds'],
  subnetIds: ['subnetIds'],
};

Properties

NameTypeDescription
securityGroupIds?string[]The list of security group IDs that are associated with the VPC endpoints for the domain.
subnetIds?string[]Provide one subnet ID for each Availability Zone that your domain uses.

securityGroupIds?

Type: string[] (optional)

The list of security group IDs that are associated with the VPC endpoints for the domain.

If you don't provide a security group ID, OpenSearch Service uses the default security group for the VPC. To learn more, see Security groups for your VPC in the Amazon VPC User Guide .

subnetIds?

Type: string[] (optional)

Provide one subnet ID for each Availability Zone that your domain uses.

For example, you must specify three subnet IDs for a three Availability Zone domain. To learn more, see VPCs and subnets in the Amazon VPC User Guide .

Required if you're creating your domain inside a VPC.

← PreviousNext →