Interface CfnDomain.IVPCOptionsProperty
The virtual private cloud (VPC) configuration for the OpenSearch Service domain.
Namespace: Amazon.CDK.AWS.OpenSearchService
Assembly: Amazon.CDK.AWS.OpenSearchService.dll
Syntax (csharp)
public interface IVPCOptionsProperty
Syntax (vb)
Public Interface IVPCOptionsProperty
Remarks
For more information, see Launching your Amazon OpenSearch Service domains using a VPC in the Amazon OpenSearch Service Developer Guide .
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.OpenSearchService;
var vPCOptionsProperty = new VPCOptionsProperty {
SecurityGroupIds = new [] { "securityGroupIds" },
SubnetIds = new [] { "subnetIds" }
};
Synopsis
Properties
SecurityGroupIds | The list of security group IDs that are associated with the VPC endpoints for the domain. |
SubnetIds | Provide one subnet ID for each Availability Zone that your domain uses. |
Properties
SecurityGroupIds
The list of security group IDs that are associated with the VPC endpoints for the domain.
virtual string[] SecurityGroupIds { get; }
Property Value
System.String[]
Remarks
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
Provide one subnet ID for each Availability Zone that your domain uses.
virtual string[] SubnetIds { get; }
Property Value
System.String[]
Remarks
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.