Class CfnDomain.VPCOptionsProperty
The virtual private cloud (VPC) configuration for the OpenSearch Service domain.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.Elasticsearch
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class VPCOptionsProperty : Object, CfnDomain.IVPCOptionsProperty
Syntax (vb)
Public Class VPCOptionsProperty
Inherits Object
Implements CfnDomain.IVPCOptionsProperty
Remarks
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 .
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.Elasticsearch;
var vPCOptionsProperty = new VPCOptionsProperty {
SecurityGroupIds = new [] { "securityGroupIds" },
SubnetIds = new [] { "subnetIds" }
};
Synopsis
Constructors
VPCOptionsProperty() |
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. |
Constructors
VPCOptionsProperty()
public VPCOptionsProperty()
Properties
SecurityGroupIds
The list of security group IDs that are associated with the VPC endpoints for the domain.
public string[] SecurityGroupIds { get; set; }
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.
public string[] SubnetIds { get; set; }
Property Value
System.String[]
Remarks
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.