interface VPCOptionsProperty
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.CfnPropertyMixins.AWS.OpenSearchService.CfnDomainPropsMixin.VPCOptionsProperty |
 Go | github.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awsopensearchservice#CfnDomainPropsMixin_VPCOptionsProperty |
 Java | software.amazon.awscdk.cfnpropertymixins.services.opensearchservice.CfnDomainPropsMixin.VPCOptionsProperty |
 Python | aws_cdk.cfn_property_mixins.aws_opensearchservice.CfnDomainPropsMixin.VPCOptionsProperty |
 TypeScript | @aws-cdk/cfn-property-mixins » aws_opensearchservice » CfnDomainPropsMixin » 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 .
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_opensearchservice as opensearchservice } from '@aws-cdk/cfn-property-mixins';
const vPCOptionsProperty: opensearchservice.CfnDomainPropsMixin.VPCOptionsProperty = {
securityGroupIds: ['securityGroupIds'],
subnetIds: ['subnetIds'],
};
Properties
| Name | Type | Description |
|---|---|---|
| security | (string | ISecurity)[] | The list of security group IDs that are associated with the VPC endpoints for the domain. |
| subnet | (string | ISubnet)[] | Provide one subnet ID for each Availability Zone that your domain uses. |
securityGroupIds?
Type:
(string | ISecurity)[]
(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 | ISubnet)[]
(optional)
Provide one subnet ID for each Availability Zone that your domain uses.
For example, you must specify three subnet IDs for a three-AZ domain. To learn more, see VPCs and subnets in the Amazon VPC User Guide .
If you specify more than one subnet, you must also configure ZoneAwarenessEnabled and ZoneAwarenessConfig within ClusterConfig , otherwise you'll see the error "You must specify exactly one subnet" during template creation.